blob: 68b93b0f841640c63ffdfda73a6b7d9b1b90291e [file] [log] [blame]
// Copyright 2014 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "extensions/browser/image_loader.h"
#include "base/files/file_path.h"
#include "base/json/json_file_value_serializer.h"
#include "base/message_loop/message_loop.h"
#include "base/path_service.h"
#include "base/strings/string_util.h"
#include "chrome/browser/chrome_notification_types.h"
#include "chrome/common/chrome_paths.h"
#include "content/public/browser/notification_service.h"
#include "content/public/test/test_browser_thread.h"
#include "extensions/browser/component_extension_resource_manager.h"
#include "extensions/browser/extensions_browser_client.h"
#include "extensions/common/constants.h"
#include "extensions/common/extension.h"
#include "extensions/common/extension_icon_set.h"
#include "extensions/common/extension_resource.h"
#include "extensions/common/manifest.h"
#include "extensions/common/manifest_handlers/icons_handler.h"
#include "testing/gtest/include/gtest/gtest.h"
#include "third_party/skia/include/core/SkBitmap.h"
#include "ui/gfx/image/image.h"
#include "ui/gfx/image/image_family.h"
#include "ui/gfx/image/image_skia.h"
#include "ui/gfx/size.h"
#if defined(OS_CHROMEOS)
#include "ui/file_manager/grit/file_manager_resources.h"
#endif
using content::BrowserThread;
using extensions::Extension;
using extensions::ExtensionResource;
using extensions::ImageLoader;
using extensions::Manifest;
using extensions::UnloadedExtensionInfo;
class ImageLoaderTest : public testing::Test {
public:
ImageLoaderTest()
: image_loaded_count_(0),
quit_in_image_loaded_(false),
ui_thread_(BrowserThread::UI, &ui_loop_),
file_thread_(BrowserThread::FILE),
io_thread_(BrowserThread::IO) {
}
void OnImageLoaded(const gfx::Image& image) {
image_loaded_count_++;
if (quit_in_image_loaded_)
base::MessageLoop::current()->Quit();
image_ = image;
}
void OnImageFamilyLoaded(const gfx::ImageFamily& image_family) {
image_loaded_count_++;
if (quit_in_image_loaded_)
base::MessageLoop::current()->Quit();
image_family_ = image_family;
}
void WaitForImageLoad() {
quit_in_image_loaded_ = true;
base::MessageLoop::current()->Run();
quit_in_image_loaded_ = false;
}
int image_loaded_count() {
int result = image_loaded_count_;
image_loaded_count_ = 0;
return result;
}
scoped_refptr<Extension> CreateExtension(const char* name,
Manifest::Location location) {
// Create and load an extension.
base::FilePath test_file;
if (!PathService::Get(chrome::DIR_TEST_DATA, &test_file)) {
EXPECT_FALSE(true);
return NULL;
}
test_file = test_file.AppendASCII("extensions")
.AppendASCII(name);
int error_code = 0;
std::string error;
JSONFileValueSerializer serializer(test_file.AppendASCII("app.json"));
scoped_ptr<base::DictionaryValue> valid_value(
static_cast<base::DictionaryValue*>(serializer.Deserialize(&error_code,
&error)));
EXPECT_EQ(0, error_code) << error;
if (error_code != 0)
return NULL;
EXPECT_TRUE(valid_value.get());
if (!valid_value)
return NULL;
if (location == Manifest::COMPONENT) {
if (!PathService::Get(chrome::DIR_RESOURCES, &test_file)) {
EXPECT_FALSE(true);
return NULL;
}
test_file = test_file.AppendASCII(name);
}
return Extension::Create(test_file, location, *valid_value,
Extension::NO_FLAGS, &error);
}
gfx::Image image_;
gfx::ImageFamily image_family_;
private:
virtual void SetUp() OVERRIDE {
testing::Test::SetUp();
file_thread_.Start();
io_thread_.Start();
}
int image_loaded_count_;
bool quit_in_image_loaded_;
base::MessageLoop ui_loop_;
content::TestBrowserThread ui_thread_;
content::TestBrowserThread file_thread_;
content::TestBrowserThread io_thread_;
};
// Tests loading an image works correctly.
TEST_F(ImageLoaderTest, LoadImage) {
scoped_refptr<Extension> extension(CreateExtension(
"image_loading_tracker", Manifest::INVALID_LOCATION));
ASSERT_TRUE(extension.get() != NULL);
ExtensionResource image_resource = extensions::IconsInfo::GetIconResource(
extension.get(),
extension_misc::EXTENSION_ICON_SMALLISH,
ExtensionIconSet::MATCH_EXACTLY);
gfx::Size max_size(extension_misc::EXTENSION_ICON_SMALLISH,
extension_misc::EXTENSION_ICON_SMALLISH);
ImageLoader loader;
loader.LoadImageAsync(extension.get(),
image_resource,
max_size,
base::Bind(&ImageLoaderTest::OnImageLoaded,
base::Unretained(this)));
// The image isn't cached, so we should not have received notification.
EXPECT_EQ(0, image_loaded_count());
WaitForImageLoad();
// We should have gotten the image.
EXPECT_EQ(1, image_loaded_count());
// Check that the image was loaded.
EXPECT_EQ(extension_misc::EXTENSION_ICON_SMALLISH,
image_.ToSkBitmap()->width());
}
// Tests deleting an extension while waiting for the image to load doesn't cause
// problems.
TEST_F(ImageLoaderTest, DeleteExtensionWhileWaitingForCache) {
scoped_refptr<Extension> extension(CreateExtension(
"image_loading_tracker", Manifest::INVALID_LOCATION));
ASSERT_TRUE(extension.get() != NULL);
ExtensionResource image_resource = extensions::IconsInfo::GetIconResource(
extension.get(),
extension_misc::EXTENSION_ICON_SMALLISH,
ExtensionIconSet::MATCH_EXACTLY);
gfx::Size max_size(extension_misc::EXTENSION_ICON_SMALLISH,
extension_misc::EXTENSION_ICON_SMALLISH);
ImageLoader loader;
std::set<int> sizes;
sizes.insert(extension_misc::EXTENSION_ICON_SMALLISH);
loader.LoadImageAsync(extension.get(),
image_resource,
max_size,
base::Bind(&ImageLoaderTest::OnImageLoaded,
base::Unretained(this)));
// The image isn't cached, so we should not have received notification.
EXPECT_EQ(0, image_loaded_count());
// Send out notification the extension was uninstalled.
UnloadedExtensionInfo details(extension.get(),
UnloadedExtensionInfo::REASON_UNINSTALL);
content::NotificationService::current()->Notify(
chrome::NOTIFICATION_EXTENSION_UNLOADED_DEPRECATED,
content::NotificationService::AllSources(),
content::Details<UnloadedExtensionInfo>(&details));
// Chuck the extension, that way if anyone tries to access it we should crash
// or get valgrind errors.
extension = NULL;
WaitForImageLoad();
// Even though we deleted the extension, we should still get the image.
// We should still have gotten the image.
EXPECT_EQ(1, image_loaded_count());
// Check that the image was loaded.
EXPECT_EQ(extension_misc::EXTENSION_ICON_SMALLISH,
image_.ToSkBitmap()->width());
}
// Tests loading multiple dimensions of the same image.
TEST_F(ImageLoaderTest, MultipleImages) {
scoped_refptr<Extension> extension(CreateExtension(
"image_loading_tracker", Manifest::INVALID_LOCATION));
ASSERT_TRUE(extension.get() != NULL);
std::vector<ImageLoader::ImageRepresentation> info_list;
int sizes[] = {extension_misc::EXTENSION_ICON_BITTY,
extension_misc::EXTENSION_ICON_SMALLISH, };
for (size_t i = 0; i < arraysize(sizes); ++i) {
ExtensionResource resource = extensions::IconsInfo::GetIconResource(
extension.get(), sizes[i], ExtensionIconSet::MATCH_EXACTLY);
info_list.push_back(ImageLoader::ImageRepresentation(
resource,
ImageLoader::ImageRepresentation::RESIZE_WHEN_LARGER,
gfx::Size(sizes[i], sizes[i]),
ui::SCALE_FACTOR_NONE));
}
ImageLoader loader;
loader.LoadImagesAsync(extension.get(), info_list,
base::Bind(&ImageLoaderTest::OnImageLoaded,
base::Unretained(this)));
// The image isn't cached, so we should not have received notification.
EXPECT_EQ(0, image_loaded_count());
WaitForImageLoad();
// We should have gotten the image.
EXPECT_EQ(1, image_loaded_count());
// Check that all images were loaded.
std::vector<gfx::ImageSkiaRep> image_reps =
image_.ToImageSkia()->image_reps();
ASSERT_EQ(2u, image_reps.size());
const gfx::ImageSkiaRep* img_rep1 = &image_reps[0];
const gfx::ImageSkiaRep* img_rep2 = &image_reps[1];
EXPECT_EQ(extension_misc::EXTENSION_ICON_BITTY,
img_rep1->pixel_width());
EXPECT_EQ(extension_misc::EXTENSION_ICON_SMALLISH,
img_rep2->pixel_width());
}
// Tests loading multiple dimensions of the same image into an image family.
TEST_F(ImageLoaderTest, LoadImageFamily) {
scoped_refptr<Extension> extension(
CreateExtension("image_loading_tracker", Manifest::INVALID_LOCATION));
ASSERT_TRUE(extension.get() != NULL);
std::vector<ImageLoader::ImageRepresentation> info_list;
int sizes[] = {extension_misc::EXTENSION_ICON_BITTY,
extension_misc::EXTENSION_ICON_SMALLISH, };
for (size_t i = 0; i < arraysize(sizes); ++i) {
ExtensionResource resource = extensions::IconsInfo::GetIconResource(
extension.get(), sizes[i], ExtensionIconSet::MATCH_EXACTLY);
info_list.push_back(ImageLoader::ImageRepresentation(
resource,
ImageLoader::ImageRepresentation::NEVER_RESIZE,
gfx::Size(sizes[i], sizes[i]),
ui::SCALE_FACTOR_100P));
}
// Add a second icon of 200P which should get grouped with the smaller icon's
// ImageSkia.
ExtensionResource resource = extensions::IconsInfo::GetIconResource(
extension.get(),
extension_misc::EXTENSION_ICON_SMALLISH,
ExtensionIconSet::MATCH_EXACTLY);
info_list.push_back(ImageLoader::ImageRepresentation(
resource,
ImageLoader::ImageRepresentation::NEVER_RESIZE,
gfx::Size(extension_misc::EXTENSION_ICON_BITTY,
extension_misc::EXTENSION_ICON_BITTY),
ui::SCALE_FACTOR_200P));
ImageLoader loader;
loader.LoadImageFamilyAsync(extension.get(),
info_list,
base::Bind(&ImageLoaderTest::OnImageFamilyLoaded,
base::Unretained(this)));
// The image isn't cached, so we should not have received notification.
EXPECT_EQ(0, image_loaded_count());
WaitForImageLoad();
// We should have gotten the image.
EXPECT_EQ(1, image_loaded_count());
// Check that all images were loaded.
for (size_t i = 0; i < arraysize(sizes); ++i) {
const gfx::Image* image = image_family_.GetBest(sizes[i], sizes[i]);
EXPECT_EQ(sizes[i], image->Width());
}
// Check the smaller image has 2 representations of different scale factors.
std::vector<gfx::ImageSkiaRep> image_reps =
image_family_.GetBest(extension_misc::EXTENSION_ICON_BITTY,
extension_misc::EXTENSION_ICON_BITTY)
->ToImageSkia()
->image_reps();
ASSERT_EQ(2u, image_reps.size());
const gfx::ImageSkiaRep* img_rep1 = &image_reps[0];
const gfx::ImageSkiaRep* img_rep2 = &image_reps[1];
EXPECT_EQ(extension_misc::EXTENSION_ICON_BITTY, img_rep1->pixel_width());
EXPECT_EQ(1.0f, img_rep1->scale());
EXPECT_EQ(extension_misc::EXTENSION_ICON_SMALLISH, img_rep2->pixel_width());
EXPECT_EQ(2.0f, img_rep2->scale());
}
// Tests IsComponentExtensionResource function.
// TODO(mukai): move this to ChromeComponentExtensionResourceManager's test.
TEST_F(ImageLoaderTest, IsComponentExtensionResource) {
extensions::ComponentExtensionResourceManager* resource_manager =
extensions::ExtensionsBrowserClient::Get()->
GetComponentExtensionResourceManager();
if (!resource_manager)
return;
scoped_refptr<Extension> extension(CreateExtension(
"file_manager", Manifest::COMPONENT));
ASSERT_TRUE(extension.get() != NULL);
ExtensionResource resource = extensions::IconsInfo::GetIconResource(
extension.get(),
extension_misc::EXTENSION_ICON_BITTY,
ExtensionIconSet::MATCH_EXACTLY);
#if defined(OS_CHROMEOS)
int resource_id;
ASSERT_TRUE(resource_manager->IsComponentExtensionResource(
extension->path(),
resource.relative_path(),
&resource_id));
ASSERT_EQ(IDR_FILE_MANAGER_ICON_16, resource_id);
#endif
}