Revert "Remove deprecated Config#packageName()"

This reverts commit 521031c.

Author: MGaetan89

annotations/src/main/java/org/robolectric/annotation/Config.java

@@ -37,6 +37,7 @@
 
   String DEFAULT_MANIFEST_NAME = "AndroidManifest.xml";
   Class<? extends Application> DEFAULT_APPLICATION = DefaultApplication.class;
+  String DEFAULT_PACKAGE_NAME = "";
   String DEFAULT_QUALIFIERS = "";
   String DEFAULT_RES_FOLDER = "res";
   String DEFAULT_ASSET_FOLDER = "assets";
@@ -87,6 +88,26 @@
   Class<? extends Application> application() default
       DefaultApplication.class; // DEFAULT_APPLICATION
 
+  /**
+   * Java package name where the "R.class" file is located. This only needs to be specified if you
+   * define an {@code applicationId} associated with {@code productFlavors} or specify {@code
+   * applicationIdSuffix} in your build.gradle.
+   *
+   * <p>If not specified, Robolectric defaults to the {@code applicationId}.
+   *
+   * @return The java package name for R.class.
+   * @deprecated To change your package name please override the applicationId in your build system.
+   *     Changing package name here is broken as the package name will no longer match the package
+   *     name encoded in the arsc resources file. If you are looking to simulate another application
+   *     you can create another applications Context using {@link
+   *     android.content.Context#createPackageContext(String, int)}. Note that you must add this
+   *     package to {@link
+   *     org.robolectric.shadows.ShadowPackageManager#addPackage(android.content.pm.PackageInfo)}
+   *     first.
+   */
+  @Deprecated
+  String packageName() default DEFAULT_PACKAGE_NAME;
+
   /**
    * Qualifiers specifying device configuration for this test, such as "fr-normal-port-hdpi".
    *
@@ -158,6 +179,7 @@ class Implementation implements Config {
     private final String qualifiers;
     private final String resourceDir;
     private final String assetDir;
+    private final String packageName;
     private final Class<?>[] shadows;
     private final String[] instrumentedPackages;
     private final Class<? extends Application> application;
@@ -172,6 +194,7 @@ public static Config fromProperties(Properties properties) {
           properties.getProperty("manifest", DEFAULT_VALUE_STRING),
           properties.getProperty("qualifiers", DEFAULT_QUALIFIERS),
           Float.parseFloat(properties.getProperty("fontScale", "1.0f")),
+          properties.getProperty("packageName", DEFAULT_PACKAGE_NAME),
           properties.getProperty("resourceDir", DEFAULT_RES_FOLDER),
           properties.getProperty("assetDir", DEFAULT_ASSET_FOLDER),
           parseClasses(properties.getProperty("shadows", "")),
@@ -272,6 +295,7 @@ public Implementation(
         String manifest,
         String qualifiers,
         float fontScale,
+        String packageName,
         String resourceDir,
         String assetDir,
         Class<?>[] shadows,
@@ -284,6 +308,7 @@ public Implementation(
       this.manifest = manifest;
       this.qualifiers = qualifiers;
       this.fontScale = fontScale;
+      this.packageName = packageName;
       this.resourceDir = resourceDir;
       this.assetDir = assetDir;
       this.shadows = shadows;
@@ -329,6 +354,11 @@ public String qualifiers() {
       return qualifiers;
     }
 
+    @Override
+    public String packageName() {
+      return packageName;
+    }
+
     @Override
     public String resourceDir() {
       return resourceDir;
@@ -381,6 +411,9 @@ public String toString() {
           + ", assetDir='"
           + assetDir
           + '\''
+          + ", packageName='"
+          + packageName
+          + '\''
           + ", shadows="
           + Arrays.toString(shadows)
           + ", instrumentedPackages="
@@ -400,6 +433,7 @@ class Builder {
     protected float fontScale = 1.0f;
     protected String manifest = Config.DEFAULT_VALUE_STRING;
     protected String qualifiers = Config.DEFAULT_QUALIFIERS;
+    protected String packageName = Config.DEFAULT_PACKAGE_NAME;
     protected String resourceDir = Config.DEFAULT_RES_FOLDER;
     protected String assetDir = Config.DEFAULT_ASSET_FOLDER;
     protected Class<?>[] shadows = new Class[0];
@@ -416,6 +450,7 @@ public Builder(Config config) {
       manifest = config.manifest();
       qualifiers = config.qualifiers();
       fontScale = config.fontScale();
+      packageName = config.packageName();
       resourceDir = config.resourceDir();
       assetDir = config.assetDir();
       shadows = config.shadows();
@@ -449,6 +484,11 @@ public Builder setQualifiers(String qualifiers) {
       return this;
     }
 
+    public Builder setPackageName(String packageName) {
+      this.packageName = packageName;
+      return this;
+    }
+
     public Builder setResourceDir(String resourceDir) {
       this.resourceDir = resourceDir;
       return this;
@@ -528,6 +568,7 @@ public Builder overlay(Config overlayConfig) {
         }
       }
 
+      this.packageName = pick(this.packageName, overlayConfig.packageName(), "");
       this.resourceDir =
           pick(this.resourceDir, overlayConfig.resourceDir(), Config.DEFAULT_RES_FOLDER);
       this.assetDir = pick(this.assetDir, overlayConfig.assetDir(), Config.DEFAULT_ASSET_FOLDER);
@@ -568,6 +609,7 @@ public Implementation build() {
           manifest,
           qualifiers,
           fontScale,
+          packageName,
           resourceDir,
           assetDir,
           shadows,

robolectric/src/main/java/org/robolectric/internal/DefaultManifestFactory.java

@@ -42,6 +42,10 @@ public ManifestIdentifier identify(Config config) {
       assetsDir = getResource(config.assetDir());
     }
 
+    if (!Config.DEFAULT_PACKAGE_NAME.equals(config.packageName())) {
+      packageName = config.packageName();
+    }
+
     List<ManifestIdentifier> libraryDirs = emptyList();
     if (config.libraries().length > 0) {
       Logger.info("@Config(libraries) specified while using Build System API, ignoring");

robolectric/src/test/java/org/robolectric/ManifestFactoryTest.java

@@ -71,7 +71,10 @@ protected Properties getBuildSystemApiProperties() {
         };
 
     Config.Implementation config =
-        Config.Builder.defaults().setManifest("TestAndroidManifest.xml").build();
+        Config.Builder.defaults()
+            .setManifest("TestAndroidManifest.xml")
+            .setPackageName("another.package")
+            .build();
     ManifestFactory manifestFactory = testRunner.getManifestFactory(config);
     assertThat(manifestFactory).isInstanceOf(DefaultManifestFactory.class);
     ManifestIdentifier manifestIdentifier = manifestFactory.identify(config);
@@ -80,6 +83,6 @@ protected Properties getBuildSystemApiProperties() {
     assertThat(manifestIdentifier.getResDir()).isEqualTo(Paths.get("/path/to/merged-resources"));
     assertThat(manifestIdentifier.getAssetDir()).isEqualTo(Paths.get("/path/to/merged-assets"));
     assertThat(manifestIdentifier.getLibraries()).isEmpty();
-    assertThat(manifestIdentifier.getPackageName()).isNull();
+    assertThat(manifestIdentifier.getPackageName()).isEqualTo("another.package");
   }
 }

robolectric/src/test/java/org/robolectric/internal/DefaultManifestFactoryTest.java

@@ -91,13 +91,14 @@ public void identify_packageCanBeOverriddenFromConfig() {
     properties.put("android_merged_resources", "gradle/res");
     properties.put("android_merged_assets", "gradle/assets");
     DefaultManifestFactory factory = new DefaultManifestFactory(properties);
-    ManifestIdentifier identifier = factory.identify(Config.Builder.defaults().build());
+    ManifestIdentifier identifier =
+        factory.identify(Config.Builder.defaults().setPackageName("overridden.package").build());
     AndroidManifest manifest = RobolectricTestRunner.createAndroidManifest(identifier);
 
     assertThat(manifest.getAndroidManifestFile())
         .isEqualTo(Paths.get("gradle/AndroidManifest.xml"));
     assertThat(manifest.getResDirectory()).isEqualTo(Paths.get("gradle/res"));
     assertThat(manifest.getAssetsDirectory()).isEqualTo(Paths.get("gradle/assets"));
-    assertThat(manifest.getRClassName()).isEqualTo("org.robolectric.default.R");
+    assertThat(manifest.getRClassName()).isEqualTo("overridden.package.R");
   }
 }