Add better testing support for TransportRuntime. (#3670)

* Add better testing support for TransportRuntime.

* Add licenses

* Fix lint errors.

* Update transport/transport-runtime-testing/src/main/AndroidManifest.xml

Co-authored-by: Rodrigo Lazo <[email protected]>

* Update transport/transport-runtime-testing/transport-runtime-testing.gradle

Co-authored-by: Rodrigo Lazo <[email protected]>

Co-authored-by: Rodrigo Lazo <[email protected]>

Author: vkryachko

subprojects.cfg

@@ -75,3 +75,4 @@ transport
 transport:transport-api
 transport:transport-backend-cct
 transport:transport-runtime
+transport:transport-runtime-testing

transport/transport-runtime-testing/src/main/AndroidManifest.xml

@@ -0,0 +1,19 @@
+<!-- Copyright 2022 Google LLC -->
+<!-- -->
+<!-- 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. -->
+
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    package="com.google.android.datatransport.runtime.testing">
+    <!--Although the *SdkVersion is captured in gradle build files, this is required for non gradle builds-->
+    <!--<uses-sdk android:minSdkVersion="14"/>-->
+</manifest>

transport/transport-runtime-testing/src/main/java/com/google/android/datatransport/runtime/TransportRuntimeTesting.java

@@ -0,0 +1,34 @@
+// Copyright 2022 Google LLC
+//
+// 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.google.android.datatransport.runtime;
+
+import com.google.android.datatransport.Priority;
+import com.google.android.datatransport.runtime.backends.BackendResponse;
+import com.google.android.datatransport.runtime.scheduling.jobscheduling.UploadTestSupport;
+
+/** Test support for {@link TransportRuntime}. */
+public final class TransportRuntimeTesting {
+  private TransportRuntimeTesting() {}
+
+  /** Synchronously force upload all scheduled events for a given destination and priority. */
+  public static BackendResponse forceUpload(Destination destination, Priority priority) {
+    return UploadTestSupport.forceUpload(
+        TransportContext.builder()
+            .setBackendName(destination.getName())
+            .setExtras(destination.getExtras())
+            .setPriority(priority)
+            .build());
+  }
+}

transport/transport-runtime-testing/src/main/java/com/google/android/datatransport/runtime/scheduling/jobscheduling/UploadTestSupport.java

@@ -0,0 +1,31 @@
+// Copyright 2022 Google LLC
+//
+// 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.google.android.datatransport.runtime.scheduling.jobscheduling;
+
+import com.google.android.datatransport.runtime.TransportContext;
+import com.google.android.datatransport.runtime.TransportRuntime;
+import com.google.android.datatransport.runtime.backends.BackendResponse;
+
+/**
+ * Support class that avoids making {@link Uploader#logAndUpdateState(TransportContext, int) }
+ * method public in the SDK code.
+ */
+public class UploadTestSupport {
+  private UploadTestSupport() {}
+
+  public static BackendResponse forceUpload(TransportContext context) {
+    return TransportRuntime.getInstance().getUploader().logAndUpdateState(context, 1);
+  }
+}

transport/transport-runtime-testing/transport-runtime-testing.gradle

@@ -0,0 +1,47 @@
+// Copyright 2022 Google LLC
+//
+// 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.
+
+plugins {
+    // not a firebase-library, since we don't intend to release this artifact.
+    id 'com.android.library'
+}
+
+android {
+    compileSdkVersion project.targetSdkVersion
+    defaultConfig {
+        minSdkVersion project.minSdkVersion
+        targetSdkVersion project.targetSdkVersion
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+    }
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_1_8
+        targetCompatibility JavaVersion.VERSION_1_8
+    }
+    testOptions.unitTests {
+        includeAndroidResources = true
+    }
+}
+
+dependencies {
+    implementation project(':transport:transport-api')
+    implementation project(':transport:transport-runtime')
+    implementation 'androidx.annotation:annotation:1.3.0'
+
+    implementation project(':transport:transport-backend-cct')
+    androidTestImplementation 'junit:junit:4.13.2'
+    androidTestImplementation "com.google.truth:truth:$googleTruthVersion"
+    androidTestImplementation 'androidx.test:runner:1.4.0'
+    androidTestImplementation 'androidx.test.ext:junit:1.1.3'
+    androidTestImplementation 'androidx.test:rules:1.4.0'
+}

transport/transport-runtime/src/main/java/com/google/android/datatransport/runtime/TransportContext.java

@@ -72,7 +72,7 @@ public static Builder builder() {
    *
    * @hide
    */
-  @RestrictTo(RestrictTo.Scope.LIBRARY)
+  @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
   public TransportContext withPriority(Priority priority) {
     return builder()
         .setBackendName(getBackendName())
@@ -89,7 +89,7 @@ public abstract static class Builder {
     public abstract Builder setExtras(@Nullable byte[] extras);
 
     /** @hide */
-    @RestrictTo(RestrictTo.Scope.LIBRARY)
+    @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
     public abstract Builder setPriority(Priority priority);
 
     public abstract TransportContext build();

transport/transport-runtime/src/main/java/com/google/android/datatransport/runtime/TransportRuntime.java

@@ -141,7 +141,7 @@ private static Set<Encoding> getSupportedEncodings(Destination destination) {
     return Collections.singleton(Encoding.of("proto"));
   }
 
-  @RestrictTo(RestrictTo.Scope.LIBRARY)
+  @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
   public Uploader getUploader() {
     return uploader;
   }

transport/transport-runtime/src/main/java/com/google/android/datatransport/runtime/scheduling/jobscheduling/Uploader.java

@@ -111,20 +111,20 @@ public void upload(TransportContext transportContext, int attemptNumber, Runnabl
         });
   }
 
-  void logAndUpdateState(TransportContext transportContext, int attemptNumber) {
+  BackendResponse logAndUpdateState(TransportContext transportContext, int attemptNumber) {
     TransportBackend backend = backendRegistry.get(transportContext.getBackendName());
     long maxNextRequestWaitMillis = 0;
 
+    BackendResponse response = BackendResponse.ok(maxNextRequestWaitMillis);
     while (guard.runCriticalSection(() -> eventStore.hasPendingEventsFor(transportContext))) {
       Iterable<PersistedEvent> persistedEvents =
           guard.runCriticalSection(() -> eventStore.loadBatch(transportContext));
 
       // Do not make a call to the backend if the list is empty.
       if (!persistedEvents.iterator().hasNext()) {
-        return;
+        return response;
       }
 
-      BackendResponse response;
       if (backend == null) {
         Logging.d(
             LOG_TAG, "Unknown backend for %s, deleting event batch for it...", transportContext);
@@ -157,7 +157,7 @@ void logAndUpdateState(TransportContext transportContext, int attemptNumber) {
               return null;
             });
         workScheduler.schedule(transportContext, attemptNumber + 1, true);
-        return;
+        return response;
       } else {
         guard.runCriticalSection(
             () -> {
@@ -202,6 +202,7 @@ void logAndUpdateState(TransportContext transportContext, int attemptNumber) {
               transportContext, clock.getTime() + finalMaxNextRequestWaitMillis);
           return null;
         });
+    return response;
   }
 
   @VisibleForTesting