Bug 1411654 - Part 2: Update Robolectric to 3.5.1. r=mcomella

There were a few API changes, mostly around explicitly creating
Services/Activities/ContentProvider instances, but they were pretty
easy to address.

Sadly, Robolectric doesn't really work with the new aapt2 processing
in Android-Gradle plugin 3.0+ -- see in particular
robolectric/robolectric#3333 (comment)
-- so we have to opt-out of the new implementation for now.  Hopefully
plugin 3.1+ will address these issues, which are widespread.

MozReview-Commit-ID: dlbd32kMs6

gradle.properties

@@ -1,3 +1,4 @@
 org.gradle.parallel=true
 org.gradle.daemon=true
 org.gradle.jvmargs=-Xmx2560M
+android.enableAapt2=false

mobile/android/app/build.gradle

@@ -226,6 +226,9 @@ android {
     }
 
     testOptions {
+        // For Robolectric: see https://github.com/robolectric/robolectric/issues/3333#issuecomment-324300418.
+        unitTests.includeAndroidResources true
+
         unitTests.all {
             // We'd like to use (Runtime.runtime.availableProcessors()/2), but
             // we have tests that start test servers and the bound ports
@@ -279,7 +282,7 @@ dependencies {
     implementation project(path: ':thirdparty')
 
     testImplementation 'junit:junit:4.12'
-    testImplementation 'org.robolectric:robolectric:3.1.2'
+    testImplementation 'org.robolectric:robolectric:3.5.1'
     testImplementation 'org.simpleframework:simple-http:6.0.1'
     testImplementation 'org.mockito:mockito-core:1.10.19'
 

mobile/android/app/src/test/java/org/mozilla/gecko/GlobalPageMetadataTest.java

@@ -3,6 +3,7 @@
 
 package org.mozilla.gecko;
 
+import android.content.ContentProvider;
 import android.content.ContentProviderClient;
 import android.content.ContentValues;
 import android.database.Cursor;
@@ -15,7 +16,6 @@
 import org.mozilla.gecko.db.BrowserContract;
 import org.mozilla.gecko.db.BrowserContract.PageMetadata;
 import org.mozilla.gecko.db.BrowserDB;
-import org.mozilla.gecko.db.BrowserProvider;
 import org.mozilla.gecko.db.LocalBrowserDB;
 import org.robolectric.shadows.ShadowContentResolver;
 
@@ -27,11 +27,8 @@ public class GlobalPageMetadataTest {
     public void testQueueing() throws Exception {
         BrowserDB db = new LocalBrowserDB("default");
 
-        BrowserProvider provider = new BrowserProvider();
+        final ContentProvider provider = DelegatingTestContentProvider.createDelegatingBrowserProvider();
         try {
-            provider.onCreate();
-            ShadowContentResolver.registerProvider(BrowserContract.AUTHORITY, new DelegatingTestContentProvider(provider));
-
             ShadowContentResolver cr = new ShadowContentResolver();
             ContentProviderClient pageMetadataClient = cr.acquireContentProviderClient(PageMetadata.CONTENT_URI);
 
@@ -64,11 +61,8 @@ public void testInsertingMetadata() throws Exception {
         // Start listening for events.
         GlobalPageMetadata.getInstance().init();
 
-        BrowserProvider provider = new BrowserProvider();
+        final ContentProvider provider = DelegatingTestContentProvider.createDelegatingBrowserProvider();
         try {
-            provider.onCreate();
-            ShadowContentResolver.registerProvider(BrowserContract.AUTHORITY, new DelegatingTestContentProvider(provider));
-
             ShadowContentResolver cr = new ShadowContentResolver();
             ContentProviderClient historyClient = cr.acquireContentProviderClient(BrowserContract.History.CONTENT_URI);
             ContentProviderClient pageMetadataClient = cr.acquireContentProviderClient(PageMetadata.CONTENT_URI);
@@ -171,4 +165,4 @@ private void assertPageMetadataCountForGUID(int expected, String guid, ContentPr
             cursor.close();
         }
     }
-}
+}

mobile/android/app/src/test/java/org/mozilla/gecko/icons/loader/TestLegacyLoader.java

@@ -3,29 +3,21 @@
 
 package org.mozilla.gecko.icons.loader;
 
+import android.content.ContentProvider;
 import android.graphics.Bitmap;
 
 import org.junit.Assert;
-import org.junit.Before;
 import org.junit.Test;
 import org.junit.runner.RunWith;
-import org.mozilla.gecko.GeckoProfile;
 import org.mozilla.gecko.background.db.DelegatingTestContentProvider;
 import org.mozilla.gecko.background.testhelpers.TestRunner;
-import org.mozilla.gecko.db.BrowserContract;
-import org.mozilla.gecko.db.BrowserDB;
-import org.mozilla.gecko.db.BrowserProvider;
 import org.mozilla.gecko.icons.IconDescriptor;
 import org.mozilla.gecko.icons.IconRequest;
 import org.mozilla.gecko.icons.IconResponse;
 import org.mozilla.gecko.icons.Icons;
 import org.robolectric.RuntimeEnvironment;
-import org.robolectric.shadows.ShadowContentResolver;
 
-import java.lang.reflect.Field;
-import java.lang.reflect.Modifier;
 import java.util.Iterator;
-import java.util.concurrent.ConcurrentHashMap;
 
 import static org.mockito.Mockito.doReturn;
 import static org.mockito.Mockito.mock;
@@ -46,9 +38,7 @@ public void testDatabaseIsQueriesForNormalRequestsWithNetworkSkipped() {
         // We need to ensure we close our db connection properly.
         // This is the only test in this class that actually accesses a database. If that changes,
         // move BrowserProvider registration into a @Before method, and provider.shutdown into @After.
-        final BrowserProvider provider = new BrowserProvider();
-        provider.onCreate();
-        ShadowContentResolver.registerProvider(BrowserContract.AUTHORITY, new DelegatingTestContentProvider(provider));
+        final ContentProvider provider = DelegatingTestContentProvider.createDelegatingBrowserProvider();
         try {
             final IconRequest request = Icons.with(RuntimeEnvironment.application)
                     .pageUrl(TEST_PAGE_URL)
@@ -61,8 +51,8 @@ public void testDatabaseIsQueriesForNormalRequestsWithNetworkSkipped() {
 
             verify(loader).loadBitmapFromDatabase(request);
             Assert.assertNull(response);
-        // Close any open db connections.
         } finally {
+            // Close any open db connections.
             provider.shutdown();
         }
     }

mobile/android/app/src/test/java/org/mozilla/gecko/util/NetworkUtilsTest.java

@@ -12,13 +12,17 @@
 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.mozilla.gecko.background.testhelpers.TestRunner;
-import org.mozilla.gecko.util.NetworkUtils.*;
+import org.mozilla.gecko.util.NetworkUtils.ConnectionSubType;
+import org.mozilla.gecko.util.NetworkUtils.ConnectionType;
+import org.mozilla.gecko.util.NetworkUtils.NetworkStatus;
 import org.robolectric.RuntimeEnvironment;
-import org.robolectric.internal.ShadowExtractor;
+import org.robolectric.shadow.api.Shadow;
 import org.robolectric.shadows.ShadowConnectivityManager;
 import org.robolectric.shadows.ShadowNetworkInfo;
 
-import static org.junit.Assert.*;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
 
 @RunWith(TestRunner.class)
 public class NetworkUtilsTest {
@@ -31,7 +35,7 @@ public void setUp() {
 
         // Not using Shadows.shadowOf(connectivityManager) because of Robolectric bug when using API23+
         // See: https://github.com/robolectric/robolectric/issues/1862
-        shadowConnectivityManager = (ShadowConnectivityManager) ShadowExtractor.extract(connectivityManager);
+        shadowConnectivityManager = (ShadowConnectivityManager) Shadow.extract(connectivityManager);
     }
 
     @Test
@@ -182,4 +186,4 @@ public void testGetNetworkStatus() {
         );
         assertEquals(NetworkStatus.UP, NetworkUtils.getNetworkStatus(connectivityManager));
     }
-}
+}

mobile/android/app/src/test/resources/robolectric.properties

@@ -1,3 +1,3 @@
-sdk=21
+sdk=23
 constants=org.mozilla.gecko.BuildConfig
 packageName=org.mozilla.gecko

mobile/android/services/src/test/java/org/mozilla/gecko/background/db/DelegatingTestContentProvider.java

@@ -8,31 +8,74 @@
 import android.content.ContentProviderOperation;
 import android.content.ContentProviderResult;
 import android.content.ContentValues;
+import android.content.Context;
 import android.content.OperationApplicationException;
+import android.content.pm.ProviderInfo;
 import android.database.Cursor;
 import android.net.Uri;
 import android.os.Bundle;
 import android.support.annotation.Nullable;
 
 import org.mozilla.gecko.db.BrowserContract;
+import org.mozilla.gecko.db.BrowserProvider;
+import org.mozilla.gecko.db.TabsProvider;
+import org.robolectric.android.controller.ContentProviderController;
+import org.robolectric.util.ReflectionHelpers;
 
 import java.util.ArrayList;
 
 /**
  * Wrap a ContentProvider, appending &test=1 to all queries.
  */
 public class DelegatingTestContentProvider extends ContentProvider {
-    protected final ContentProvider mTargetProvider;
+    protected ContentProvider mTargetProvider;
 
     protected static Uri appendUriParam(Uri uri, String param, String value) {
         return uri.buildUpon().appendQueryParameter(param, value).build();
     }
 
+    /**
+     * Create and register a new <tt>BrowserProvider</tt> that has test delegation.
+     * <p>
+     * Robolectric doesn't make it easy to parameterize a created
+     * <tt>ContentProvider</tt>, so we modify a built-in helper to do it.
+     * @return delegated <tt>ContentProvider</tt>.
+     */
+    public static ContentProvider createDelegatingBrowserProvider() {
+        final ContentProviderController<DelegatingTestContentProvider> contentProviderController
+                = ContentProviderController.of(ReflectionHelpers.callConstructor(DelegatingTestContentProvider.class,
+                ReflectionHelpers.ClassParameter.from(ContentProvider.class, new BrowserProvider())));
+        return contentProviderController.create(BrowserContract.AUTHORITY).get();
+    }
+
+    /**
+     * Create and register a new <tt>TabsProvider</tt> that has test delegation.
+     * <p>
+     * Robolectric doesn't make it easy to parameterize a created
+     * <tt>ContentProvider</tt>, so we modify a built-in helper to do it.
+     * @return delegated <tt>ContentProvider</tt>.
+     */
+    public static ContentProvider createDelegatingTabsProvider() {
+        final ContentProviderController<DelegatingTestContentProvider> contentProviderController
+                = ContentProviderController.of(ReflectionHelpers.callConstructor(DelegatingTestContentProvider.class,
+                ReflectionHelpers.ClassParameter.from(ContentProvider.class, new TabsProvider())));
+        return contentProviderController.create(BrowserContract.TABS_AUTHORITY).get();
+    }
+
     public DelegatingTestContentProvider(ContentProvider targetProvider) {
         super();
         mTargetProvider = targetProvider;
     }
 
+    public void attachInfo(Context context, ProviderInfo info) {
+        // With newer Robolectric versions, we must create the target provider
+        // before calling into super.  If we don't do this, the target
+        // provider's onCreate() will witness a null getContext(), which the
+        // Android documentation guarantees never happens on device.
+        mTargetProvider.attachInfo(context, null);
+        super.attachInfo(context, info);
+    }
+
     private Uri appendTestParam(Uri uri) {
         return appendUriParam(uri, BrowserContract.PARAM_IS_TEST, "1");
     }
@@ -88,6 +131,10 @@ public Bundle call(String method, String arg, Bundle extras) {
         return mTargetProvider.call(method, arg, extras);
     }
 
+    public void shutdown() {
+        mTargetProvider.shutdown();
+    }
+
     public ContentProvider getTargetProvider() {
         return mTargetProvider;
     }

mobile/android/services/src/test/java/org/mozilla/gecko/background/db/TestTabsProvider.java

@@ -3,6 +3,7 @@
 
 package org.mozilla.gecko.background.db;
 
+import android.content.ContentProvider;
 import android.content.ContentProviderClient;
 import android.content.ContentValues;
 import android.database.Cursor;
@@ -17,7 +18,6 @@
 import org.junit.runner.RunWith;
 import org.mozilla.gecko.background.testhelpers.TestRunner;
 import org.mozilla.gecko.db.BrowserContract;
-import org.mozilla.gecko.db.TabsProvider;
 import org.mozilla.gecko.sync.repositories.android.BrowserContractHelpers;
 import org.mozilla.gecko.sync.repositories.android.FennecTabsRepository;
 import org.mozilla.gecko.sync.repositories.domain.TabsRecord;
@@ -35,13 +35,11 @@ public class TestTabsProvider {
     protected Tab testTab2;
     protected Tab testTab3;
 
-    protected TabsProvider provider;
+    protected ContentProvider provider;
 
     @Before
     public void setUp() {
-        provider = new TabsProvider();
-        provider.onCreate();
-        ShadowContentResolver.registerProvider(BrowserContract.TABS_AUTHORITY, new DelegatingTestContentProvider(provider));
+        provider = DelegatingTestContentProvider.createDelegatingTabsProvider();
     }
 
     @After

mobile/android/services/src/test/java/org/mozilla/gecko/background/testhelpers/MockGlobalSession.java

@@ -13,6 +13,8 @@
 import org.mozilla.gecko.sync.stage.CompletedStage;
 import org.mozilla.gecko.sync.stage.GlobalSyncStage;
 import org.mozilla.gecko.sync.stage.GlobalSyncStage.Stage;
+import org.robolectric.Robolectric;
+import org.robolectric.RuntimeEnvironment;
 
 import java.io.IOException;
 import java.util.HashMap;
@@ -26,7 +28,7 @@ public MockGlobalSession(String username, String password, KeyBundle keyBundle,
 
   public MockGlobalSession(SyncConfiguration config, GlobalSessionCallback callback)
           throws SyncConfigurationException, IllegalArgumentException, IOException, NonObjectJSONException {
-    super(config, callback, null, null);
+    super(config, callback, RuntimeEnvironment.application, null);
   }
 
   @Override

mobile/android/services/src/test/java/org/mozilla/gecko/background/testhelpers/MockPrefsGlobalSession.java

@@ -53,9 +53,4 @@ public static MockPrefsGlobalSession getSession(
     config.syncKeyBundle = syncKeyBundle;
     return new MockPrefsGlobalSession(config, callback, context, clientsDelegate);
   }
-
-  @Override
-  public Context getContext() {
-    return null;
-  }
 }

mobile/android/services/src/test/java/org/mozilla/gecko/db/BrowserProviderBookmarksTest.java

@@ -3,6 +3,7 @@
 
 package org.mozilla.gecko.db;
 
+import android.content.ContentProvider;
 import android.content.ContentProviderClient;
 import android.content.ContentUris;
 import android.content.ContentValues;
@@ -17,12 +18,11 @@
 import org.junit.runner.RunWith;
 import org.mozilla.gecko.background.db.DelegatingTestContentProvider;
 import org.mozilla.gecko.background.testhelpers.TestRunner;
+import org.mozilla.gecko.db.BrowserContract.Bookmarks;
 import org.mozilla.gecko.sync.Utils;
 import org.mozilla.gecko.sync.repositories.android.BrowserContractHelpers;
 import org.robolectric.shadows.ShadowContentResolver;
 
-import org.mozilla.gecko.db.BrowserContract.Bookmarks;
-
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
@@ -41,8 +41,9 @@
 import static org.mozilla.gecko.db.BrowserProviderGeneralTest.assertVersionsForSelection;
 import static org.mozilla.gecko.db.BrowserProviderGeneralTest.bookmarksTestSyncUri;
 import static org.mozilla.gecko.db.BrowserProviderGeneralTest.bookmarksTestUri;
-import static org.mozilla.gecko.db.BrowserProviderGeneralTest.getBookmarksTestSyncIncrementLocalVersionUri;
 import static org.mozilla.gecko.db.BrowserProviderGeneralTest.getBookmarkIdFromGuid;
+import static org.mozilla.gecko.db.BrowserProviderGeneralTest
+        .getBookmarksTestSyncIncrementLocalVersionUri;
 import static org.mozilla.gecko.db.BrowserProviderGeneralTest.insertBookmark;
 import static org.mozilla.gecko.db.BrowserProviderGeneralTest.withDeleted;
 import static org.mozilla.gecko.db.BrowserProviderGeneralTest.withSync;
@@ -53,13 +54,11 @@
 @RunWith(TestRunner.class)
 public class BrowserProviderBookmarksTest {
     private ContentProviderClient bookmarksClient;
-    private BrowserProvider provider;
+    private ContentProvider provider;
 
     @Before
     public void setUp() throws Exception {
-        provider = new BrowserProvider();
-        provider.onCreate();
-        ShadowContentResolver.registerProvider(BrowserContract.AUTHORITY, new DelegatingTestContentProvider(provider));
+        provider = DelegatingTestContentProvider.createDelegatingBrowserProvider();
 
         ShadowContentResolver contentResolver = new ShadowContentResolver();
         bookmarksClient = contentResolver.acquireContentProviderClient(BrowserContractHelpers.BOOKMARKS_CONTENT_URI);

mobile/android/services/src/test/java/org/mozilla/gecko/db/BrowserProviderGeneralTest.java

@@ -3,13 +3,13 @@
 
 package org.mozilla.gecko.db;
 
+import android.content.ContentProvider;
 import android.content.ContentProviderClient;
 import android.content.ContentValues;
 import android.database.Cursor;
 import android.net.Uri;
 import android.os.Bundle;
 import android.os.RemoteException;
-import android.provider.Browser;
 
 import org.junit.After;
 import org.junit.Before;
@@ -41,15 +41,12 @@ public class BrowserProviderGeneralTest {
 
     private static final long INVALID_ID = -1;
 
-    private BrowserProvider provider;
+    private ContentProvider provider;
     private ContentProviderClient browserClient;
 
     @Before
     public void setUp() throws Exception {
-        provider = new BrowserProvider();
-        provider.onCreate();
-
-        ShadowContentResolver.registerProvider(BrowserContract.AUTHORITY, new DelegatingTestContentProvider(provider));
+        provider = DelegatingTestContentProvider.createDelegatingBrowserProvider();
 
         ShadowContentResolver contentResolver = new ShadowContentResolver();
         browserClient = contentResolver.acquireContentProviderClient(BrowserContractHelpers.BOOKMARKS_CONTENT_URI);