Fix #3607: ExplorationPlayer End to End tests

.github/CODEOWNERS

@@ -195,6 +195,14 @@ NOTICE @BenHenning
 # Global model ownership.
 /model/ @vinitamurthi @BenHenning
 
+
+#####################################################################################
+#                                  instrumentation                                  #
+#####################################################################################
+
+# End-to-end test utilities and modules.
+/instrumentation/src/java/**/*.kt @anandwana001 @BenHenning
+
 #####################################################################################
 #                                global overrides                                   #
 #####################################################################################

BUILD.bazel

@@ -30,6 +30,7 @@ package_group(
         "//app/...",
         "//data/...",
         "//domain/...",
+        "//instrumentation/...",
         "//testing/...",
         "//utility/...",
     ],

WORKSPACE

@@ -141,6 +141,21 @@ http_archive(
 
 load("@rules_jvm_external//:defs.bzl", "maven_install")
 
+ATS_TAG = "1edfdab3134a7f01b37afabd3eebfd2c5bb05151"
+
+ATS_SHA256 = "dcd1ff76aef1a26329d77863972780c8fe1fc8ff625747342239f0489c2837ec"
+
+http_archive(
+    name = "android_test_support",
+    sha256 = ATS_SHA256,
+    strip_prefix = "android-test-%s" % ATS_TAG,
+    urls = ["https://github.com/android/android-test/archive/%s.tar.gz" % ATS_TAG],
+)
+
+load("@android_test_support//:repo.bzl", "android_test_repositories")
+
+android_test_repositories()
+
 # Note to developers: new dependencies should be added to //third_party:versions.bzl, not here.
 maven_install(
     artifacts = DAGGER_ARTIFACTS + get_maven_dependencies(),

instrumentation/BUILD.bazel

@@ -0,0 +1,30 @@
+"""
+This library contains all android_binary and android_instrumentation_test targets to each
+test suite in instrumentation module as a oppia_instrumentation_test wrapper.
+Note that:
+ - All the oppia_instrumentation_test targets are named similar to the respective class name
+ of the test suite.
+"""
+
+exports_files(["src/javatests/AndroidManifest.xml"])
+
+# Used for end-to-end tests
+android_binary(
+    name = "oppia_test",
+    testonly = True,
+    custom_package = "org.oppia.android",
+    enable_data_binding = True,
+    manifest = "//app:src/main/AndroidManifest.xml",
+    manifest_values = {
+        "applicationId": "org.oppia.android",
+        "minSdkVersion": "19",
+        "targetSdkVersion": "29",
+        "versionCode": "0",
+        "versionName": "0.1-test",
+    },
+    multidex = "native",
+    visibility = ["//:oppia_testing_visibility"],
+    deps = [
+        "//app",
+    ],
+)

instrumentation/oppia_instrumentation_test.bzl

@@ -0,0 +1,40 @@
+"""
+Instrumentation macros to define up end-to-end tests.
+"""
+
+load("@io_bazel_rules_kotlin//kotlin:kotlin.bzl", "kt_android_library")
+
+def oppia_instrumentation_test(
+        name,
+        srcs,
+        deps):
+    """
+    Creates library, binary, and instrumentation test for each test suite.
+
+    Args:
+        name: str. The class name of the test suite.
+        srcs: list of str. List of test files corresponding to this test suite.
+        deps: list of str. The list of dependencies needed to build and run the test.
+    """
+    kt_android_library(
+        name = "%s_lib" % name,
+        testonly = True,
+        srcs = srcs,
+        deps = deps,
+    )
+
+    native.android_binary(
+        name = "%sBinary" % name,
+        testonly = True,
+        custom_package = "org.oppia.android",
+        instruments = "//instrumentation:oppia_test",
+        manifest = "//instrumentation:src/javatests/AndroidManifest.xml",
+        deps = [":%s_lib" % name],
+    )
+
+    # TODO(#3617): Target isn't supported yet.
+    native.android_instrumentation_test(
+        name = name,
+        target_device = "@android_test_support//tools/android/emulated_devices/generic_phone:android_23_x86_qemu2",
+        test_app = ":%sBinary" % name,
+    )

instrumentation/src/java/org/oppia/android/instrumentation/testing/BUILD.bazel

@@ -0,0 +1,19 @@
+"""
+This library contains the utilities used in end-to-end testing.
+"""
+
+load("@io_bazel_rules_kotlin//kotlin:kotlin.bzl", "kt_android_library")
+
+kt_android_library(
+    name = "e2e_test_helper",
+    testonly = True,
+    srcs = [
+        "EndToEndTestHelper.kt",
+    ],
+    visibility = ["//:oppia_testing_visibility"],
+    deps = [
+        "//third_party:androidx_test_ext_junit",
+        "//third_party:androidx_test_uiautomator_uiautomator",
+        "//third_party:com_google_truth_truth",
+    ],
+)

instrumentation/src/java/org/oppia/android/instrumentation/testing/EndToEndTestHelper.kt

@@ -0,0 +1,85 @@
+package org.oppia.android.instrumentation.testing
+
+import android.content.Context
+import android.content.Intent
+import androidx.test.core.app.ApplicationProvider
+import androidx.test.uiautomator.By
+import androidx.test.uiautomator.UiDevice
+import androidx.test.uiautomator.UiObject2
+import androidx.test.uiautomator.UiScrollable
+import androidx.test.uiautomator.UiSelector
+import androidx.test.uiautomator.Until
+import com.google.common.truth.Truth.assertThat
+
+/** This object contains common operations used for end-to-end tests. */
+object EndToEndTestHelper {
+
+  private val OPPIA_PACKAGE = "org.oppia.android"
+  private val LAUNCH_TIMEOUT_SECONDS = 30000L
+  private val TRANSITION_TIMEOUT_SECONDS = 5000L
+
+  /** Starts Oppia from the home screen. */
+  fun UiDevice.startOppiaFromScratch() {
+    // Start from the home screen
+    pressHome()
+
+    // Wait for launcher
+    val launcherPackage = launcherPackageName
+    assertThat(launcherPackage).isNotNull()
+    wait(Until.hasObject(By.pkg(launcherPackage).depth(1)), LAUNCH_TIMEOUT_SECONDS)
+
+    // Launch the blueprint app
+    val context = ApplicationProvider.getApplicationContext<Context>()
+    val intent = context.packageManager
+      .getLaunchIntentForPackage(OPPIA_PACKAGE)
+    intent!!.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TASK) // Clear out any previous instances
+    context.startActivity(intent)
+
+    // Wait for the app to appear
+    wait(Until.hasObject(By.pkg(OPPIA_PACKAGE)), LAUNCH_TIMEOUT_SECONDS)
+  }
+
+  /** Waits for the view with given resourceId to appear. */
+  fun UiDevice.waitForRes(resourceId: String, timeout: Long = TRANSITION_TIMEOUT_SECONDS) {
+    wait(Until.hasObject(By.res(resourceId)), timeout)
+  }
+
+  /** Waits for the view with given text to appear. */
+  fun UiDevice.waitForText(text: String) {
+    wait(Until.hasObject(By.text(text)), TRANSITION_TIMEOUT_SECONDS)
+  }
+
+  /** Waits for the view with given content description to appear. */
+  fun UiDevice.waitForDesc(text: String) {
+    wait(Until.hasObject(By.desc(text)), TRANSITION_TIMEOUT_SECONDS)
+  }
+
+  /** Return the UiObject with the given text. */
+  fun UiDevice.findObjectByText(text: String): UiObject2? {
+    waitForText(text)
+    return findObject(By.text(text))
+  }
+
+  /** Returns the UiObject for the given resourceId. */
+  fun UiDevice.findObjectByRes(resourceId: String): UiObject2? {
+    waitForRes(resourceId)
+    return findObject(By.res("$OPPIA_PACKAGE:id/$resourceId"))
+  }
+
+  /** Returns the UiObject for the given content description. */
+  fun UiDevice.findObjectByDesc(text: String): UiObject2? {
+    waitForDesc(text)
+    return findObject(By.desc(text))
+  }
+
+  /** Performs a scroll until the view with the give text is visible. */
+  fun scrollRecyclerViewTextIntoView(text: String, isVertical: Boolean = true) {
+    val recyclerView = UiScrollable(UiSelector().scrollable(true))
+    if (isVertical) {
+      recyclerView.setAsVerticalList()
+    } else {
+      recyclerView.setAsHorizontalList()
+    }
+    recyclerView.scrollTextIntoView(text)
+  }
+}

instrumentation/src/javatests/AndroidManifest.xml

@@ -0,0 +1,11 @@
+<?xmxl version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+  package="org.oppia.android.app.instrumentation">
+  <uses-sdk
+    android:minSdkVersion="19"
+    android:targetSdkVersion="29" />
+  <instrumentation
+    android:targetPackage="org.oppia.android"
+    android:name="androidx.test.runner.AndroidJUnitRunner" />
+  <application android:label="OppiaTest" />
+</manifest>

instrumentation/src/javatests/org/oppia/android/instrumentation/player/BUILD.bazel

@@ -0,0 +1,20 @@
+"""
+This library contains the test suite source files of the player package.
+"""
+
+load("//instrumentation:oppia_instrumentation_test.bzl", "oppia_instrumentation_test")
+
+oppia_instrumentation_test(
+    name = "ExplorationPlayerTest",
+    srcs = [
+        "ExplorationPlayerTest.kt",
+    ],
+    deps = [
+        "//instrumentation/src/java/org/oppia/android/instrumentation/testing:e2e_test_helper",
+        "//third_party:androidx_test_ext_junit",
+        "//third_party:androidx_test_runner",
+        "//third_party:androidx_test_uiautomator_uiautomator",
+        "//third_party:com_google_truth_truth",
+        "//third_party:junit_junit",
+    ],
+)