Merge "Add demo and prod product flavors. Remove staging variant." into main

README.md

@@ -52,18 +52,26 @@ and is described in detail in the
 
 # Build
 
-The `debug` variant of `app` uses local data to allow immediate building and exploring the UI.
+The app contains the usual `debug` and `release` build variants. 
 
-The `staging` and `release` variants of `app` make real network calls to a backend server, providing
+In addition, the `benchmark` variant of `app` is used to test startup performance and generate a
-up-to-date data as new episodes of Now in Android are released. At this time, there is not a
+baseline profile (see below for more information).
-public backend available.
-
-The `benchmark` variant of `app` is used to test startup performance and generate a baseline profile
-(see below for more information).
 
 `app-nia-catalog` is a standalone app that displays the list of components that are stylized for
 Now in Android.
 
+The app also uses
+[product flavors](https://developer.android.com/studio/build/build-variants#product-flavors) to
+control where content for the app should be loaded from.
+
+The `demo` flavor uses static local data to allow immediate building and exploring the UI.
+
+The `prod` flavor makes real network calls to a backend server, providing up-to-date content. At 
+this time, there is not a public backend available.
+
+For normal development use the `demoDebug` variant. For UI performance testing use the
+`demoRelease` variant. 
+
 # Testing
 
 To facilitate testing of components, Now in Android uses dependency injection with

app-nia-catalog/build.gradle.kts

@@ -22,6 +22,10 @@ plugins {
 android {
     defaultConfig {
         applicationId = "com.google.samples.apps.niacatalog"
+
+        // The UI catalog does not depend on content from the app, however, it depends on modules
+        // which do, so we must specify a default value for the contentType dimension.
+        missingDimensionStrategy("contentType", "demo")
     }
 
     packagingOptions {

app/build.gradle.kts

@@ -13,6 +13,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import com.google.samples.apps.nowinandroid.FlavorDimension
+import com.google.samples.apps.nowinandroid.Flavor
+
 plugins {
     id("nowinandroid.android.application")
     id("nowinandroid.android.application.compose")
@@ -43,6 +46,11 @@ android {
         val release by getting {
             isMinifyEnabled = true
             proguardFiles(getDefaultProguardFile("proguard-android-optimize.txt"), "proguard-rules.pro")
+
+            // To publish on the Play store a private signing key is required, but to allow anyone
+            // who clones the code to sign and run the release variant, use the debug signing key.
+            // TODO: Abstract the signing configuration to a separate file to avoid hardcoding this.
+            signingConfig = signingConfigs.getByName("debug")
         }
         val benchmark by creating {
             initWith(release)
@@ -50,13 +58,21 @@ android {
             matchingFallbacks.add("release")
             proguardFiles("benchmark-rules.pro")
         }
-        val staging by creating {
+    }
-            initWith(debug)
+
-            signingConfig = signingConfigs.getByName("debug")
+    // @see Flavor for more details on the app product flavors.
-            matchingFallbacks.add("debug")
+    flavorDimensions += FlavorDimension.contentType.name
-            applicationIdSuffix = ".staging"
+    productFlavors {
+        Flavor.values().forEach {
+            create(it.name) {
+                dimension = it.dimension.name
+                if (it.applicationIdSuffix != null) {
+                    applicationIdSuffix = it.applicationIdSuffix
+                }
+            }
         }
     }
+
     packagingOptions {
         resources {
             excludes.add("/META-INF/{AL2.0,LGPL2.1}")

build-logic/convention/src/main/kotlin/com/google/samples/apps/nowinandroid/Flavor.kt

@@ -0,0 +1,31 @@
+package com.google.samples.apps.nowinandroid
+
+import com.android.build.api.dsl.CommonExtension
+import org.gradle.api.Project
+
+enum class FlavorDimension {
+    contentType
+}
+
+// The content for the app can either come from local static data which is useful for demo
+// purposes, or from a production backend server which supplies up-to-date, real content.
+// These two product flavors reflect this behaviour.
+enum class Flavor (val dimension : FlavorDimension, val applicationIdSuffix : String? = null) {
+    demo(FlavorDimension.contentType, ".demo"),
+    prod(FlavorDimension.contentType)
+}
+
+fun Project.configureFlavors(
+    commonExtension: CommonExtension<*, *, *, *>
+) {
+    commonExtension.apply {
+        flavorDimensions += FlavorDimension.contentType.name
+        productFlavors {
+            Flavor.values().forEach{
+                create(it.name) {
+                    dimension = it.dimension.name
+                }
+            }
+        }
+    }
+}

build-logic/convention/src/main/kotlin/nowinandroid.android.library.gradle.kts

@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 
+import com.google.samples.apps.nowinandroid.configureFlavors
 import com.google.samples.apps.nowinandroid.configureKotlinAndroid
 
 plugins {
@@ -27,6 +28,8 @@ android {
     defaultConfig {
         targetSdk = 32
     }
+
+    configureFlavors(this)
 }
 
 val libs = extensions.getByType<VersionCatalogsExtension>().named("libs")

core-network/build.gradle.kts

@@ -23,22 +23,6 @@ plugins {
     id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin")
 }
 
-android {
-    buildTypes {
-        val staging by creating {
-            initWith(getByName("debug"))
-            matchingFallbacks.add("debug")
-        }
-    }
-    // Force the staging variant to use the release source directory. This is necessary so that the
-    // staging variant uses the remote network.
-    sourceSets {
-        getByName("staging") {
-            java.srcDir("src/release/java")
-        }
-    }
-}
-
 secrets {
     defaultPropertiesFileName = "secrets.defaults.properties"
 }

kokoro/build.sh

@@ -62,8 +62,8 @@ run_firebase_test_lab() {
   while [ $result != 0 -a $counter -lt $MAX_RETRY ]; do
     gcloud firebase test android run \
       --type instrumentation \
-      --app  "app/build/outputs/apk/debug/app-debug.apk" \
+      --app  "app/build/outputs/apk/demo/debug/app-demo-debug.apk" \
-      --test "$module/build/outputs/apk/androidTest/debug/$module-debug-androidTest.apk" \
+      --test "$module/build/outputs/apk/androidTest/demo/debug/$module-demo-debug-androidTest.apk" \
       --device-ids $deviceIds \
       --os-version-ids $osVersionIds \
       --locales en \