Fix #3528: Setup Infrastructure to test using local dev server

.github/CODEOWNERS

@@ -196,6 +196,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,11 +30,19 @@ package_group(
         "//app/...",
         "//data/...",
         "//domain/...",
+        "//instrumentation/...",
         "//testing/...",
         "//utility/...",
     ],
 )
 
+package_group(
+    name = "oppia_e2e_testing_visibility",
+    packages = [
+        "//instrumentation/...",
+    ],
+)
+
 # Special visibility group specific to debug mode. This provides access to the target for both the
 # Oppia tests and specific debug only packages.
 package_group(

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(),

app/BUILD.bazel

@@ -654,6 +654,7 @@ kt_android_library(
         ":resources",
         ":view_models",
         ":views",
+        "//data/src/main/java/org/oppia/android/data/backends/gae:network_config_prod_module",
         "//data/src/main/java/org/oppia/android/data/backends/gae:prod_module",
         "//model:arguments_java_proto_lite",
         "//third_party:androidx_databinding_databinding-adapters",

app/src/main/java/org/oppia/android/app/application/ApplicationComponent.kt

@@ -11,6 +11,7 @@ import org.oppia.android.app.player.state.hintsandsolution.HintsAndSolutionConfi
 import org.oppia.android.app.shim.IntentFactoryShimModule
 import org.oppia.android.app.shim.ViewBindingShimModule
 import org.oppia.android.app.topic.PracticeTabModule
+import org.oppia.android.data.backends.gae.NetworkConfigProdModule
 import org.oppia.android.data.backends.gae.NetworkModule
 import org.oppia.android.domain.classify.InteractionsModule
 import org.oppia.android.domain.classify.rules.continueinteraction.ContinueModule
@@ -79,7 +80,8 @@ import javax.inject.Singleton
     HintsAndSolutionConfigModule::class, FirebaseLogUploaderModule::class,
     NetworkModule::class, PracticeTabModule::class, PlatformParameterModule::class,
     ExplorationStorageModule::class, DeveloperOptionsStarterModule::class,
-    DeveloperOptionsModule::class, NetworkConnectionUtilDebugModule::class,
+    DeveloperOptionsModule::class, NetworkConfigProdModule::class,
+    NetworkConnectionUtilDebugModule::class,
     // TODO(#59): Remove this module once we completely migrate to Bazel from Gradle as we can then
     //  directly exclude debug files from the build and thus won't be requiring this module.
     NetworkConnectionDebugUtilModule::class

app/src/sharedTest/java/org/oppia/android/app/help/HelpActivityTest.kt

@@ -26,6 +26,7 @@ import org.oppia.android.app.devoptions.DeveloperOptionsStarterModule
 import org.oppia.android.app.player.state.hintsandsolution.HintsAndSolutionConfigModule
 import org.oppia.android.app.shim.ViewBindingShimModule
 import org.oppia.android.app.topic.PracticeTabModule
+import org.oppia.android.data.backends.gae.NetworkConfigProdModule
 import org.oppia.android.data.backends.gae.NetworkModule
 import org.oppia.android.domain.classify.InteractionsModule
 import org.oppia.android.domain.classify.rules.continueinteraction.ContinueModule
@@ -129,7 +130,8 @@ class HelpActivityTest {
       WorkManagerConfigurationModule::class, HintsAndSolutionConfigModule::class,
       FirebaseLogUploaderModule::class, FakeOppiaClockModule::class, PracticeTabModule::class,
       DeveloperOptionsStarterModule::class, DeveloperOptionsModule::class,
-      ExplorationStorageModule::class, NetworkConnectionUtilDebugModule::class
+      ExplorationStorageModule::class, NetworkConfigProdModule::class,
+      NetworkConnectionUtilDebugModule::class
     ]
   )
   interface TestApplicationComponent : ApplicationComponent {

data/BUILD.bazel

@@ -9,6 +9,7 @@ load("//data:data_test.bzl", "data_test")
 # keep sorted
 TEST_DEPS = [
     ":dagger",
+    "//data/src/main/java/org/oppia/android/data/backends/gae:network_config_prod_module",
     "//data/src/main/java/org/oppia/android/data/backends/gae:oppia_retrofit",
     "//data/src/main/java/org/oppia/android/data/backends/gae:prod_module",
     "//data/src/main/java/org/oppia/android/data/backends/gae/model",

data/src/main/java/org/oppia/android/data/backends/gae/BUILD.bazel

@@ -16,7 +16,7 @@ kt_android_library(
     visibility = ["//:oppia_testing_visibility"],
     deps = [
         ":constants",
-        ":network_settings",
+        ":network_config_annotations",
         "//model:arguments_java_proto_lite",
         "//third_party:com_squareup_okhttp3_okhttp",
         "//third_party:javax_inject_javax_inject",
@@ -25,11 +25,15 @@ kt_android_library(
 )
 
 kt_android_library(
-    name = "network_settings",
+    name = "network_config_prod_module",
     srcs = [
-        "NetworkSettings.kt",
+        "NetworkConfigProdModule.kt",
+    ],
+    visibility = ["//:oppia_prod_module_visibility"],
+    deps = [
+        ":dagger",
+        ":network_config_annotations",
     ],
-    visibility = ["//:oppia_testing_visibility"],
 )
 
 kt_android_library(
@@ -39,14 +43,26 @@ kt_android_library(
     ],
 )
 
+kt_android_library(
+    name = "network_config_annotations",
+    srcs = [
+        "BaseUrl.kt",
+        "XssiPrefix.kt",
+    ],
+    visibility = ["//:oppia_api_visibility"],
+    deps = [
+        "//third_party:javax_inject_javax_inject",
+    ],
+)
+
 kt_android_library(
     name = "oppia_retrofit",
     srcs = [
         "OppiaRetrofit.kt",
     ],
-    visibility = ["//:oppia_testing_visibility"],
+    visibility = ["//:oppia_api_visibility"],
     deps = [
-        ":dagger",
+        "//third_party:javax_inject_javax_inject",
     ],
 )
 
@@ -58,8 +74,8 @@ kt_android_library(
     visibility = ["//:oppia_prod_module_visibility"],
     deps = [
         ":dagger",
+        ":network_config_annotations",
         ":network_interceptors",
-        ":network_settings",
         ":oppia_retrofit",
         "//data/src/main/java/org/oppia/android/data/backends/gae/api",
         "//third_party:com_squareup_retrofit2_converter-moshi",

data/src/main/java/org/oppia/android/data/backends/gae/BaseUrl.kt

@@ -0,0 +1,7 @@
+package org.oppia.android.data.backends.gae
+
+import javax.inject.Qualifier
+
+/** Qualifier for an application-injectable string representing the server URL used for networking. */
+@Qualifier
+annotation class BaseUrl

data/src/main/java/org/oppia/android/data/backends/gae/JsonPrefixNetworkInterceptor.kt

@@ -13,7 +13,9 @@ import javax.inject.Singleton
  * The Interceptor removes XSSI_PREFIX from every response to produce valid Json.
  */
 @Singleton
-class JsonPrefixNetworkInterceptor @Inject constructor() : Interceptor {
+class JsonPrefixNetworkInterceptor @Inject constructor(
+  @XssiPrefix private val xssiPrefix: String
+) : Interceptor {
 
   @Throws(IOException::class)
   override fun intercept(chain: Interceptor.Chain): Response {
@@ -34,6 +36,6 @@ class JsonPrefixNetworkInterceptor @Inject constructor() : Interceptor {
 
   /** Removes the XSSI prefix from the specified raw JSON & returns the result. */
   fun removeXssiPrefix(rawJson: String): String {
-    return rawJson.removePrefix(NetworkSettings.XSSI_PREFIX).trimStart()
+    return rawJson.removePrefix(xssiPrefix).trimStart()
   }
 }

data/src/main/java/org/oppia/android/data/backends/gae/NetworkConfigProdModule.kt

@@ -0,0 +1,27 @@
+package org.oppia.android.data.backends.gae
+
+import dagger.Module
+import dagger.Provides
+
+/** Provides network-specific constants. */
+@Module
+class NetworkConfigProdModule {
+
+  /** Provides BaseUrl that connects to production server. */
+  @Provides
+  @BaseUrl
+  fun provideNetworkBaseUrl(): String {
+    return "https://oppia.org"
+  }
+
+  /**
+   * Prefix in Json response for extra layer of security in API calls
+   * https://github.com/oppia/oppia/blob/8f9eed/feconf.py#L319
+   * Remove this prefix from every Json response which is achieved in [NetworkInterceptor]
+   */
+  @Provides
+  @XssiPrefix
+  fun provideXssiPrefix(): String {
+    return ")]}'"
+  }
+}

data/src/main/java/org/oppia/android/data/backends/gae/NetworkModule.kt

@@ -28,15 +28,16 @@ class NetworkModule {
   @Singleton
   fun provideRetrofitInstance(
     jsonPrefixNetworkInterceptor: JsonPrefixNetworkInterceptor,
-    remoteAuthNetworkInterceptor: RemoteAuthNetworkInterceptor
+    remoteAuthNetworkInterceptor: RemoteAuthNetworkInterceptor,
+    @BaseUrl baseUrl: String
   ): Retrofit {
     val client = OkHttpClient.Builder()
       .addInterceptor(jsonPrefixNetworkInterceptor)
       .addInterceptor(remoteAuthNetworkInterceptor)
       .build()
 
     return Retrofit.Builder()
-      .baseUrl(NetworkSettings.getBaseUrl())
+      .baseUrl(baseUrl)
       .addConverterFactory(MoshiConverterFactory.create())
       .client(client)
       .build()

data/src/main/java/org/oppia/android/data/backends/gae/XssiPrefix.kt

@@ -0,0 +1,10 @@
+package org.oppia.android.data.backends.gae
+
+import javax.inject.Qualifier
+
+/**
+ * Qualifier for an application-injectable string representing the prefix in Json response used for
+ * security in API calls.
+ */
+@Qualifier
+annotation class XssiPrefix

data/src/test/java/org/oppia/android/data/backends/gae/JsonPrefixNetworkInterceptorTest.kt

@@ -19,7 +19,7 @@ import retrofit2.Retrofit
 import javax.inject.Inject
 import javax.inject.Singleton
 
-/** Tests for [JsonPrefixNetworkInterceptorTest] */
+/** Tests for [JsonPrefixNetworkInterceptor]. */
 @RunWith(AndroidJUnit4::class)
 @LooperMode(LooperMode.Mode.PAUSED)
 class JsonPrefixNetworkInterceptorTest {
@@ -95,7 +95,7 @@ class JsonPrefixNetworkInterceptorTest {
 
   // TODO(#89): Move this to a common test application component.
   @Singleton
-  @Component(modules = [NetworkModule::class])
+  @Component(modules = [TestNetworkModule::class, NetworkConfigProdModule::class])
   interface TestApplicationComponent {
     @Component.Builder
     interface Builder {

data/src/test/java/org/oppia/android/data/backends/gae/NetworkConfigProdModuleTest.kt

@@ -0,0 +1,90 @@
+package org.oppia.android.data.backends.gae
+
+import android.app.Application
+import android.content.Context
+import androidx.test.core.app.ApplicationProvider
+import androidx.test.ext.junit.runners.AndroidJUnit4
+import com.google.common.truth.Truth.assertThat
+import dagger.BindsInstance
+import dagger.Component
+import dagger.Module
+import dagger.Provides
+import org.junit.Before
+import org.junit.Test
+import org.junit.runner.RunWith
+import org.robolectric.annotation.Config
+import org.robolectric.annotation.LooperMode
+import javax.inject.Inject
+import javax.inject.Singleton
+
+/** Tests for [NetworkConfigProdModule]. */
+@RunWith(AndroidJUnit4::class)
+@LooperMode(LooperMode.Mode.PAUSED)
+@Config(application = NetworkConfigProdModuleTest.TestApplication::class)
+class NetworkConfigProdModuleTest {
+
+  @field:[Inject BaseUrl]
+  lateinit var baseUrl: String
+
+  @field:[Inject XssiPrefix]
+  lateinit var xssiPrefix: String
+
+  @Before
+  fun setUp() {
+    setUpTestApplicationComponent()
+  }
+
+  @Test
+  fun testModule_baseUrl_isProdUrl() {
+    assertThat(baseUrl).isEqualTo("https://oppia.org")
+  }
+
+  @Test
+  fun testModule_xssiPrefix_isXssiPrefix() {
+    assertThat(xssiPrefix).isEqualTo(")]}'")
+  }
+
+  private fun setUpTestApplicationComponent() {
+    ApplicationProvider.getApplicationContext<TestApplication>()
+      .inject(this)
+  }
+
+  @Module
+  class TestModule {
+    @Provides
+    @Singleton
+    fun provideContext(application: Application): Context {
+      return application
+    }
+  }
+
+  @Singleton
+  @Component(
+    modules = [
+      TestModule::class, NetworkConfigProdModule::class
+    ]
+  )
+
+  interface TestApplicationComponent {
+    @Component.Builder
+    interface Builder {
+      @BindsInstance
+      fun setApplication(application: Application): Builder
+      fun build(): TestApplicationComponent
+    }
+
+    fun inject(networkConfigModuleTest: NetworkConfigProdModuleTest)
+  }
+
+  class TestApplication : Application() {
+    private val component: TestApplicationComponent by lazy {
+      DaggerNetworkConfigProdModuleTest_TestApplicationComponent.builder()
+        .setApplication(this)
+        .build()
+    }
+
+    fun inject(networkConfigModuleTest: NetworkConfigProdModuleTest) {
+      component.inject(networkConfigModuleTest)
+    }
+  }
+}