[All] Share tests to run on Robolectric & Emulators (#180)

* Add Robolectric test support on :insets

* Add Robolectric test support to :flowlayout

* Add Robolectric test support on :pager

* Missed PagerStateTest

* Remove test-parameter-injector

As we can't use it with Robolectric

* Migrate :swiperefresh tests to Robolectric

* Migrate :appcompat-theme tests to Robolectric

* Rename package in :internal-testutils

* Migrate SystemUiController tests to Robolectric

* Only run necessary tests on PRs/commits

Most tests are covered by Robolectric, but we still need to run the
remaining tests on device. Also setup a twice-daily run which runs all
tests on devices, similar to what we currently run.

Extract all of the logic into a shell script for easy re-use.

* Stop using trap. Messes with CI

* Migrate :placeholder to Robolectric

* Move more common utils to internal-testutils

* Revert permissions waitUntil

* Reduce number of Pager instrumented tests

* Add comments to tests

* Revert CI gradle command

Author: chrisbanes

.github/workflows/build.yml

@@ -18,11 +18,12 @@ jobs:
 
     runs-on: ubuntu-latest
     timeout-minutes: 30
-    env:
-      TERM: dumb
 
     steps:
       - uses: actions/checkout@v2
+        with:
+          # Fetch expanded history, which is needed for affected module detection
+          fetch-depth: '500'
 
       - name: Copy CI gradle.properties
         run: mkdir -p ~/.gradle ; cp .github/ci-gradle.properties ~/.gradle/gradle.properties
@@ -46,8 +47,29 @@ jobs:
             ~/.gradle/caches/build-cache-*
           key: gradle-${{ hashFiles('checksum.txt') }}
 
-      - name: Build, lint and spotless
-        run: ./gradlew spotlessCheck assemble assembleAndroidTest lintDebug metalavaCheckCompatibility --scan
+      - name: Build
+        run: |
+          ./gradlew --scan --stacktrace \
+              spotlessCheck \
+              assemble \
+              metalavaCheckCompatibility \
+              lintDebug
+
+      - name: Unit Tests
+        run: |
+          ./scripts/run-tests.sh \
+              --unit-tests \
+              --run-affected \
+              --affected-base-ref=$BASE_REF
+
+      - name: Upload test results
+        if: always()
+        uses: actions/upload-artifact@v2
+        with:
+          name: test-results-robolectric
+          path: |
+            **/build/test-results/*
+            **/build/reports/*
 
       - name: Clean secrets
         if: always()
@@ -56,7 +78,7 @@ jobs:
   test:
     runs-on: macos-11.0
     needs: build
-    timeout-minutes: 70
+    timeout-minutes: 50
 
     strategy:
       # Allow tests to continue on other devices if they fail on one device.
@@ -71,8 +93,8 @@ jobs:
     steps:
       - uses: actions/checkout@v2
         with:
-          # 0 == fetch all history, which is needed for affected module detection
-          fetch-depth: '0'
+          # Fetch expanded history, which is needed for affected module detection
+          fetch-depth: '500'
 
       - name: Copy CI gradle.properties
         run: mkdir -p ~/.gradle ; cp .github/ci-gradle.properties ~/.gradle/gradle.properties
@@ -116,7 +138,7 @@ jobs:
           target: ${{ steps.determine-target.outputs.TARGET }}
           profile: Galaxy Nexus
           # We run all affected tests of the PR (or commit)
-          script: ./scripts/run-device-tests.sh --log-file=logcat.txt --run-affected --affected-base-ref=$BASE_REF --shard-index=${{ matrix.shard }} --shard-count=2
+          script: ./scripts/run-tests.sh --log-file=logcat.txt --run-affected --affected-base-ref=$BASE_REF --shard-index=${{ matrix.shard }} --shard-count=2
 
       - name: Clean secrets
         if: always()
@@ -142,7 +164,7 @@ jobs:
     if: github.event_name == 'push' # only deploy for pushed commits (not PRs)
 
     runs-on: ubuntu-latest
-    needs: [build, test]
+    needs: [ build, test ]
     timeout-minutes: 30
     env:
       TERM: dumb
@@ -173,7 +195,7 @@ jobs:
           key: gradle-${{ hashFiles('checksum.txt') }}
 
       - name: Deploy to Sonatype
-        run: ./gradlew publish --no-parallel
+        run: ./gradlew publish --no-parallel --stacktrace
         env:
           ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.SONATYPE_NEXUS_USERNAME }}
           ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.SONATYPE_NEXUS_PASSWORD }}

.github/workflows/device-tests.yml

@@ -60,14 +60,14 @@ jobs:
           fi
           echo "::set-output name=TARGET::$TARGET"
 
-      - name: Run tests
+      - name: Run device tests
         uses: reactivecircus/android-emulator-runner@v2
         with:
           api-level: ${{ matrix.api-level }}
           target: ${{ steps.determine-target.outputs.TARGET }}
           profile: Galaxy Nexus
           # We run all tests, sharding them over 3 shards
-          script: ./scripts/run-device-tests.sh --log-file=logcat.txt --shard-index=${{ matrix.shard }} --shard-count=3
+          script: ./scripts/run-tests.sh --log-file=logcat.txt --shard-index=${{ matrix.shard }} --shard-count=3
 
       - name: Clean secrets
         if: always()

appcompat-theme/build.gradle

@@ -68,6 +68,17 @@ android {
         }
         animationsDisabled true
     }
+
+    sourceSets {
+        test {
+            java.srcDirs += 'src/sharedTest/kotlin'
+            res.srcDirs += 'src/sharedTest/res'
+        }
+        androidTest {
+            java.srcDirs += 'src/sharedTest/kotlin'
+            res.srcDirs += 'src/sharedTest/res'
+        }
+    }
 }
 
 dependencies {
@@ -76,9 +87,23 @@ dependencies {
 
     api libs.androidx.appcompat
 
+    // ======================
+    // Test dependencies
+    // ======================
+
+    androidTestImplementation project(':internal-testutils')
+    testImplementation project(':internal-testutils')
+
     androidTestImplementation libs.junit
+    testImplementation libs.junit
+
     androidTestImplementation libs.compose.ui.test.junit4
+    testImplementation libs.compose.ui.test.junit4
+
     androidTestImplementation libs.androidx.test.runner
+    testImplementation libs.androidx.test.runner
+
+    testImplementation libs.robolectric
 }
 
 apply plugin: 'com.vanniktech.maven.publish'

appcompat-theme/src/androidTest/kotlin/com/google/accompanist/appcompattheme/InstrumentedAppCompatThemeTest.kt

@@ -0,0 +1,63 @@
+/*
+ * Copyright 2021 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.google.accompanist.appcompattheme
+
+import androidx.appcompat.app.AppCompatActivity
+import androidx.compose.material.MaterialTheme
+import androidx.compose.ui.text.font.Font
+import androidx.compose.ui.text.font.FontWeight
+import androidx.compose.ui.text.font.toFontFamily
+import androidx.test.filters.SdkSuppress
+import com.google.accompanist.appcompattheme.test.R
+import org.junit.Test
+import org.junit.runner.RunWith
+import org.junit.runners.Parameterized
+
+/**
+ * Version of [BaseAppCompatThemeTest] which is designed to be run on device/emulators.
+ */
+@RunWith(Parameterized::class)
+class InstrumentedAppCompatThemeTest<T : AppCompatActivity>(
+    activityClass: Class<T>
+) : BaseAppCompatThemeTest<T>(activityClass) {
+    companion object {
+        @JvmStatic
+        @Parameterized.Parameters
+        fun activities() = listOf(
+            DarkAppCompatActivity::class.java,
+            LightAppCompatActivity::class.java
+        )
+    }
+
+    /**
+     * On API 21-22, the family is loaded with only the 400 font.
+     *
+     * This only works on device as Robolectric seems to always use the behavior from API 23+,
+     * which is not what we want to test.
+     */
+    @Test
+    @SdkSuppress(maxSdkVersion = 22)
+    fun type_rubik_family_api21() = composeTestRule.setContent {
+        val rubik = Font(R.font.rubik, FontWeight.W400).toFontFamily()
+
+        WithThemeOverlay(R.style.ThemeOverlay_RubikFontFamily) {
+            AppCompatTheme {
+                MaterialTheme.typography.assertFontFamily(expected = rubik)
+            }
+        }
+    }
+}

appcompat-theme/src/androidTest/java/com/google/accompanist/appcompattheme/AppCompatThemeTest.kt renamed to appcompat-theme/src/sharedTest/kotlin/com/google/accompanist/appcompattheme/BaseAppCompatThemeTest.kt

@@ -33,27 +33,20 @@ import androidx.compose.ui.text.font.Font
 import androidx.compose.ui.text.font.FontFamily
 import androidx.compose.ui.text.font.FontWeight
 import androidx.compose.ui.text.font.toFontFamily
-import androidx.test.filters.LargeTest
 import androidx.test.filters.SdkSuppress
 import com.google.accompanist.appcompattheme.test.R
 import org.junit.Assert.assertEquals
 import org.junit.Rule
 import org.junit.Test
-import org.junit.runner.RunWith
-import org.junit.runners.Parameterized
-
-@LargeTest
-@RunWith(Parameterized::class)
-class AppCompatThemeTest<T : AppCompatActivity>(activityClass: Class<T>) {
-    companion object {
-        @JvmStatic
-        @Parameterized.Parameters
-        fun activities() = listOf(
-            DarkAppCompatActivity::class.java,
-            LightAppCompatActivity::class.java
-        )
-    }
 
+/**
+ * Class which contains the majority of the tests. This class is extended
+ * in both the `androidTest` and `test` source sets for setup of the relevant
+ * test runner.
+ */
+abstract class BaseAppCompatThemeTest<T : AppCompatActivity>(
+    activityClass: Class<T>
+) {
     @get:Rule
     val composeTestRule = createAndroidComposeRule(activityClass)
 
@@ -125,21 +118,9 @@ class AppCompatThemeTest<T : AppCompatActivity>(activityClass: Class<T>) {
         }
     }
 
-    @Test
-    @SdkSuppress(maxSdkVersion = 22) // On API 21-22, the family is loaded with only the 400 font
-    fun type_rubik_family_api21() = composeTestRule.setContent {
-        val rubik = Font(R.font.rubik, FontWeight.W400).toFontFamily()
-
-        WithThemeOverlay(R.style.ThemeOverlay_RubikFontFamily) {
-            AppCompatTheme {
-                MaterialTheme.typography.assertFontFamily(expected = rubik)
-            }
-        }
-    }
-
     @Test
     @SdkSuppress(minSdkVersion = 23) // XML font families with >1 fonts are only supported on API 23+
-    fun type_rubik_family_api23() = composeTestRule.setContent {
+    open fun type_rubik_family_api23() = composeTestRule.setContent {
         val rubik = FontFamily(
             Font(R.font.rubik_300, FontWeight.W300),
             Font(R.font.rubik_400, FontWeight.W400),
@@ -165,7 +146,7 @@ class AppCompatThemeTest<T : AppCompatActivity>(activityClass: Class<T>) {
     }
 }
 
-private fun Typography.assertFontFamily(expected: FontFamily) {
+internal fun Typography.assertFontFamily(expected: FontFamily) {
     assertEquals(expected, h1.fontFamily)
     assertEquals(expected, h2.fontFamily)
     assertEquals(expected, h3.fontFamily)

appcompat-theme/src/androidTest/java/com/google/accompanist/appcompattheme/DarkAppCompatActivity.kt renamed to appcompat-theme/src/sharedTest/kotlin/com/google/accompanist/appcompattheme/DarkAppCompatActivity.kt

@@ -17,14 +17,12 @@
 package com.google.accompanist.appcompattheme
 
 import androidx.compose.ui.test.junit4.createAndroidComposeRule
-import androidx.test.filters.MediumTest
+import androidx.test.ext.junit.runners.AndroidJUnit4
 import org.junit.Rule
 import org.junit.Test
 import org.junit.runner.RunWith
-import org.junit.runners.JUnit4
 
-@MediumTest
-@RunWith(JUnit4::class)
+@RunWith(AndroidJUnit4::class)
 class NotAppCompatThemeTest {
     @get:Rule
     val composeTestRule = createAndroidComposeRule<NotAppCompatActivity>()

appcompat-theme/src/androidTest/java/com/google/accompanist/appcompattheme/DummyTests.kt renamed to appcompat-theme/src/sharedTest/kotlin/com/google/accompanist/appcompattheme/DummyTests.kt

@@ -0,0 +1,34 @@
+<!--
+  ~ Copyright 2020 The Android Open Source Project
+  ~
+  ~ Licensed under the Apache License, Version 2.0 (the "License");
+  ~ you may not use this file except in compliance with the License.
+  ~ You may obtain a copy of the License at
+  ~
+  ~      https://www.apache.org/licenses/LICENSE-2.0
+  ~
+  ~ Unless required by applicable law or agreed to in writing, software
+  ~ distributed under the License is distributed on an "AS IS" BASIS,
+  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  ~ See the License for the specific language governing permissions and
+  ~ limitations under the License.
+  -->
+
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    package="com.google.accompanist.appcompattheme">
+
+    <application>
+        <activity
+            android:name=".LightAppCompatActivity"
+            android:theme="@style/Theme.AppCompatThemeTest" />
+
+        <activity
+            android:name=".DarkAppCompatActivity"
+            android:theme="@style/Theme.AppCompatThemeTest" />
+
+        <activity
+            android:name=".NotAppCompatActivity"
+            android:theme="@android:style/Theme.Material" />
+    </application>
+
+</manifest>

appcompat-theme/src/androidTest/java/com/google/accompanist/appcompattheme/LightAppCompatActivity.kt renamed to appcompat-theme/src/sharedTest/kotlin/com/google/accompanist/appcompattheme/LightAppCompatActivity.kt

@@ -0,0 +1,40 @@
+/*
+ * Copyright 2021 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.google.accompanist.appcompattheme
+
+import androidx.appcompat.app.AppCompatActivity
+import org.junit.runner.RunWith
+import org.robolectric.ParameterizedRobolectricTestRunner
+
+/**
+ * Version of [BaseAppCompatThemeTest] which is designed to be run using Robolectric.
+ *
+ * All of the tests are provided by [BaseAppCompatThemeTest].
+ */
+@RunWith(ParameterizedRobolectricTestRunner::class)
+class RobolectricAppCompatThemeTest<T : AppCompatActivity>(
+    activityClass: Class<T>
+) : BaseAppCompatThemeTest<T>(activityClass) {
+    companion object {
+        @JvmStatic
+        @ParameterizedRobolectricTestRunner.Parameters
+        fun activities() = listOf(
+            DarkAppCompatActivity::class.java,
+            LightAppCompatActivity::class.java
+        )
+    }
+}