Support for shared invalidator client IDs

chrome/android/javatests/src/org/chromium/chrome/browser/invalidation/InvalidationControllerTest.java

 // Copyright 2013 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.
 
 package org.chromium.chrome.browser.invalidation;
 
 import android.accounts.Account;
 import android.app.Activity;
 import android.content.ComponentName;
 import android.content.Context;
 import android.content.Intent;
 import android.content.pm.PackageManager;
 import android.test.InstrumentationTestCase;
 import android.test.suitebuilder.annotation.SmallTest;
 
 import com.google.ipc.invalidation.external.client.types.ObjectId;
 
 import org.chromium.base.ActivityStatus;
 import org.chromium.base.CollectionUtil;
 import org.chromium.base.test.util.AdvancedMockContext;
 import org.chromium.base.test.util.Feature;
+import org.chromium.chrome.browser.identity.UniqueIdentificationGenerator;
+import org.chromium.chrome.browser.identity.UniqueIdentificationGeneratorFactory;
 import org.chromium.sync.internal_api.pub.base.ModelType;
 import org.chromium.sync.notifier.InvalidationIntentProtocol;
 import org.chromium.sync.notifier.InvalidationPreferences;
 import org.chromium.sync.notifier.InvalidationService;
 import org.chromium.sync.notifier.SyncStatusHelper;
 import org.chromium.sync.signin.AccountManagerHelper;
 import org.chromium.sync.signin.ChromeSigninController;
 import org.chromium.sync.test.util.MockSyncContentResolverDelegate;
 
+import java.util.Arrays;
 import java.util.ArrayList;
 import java.util.HashSet;
 import java.util.List;
 import java.util.Set;
 import java.util.concurrent.atomic.AtomicBoolean;
 import java.util.concurrent.atomic.AtomicReference;
 
+import javax.annotation.Nullable;
+
 /**
  * Tests for the {@link InvalidationController}.
  */
 public class InvalidationControllerTest extends InstrumentationTestCase {
     private IntentSavingContext mContext;
     private InvalidationController mController;
 
     @Override
     protected void setUp() throws Exception {
         mContext = new IntentSavingContext(getInstrumentation().getTargetContext());
         mController = InvalidationController.get(mContext);
         // We don't want to use the system content resolver, so we override it.
         MockSyncContentResolverDelegate delegate = new MockSyncContentResolverDelegate();
         // Android master sync can safely always be on.
         delegate.setMasterSyncAutomatically(true);
         SyncStatusHelper.overrideSyncStatusHelperForTests(mContext, delegate);
     }
 
     @SmallTest
     @Feature({"Sync"})
     public void testStart() throws Exception {
         mController.start();
         assertEquals(1, mContext.getNumStartedIntents());
         Intent intent = mContext.getStartedIntent(0);
         validateIntentComponent(intent);
-        assertNull(intent.getExtras());
+        assertTrue(intent.hasExtra(InvalidationIntentProtocol.EXTRA_CLIENT_NAME));
     }
 
     @SmallTest
     @Feature({"Sync"})
     public void testStop() throws Exception {
         mController.stop();
         assertEquals(1, mContext.getNumStartedIntents());
         Intent intent = mContext.getStartedIntent(0);
         validateIntentComponent(intent);
-        assertEquals(1, intent.getExtras().size());
+        assertEquals(2, intent.getExtras().size());
+        assertTrue(intent.hasExtra(InvalidationIntentProtocol.EXTRA_CLIENT_NAME));
         assertTrue(intent.hasExtra(InvalidationIntentProtocol.EXTRA_STOP));
         assertTrue(intent.getBooleanExtra(InvalidationIntentProtocol.EXTRA_STOP, false));
     }
 
     @SmallTest
     @Feature({"Sync"})
     public void testResumingMainActivity() throws Exception {
         // Resuming main activity should trigger a start if sync is enabled.
         setupSync(true);
         mController.onActivityStateChange(ActivityStatus.RESUMED);
         assertEquals(1, mContext.getNumStartedIntents());
         Intent intent = mContext.getStartedIntent(0);
         validateIntentComponent(intent);
-        assertNull(intent.getExtras());
     }
 
     @SmallTest
     @Feature({"Sync"})
     public void testResumingMainActivityWithSyncDisabled() throws Exception {
         // Resuming main activity should NOT trigger a start if sync is disabled.
         setupSync(false);
         mController.onActivityStateChange(ActivityStatus.RESUMED);
         assertEquals(0, mContext.getNumStartedIntents());
     }
 
     @SmallTest
     @Feature({"Sync"})
     public void testPausingMainActivity() throws Exception {
         // Resuming main activity should trigger a stop if sync is enabled.
         setupSync(true);
         mController.onActivityStateChange(ActivityStatus.PAUSED);
         assertEquals(1, mContext.getNumStartedIntents());
         Intent intent = mContext.getStartedIntent(0);
         validateIntentComponent(intent);
-        assertEquals(1, intent.getExtras().size());
+        assertEquals(2, intent.getExtras().size());
+        assertTrue(intent.hasExtra(InvalidationIntentProtocol.EXTRA_CLIENT_NAME));
         assertTrue(intent.hasExtra(InvalidationIntentProtocol.EXTRA_STOP));
         assertTrue(intent.getBooleanExtra(InvalidationIntentProtocol.EXTRA_STOP, false));
     }
 
     @SmallTest
     @Feature({"Sync"})
     public void testPausingMainActivityWithSyncDisabled() throws Exception {
         // Resuming main activity should NOT trigger a stop if sync is disabled.
         setupSync(false);
         mController.onActivityStateChange(ActivityStatus.PAUSED);
@@ skipping 186 matching lines @@
         // Validate registered object ids. The bookmark object should not be registered since it is
         // a Sync type.
         assertNull(intent.getStringArrayListExtra(
                                 InvalidationIntentProtocol.EXTRA_REGISTERED_TYPES));
         Set<ObjectId> objectIds = InvalidationIntentProtocol.getRegisteredObjectIds(intent);
         assertEquals(2, objectIds.size());
         assertTrue(objectIds.contains(ObjectId.newInstance(1, "a".getBytes())));
         assertTrue(objectIds.contains(ObjectId.newInstance(2, "b".getBytes())));
     }
 
+    @SmallTest
+    @Feature({"Sync"})
+    public void testFallbackClientId() {
+      // Test that the InvalidationController consistently returns the same ID even when it has to
+      // resort to its "fallback" ID generation code.
+      InvalidationController controller = new InvalidationController(mContext);
+      byte[] id1 = controller.getInvalidatorClientId();
+      byte[] id2 = controller.getInvalidatorClientId();
+
+      assertTrue(Arrays.equals(id1, id2));
+
+      // Even if initialize the generator late, the ID will remain consistent.
+      registerHardCodedIdGenerator();
+
+      byte[] id3 = controller.getInvalidatorClientId();
+      assertTrue(Arrays.equals(id2, id3));
+    }
+
+    @SmallTest
+    @Feature({"Sync"})
+    public void testPreRegisteredClientId() {
+      registerHardCodedIdGenerator();
+
+      UniqueIdentificationGenerator generator =
+           UniqueIdentificationGeneratorFactory.getInstance(InvalidationController.ID_GENERATOR);
+      String generatorId = generator.getUniqueId(null);
+
+      InvalidationController controller = new InvalidationController(mContext);
+      byte[] id = controller.getInvalidatorClientId();
+      byte[] id2 = controller.getInvalidatorClientId();
+
+      assertTrue(Arrays.equals(generatorId.getBytes(), id));
+      assertTrue(Arrays.equals(id, id2));
+    }
+
     /**
      * Asserts that {@code intent} is destined for the correct component.
      */
     private static void validateIntentComponent(Intent intent) {
         assertNotNull(intent.getComponent());
         assertEquals(InvalidationService.class.getName(),
                 intent.getComponent().getClassName());
     }
 
     /**
@@ skipping 18 matching lines @@
 
         Intent getStartedIntent(int idx) {
             return startedIntents.get(idx);
         }
 
         @Override
         public PackageManager getPackageManager() {
             return getBaseContext().getPackageManager();
         }
     }
+
+    private static void registerHardCodedIdGenerator() {
+      UniqueIdentificationGeneratorFactory.registerGenerator(
+          InvalidationController.ID_GENERATOR,
+          new UniqueIdentificationGenerator() {
+            public String getUniqueId(@Nullable String salt) {
+              return "Testable ID";
+            }
+          },
+          true);
+    }
 }