Closes #3977: Add basic navigational UI tests

- Adds UI tests (and assets) for basic navigation fix: review changes fix: linter cleanup fix: detekt cleanup fix: adjust wait approaches
mozilla-mobile · Jul 16, 2019 · 432fa67 · 432fa67
1 parent 5792acf
commit 432fa67
Show file tree

Hide file tree

Showing 9 changed files with 322 additions and 6 deletions.
diff --git a/app/src/androidTest/assets/pages/generic1.html b/app/src/androidTest/assets/pages/generic1.html
@@ -0,0 +1,7 @@
+<html>
+<body>
+<h1>
+    <p id="testContent">Page content: 1</p>
+</h1>
+</body>
+</html>
diff --git a/app/src/androidTest/assets/pages/generic2.html b/app/src/androidTest/assets/pages/generic2.html
@@ -0,0 +1,7 @@
+<html>
+<body>
+<h1>
+    <p id="testContent">Page content: 2</p>
+</h1>
+</body>
+</html>
diff --git a/app/src/androidTest/assets/pages/generic3.html b/app/src/androidTest/assets/pages/generic3.html
@@ -0,0 +1,7 @@
+<html>
+<body>
+<h1>
+    <p id="testContent">Page content: 3</p>
+</h1>
+</body>
+</html>
diff --git a/app/src/androidTest/assets/pages/jquery-3.4.1.slim.min.js b/app/src/androidTest/assets/pages/jquery-3.4.1.slim.min.js
diff --git a/app/src/androidTest/assets/pages/refresh.html b/app/src/androidTest/assets/pages/refresh.html
@@ -0,0 +1,45 @@
+
+<html>
+<script src="jquery-3.4.1.slim.min.js"></script>
+<script>
+
+    function setCookie(newVal){
+	window.document.cookie = "pageStatus = " + newVal + ";";
+    }
+
+
+    function readCookie(name) {
+	var nameEQ = name + "=";
+	var ca = document.cookie.split(';');
+	for(var i=0;i < ca.length;i++) {
+	    var c = ca[i];
+	    while (c.charAt(0)==' ') c = c.substring(1,c.length);
+	    if (c.indexOf(nameEQ) == 0) return c.substring(nameEQ.length,c.length);
+	}
+	return null;
+    }
+
+    function valSwap(){
+	    currentCookie = readCookie("pageStatus");
+	    if(currentCookie == null) {
+            setCookie("DEFAULT");
+	    }
+
+        if (currentCookie.localeCompare("REFRESHED") == 0) {
+                setCookie("DEFAULT");
+            return "My little test page - DEFAULT";
+        } else {
+                setCookie("REFRESHED");
+            return "My little test page - REFRESHED!";
+        }
+    }
+
+    var textToShow = valSwap();
+    window.addEventListener('DOMContentLoaded', (event) => {
+        document.querySelector('h1').innerHTML = textToShow;
+    });
+</script>
+<body>
+<h1>My little test page - DEFAULT</h1>
+</body>
+</html>
diff --git a/app/src/androidTest/java/org/mozilla/fenix/ui/NavigationToolbarTest.kt b/app/src/androidTest/java/org/mozilla/fenix/ui/NavigationToolbarTest.kt
@@ -0,0 +1,121 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+package org.mozilla.fenix.ui
+
+import androidx.test.platform.app.InstrumentationRegistry
+import androidx.test.uiautomator.UiDevice
+import okhttp3.mockwebserver.MockWebServer
+import org.junit.After
+import org.junit.Before
+import org.junit.Rule
+import org.junit.Test
+import org.mozilla.fenix.helpers.AndroidAssetDispatcher
+import org.mozilla.fenix.helpers.HomeActivityTestRule
+import org.mozilla.fenix.helpers.TestAssetHelper
+import org.mozilla.fenix.ui.robots.navigationToolbar
+
+/**
+ *  Tests for verifying basic functionality of browser navigation
+ *
+ *  Including:
+ *  - Visiting a URL
+ *  - Back and Forward navigation
+ *  - Refresh
+ */
+
+class NavigationToolbarTest {
+    private val mDevice = UiDevice.getInstance(InstrumentationRegistry.getInstrumentation())
+    private lateinit var mockWebServer: MockWebServer
+
+    /* ktlint-disable no-blank-line-before-rbrace */ // This imposes unreadable grouping.
+    @get:Rule
+    val activityTestRule = HomeActivityTestRule()
+
+    @Before
+    fun setUp() {
+        mockWebServer = MockWebServer().apply {
+            setDispatcher(AndroidAssetDispatcher())
+            start()
+        }
+    }
+
+    @After
+    fun tearDown() {
+        mockWebServer.shutdown()
+    }
+
+    @Test
+    fun goBackTest() {
+        val defaultWebPage = TestAssetHelper.getGenericAsset(mockWebServer, 1)
+        val nextWebPage = TestAssetHelper.getGenericAsset(mockWebServer, 2)
+
+        navigationToolbar {
+        }.enterURLAndEnterToBrowser(defaultWebPage.url) {
+            verifyPageContent(defaultWebPage.content)
+        }.openNavigationToolbar {
+        }.enterURLAndEnterToBrowser(nextWebPage.url) {
+            verifyPageContent(nextWebPage.content)
+        }
+
+        // Re-open the three-dot menu for verification
+        navigationToolbar {
+        }.openThreeDotMenu {
+            verifyThreeDotMenuExists()
+        }.goBack {
+            verifyPageContent(defaultWebPage.content)
+        }
+    }
+
+    @Test
+    fun goForwardTest() {
+        val defaultWebPage = TestAssetHelper.getGenericAsset(mockWebServer, 1)
+        val nextWebPage = TestAssetHelper.getGenericAsset(mockWebServer, 2)
+
+        navigationToolbar {
+        }.enterURLAndEnterToBrowser(defaultWebPage.url) {
+            verifyPageContent(defaultWebPage.content)
+        }.openNavigationToolbar {
+        }.enterURLAndEnterToBrowser(nextWebPage.url) {
+            verifyPageContent(nextWebPage.content)
+            mDevice.pressBack()
+            verifyPageContent(defaultWebPage.content)
+        }
+
+        // Re-open the three-dot menu for verification
+        navigationToolbar {
+        }.openThreeDotMenu {
+            verifyThreeDotMenuExists()
+        }.goForward {
+            verifyPageContent(nextWebPage.content)
+        }
+    }
+
+    @Test
+    fun refreshPageTest() {
+        val refreshWebPage = TestAssetHelper.getRefreshAsset(mockWebServer)
+
+        navigationToolbar {
+        }.enterURLAndEnterToBrowser(refreshWebPage.url) {
+            verifyPageContent("DEFAULT")
+        }
+
+        // Use refresh from the three-dot menu
+        navigationToolbar {
+        }.openThreeDotMenu {
+        }.refreshPage {
+            verifyPageContent("REFRESHED")
+        }
+    }
+
+    @Test
+    fun visitURLTest() {
+        val defaultWebPage = TestAssetHelper.getGenericAsset(mockWebServer, 1)
+
+        navigationToolbar {
+        }.enterURLAndEnterToBrowser(defaultWebPage.url) {
+            verifyPageContent(defaultWebPage.content)
+        }
+    }
+}
diff --git a/app/src/androidTest/java/org/mozilla/fenix/ui/robots/BrowserRobot.kt b/app/src/androidTest/java/org/mozilla/fenix/ui/robots/BrowserRobot.kt
@@ -11,9 +11,13 @@ import androidx.test.espresso.assertion.ViewAssertions.matches
 import androidx.test.espresso.matcher.ViewMatchers.withId
 import androidx.test.espresso.matcher.ViewMatchers.withText
 import androidx.test.platform.app.InstrumentationRegistry
+import androidx.test.uiautomator.By
 import androidx.test.uiautomator.UiDevice
+import androidx.test.uiautomator.Until
 import org.hamcrest.CoreMatchers.containsString
 import org.mozilla.fenix.R
+import org.mozilla.fenix.helpers.TestAssetHelper
+import org.mozilla.fenix.helpers.click
 
 class BrowserRobot {
 
@@ -26,12 +30,30 @@ class BrowserRobot {
             .check(matches(withText(containsString(redirectUrl))))
     }
 
-    class Transition {
+    /* Asserts that the text within DOM element with ID="testContent" has the given text, i.e.
+    *  document.querySelector('#testContent').innerText == expectedText
+    */
+    fun verifyPageContent(expectedText: String) {
         val mDevice = UiDevice.getInstance(InstrumentationRegistry.getInstrumentation())
+        mDevice.wait(Until.findObject(By.res(expectedText)), TestAssetHelper.waitingTime)
+    }
+
+    class Transition {
+        private val mDevice = UiDevice.getInstance(InstrumentationRegistry.getInstrumentation())
+
+        fun openNavigationToolbar(interact: NavigationToolbarRobot.() -> Unit): NavigationToolbarRobot.Transition {
+
+            navURLBar().click()
+
+            NavigationToolbarRobot().interact()
+            return NavigationToolbarRobot.Transition()
+        }
     }
 }
 
 fun browserScreen(interact: BrowserRobot.() -> Unit): BrowserRobot.Transition {
     BrowserRobot().interact()
     return BrowserRobot.Transition()
 }
+
+fun navURLBar() = onView(withId(R.id.mozac_browser_toolbar_url_view))
diff --git a/app/src/androidTest/java/org/mozilla/fenix/ui/robots/NavigationToolbarRobot.kt b/app/src/androidTest/java/org/mozilla/fenix/ui/robots/NavigationToolbarRobot.kt
@@ -0,0 +1,57 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+@file:Suppress("TooManyFunctions")
+
+package org.mozilla.fenix.ui.robots
+
+import android.net.Uri
+import androidx.test.espresso.Espresso.onView
+import androidx.test.espresso.action.ViewActions.click
+import androidx.test.espresso.action.ViewActions.pressImeActionButton
+import androidx.test.espresso.action.ViewActions.replaceText
+import androidx.test.espresso.matcher.ViewMatchers
+import androidx.test.platform.app.InstrumentationRegistry
+import androidx.test.uiautomator.By
+import androidx.test.uiautomator.UiDevice
+import androidx.test.uiautomator.Until
+import org.mozilla.fenix.R
+import org.mozilla.fenix.helpers.TestAssetHelper.waitingTime
+import org.mozilla.fenix.helpers.click
+
+/**
+ * Implementation of Robot Pattern for the URL toolbar.
+ */
+class NavigationToolbarRobot {
+    class Transition {
+
+        val mDevice = UiDevice.getInstance(InstrumentationRegistry.getInstrumentation())
+
+        fun enterURLAndEnterToBrowser(url: Uri, interact: BrowserRobot.() -> Unit): BrowserRobot.Transition {
+            mDevice.wait(Until.findObject(By.text("Search or enter address")), waitingTime)
+            urlBar().click()
+            awesomeBar().perform(replaceText(url.toString()), pressImeActionButton())
+
+            BrowserRobot().interact()
+            return BrowserRobot.Transition()
+        }
+
+        fun openThreeDotMenu(interact: ThreeDotMenuRobot.() -> Unit): ThreeDotMenuRobot.Transition {
+            mDevice.wait(Until.findObject(By.text("Menu")), waitingTime)
+            threeDotButton().click()
+
+            ThreeDotMenuRobot().interact()
+            return ThreeDotMenuRobot.Transition()
+        }
+    }
+}
+
+fun navigationToolbar(interact: NavigationToolbarRobot.() -> Unit): NavigationToolbarRobot.Transition {
+    NavigationToolbarRobot().interact()
+    return NavigationToolbarRobot.Transition()
+}
+
+private fun urlBar() = onView(ViewMatchers.withId(R.id.toolbar))
+private fun awesomeBar() = onView(ViewMatchers.withId(R.id.mozac_browser_toolbar_edit_url_view))
+private fun threeDotButton() = onView(ViewMatchers.withContentDescription("Menu"))