Subscriber Connectivity Tests

.github/workflows/emulate.yml

@@ -90,3 +90,10 @@ jobs:
         with:
           name: api-level-${{ matrix.api-level }}-publishing-sdk-build-reports
           path: publishing-sdk/build/reports
+
+      - uses: actions/upload-artifact@v3
+        name: Build Reports for subscribing-sdk
+        if: always()
+        with:
+          name: api-level-${{ matrix.api-level }}-subscribing-sdk-build-reports
+          path: subscribing-sdk/build/reports

android-test-common/src/main/java/com/ably/tracking/test/android/common/AblyProxy.kt

@@ -44,6 +44,7 @@ private const val REALTIME_HOST = "realtime.ably.io"
 private const val REALTIME_PORT = 443
 
 const val PUBLISHER_CLIENT_ID = "AatNetworkConnectivityTests_Publisher"
+const val SUBSCRIBER_CLIENT_ID = "AatNetworkConnectivityTests_Subscriber"
 
 /**
  * A local proxy that can be used to intercept Realtime traffic for testing
@@ -310,6 +311,7 @@ class Layer7Proxy(
     override fun stop() {
         testLogD("$tag: stopping...")
         server?.stop()
+        testLogD("$tag: done stopping...")
     }
 
     /**

android-test-common/src/main/java/com/ably/tracking/test/android/common/Faults.kt

@@ -49,7 +49,10 @@ abstract class FaultSimulation {
      * The advantage of this approach is that the test code remains active and continually compiled as
      * a first class citizen of the codebase, while we work on other things to get it passing.
      */
-    open val skipTest: Boolean = false
+    open val skipPublisherTest: Boolean = false
+
+    // Causes the same behaviour as skipPublisherTest for the subscriber NetworkConnectivityTests
+    open val skipSubscriberTest: Boolean = false
 
     /**
      * A RealtimeProxy instance that will be manipulated by this fault
@@ -162,6 +165,9 @@ class TcpConnectionRefused(apiKey: String) : TransportLayerFault(apiKey) {
         onlineWithinMillis = 60_000
     )
 
+    // May be able to be removed once the issues surrounding skipTest are resolved
+    override val skipSubscriberTest = true
+
     override fun enable() {
         tcpProxy.stop()
     }
@@ -177,6 +183,8 @@ class TcpConnectionRefused(apiKey: String) : TransportLayerFault(apiKey) {
  */
 class TcpConnectionUnresponsive(apiKey: String) : TransportLayerFault(apiKey) {
 
+    override val skipSubscriberTest = true
+
     companion object {
         val fault = object : Fault() {
             override fun simulate(apiKey: String) = TcpConnectionUnresponsive(apiKey)
@@ -212,6 +220,9 @@ class DisconnectAndSuspend(apiKey: String) : TransportLayerFault(apiKey) {
         }
     }
 
+    // May be able to be removed once the issues surrounding skipTest are resolved
+    override val skipSubscriberTest = true
+
     private val timer = Timer()
 
     override val type = FaultType.Nonfatal(
@@ -445,6 +456,8 @@ class EnterUnresponsive(apiKey: String) : UnresponsiveAfterAction(
     direction = FrameDirection.ClientToServer,
     action = Message.Action.PRESENCE
 ) {
+    override val skipSubscriberTest = true
+
     companion object {
         val fault = object : Fault() {
             override fun simulate(apiKey: String) = EnterUnresponsive(apiKey)
@@ -462,7 +475,6 @@ class EnterUnresponsive(apiKey: String) : UnresponsiveAfterAction(
  * Publisher should continue regardless.
  */
 class DisconnectWithFailedResume(apiKey: String) : ApplicationLayerFault(apiKey) {
-
     companion object {
         val fault = object : Fault() {
             override fun simulate(apiKey: String) = DisconnectWithFailedResume(apiKey)
@@ -620,6 +632,9 @@ class EnterFailedWithNonfatalNack(apiKey: String) : PresenceNackFault(
         }
     }
 
+    // Can probably be removed once skipTest issues are resolved
+    override val skipSubscriberTest = true
+
     override val type = FaultType.Nonfatal(
         resolvedWithinMillis = 60_000L
     )
@@ -642,6 +657,8 @@ class UpdateFailedWithNonfatalNack(apiKey: String) : PresenceNackFault(
         }
     }
 
+    override val skipSubscriberTest = true
+
     override val type = FaultType.Nonfatal(
         resolvedWithinMillis = 60_000L
     )
@@ -655,6 +672,8 @@ class UpdateFailedWithNonfatalNack(apiKey: String) : PresenceNackFault(
  */
 class ReenterOnResumeFailed(apiKey: String) : ApplicationLayerFault(apiKey) {
 
+    override val skipSubscriberTest = true
+
     companion object {
         val fault = object : Fault() {
             override fun simulate(apiKey: String) = ReenterOnResumeFailed(apiKey)

common/src/main/java/com/ably/tracking/common/Ably.kt

@@ -127,6 +127,16 @@ interface Ably {
         callback: (Result<Unit>) -> Unit
     )
 
+    /**
+     * Sends an enhanced location update to the channel in a suspending fashion.
+     * Should be called only when there's an existing channel for the [trackableId].
+     * If a channel for the [trackableId] doesn't exist then it just returns.
+     *
+     * @param trackableId The ID of the trackable channel.
+     * @param locationUpdate The location update that is sent to the channel.
+     */
+    suspend fun sendEnhancedLocationSuspending(trackableId: String, locationUpdate: EnhancedLocationUpdate)
+
     /**
      * Sends a raw location update to the channel.
      * Should be called only when there's an existing channel for the [trackableId].
@@ -557,6 +567,22 @@ constructor(
         }
     }
 
+    override suspend fun sendEnhancedLocationSuspending(trackableId: String, locationUpdate: EnhancedLocationUpdate) {
+        logHandler?.d("$TAG sendEnhancedLocationMessageSuspending: publishing")
+        suspendCancellableCoroutine { continuation ->
+            sendEnhancedLocation(
+                trackableId,
+                locationUpdate,
+            ) { result ->
+                try {
+                    continuation.resume(result.getOrThrow())
+                } catch (exception: Exception) {
+                    continuation.resumeWithException(exception)
+                }
+            }
+        }
+    }
+
     override fun sendEnhancedLocation(
         trackableId: String,
         locationUpdate: EnhancedLocationUpdate,

publishing-sdk/src/androidTest/java/com/ably/tracking/publisher/NetworkConnectivityTests.kt

@@ -111,7 +111,7 @@ class NetworkConnectivityTests(private val testFault: Fault) {
     @Before
     fun setUp() {
         val simulation = testFault.simulate(BuildConfig.ABLY_API_KEY)
-        Assume.assumeFalse(simulation.skipTest)
+        Assume.assumeFalse(simulation.skipPublisherTest)
 
         // We cannot use ktor on API Level 21 (Lollipop) because of:
         // https://youtrack.jetbrains.com/issue/KTOR-4751/HttpCache-plugin-uses-ConcurrentMap.computeIfAbsent-method-that-is-available-only-since-Android-API-24

subscribing-sdk/build.gradle

@@ -17,6 +17,7 @@ android {
 dependencies {
     api project(':core-sdk')
     implementation project(':common')
+    androidTestImplementation "io.ably:ably-android:$ably_core_version"
 }
 
 ext {