sync: Refactor themes sync integration tests

chrome/browser/sync/test/integration/two_client_themes_sync_test.cc

 // Copyright (c) 2012 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 "base/basictypes.h"
 #include "chrome/browser/sync/test/integration/profile_sync_service_harness.h"
 #include "chrome/browser/sync/test/integration/sync_integration_test_util.h"
 #include "chrome/browser/sync/test/integration/sync_test.h"
 #include "chrome/browser/sync/test/integration/themes_helper.h"
 
-using sync_integration_test_util::AwaitCommitActivityCompletion;
+using themes_helper::AwaitThemeIsPendingInstall;
+using themes_helper::AwaitUsingSystemTheme;
+using themes_helper::AwaitUsingDefaultTheme;
 using themes_helper::GetCustomTheme;
 using themes_helper::GetThemeID;
-using themes_helper::HasOrWillHaveCustomTheme;
-using themes_helper::ThemeIsPendingInstall;
 using themes_helper::UseCustomTheme;
 using themes_helper::UseDefaultTheme;
 using themes_helper::UseSystemTheme;
 using themes_helper::UsingCustomTheme;
 using themes_helper::UsingDefaultTheme;
 using themes_helper::UsingSystemTheme;
 
 class TwoClientThemesSyncTest : public SyncTest {
  public:
   TwoClientThemesSyncTest() : SyncTest(TWO_CLIENT) {}
   virtual ~TwoClientThemesSyncTest() {}
 
  private:
   DISALLOW_COPY_AND_ASSIGN(TwoClientThemesSyncTest);
 };
 
 class LegacyTwoClientThemesSyncTest : public SyncTest {

[pval...(no longer on Chromium), 2014/07/15 20:34:47]

remove this (woo)

[rlarocque, 2014/07/15 20:47:01]

Done.

  public:
   LegacyTwoClientThemesSyncTest() : SyncTest(TWO_CLIENT_LEGACY) {}
   virtual ~LegacyTwoClientThemesSyncTest() {}
 
  private:
   DISALLOW_COPY_AND_ASSIGN(LegacyTwoClientThemesSyncTest);
 };
 
-// TODO(akalin): Add tests for model association (i.e., tests that
-// start with SetupClients(), change the theme state, then call
-// SetupSync()).
-
-// TCM ID - 3667311.
-IN_PROC_BROWSER_TEST_F(TwoClientThemesSyncTest, CustomTheme) {
-  ASSERT_TRUE(SetupSync()) << "SetupSync() failed.";
+// Starts with default themes, then sets up sync and uses it to set all
+// profiles to use a custom theme.  Does not actually install any themes, but
+// instead verifies the custom theme is pending for install.
+IN_PROC_BROWSER_TEST_F(TwoClientThemesSyncTest, DefaultThenSyncCustom) {
+  ASSERT_TRUE(SetupSync());
 
   ASSERT_FALSE(UsingCustomTheme(GetProfile(0)));
   ASSERT_FALSE(UsingCustomTheme(GetProfile(1)));
   ASSERT_FALSE(UsingCustomTheme(verifier()));
 
   UseCustomTheme(GetProfile(0), 0);
   UseCustomTheme(verifier(), 0);
   ASSERT_EQ(GetCustomTheme(0), GetThemeID(GetProfile(0)));
   ASSERT_EQ(GetCustomTheme(0), GetThemeID(verifier()));
 
-  ASSERT_TRUE(GetClient(0)->AwaitMutualSyncCycleCompletion(GetClient(1)));
-
-  ASSERT_EQ(GetCustomTheme(0), GetThemeID(GetProfile(0)));
-  ASSERT_FALSE(UsingCustomTheme(GetProfile(1)));
-  // TODO(akalin): Add functions to simulate when a pending extension
+  // TODO(sync): Add functions to simulate when a pending extension

[pval...(no longer on Chromium), 2014/07/15 20:34:47]

it may not have been exactly what akalin had in mind, but doesn't your CL
basically accomplish the first part of this TODO?

[rlarocque, 2014/07/15 20:47:01]

No, not really.

Custom themes are implemented as extensions, and these extensions are supposed
to be downloaded from the app store.  In the extensions integration tests, we
create fake extensions and install them manually to simulate this.

In the themes tests, we never install nor fail to install themes.  We just check
that these themes/extensions are *pending* for install and consider that good
enough.

We could fake it in the same way as we do for the extensions tests, but:
1. That's outside the scope of this change.
2. It's of questionable value, since it would be using some hacks that don't
really reflect how these things are installed in the real world.

[pval...(no longer on Chromium), 2014/07/16 00:03:46]

K; makes sense.

   // is installed as well as when a pending extension fails to
   // install.
-  ASSERT_TRUE(ThemeIsPendingInstall(GetProfile(1), GetCustomTheme(0)));
-  ASSERT_EQ(GetCustomTheme(0), GetThemeID(verifier()));
+  ASSERT_TRUE(AwaitThemeIsPendingInstall(GetProfile(1), GetCustomTheme(0)));
+
+  EXPECT_EQ(GetCustomTheme(0), GetThemeID(GetProfile(0)));
+  EXPECT_FALSE(UsingCustomTheme(GetProfile(1)));
+  EXPECT_EQ(GetCustomTheme(0), GetThemeID(verifier()));
 }
 
-// TCM ID - 3599303.
-// TODO(sync): Fails on Chrome OS. See http://crbug.com/84575.
-#if defined(OS_CHROMEOS)
-IN_PROC_BROWSER_TEST_F(TwoClientThemesSyncTest, DISABLED_NativeTheme) {
-#else
-IN_PROC_BROWSER_TEST_F(TwoClientThemesSyncTest, NativeTheme) {
-#endif  // OS_CHROMEOS
-  ASSERT_TRUE(SetupSync()) << "SetupSync() failed.";
+// Starts with custom themes, then sets up sync and uses it to set all profiles
+// to the system theme.
+IN_PROC_BROWSER_TEST_F(TwoClientThemesSyncTest, CustomThenSyncNative) {
+  ASSERT_TRUE(SetupClients());
 
   UseCustomTheme(GetProfile(0), 0);
   UseCustomTheme(GetProfile(1), 0);
   UseCustomTheme(verifier(), 0);
 
-  ASSERT_TRUE(AwaitQuiescence());
+  ASSERT_TRUE(SetupSync());
 
   UseSystemTheme(GetProfile(0));
   UseSystemTheme(verifier());
   ASSERT_TRUE(UsingSystemTheme(GetProfile(0)));
   ASSERT_TRUE(UsingSystemTheme(verifier()));
 
-  ASSERT_TRUE(GetClient(0)->AwaitMutualSyncCycleCompletion(GetClient(1)));
+  ASSERT_TRUE(AwaitUsingSystemTheme(GetProfile(1)));
 
-  ASSERT_TRUE(UsingSystemTheme(GetProfile(0)));
-  ASSERT_TRUE(UsingSystemTheme(GetProfile(1)));
-  ASSERT_TRUE(UsingSystemTheme(verifier()));
+  EXPECT_TRUE(UsingSystemTheme(GetProfile(0)));
+  EXPECT_TRUE(UsingSystemTheme(GetProfile(1)));
+  EXPECT_TRUE(UsingSystemTheme(verifier()));
 }
 
-// TCM ID - 7247455.
-IN_PROC_BROWSER_TEST_F(TwoClientThemesSyncTest, DefaultTheme) {
-  ASSERT_TRUE(SetupSync()) << "SetupSync() failed.";
+// Starts with custom themes, then sets up sync and uses it to set all profiles
+// to the default theme.
+IN_PROC_BROWSER_TEST_F(TwoClientThemesSyncTest, CustomThenSyncDefault) {
+  ASSERT_TRUE(SetupClients());
 
   UseCustomTheme(GetProfile(0), 0);
   UseCustomTheme(GetProfile(1), 0);
   UseCustomTheme(verifier(), 0);
 
-  ASSERT_TRUE(AwaitQuiescence());
+  ASSERT_TRUE(SetupSync());
 
   UseDefaultTheme(GetProfile(0));
   UseDefaultTheme(verifier());
-  ASSERT_TRUE(UsingDefaultTheme(GetProfile(0)));
-  ASSERT_TRUE(UsingDefaultTheme(verifier()));
+  EXPECT_TRUE(UsingDefaultTheme(GetProfile(0)));
+  EXPECT_TRUE(UsingDefaultTheme(verifier()));
 
-  ASSERT_TRUE(GetClient(0)->AwaitMutualSyncCycleCompletion(GetClient(1)));
-
-  ASSERT_TRUE(UsingDefaultTheme(GetProfile(0)));
-  ASSERT_TRUE(UsingDefaultTheme(GetProfile(1)));
-  ASSERT_TRUE(UsingDefaultTheme(verifier()));
+  ASSERT_TRUE(AwaitUsingDefaultTheme(GetProfile(1)));
+  EXPECT_TRUE(UsingDefaultTheme(GetProfile(0)));
+  EXPECT_TRUE(UsingDefaultTheme(GetProfile(1)));
+  EXPECT_TRUE(UsingDefaultTheme(verifier()));
 }
 
-// TCM ID - 7292065.
-// TODO(sync): Fails on Chrome OS. See http://crbug.com/84575.
-// TODO(erg): Fails on linux_aura. See http://crbug.com/304554
-#if defined(OS_CHROMEOS) || defined(OS_LINUX)
-IN_PROC_BROWSER_TEST_F(TwoClientThemesSyncTest, DISABLED_NativeDefaultRace) {
-#else
-IN_PROC_BROWSER_TEST_F(TwoClientThemesSyncTest, NativeDefaultRace) {
-#endif  // OS_CHROMEOS
-  ASSERT_TRUE(SetupSync()) << "SetupSync() failed.";
-
-  UseSystemTheme(GetProfile(0));
-  UseDefaultTheme(GetProfile(1));
-  ASSERT_TRUE(UsingSystemTheme(GetProfile(0)));
-  ASSERT_TRUE(UsingDefaultTheme(GetProfile(1)));
-
-  ASSERT_TRUE(AwaitQuiescence());
-
-  // TODO(akalin): Add function that compares two profiles to see if
-  // they're at the same state.
-
-  ASSERT_EQ(UsingSystemTheme(GetProfile(0)),
-            UsingSystemTheme(GetProfile(1)));
-  ASSERT_EQ(UsingDefaultTheme(GetProfile(0)),
-            UsingDefaultTheme(GetProfile(1)));
-}
-
-// TCM ID - 7294077.
-// TODO(sync): Fails on Chrome OS. See http://crbug.com/84575.
-#if defined(OS_CHROMEOS)
-IN_PROC_BROWSER_TEST_F(TwoClientThemesSyncTest, DISABLED_CustomNativeRace) {
-#else
-IN_PROC_BROWSER_TEST_F(TwoClientThemesSyncTest, CustomNativeRace) {
-#endif  // OS_CHROMEOS
+// Cycles through a set of options.
+//
+// Most other tests have significant coverage of model association.  This test
+// is intended to test steady-state scenarios.
+IN_PROC_BROWSER_TEST_F(TwoClientThemesSyncTest, CycleOptions) {
   ASSERT_TRUE(SetupSync()) << "SetupSync() failed.";
 
   UseCustomTheme(GetProfile(0), 0);
-  UseSystemTheme(GetProfile(1));
-  ASSERT_EQ(GetCustomTheme(0), GetThemeID(GetProfile(0)));
-  ASSERT_TRUE(UsingSystemTheme(GetProfile(1)));
+  UseCustomTheme(verifier(), 0);
 
-  ASSERT_TRUE(AwaitQuiescence());
+  ASSERT_TRUE(AwaitThemeIsPendingInstall(GetProfile(1), GetCustomTheme(0)));
+  EXPECT_EQ(GetCustomTheme(0), GetThemeID(GetProfile(0)));
+  EXPECT_EQ(GetCustomTheme(0), GetThemeID(verifier()));
 
-  // TODO(akalin): Add function to wait for pending extensions to be
-  // installed.
+  UseSystemTheme(GetProfile(0));
+  UseSystemTheme(verifier());
 
-  ASSERT_EQ(HasOrWillHaveCustomTheme(GetProfile(0), GetCustomTheme(0)),
-            HasOrWillHaveCustomTheme(GetProfile(1), GetCustomTheme(0)));
+  ASSERT_TRUE(AwaitUsingSystemTheme(GetProfile(1)));
+  EXPECT_TRUE(UsingSystemTheme(GetProfile(0)));
+  EXPECT_TRUE(UsingSystemTheme(GetProfile(1)));
+  EXPECT_TRUE(UsingSystemTheme(verifier()));
+
+  UseDefaultTheme(GetProfile(0));
+  UseDefaultTheme(verifier());
+
+  ASSERT_TRUE(AwaitUsingDefaultTheme(GetProfile(1)));
+  EXPECT_TRUE(UsingDefaultTheme(GetProfile(0)));
+  EXPECT_TRUE(UsingDefaultTheme(GetProfile(1)));
+  EXPECT_TRUE(UsingDefaultTheme(verifier()));
+
+  UseCustomTheme(GetProfile(0), 1);
+  UseCustomTheme(verifier(), 1);
+  ASSERT_TRUE(AwaitThemeIsPendingInstall(GetProfile(1), GetCustomTheme(1)));
+  EXPECT_EQ(GetCustomTheme(1), GetThemeID(GetProfile(0)));
+  EXPECT_EQ(GetCustomTheme(1), GetThemeID(verifier()));
 }
-
-// TCM ID - 7307225.
-IN_PROC_BROWSER_TEST_F(TwoClientThemesSyncTest, CustomDefaultRace) {
-  ASSERT_TRUE(SetupSync()) << "SetupSync() failed.";
-
-  UseCustomTheme(GetProfile(0), 0);
-  UseDefaultTheme(GetProfile(1));
-  ASSERT_EQ(GetCustomTheme(0), GetThemeID(GetProfile(0)));
-  ASSERT_TRUE(UsingDefaultTheme(GetProfile(1)));
-
-  ASSERT_TRUE(AwaitQuiescence());
-
-  ASSERT_EQ(HasOrWillHaveCustomTheme(GetProfile(0), GetCustomTheme(0)),
-            HasOrWillHaveCustomTheme(GetProfile(1), GetCustomTheme(0)));
-}
-
-// TCM ID - 7264758.
-IN_PROC_BROWSER_TEST_F(TwoClientThemesSyncTest, CustomCustomRace) {
-  ASSERT_TRUE(SetupSync()) << "SetupSync() failed.";
-
-  // TODO(akalin): Generalize this to n clients.
-
-  UseCustomTheme(GetProfile(0), 0);
-  UseCustomTheme(GetProfile(1), 1);
-  ASSERT_EQ(GetCustomTheme(0), GetThemeID(GetProfile(0)));
-  ASSERT_EQ(GetCustomTheme(1), GetThemeID(GetProfile(1)));
-
-  ASSERT_TRUE(AwaitQuiescence());
-
-  bool using_theme_0 =
-      (GetThemeID(GetProfile(0)) == GetCustomTheme(0)) &&
-      HasOrWillHaveCustomTheme(GetProfile(1), GetCustomTheme(0));
-  bool using_theme_1 =
-      HasOrWillHaveCustomTheme(GetProfile(0), GetCustomTheme(1)) &&
-      (GetThemeID(GetProfile(1)) == GetCustomTheme(1));
-
-  // Equivalent to using_theme_0 xor using_theme_1.
-  ASSERT_NE(using_theme_0, using_theme_1);
-}
-
-// TCM ID - 3723272.
-IN_PROC_BROWSER_TEST_F(LegacyTwoClientThemesSyncTest, DisableThemes) {
-  ASSERT_TRUE(SetupSync()) << "SetupSync() failed.";
-
-  ASSERT_FALSE(UsingCustomTheme(GetProfile(0)));
-  ASSERT_FALSE(UsingCustomTheme(GetProfile(1)));
-  ASSERT_FALSE(UsingCustomTheme(verifier()));
-
-  ASSERT_TRUE(GetClient(1)->DisableSyncForDatatype(syncer::THEMES));
-  UseCustomTheme(GetProfile(0), 0);
-  UseCustomTheme(verifier(), 0);
-  ASSERT_TRUE(AwaitCommitActivityCompletion(GetSyncService((0))));
-
-  ASSERT_EQ(GetCustomTheme(0), GetThemeID(GetProfile(0)));
-  ASSERT_FALSE(UsingCustomTheme(GetProfile(1)));
-  ASSERT_EQ(GetCustomTheme(0), GetThemeID(verifier()));
-
-  ASSERT_TRUE(GetClient(1)->EnableSyncForDatatype(syncer::THEMES));
-  ASSERT_TRUE(AwaitQuiescence());
-
-  ASSERT_EQ(GetCustomTheme(0), GetThemeID(GetProfile(0)));
-  ASSERT_FALSE(UsingCustomTheme(GetProfile(1)));
-  ASSERT_TRUE(ThemeIsPendingInstall(GetProfile(1), GetCustomTheme(0)));
-  ASSERT_EQ(GetCustomTheme(0), GetThemeID(verifier()));
-}
-
-// TCM ID - 3687288.
-IN_PROC_BROWSER_TEST_F(TwoClientThemesSyncTest, DisableSync) {
-  ASSERT_TRUE(SetupSync()) << "SetupSync() failed.";
-
-  ASSERT_FALSE(UsingCustomTheme(GetProfile(0)));
-  ASSERT_FALSE(UsingCustomTheme(GetProfile(1)));
-  ASSERT_FALSE(UsingCustomTheme(verifier()));
-
-  ASSERT_TRUE(GetClient(1)->DisableSyncForAllDatatypes());
-  UseCustomTheme(GetProfile(0), 0);
-  UseCustomTheme(verifier(), 0);
-  ASSERT_TRUE(
-      AwaitCommitActivityCompletion(GetSyncService((0))));
-
-  ASSERT_EQ(GetCustomTheme(0), GetThemeID(GetProfile(0)));
-  ASSERT_FALSE(UsingCustomTheme(GetProfile(1)));
-  ASSERT_EQ(GetCustomTheme(0), GetThemeID(verifier()));
-
-  ASSERT_TRUE(GetClient(1)->EnableSyncForAllDatatypes());
-  ASSERT_TRUE(AwaitQuiescence());
-
-  ASSERT_EQ(GetCustomTheme(0), GetThemeID(GetProfile(0)));
-  ASSERT_EQ(GetCustomTheme(0), GetThemeID(verifier()));
-  ASSERT_FALSE(UsingCustomTheme(GetProfile(1)));
-  ASSERT_TRUE(ThemeIsPendingInstall(GetProfile(1), GetCustomTheme(0)));
-}