1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
|
// Copyright 2014 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "chrome/browser/ash/customization/customization_wallpaper_downloader.h"
#include <stddef.h>
#include <algorithm>
#include <vector>
#include "ash/constants/ash_switches.h"
#include "ash/public/cpp/wallpaper/wallpaper_controller.h"
#include "ash/public/cpp/wallpaper/wallpaper_controller_observer.h"
#include "base/command_line.h"
#include "base/functional/bind.h"
#include "base/run_loop.h"
#include "base/strings/stringprintf.h"
#include "base/test/bind.h"
#include "base/time/time.h"
#include "chrome/browser/ash/customization/customization_document.h"
#include "chrome/test/base/in_process_browser_test.h"
#include "chrome/test/base/testing_browser_process.h"
#include "content/public/test/browser_test.h"
#include "net/http/http_response_headers.h"
#include "net/http/http_status_code.h"
#include "net/test/embedded_test_server/http_response.h"
#include "testing/gtest/include/gtest/gtest.h"
#include "third_party/skia/include/core/SkBitmap.h"
#include "ui/gfx/codec/jpeg_codec.h"
#include "ui/gfx/geometry/point.h"
#include "ui/gfx/geometry/rect.h"
#include "ui/gfx/geometry/size.h"
namespace ash {
namespace {
constexpr char kOEMWallpaperRelativeURL[] = "/image.png";
constexpr char kServicesManifest[] =
"{"
" \"version\": \"1.0\","
" \"default_wallpaper\": \"\%s\",\n"
" \"default_apps\": [\n"
" \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\n"
" \"bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb\"\n"
" ],\n"
" \"localized_content\": {\n"
" \"en-US\": {\n"
" \"default_apps_folder_name\": \"EN-US OEM Name\"\n"
" },\n"
" \"en\": {\n"
" \"default_apps_folder_name\": \"EN OEM Name\"\n"
" },\n"
" \"default\": {\n"
" \"default_apps_folder_name\": \"Default OEM Name\"\n"
" }\n"
" }\n"
"}";
// Expected minimal wallpaper download retry interval in milliseconds.
constexpr int kDownloadRetryIntervalMS = 100;
// Dimension used for width and height of default wallpaper images. A small
// value is used to minimize the amount of time spent compressing and writing
// images.
constexpr int kWallpaperSize = 2;
constexpr SkColor kCustomizedDefaultWallpaperColor = SK_ColorDKGRAY;
std::string ManifestForURL(const std::string& url) {
return base::StringPrintf(kServicesManifest, url.c_str());
}
// Returns true if the color at the center of |image| is close to
// |expected_color|. (The center is used so small wallpaper images can be
// used.)
bool ImageIsNearColor(gfx::ImageSkia image, SkColor expected_color) {
if (image.size().IsEmpty()) {
LOG(ERROR) << "Image is empty";
return false;
}
const SkBitmap* bitmap = image.bitmap();
if (!bitmap) {
LOG(ERROR) << "Unable to get bitmap from image";
return false;
}
gfx::Point center = gfx::Rect(image.size()).CenterPoint();
SkColor image_color = bitmap->getColor(center.x(), center.y());
const int kDiff = 3;
if (std::abs(static_cast<int>(SkColorGetA(image_color)) -
static_cast<int>(SkColorGetA(expected_color))) > kDiff ||
std::abs(static_cast<int>(SkColorGetR(image_color)) -
static_cast<int>(SkColorGetR(expected_color))) > kDiff ||
std::abs(static_cast<int>(SkColorGetG(image_color)) -
static_cast<int>(SkColorGetG(expected_color))) > kDiff ||
std::abs(static_cast<int>(SkColorGetB(image_color)) -
static_cast<int>(SkColorGetB(expected_color))) > kDiff) {
LOG(ERROR) << "Expected color near 0x" << std::hex << expected_color
<< " but got 0x" << image_color;
return false;
}
return true;
}
// Creates compressed JPEG image of solid color. Result bytes are written to
// |output|. Returns true on success.
std::vector<uint8_t> CreateJPEGImage(int width, int height, SkColor color) {
SkBitmap bitmap;
bitmap.allocN32Pixels(width, height);
bitmap.eraseColor(color);
return gfx::JPEGCodec::Encode(bitmap, 80 /*quality=*/).value();
}
class TestWallpaperObserver : public WallpaperControllerObserver {
public:
TestWallpaperObserver() {
ash::WallpaperController::Get()->AddObserver(this);
}
TestWallpaperObserver(const TestWallpaperObserver&) = delete;
TestWallpaperObserver& operator=(const TestWallpaperObserver&) = delete;
~TestWallpaperObserver() override {
ash::WallpaperController::Get()->RemoveObserver(this);
}
// WallpaperControllerObserver:
void OnWallpaperChanged() override {
finished_ = true;
if (run_loop_) {
run_loop_->Quit();
}
}
// Wait until the wallpaper update is completed.
void WaitForWallpaperChanged() {
while (!finished_) {
run_loop_ = std::make_unique<base::RunLoop>();
run_loop_->Run();
}
}
void Reset() { finished_ = false; }
private:
bool finished_ = false;
std::unique_ptr<base::RunLoop> run_loop_;
};
} // namespace
class CustomizationWallpaperDownloaderBrowserTest
: public InProcessBrowserTest {
public:
CustomizationWallpaperDownloaderBrowserTest() = default;
CustomizationWallpaperDownloaderBrowserTest(
const CustomizationWallpaperDownloaderBrowserTest&) = delete;
CustomizationWallpaperDownloaderBrowserTest& operator=(
const CustomizationWallpaperDownloaderBrowserTest&) = delete;
~CustomizationWallpaperDownloaderBrowserTest() override = default;
// InProcessBrowserTest overrides:
void SetUpOnMainThread() override {
InProcessBrowserTest::SetUpOnMainThread();
std::vector<uint8_t> oem_wallpaper = CreateJPEGImage(
kWallpaperSize, kWallpaperSize, kCustomizedDefaultWallpaperColor);
jpeg_data_.resize(oem_wallpaper.size());
std::ranges::copy(oem_wallpaper, jpeg_data_.begin());
// Set up the test server.
embedded_test_server()->RegisterRequestHandler(base::BindRepeating(
&CustomizationWallpaperDownloaderBrowserTest::HandleRequest,
base::Unretained(this)));
ASSERT_TRUE(embedded_test_server()->Start());
}
void SetUpCommandLine(base::CommandLine* command_line) override {
command_line->AppendSwitch(switches::kLoginManager);
command_line->AppendSwitchASCII(switches::kLoginProfile, "user");
}
void SetRequiredRetries(size_t retries) { required_retries_ = retries; }
size_t num_attempts() const { return attempts_.size(); }
private:
std::unique_ptr<net::test_server::HttpResponse> HandleRequest(
const net::test_server::HttpRequest& request) {
ServicesCustomizationDocument* customization =
ServicesCustomizationDocument::GetInstance();
customization->wallpaper_downloader_for_testing()
->set_retry_delay_for_testing(
base::Milliseconds(kDownloadRetryIntervalMS));
attempts_.push_back(base::TimeTicks::Now());
if (attempts_.size() > 1) {
const int retry = num_attempts() - 1;
const base::TimeDelta current_delay =
customization->wallpaper_downloader_for_testing()
->retry_current_delay_for_testing();
const double base_interval =
base::Milliseconds(kDownloadRetryIntervalMS).InSecondsF();
EXPECT_GE(current_delay, base::Seconds(base_interval * retry * retry))
<< "Retry too fast. Actual interval " << current_delay.InSecondsF()
<< " seconds, but expected at least " << base_interval
<< " * (retry=" << retry
<< " * retry)= " << base_interval * retry * retry << " seconds.";
}
if (attempts_.size() > required_retries_) {
std::unique_ptr<net::test_server::BasicHttpResponse> response =
std::make_unique<net::test_server::BasicHttpResponse>();
response->set_content_type("image/jpeg");
response->set_code(net::HTTP_OK);
response->set_content(jpeg_data_);
return std::move(response);
}
return nullptr;
}
// Sample Wallpaper content.
std::string jpeg_data_;
// Number of loads performed.
std::vector<base::TimeTicks> attempts_;
// Number of retries required.
size_t required_retries_ = 0;
};
IN_PROC_BROWSER_TEST_F(CustomizationWallpaperDownloaderBrowserTest,
OEMWallpaperIsPresent) {
TestWallpaperObserver observer;
// Show a built-in default wallpaper first.
ash::WallpaperController::Get()->ShowSigninWallpaper();
observer.WaitForWallpaperChanged();
observer.Reset();
// Set the number of required retries.
SetRequiredRetries(0);
// Start fetching the customized default wallpaper.
GURL url = embedded_test_server()->GetURL(kOEMWallpaperRelativeURL);
ServicesCustomizationDocument* customization =
ServicesCustomizationDocument::GetInstance();
EXPECT_TRUE(
customization->LoadManifestFromString(ManifestForURL(url.spec())));
observer.WaitForWallpaperChanged();
observer.Reset();
// Verify the customized default wallpaper has replaced the built-in default
// wallpaper.
gfx::ImageSkia image = ash::WallpaperController::Get()->GetWallpaperImage();
EXPECT_TRUE(ImageIsNearColor(image, kCustomizedDefaultWallpaperColor));
EXPECT_EQ(1U, num_attempts());
}
IN_PROC_BROWSER_TEST_F(CustomizationWallpaperDownloaderBrowserTest,
OEMWallpaperRetryFetch) {
TestWallpaperObserver observer;
// Show a built-in default wallpaper.
ash::WallpaperController::Get()->ShowSigninWallpaper();
observer.WaitForWallpaperChanged();
observer.Reset();
// Set the number of required retries.
SetRequiredRetries(1);
// Start fetching the customized default wallpaper.
GURL url = embedded_test_server()->GetURL(kOEMWallpaperRelativeURL);
ServicesCustomizationDocument* customization =
ServicesCustomizationDocument::GetInstance();
EXPECT_TRUE(
customization->LoadManifestFromString(ManifestForURL(url.spec())));
observer.WaitForWallpaperChanged();
observer.Reset();
// Verify the customized default wallpaper has replaced the built-in default
// wallpaper.
gfx::ImageSkia image = ash::WallpaperController::Get()->GetWallpaperImage();
EXPECT_TRUE(ImageIsNearColor(image, kCustomizedDefaultWallpaperColor));
EXPECT_EQ(2U, num_attempts());
}
} // namespace ash
|