Adds UI tests setup

Author: Manuel Vivo

JetNews/README.md

@@ -75,6 +75,10 @@ on and off, light and dark version in the Android Studio Preview.
 
 The data in the sample is static, held in the `com.example.jetnews.data` package.
 
+### UI testing
+
+Run UI tests from Android Studio or with the `./gradlew connectedCheck` command.
+
 ## License
 
 ```

JetNews/app/build.gradle

@@ -26,6 +26,7 @@ android {
         versionCode 1
         versionName "1.0"
         vectorDrawables.useSupportLibrary = true
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
     }
     buildTypes {
         release {
@@ -64,6 +65,13 @@ dependencies {
     implementation('androidx.appcompat:appcompat:1.1.0')
     implementation('androidx.activity:activity-ktx:1.0.0')
     implementation "androidx.core:core-ktx:1.1.0"
+
+    androidTestImplementation("junit:junit:4.12")
+    androidTestImplementation("androidx.test:rules:1.2.0")
+    androidTestImplementation("androidx.test:runner:1.2.0")
+    androidTestImplementation("androidx.ui:ui-platform:$compose_version")
+    androidTestImplementation("androidx.ui:ui-test:$compose_version")
+
     ktlint "com.pinterest:ktlint:0.35.0"
 }
 

JetNews/app/src/androidTest/java/com/example/jetnews/JetnewsUiTest.kt

@@ -0,0 +1,60 @@
+/*
+ * Copyright 2019 Google, Inc.
+ *
+ * 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
+ *
+ *     http://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.example.jetnews
+
+import androidx.test.filters.MediumTest
+import androidx.ui.test.assertIsDisplayed
+import androidx.ui.test.doClick
+import androidx.ui.test.findByText
+import com.example.jetnews.util.JetnewsComposeTestRule
+import com.example.jetnews.util.findAllByText
+import com.example.jetnews.util.goBack
+import com.example.jetnews.util.launchJetNewsApp
+import com.example.jetnews.util.workForComposeToBeIdle
+import org.junit.Before
+import org.junit.Rule
+import org.junit.Test
+import org.junit.runner.RunWith
+import org.junit.runners.JUnit4
+
+@MediumTest
+@RunWith(JUnit4::class)
+class JetnewsUiTest {
+
+    @get:Rule
+    val composeTestRule = JetnewsComposeTestRule()
+
+    @Before
+    fun setUp() {
+        composeTestRule.launchJetNewsApp()
+    }
+
+    @Test
+    fun app_launches() {
+        findByText("Jetnews").assertIsDisplayed()
+    }
+
+    @Test
+    fun app_opensArticle() {
+        findAllByText("Manuel Vivo").first().doClick()
+        workForComposeToBeIdle()
+        findByText("July 30 • 3 min read").assertIsDisplayed()
+
+        // Temporary workaround - needs to go back since Activities don't start from scratch
+        goBack()
+    }
+}

JetNews/app/src/androidTest/java/com/example/jetnews/util/JetnewsComposeTestRule.kt

@@ -0,0 +1,102 @@
+package com.example.jetnews.util
+
+import android.util.DisplayMetrics
+import android.view.ViewGroup
+import android.view.ViewTreeObserver
+import androidx.compose.Composable
+import androidx.test.rule.ActivityTestRule
+import androidx.ui.core.Density
+import androidx.ui.core.setContent
+import androidx.ui.test.ComposeTestCase
+import androidx.ui.test.ComposeTestCaseSetup
+import androidx.ui.test.ComposeTestRule
+import androidx.ui.test.android.AndroidComposeTestCaseSetup
+import com.example.jetnews.ui.MainActivity
+import org.junit.runner.Description
+import org.junit.runners.model.Statement
+import java.util.concurrent.CountDownLatch
+import java.util.concurrent.TimeUnit
+
+/**
+ * Jetnews specific implementation of [ComposeTestRule].
+ */
+class JetnewsComposeTestRule : ComposeTestRule {
+
+    val activityTestRule = ActivityTestRule<MainActivity>(MainActivity::class.java)
+
+    override val density: Density get() = Density(activityTestRule.activity)
+
+    override val displayMetrics: DisplayMetrics
+        get() =
+            activityTestRule.activity.resources.displayMetrics
+
+    override fun apply(base: Statement, description: Description?): Statement {
+        return activityTestRule.apply(AndroidComposeStatement(base), description)
+    }
+
+    override fun runOnUiThread(action: () -> Unit) {
+        // Workaround for lambda bug in IR
+        activityTestRule.activity.runOnUiThread(object : Runnable {
+            override fun run() {
+                action.invoke()
+            }
+        })
+    }
+
+    /**
+     * Use this in your tests to setup the UI content to be tested. This should be called exactly
+     * once per test.
+     */
+    @SuppressWarnings("SyntheticAccessor")
+    override fun setContent(composable: @Composable() () -> Unit) {
+        val drawLatch = CountDownLatch(1)
+        val listener = object : ViewTreeObserver.OnGlobalLayoutListener {
+            override fun onGlobalLayout() {
+                drawLatch.countDown()
+                val contentViewGroup =
+                    activityTestRule.activity.findViewById<ViewGroup>(android.R.id.content)
+                contentViewGroup.viewTreeObserver.removeOnGlobalLayoutListener(this)
+            }
+        }
+        val runnable: Runnable = object : Runnable {
+            override fun run() {
+                activityTestRule.activity.setContent(composable)
+                val contentViewGroup =
+                    activityTestRule.activity.findViewById<ViewGroup>(android.R.id.content)
+                contentViewGroup.viewTreeObserver.addOnGlobalLayoutListener(listener)
+            }
+        }
+        activityTestRule.runOnUiThread(runnable)
+        drawLatch.await(1, TimeUnit.SECONDS)
+    }
+
+    override fun forGivenContent(composable: @Composable() () -> Unit): ComposeTestCaseSetup {
+        val testCase = object : ComposeTestCase {
+            @Composable
+            override fun emitContent() {
+                composable()
+            }
+        }
+        return AndroidComposeTestCaseSetup(
+            this,
+            testCase,
+            activityTestRule.activity
+        )
+    }
+
+    override fun forGivenTestCase(testCase: ComposeTestCase): ComposeTestCaseSetup {
+        return AndroidComposeTestCaseSetup(
+            this,
+            testCase,
+            activityTestRule.activity
+        )
+    }
+
+    inner class AndroidComposeStatement(
+        private val base: Statement
+    ) : Statement() {
+        override fun evaluate() {
+            base.evaluate()
+        }
+    }
+}

JetNews/app/src/androidTest/java/com/example/jetnews/util/TestHelper.kt

@@ -0,0 +1,68 @@
+/*
+ * Copyright 2019 Google, Inc.
+ *
+ * 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
+ *
+ *     http://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.example.jetnews.util
+
+import androidx.compose.Composable
+import androidx.ui.core.semantics.getOrNull
+import androidx.ui.material.MaterialTheme
+import androidx.ui.material.surface.Surface
+import androidx.ui.semantics.SemanticsProperties
+import androidx.ui.test.ComposeTestRule
+import androidx.ui.test.SemanticsNodeInteraction
+import androidx.ui.test.doClick
+import androidx.ui.test.findAll
+import com.example.jetnews.ui.JetnewsApp
+
+fun ComposeTestRule.launchJetNewsApp() {
+    setContent {
+        JetnewsApp()
+    }
+}
+
+fun ComposeTestRule.setMaterialContent(children: @Composable() () -> Unit) {
+    setContent {
+        MaterialTheme {
+            Surface(children = children)
+        }
+    }
+}
+
+/**
+ * Workarounds, this should be removed when UI testing improves
+ */
+
+fun workForComposeToBeIdle() {
+    // Temporary workaround - use waitForIdle in dev04
+    Thread.sleep(500)
+}
+
+fun goBack() {
+    // Temporary workaround - need to go back to Home
+    findEnabled().first().doClick()
+}
+
+fun findEnabled(): List<SemanticsNodeInteraction> {
+    return findAll {
+        getOrNull(SemanticsProperties.Enabled) == true
+    }
+}
+
+fun findAllByText(text: String, ignoreCase: Boolean = false): List<SemanticsNodeInteraction> {
+    return findAll {
+        getOrNull(SemanticsProperties.AccessibilityLabel).equals(text, ignoreCase)
+    }
+}