chrome/browser/chromeos/customization/customization_document_unittest.cc

   1 // Copyright (c) 2011 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #include "chrome/browser/chromeos/customization/customization_document.h"
   6
   7 #include "base/message_loop/message_loop.h"
   8 #include "base/prefs/testing_pref_service.h"
   9 #include "base/run_loop.h"
  10 #include "base/strings/stringprintf.h"
  11 #include "chrome/browser/chromeos/net/network_portal_detector_test_impl.h"
  12 #include "chrome/browser/extensions/external_provider_impl.h"
  13 #include "chrome/browser/prefs/browser_prefs.h"
  14 #include "chrome/browser/ui/app_list/app_list_syncable_service.h"
  15 #include "chrome/browser/ui/app_list/app_list_syncable_service_factory.h"
  16 #include "chrome/test/base/testing_browser_process.h"
  17 #include "chrome/test/base/testing_profile.h"
  18 #include "chromeos/dbus/dbus_thread_manager.h"
  19 #include "chromeos/network/network_handler.h"
  20 #include "chromeos/network/network_state.h"
  21 #include "chromeos/network/network_state_handler.h"
  22 #include "chromeos/system/fake_statistics_provider.h"
  23 #include "components/pref_registry/pref_registry_syncable.h"
  24 #include "components/syncable_prefs/pref_service_mock_factory.h"
  25 #include "components/syncable_prefs/pref_service_syncable.h"
  26 #include "content/public/test/test_browser_thread_bundle.h"
  27 #include "extensions/common/extension.h"
  28 #include "extensions/common/manifest.h"
  29 #include "net/http/http_response_headers.h"
  30 #include "net/http/http_status_code.h"
  31 #include "net/url_request/test_url_fetcher_factory.h"
  32 #include "net/url_request/url_request_status.h"
  33 #include "testing/gmock/include/gmock/gmock.h"
  34 #include "testing/gtest/include/gtest/gtest.h"
  35
  36 using ::testing::Exactly;
  37 using ::testing::Invoke;
  38 using ::testing::Mock;
  39 using ::testing::_;
  40
  41 namespace {
  42
  43 const char kGoodStartupManifest[] =
  44     "{"
  45     "  \"version\": \"1.0\","
  46     "  \"initial_locale\" : \"en-US\","
  47     "  \"initial_timezone\" : \"US/Pacific\","
  48     "  \"keyboard_layout\" : \"xkb:us::eng\","
  49     "  \"setup_content\" : {"
  50     "    \"en-US\" : {"
  51     "      \"eula_page\" : \"file:///opt/oem/eula/en-US/eula.html\","
  52     "    },"
  53     "    \"ru-RU\" : {"
  54     "      \"eula_page\" : \"file:///opt/oem/eula/ru-RU/eula.html\","
  55     "    },"
  56     "    \"default\" : {"
  57     "      \"eula_page\" : \"file:///opt/oem/eula/en/eula.html\","
  58     "    },"
  59     "  },"
  60     "  \"hwid_map\" : ["
  61     "    {"
  62     "      \"hwid_mask\": \"ZGA*34\","
  63     "      \"initial_locale\" : \"ja\","
  64     "      \"initial_timezone\" : \"Asia/Tokyo\","
  65     "      \"keyboard_layout\" : \"mozc-jp\","
  66     "    },"
  67     "    {"
  68     "      \"hwid_mask\": \"Mario 1?3*\","
  69     "      \"initial_locale\" : \"ru-RU\","
  70     "      \"initial_timezone\" : \"Europe/Moscow\","
  71     "      \"keyboard_layout\" : \"xkb:ru::rus\","
  72     "    },"
  73     "  ],"
  74     "}";
  75
  76 const char kBadManifest[] = "{\"version\": \"1\"}";
  77
  78 const char kGoodServicesManifest[] =
  79     "{"
  80     "  \"version\": \"1.0\","
  81     "  \"default_apps\": [\n"
  82     "    \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\n"
  83     "    {\n"
  84     "      \"id\": \"bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb\",\n"
  85     "      \"do_not_install_for_enterprise\": true\n"
  86     "    }\n"
  87     "  ],\n"
  88     "  \"localized_content\": {\n"
  89     "    \"en-US\": {\n"
  90     "      \"default_apps_folder_name\": \"EN-US OEM Name\"\n"
  91     "    },\n"
  92     "    \"en\": {\n"
  93     "      \"default_apps_folder_name\": \"EN OEM Name\"\n"
  94     "    },\n"
  95     "    \"default\": {\n"
  96     "      \"default_apps_folder_name\": \"Default OEM Name\"\n"
  97     "    }\n"
  98     "  }\n"
  99     "}";
 100
 101 const char kDummyCustomizationID[] = "test-dummy";
 102
 103 }  // anonymous namespace
 104
 105 namespace chromeos {
 106
 107 using ::testing::DoAll;
 108 using ::testing::NotNull;
 109 using ::testing::Return;
 110 using ::testing::SetArgumentPointee;
 111 using ::testing::_;
 112
 113 TEST(StartupCustomizationDocumentTest, Basic) {
 114   system::ScopedFakeStatisticsProvider fake_statistics_provider;
 115
 116   // hardware_class selects the appropriate entry in hwid_map in the manifest.
 117   fake_statistics_provider.SetMachineStatistic("hardware_class", "Mario 12345");
 118   StartupCustomizationDocument customization(&fake_statistics_provider,
 119                                              kGoodStartupManifest);
 120   EXPECT_EQ("ru-RU", customization.initial_locale());
 121   EXPECT_EQ("Europe/Moscow", customization.initial_timezone());
 122   EXPECT_EQ("xkb:ru::rus", customization.keyboard_layout());
 123
 124   EXPECT_EQ("file:///opt/oem/eula/en-US/eula.html",
 125             customization.GetEULAPage("en-US"));
 126   EXPECT_EQ("file:///opt/oem/eula/ru-RU/eula.html",
 127             customization.GetEULAPage("ru-RU"));
 128   EXPECT_EQ("file:///opt/oem/eula/en/eula.html",
 129             customization.GetEULAPage("ja"));
 130 }
 131
 132 TEST(StartupCustomizationDocumentTest, VPD) {
 133   system::ScopedFakeStatisticsProvider fake_statistics_provider;
 134
 135   // hardware_class selects the appropriate entry in hwid_map in the manifest.
 136   fake_statistics_provider.SetMachineStatistic("hardware_class", "Mario 12345");
 137   fake_statistics_provider.SetMachineStatistic("initial_locale", "ja");
 138   fake_statistics_provider.SetMachineStatistic("initial_timezone",
 139                                                "Asia/Tokyo");
 140   fake_statistics_provider.SetMachineStatistic("keyboard_layout", "mozc-jp");
 141   StartupCustomizationDocument customization(&fake_statistics_provider,
 142                                              kGoodStartupManifest);
 143   EXPECT_TRUE(customization.IsReady());
 144   EXPECT_EQ("ja", customization.initial_locale());
 145   EXPECT_EQ("Asia/Tokyo", customization.initial_timezone());
 146   EXPECT_EQ("mozc-jp", customization.keyboard_layout());
 147 }
 148
 149 TEST(StartupCustomizationDocumentTest, BadManifest) {
 150   system::ScopedFakeStatisticsProvider fake_statistics_provider;
 151   StartupCustomizationDocument customization(&fake_statistics_provider,
 152                                              kBadManifest);
 153   EXPECT_FALSE(customization.IsReady());
 154 }
 155
 156 class TestURLFetcherCallback {
 157  public:
 158   scoped_ptr<net::FakeURLFetcher> CreateURLFetcher(
 159       const GURL& url,
 160       net::URLFetcherDelegate* d,
 161       const std::string& response_data,
 162       net::HttpStatusCode response_code,
 163       net::URLRequestStatus::Status status) {
 164     scoped_ptr<net::FakeURLFetcher> fetcher(
 165         new net::FakeURLFetcher(url, d, response_data, response_code, status));
 166     OnRequestCreate(url, fetcher.get());
 167     return fetcher.Pass();
 168   }
 169   MOCK_METHOD2(OnRequestCreate,
 170                void(const GURL&, net::FakeURLFetcher*));
 171 };
 172
 173 void AddMimeHeader(const GURL& url, net::FakeURLFetcher* fetcher) {
 174   scoped_refptr<net::HttpResponseHeaders> download_headers =
 175       new net::HttpResponseHeaders("");
 176   download_headers->AddHeader("Content-Type: application/json");
 177   fetcher->set_response_headers(download_headers);
 178 }
 179
 180 class MockExternalProviderVisitor
 181     : public extensions::ExternalProviderInterface::VisitorInterface {
 182  public:
 183   MockExternalProviderVisitor() {}
 184
 185   MOCK_METHOD7(OnExternalExtensionFileFound,
 186                bool(const std::string&,
 187                     const base::Version*,
 188                     const base::FilePath&,
 189                     extensions::Manifest::Location,
 190                     int,
 191                     bool,
 192                     bool));
 193   MOCK_METHOD6(OnExternalExtensionUpdateUrlFound,
 194                bool(const std::string&,
 195                     const std::string&,
 196                     const GURL&,
 197                     extensions::Manifest::Location,
 198                     int,
 199                     bool));
 200   MOCK_METHOD1(OnExternalProviderReady,
 201                void(const extensions::ExternalProviderInterface* provider));
 202 };
 203
 204 class ServicesCustomizationDocumentTest : public testing::Test {
 205  protected:
 206   ServicesCustomizationDocumentTest()
 207     : factory_(NULL,
 208                base::Bind(&TestURLFetcherCallback::CreateURLFetcher,
 209                base::Unretained(&url_callback_))) {
 210   }
 211
 212   // testing::Test:
 213   void SetUp() override {
 214     ServicesCustomizationDocument::InitializeForTesting();
 215
 216     DBusThreadManager::Initialize();
 217     NetworkHandler::Initialize();
 218     RunUntilIdle();
 219     const NetworkState* default_network =
 220         NetworkHandler::Get()->network_state_handler()->DefaultNetwork();
 221     std::string default_network_path =
 222         default_network ? default_network->path() : "";
 223
 224     NetworkPortalDetector::InitializeForTesting(&network_portal_detector_);
 225     NetworkPortalDetector::CaptivePortalState online_state;
 226     online_state.status = NetworkPortalDetector::CAPTIVE_PORTAL_STATUS_ONLINE;
 227     online_state.response_code = 204;
 228     std::string guid =
 229         default_network ? default_network->guid() : std::string();
 230     network_portal_detector_.SetDefaultNetworkForTesting(guid);
 231     if (!guid.empty()) {
 232       network_portal_detector_.SetDetectionResultsForTesting(
 233           guid, online_state);
 234     }
 235
 236     TestingBrowserProcess::GetGlobal()->SetLocalState(&local_state_);
 237     ServicesCustomizationDocument::RegisterPrefs(local_state_.registry());
 238   }
 239
 240   void TearDown() override {
 241     TestingBrowserProcess::GetGlobal()->SetLocalState(NULL);
 242     NetworkHandler::Shutdown();
 243     DBusThreadManager::Shutdown();
 244     NetworkPortalDetector::InitializeForTesting(NULL);
 245
 246     ServicesCustomizationDocument::ShutdownForTesting();
 247   }
 248
 249   void RunUntilIdle() {
 250     base::RunLoop().RunUntilIdle();
 251   }
 252
 253   void AddCustomizationIdToVp(const std::string& id) {
 254     fake_statistics_provider_.SetMachineStatistic(system::kCustomizationIdKey,
 255                                                   id);
 256   }
 257
 258   void AddExpectedManifest(const std::string& id,
 259                            const std::string& manifest) {
 260     GURL url(base::StringPrintf(ServicesCustomizationDocument::kManifestUrl,
 261                                 id.c_str()));
 262     factory_.SetFakeResponse(url,
 263                              manifest,
 264                              net::HTTP_OK,
 265                              net::URLRequestStatus::SUCCESS);
 266     EXPECT_CALL(url_callback_, OnRequestCreate(url, _))
 267       .Times(Exactly(1))
 268       .WillRepeatedly(Invoke(AddMimeHeader));
 269   }
 270
 271   void AddManifestNotFound(const std::string& id) {
 272     GURL url(base::StringPrintf(ServicesCustomizationDocument::kManifestUrl,
 273                                 id.c_str()));
 274     factory_.SetFakeResponse(url,
 275                              std::string(),
 276                              net::HTTP_NOT_FOUND,
 277                              net::URLRequestStatus::SUCCESS);
 278     EXPECT_CALL(url_callback_, OnRequestCreate(url, _))
 279       .Times(Exactly(1))
 280       .WillRepeatedly(Invoke(AddMimeHeader));
 281   }
 282
 283   scoped_ptr<TestingProfile> CreateProfile() {
 284     TestingProfile::Builder profile_builder;
 285     syncable_prefs::PrefServiceMockFactory factory;
 286     scoped_refptr<user_prefs::PrefRegistrySyncable> registry(
 287         new user_prefs::PrefRegistrySyncable);
 288     scoped_ptr<syncable_prefs::PrefServiceSyncable> prefs(
 289         factory.CreateSyncable(registry.get()));
 290     chrome::RegisterUserProfilePrefs(registry.get());
 291     profile_builder.SetPrefService(prefs.Pass());
 292     return profile_builder.Build();
 293   }
 294
 295  private:
 296   system::ScopedFakeStatisticsProvider fake_statistics_provider_;
 297   content::TestBrowserThreadBundle thread_bundle_;
 298   TestingPrefServiceSimple local_state_;
 299   TestURLFetcherCallback url_callback_;
 300   net::FakeURLFetcherFactory factory_;
 301   NetworkPortalDetectorTestImpl network_portal_detector_;
 302 };
 303
 304 TEST_F(ServicesCustomizationDocumentTest, Basic) {
 305   AddCustomizationIdToVp(kDummyCustomizationID);
 306   AddExpectedManifest(kDummyCustomizationID, kGoodServicesManifest);
 307
 308   ServicesCustomizationDocument* doc =
 309       ServicesCustomizationDocument::GetInstance();
 310   EXPECT_FALSE(doc->IsReady());
 311
 312   doc->StartFetching();
 313   RunUntilIdle();
 314   EXPECT_TRUE(doc->IsReady());
 315
 316   GURL wallpaper_url;
 317   EXPECT_FALSE(doc->GetDefaultWallpaperUrl(&wallpaper_url));
 318   EXPECT_EQ("", wallpaper_url.spec());
 319
 320   scoped_ptr<base::DictionaryValue> default_apps(doc->GetDefaultApps());
 321   ASSERT_TRUE(default_apps);
 322   EXPECT_EQ(default_apps->size(), 2u);
 323
 324   const base::DictionaryValue* app_entry = nullptr;
 325   ASSERT_TRUE(default_apps->GetDictionary("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
 326                                           &app_entry));
 327   EXPECT_EQ(app_entry->size(), 1u);
 328   EXPECT_TRUE(
 329       app_entry->HasKey(extensions::ExternalProviderImpl::kExternalUpdateUrl));
 330
 331   ASSERT_TRUE(default_apps->GetDictionary("bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
 332                                           &app_entry));
 333   EXPECT_EQ(app_entry->size(), 2u);
 334   EXPECT_TRUE(
 335       app_entry->HasKey(extensions::ExternalProviderImpl::kExternalUpdateUrl));
 336   EXPECT_TRUE(app_entry->HasKey(
 337       extensions::ExternalProviderImpl::kDoNotInstallForEnterprise));
 338
 339   EXPECT_EQ("EN-US OEM Name", doc->GetOemAppsFolderName("en-US"));
 340   EXPECT_EQ("EN OEM Name", doc->GetOemAppsFolderName("en"));
 341   EXPECT_EQ("Default OEM Name", doc->GetOemAppsFolderName("ru"));
 342 }
 343
 344 TEST_F(ServicesCustomizationDocumentTest, NoCustomizationIdInVpd) {
 345   ServicesCustomizationDocument* doc =
 346       ServicesCustomizationDocument::GetInstance();
 347   EXPECT_FALSE(doc->IsReady());
 348
 349   scoped_ptr<TestingProfile> profile = CreateProfile();
 350   extensions::ExternalLoader* loader = doc->CreateExternalLoader(profile.get());
 351   EXPECT_TRUE(loader);
 352
 353   MockExternalProviderVisitor visitor;
 354   scoped_ptr<extensions::ExternalProviderImpl> provider(
 355       new extensions::ExternalProviderImpl(
 356           &visitor,
 357           loader,
 358           profile.get(),
 359           extensions::Manifest::EXTERNAL_PREF,
 360           extensions::Manifest::EXTERNAL_PREF_DOWNLOAD,
 361           extensions::Extension::FROM_WEBSTORE |
 362               extensions::Extension::WAS_INSTALLED_BY_DEFAULT));
 363
 364   EXPECT_CALL(visitor, OnExternalExtensionFileFound(_, _, _, _, _, _, _))
 365       .Times(0);
 366   EXPECT_CALL(visitor, OnExternalExtensionUpdateUrlFound(_, _, _, _, _, _))
 367       .Times(0);
 368   EXPECT_CALL(visitor, OnExternalProviderReady(_))
 369       .Times(1);
 370
 371   // Manually request a load.
 372   RunUntilIdle();
 373   loader->StartLoading();
 374   Mock::VerifyAndClearExpectations(&visitor);
 375
 376   RunUntilIdle();
 377   // Empty customization is used when there is no customization ID in VPD.
 378   EXPECT_TRUE(doc->IsReady());
 379 }
 380
 381 TEST_F(ServicesCustomizationDocumentTest, DefaultApps) {
 382   AddCustomizationIdToVp(kDummyCustomizationID);
 383   AddExpectedManifest(kDummyCustomizationID, kGoodServicesManifest);
 384
 385   ServicesCustomizationDocument* doc =
 386       ServicesCustomizationDocument::GetInstance();
 387   EXPECT_FALSE(doc->IsReady());
 388
 389   scoped_ptr<TestingProfile> profile = CreateProfile();
 390   extensions::ExternalLoader* loader = doc->CreateExternalLoader(profile.get());
 391   EXPECT_TRUE(loader);
 392
 393   app_list::AppListSyncableServiceFactory::GetInstance()->
 394       SetTestingFactoryAndUse(
 395           profile.get(),
 396           &app_list::AppListSyncableServiceFactory::BuildInstanceFor);
 397
 398   MockExternalProviderVisitor visitor;
 399   scoped_ptr<extensions::ExternalProviderImpl> provider(
 400       new extensions::ExternalProviderImpl(
 401           &visitor,
 402           loader,
 403           profile.get(),
 404           extensions::Manifest::EXTERNAL_PREF,
 405           extensions::Manifest::EXTERNAL_PREF_DOWNLOAD,
 406           extensions::Extension::FROM_WEBSTORE |
 407               extensions::Extension::WAS_INSTALLED_BY_DEFAULT));
 408
 409   EXPECT_CALL(visitor, OnExternalExtensionFileFound(_, _, _, _, _, _, _))
 410       .Times(0);
 411   EXPECT_CALL(visitor, OnExternalExtensionUpdateUrlFound(_, _, _, _, _, _))
 412       .Times(0);
 413   EXPECT_CALL(visitor, OnExternalProviderReady(_))
 414       .Times(1);
 415
 416   // Manually request a load.
 417   loader->StartLoading();
 418   Mock::VerifyAndClearExpectations(&visitor);
 419
 420   EXPECT_CALL(visitor, OnExternalExtensionFileFound(_, _, _, _, _, _, _))
 421       .Times(0);
 422   EXPECT_CALL(visitor, OnExternalExtensionUpdateUrlFound(_, _, _, _, _, _))
 423       .Times(2);
 424   EXPECT_CALL(visitor, OnExternalProviderReady(_))
 425       .Times(1);
 426
 427   RunUntilIdle();
 428   EXPECT_TRUE(doc->IsReady());
 429
 430   app_list::AppListSyncableService* service =
 431       app_list::AppListSyncableServiceFactory::GetForProfile(profile.get());
 432   ASSERT_TRUE(service);
 433   EXPECT_EQ("EN OEM Name", service->GetOemFolderNameForTest());
 434 }
 435
 436 TEST_F(ServicesCustomizationDocumentTest, CustomizationManifestNotFound) {
 437   AddCustomizationIdToVp(kDummyCustomizationID);
 438   AddManifestNotFound(kDummyCustomizationID);
 439
 440   ServicesCustomizationDocument* doc =
 441       ServicesCustomizationDocument::GetInstance();
 442   EXPECT_FALSE(doc->IsReady());
 443
 444   scoped_ptr<TestingProfile> profile = CreateProfile();
 445   extensions::ExternalLoader* loader = doc->CreateExternalLoader(profile.get());
 446   EXPECT_TRUE(loader);
 447
 448   MockExternalProviderVisitor visitor;
 449   scoped_ptr<extensions::ExternalProviderImpl> provider(
 450       new extensions::ExternalProviderImpl(
 451           &visitor,
 452           loader,
 453           profile.get(),
 454           extensions::Manifest::EXTERNAL_PREF,
 455           extensions::Manifest::EXTERNAL_PREF_DOWNLOAD,
 456           extensions::Extension::FROM_WEBSTORE |
 457               extensions::Extension::WAS_INSTALLED_BY_DEFAULT));
 458
 459   EXPECT_CALL(visitor, OnExternalExtensionFileFound(_, _, _, _, _, _, _))
 460       .Times(0);
 461   EXPECT_CALL(visitor, OnExternalExtensionUpdateUrlFound(_, _, _, _, _, _))
 462       .Times(0);
 463   EXPECT_CALL(visitor, OnExternalProviderReady(_))
 464       .Times(1);
 465
 466   // Manually request a load.
 467   loader->StartLoading();
 468   Mock::VerifyAndClearExpectations(&visitor);
 469
 470   EXPECT_CALL(visitor, OnExternalExtensionFileFound(_, _, _, _, _, _, _))
 471       .Times(0);
 472   EXPECT_CALL(visitor, OnExternalExtensionUpdateUrlFound(_, _, _, _, _, _))
 473       .Times(0);
 474   EXPECT_CALL(visitor, OnExternalProviderReady(_))
 475       .Times(1);
 476
 477   RunUntilIdle();
 478   EXPECT_TRUE(doc->IsReady());
 479 }
 480
 481 }  // namespace chromeos