Circumvent a bug in Robolectric

It’s complaining about a missing Manifest, but it is actually looking into the wrong location.

Author: Clément Le Provost

algoliasearch/src/test/java/com/algolia/search/saas/CustomRunner.java

@@ -0,0 +1,128 @@
+/*
+ * Copyright (c) 2012-2016 Algolia
+ * http://www.algolia.com/
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+package com.algolia.search.saas;
+
+import org.junit.runners.model.InitializationError;
+import org.robolectric.RobolectricTestRunner;
+import org.robolectric.annotation.Config;
+import org.robolectric.manifest.AndroidManifest;
+import org.robolectric.res.FileFsFile;
+import org.robolectric.util.Logger;
+import org.robolectric.util.ReflectionHelpers;
+
+
+/**
+ * Custom runner for Robolectric.
+ *
+ * **Note:** This is required to circumvent a bug in Robolectric when used in the following configuration:
+ *
+ * - Robolectric 3.0 -> 3.1.2 (at least)
+ * - Android Studio 2.2
+ * - Gradle 2.10
+ * - Build Tools 24.0.1 -> 24.0.3 (at least)
+ *
+ * Solution inspired by a reply to [Robolectric issue #1648](https://github.com/robolectric/robolectric/issues/1648).
+ */
+public class CustomRunner extends RobolectricTestRunner {
+
+    private static final String BUILD_OUTPUT = "build/intermediates";
+
+    public CustomRunner(Class<?> klass) throws InitializationError {
+        super(klass);
+    }
+
+    @Override
+    protected AndroidManifest getAppManifest(Config config) {
+        final String cwd = System.getProperty("user.dir");
+        Logger.debug("Current working directory: " + cwd);
+
+        if (config.constants() == Void.class) {
+            Logger.error("Field 'constants' not specified in @Config annotation");
+            Logger.error("This is required when using RobolectricGradleTestRunner!");
+            throw new RuntimeException("No 'constants' field in @Config annotation!");
+        }
+
+        final String type = getType(config);
+        final String flavor = getFlavor(config);
+        final String packageName = getPackageName(config);
+
+        final FileFsFile res;
+        final FileFsFile assets;
+        final FileFsFile manifest;
+
+        if (FileFsFile.from(BUILD_OUTPUT, "res").exists()) {
+            res = FileFsFile.from(BUILD_OUTPUT, "res", flavor, type);
+        } else {
+            res = FileFsFile.from(BUILD_OUTPUT, "bundles", flavor, type, "res");
+        }
+
+        if (FileFsFile.from(BUILD_OUTPUT, "assets").exists()) {
+            assets = FileFsFile.from(BUILD_OUTPUT, "assets", flavor, type);
+        } else {
+            assets = FileFsFile.from(BUILD_OUTPUT, "bundles", flavor, type, "assets");
+        }
+
+        if (FileFsFile.from(BUILD_OUTPUT, "manifests").exists()) {
+            // [CUSTOMIZED] The default implementation uses `full` instead of `aapt`.
+            manifest = FileFsFile.from(BUILD_OUTPUT, "manifests", "aapt", flavor, type, "AndroidManifest.xml");
+        } else {
+            manifest = FileFsFile.from(BUILD_OUTPUT, "bundles", flavor, type, "AndroidManifest.xml");
+        }
+
+        Logger.debug("Robolectric assets directory: " + assets.getPath());
+        Logger.debug("   Robolectric res directory: " + res.getPath());
+        Logger.debug("   Robolectric manifest path: " + manifest.getPath());
+        Logger.debug("    Robolectric package name: " + packageName);
+        return new AndroidManifest(manifest, res, assets, packageName);
+    }
+
+    private String getType(Config config) {
+        try {
+            return ReflectionHelpers.getStaticField(config.constants(), "BUILD_TYPE");
+        } catch (Throwable e) {
+            return null;
+        }
+    }
+
+    private String getFlavor(Config config) {
+        try {
+            return ReflectionHelpers.getStaticField(config.constants(), "FLAVOR");
+        } catch (Throwable e) {
+            return null;
+        }
+    }
+
+    private String getPackageName(Config config) {
+        try {
+            final String packageName = config.packageName();
+            if (packageName != null && !packageName.isEmpty()) {
+                return packageName;
+            } else {
+                return ReflectionHelpers.getStaticField(config.constants(), "APPLICATION_ID");
+            }
+        } catch (Throwable e) {
+            return null;
+        }
+    }
+}

algoliasearch/src/test/java/com/algolia/search/saas/RobolectricTestCase.java

@@ -7,12 +7,11 @@
 import org.junit.After;
 import org.junit.Before;
 import org.junit.runner.RunWith;
-import org.robolectric.RobolectricGradleTestRunner;
 import org.robolectric.annotation.Config;
 import org.robolectric.shadows.ShadowLog;
 
 @Config(shadows = {ShadowLog.class}, manifest = Config.NONE, constants = BuildConfig.class, sdk = Build.VERSION_CODES.LOLLIPOP)
-@RunWith(RobolectricGradleTestRunner.class)
+@RunWith(CustomRunner.class)
 public abstract class RobolectricTestCase {
 
     @Before