Adding the Firebase Storage Unit Test App (#303)

Author: schmidt-sebastian

firebase-storage/README.md

@@ -11,3 +11,40 @@ Storage, to access the same files.
 All Gradle commands should be run from the source root (which is one level up
 from this folder). See the README.md in the source root for instructions on
 publishing/testing Firebase Storage.
+
+## Unit Tests
+
+The Firebase Storage Unit tests exercise the public API endpoints and mock the associated network 
+activity. For each test, the unit tests verify all network traffic and state changes by comparing
+them to pre-recorded activity. The network traffic as well as the expected states are defined in the
+resource files included under `src/test/resources/activitylogs`.
+
+To add new tests, use the the test app provided under `../firebase-storage-app`. You
+can run this test app in a simulator or on a device. The app's various test cases can be activated
+through the UI and record all network traffic and state transitions. After each test run, the
+captured network traffic and all state changes are written to the app's local storage directory. You 
+can use this captured state to add additional unit tests for the storage client.
+
+The app reads both from the network and from the device. To run existing test cases, you need to
+upload the files under `src/test/resources/assets` to the Storage bucket of your Firebase project. 
+You can use [gsutil](https://cloud.google.com/storage/docs/gsutil) or the 
+[Firebase Console](https://console.firebase.google.com) for this. Furthermore, to make these file
+available locally, they should also be copied to device's local storage. The expected Storage 
+location is shown when you run a test that requires a local file (e.g. an upload tests).
+
+When a test run finishes, the test app displays the location of the test output. These files need to
+be copied to `src/test/resources/activitylogs` before the can be used in unit tests. Note that the 
+captured network traffic in these files includes your Authentication Tokens and your Project ID,
+which need to be replaced.
+
+To supply the fake authentication token used by the Unit test runner, replace any value for the
+`x-firebase-gmpid` request property with `fooey`. The expected header format is:
+
+```
+setRequestProperty:x-firebase-gmpid,fooey
+```
+
+Similarly, replace any Firebase Storage URLs (such as 
+`https://firebasestorage.googleapis.com/v0/b/{PROJECT}.appspot.com/o/...`) with 
+`https://firebasestorage.googleapis.com/v0/b/fooey.appspot.com/o/...`
+

firebase-storage/firebase-storage.gradle

@@ -38,6 +38,7 @@ android {
     sourceSets {
         androidTest {
             java {
+                srcDir 'src/androidTest'
                 srcDir 'src/testUtil'
                 //We need this since FirebaseApp rule is externalized
                 //TODO(ashwinraghav) b/113079738
@@ -47,7 +48,7 @@ android {
 
         test {
             java {
-                srcDir 'src/testUtil'
+                srcDir 'src/testUtil/java'
                 //We need this since FirebaseApp rule is externalized
                 //TODO(ashwinraghav) b/113079738
                 srcDir '../firebase-common/src/testUtil'
@@ -86,3 +87,11 @@ dependencies {
     testImplementation "com.google.truth:truth:$googleTruthVersion"
     testImplementation 'com.android.support.test:rules:1.0.2'
 }
+
+// ==========================================================================
+// Copy from here down if you want to use the google-services plugin in your
+// androidTest integration tests.
+// ==========================================================================
+ext.packageName = "com.google.firebase.storage"
+apply from: '../gradle/googleServices.gradle'
+

firebase-storage/src/androidTest/AndroidManifest.xml

@@ -13,7 +13,7 @@
 <!-- limitations under the License. -->
 
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
-    package="com.google.firebase.storage.integration">
+    package="com.google.firebase.storage">
   <!--Although the *SdkVersion is captured in gradle build files, this is required for non gradle builds-->
   <!--<uses-sdk android:minSdkVersion="15" android:targetSdkVersion="23" />-->
   <uses-permission android:name="android.permission.INTERNET"/>
@@ -25,5 +25,5 @@
 
   <instrumentation
       android:name="androidx.test.runner.AndroidJUnitRunner"
-      android:targetPackage="com.google.firebase.storage.integration" />
+      android:targetPackage="com.google.firebase.storage" />
 </manifest>

firebase-storage/src/androidTest/java/com/google/firebase/storage/integration/IntegrationTest.java renamed to firebase-storage/src/androidTest/java/com/google/firebase/storage/IntegrationTest.java

@@ -12,28 +12,25 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package com.google.firebase.storage.integration;
+package com.google.firebase.storage;
 
 import static android.Manifest.permission.WRITE_EXTERNAL_STORAGE;
 import static com.google.common.truth.Truth.assertThat;
 
 import android.net.Uri;
 import android.os.Environment;
+import android.support.annotation.NonNull;
 import android.support.test.InstrumentationRegistry;
 import android.support.test.rule.GrantPermissionRule;
 import android.support.test.runner.AndroidJUnit4;
 import com.google.android.gms.tasks.Task;
 import com.google.android.gms.tasks.Tasks;
 import com.google.firebase.FirebaseApp;
-import com.google.firebase.FirebaseOptions;
-import com.google.firebase.storage.FileDownloadTask;
-import com.google.firebase.storage.FirebaseStorage;
-import com.google.firebase.storage.StorageMetadata;
-import com.google.firebase.storage.StorageReference;
 import com.google.firebase.storage.StreamDownloadTask.TaskSnapshot;
 import java.io.File;
 import java.io.IOException;
 import java.io.InputStream;
+import java.util.UUID;
 import java.util.concurrent.ExecutionException;
 import org.junit.Before;
 import org.junit.Rule;
@@ -47,40 +44,38 @@ public class IntegrationTest {
       GrantPermissionRule.grant(WRITE_EXTERNAL_STORAGE);
 
   // The file size in bytes of "1.1mb.dat"
-  private static final int LARGE_FILE_SIZE = 1100000;
+  private static final int LARGE_FILE_SIZE_BYTES = 10 * 1024;
 
-  private static FirebaseStorage storageClient;
+  private FirebaseStorage storageClient;
+
+  private final String randomPrefix = UUID.randomUUID().toString();
 
   @Before
-  public void before() {
+  public void before() throws ExecutionException, InterruptedException {
     if (storageClient == null) {
-      FirebaseApp app =
-          FirebaseApp.initializeApp(
-              InstrumentationRegistry.getContext(),
-              new FirebaseOptions.Builder()
-                  .setApplicationId("1:196403931065:android:60949756fbe381ea")
-                  .setApiKey("AIzaSyDMAScliyLx7F0NPDEJi1QmyCgHIAODrlU")
-                  .setStorageBucket("project-5516366556574091405.appspot.com")
-                  .build());
+      FirebaseApp app = FirebaseApp.initializeApp(InstrumentationRegistry.getContext());
       storageClient = FirebaseStorage.getInstance(app);
+
+      Tasks.await(getReference("metadata.dat").putBytes(new byte[0]));
+      Tasks.await(getReference("download.dat").putBytes(new byte[LARGE_FILE_SIZE_BYTES]));
     }
   }
 
   @Test
   public void downloadFile() throws ExecutionException, InterruptedException, IOException {
-    File tempFile = new File(Environment.getExternalStorageDirectory(), "1.1mb.dat");
+    File tempFile = new File(Environment.getExternalStorageDirectory(), "download.dat");
 
     FileDownloadTask.TaskSnapshot fileTask =
-        Tasks.await(storageClient.getReference("1.1mb.dat").getFile(tempFile));
+        Tasks.await(getReference("download.dat").getFile(tempFile));
 
     assertThat(tempFile.exists()).isTrue();
-    assertThat(tempFile.length()).isEqualTo(LARGE_FILE_SIZE);
-    assertThat(fileTask.getBytesTransferred()).isEqualTo(LARGE_FILE_SIZE);
+    assertThat(tempFile.length()).isEqualTo(LARGE_FILE_SIZE_BYTES);
+    assertThat(fileTask.getBytesTransferred()).isEqualTo(LARGE_FILE_SIZE_BYTES);
   }
 
   @Test
   public void streamFile() throws ExecutionException, InterruptedException, IOException {
-    TaskSnapshot streamTask = Tasks.await(storageClient.getReference("1.1mb.dat").getStream());
+    TaskSnapshot streamTask = Tasks.await(getReference("download.dat").getStream());
 
     byte[] data = new byte[255];
 
@@ -92,13 +87,13 @@ public void streamFile() throws ExecutionException, InterruptedException, IOExce
       totalBytesRead += currentBytesRead;
     }
 
-    assertThat(totalBytesRead).isEqualTo(LARGE_FILE_SIZE);
+    assertThat(totalBytesRead).isEqualTo(LARGE_FILE_SIZE_BYTES);
   }
 
   @Test
   public void uploadBytesThenGetDownloadUrl() throws ExecutionException, InterruptedException {
     byte[] data = new byte[] {1, 2, 3};
-    StorageReference reference = storageClient.getReference("bytes.dat");
+    StorageReference reference = getReference("upload.dat");
 
     Uri downloadUrl =
         Tasks.await(
@@ -123,15 +118,20 @@ public void updateMetadata() throws ExecutionException, InterruptedException {
             .build();
 
     Task<StorageMetadata> storageMetadataTask =
-        storageClient.getReference("metadata.dat").updateMetadata(randomMetadata);
+        getReference("metadata.dat").updateMetadata(randomMetadata);
     StorageMetadata metadata = Tasks.await(storageMetadataTask);
 
     assertThat(metadata.getCustomMetadata("rand"))
         .isEqualTo(randomMetadata.getCustomMetadata("rand"));
 
-    metadata = Tasks.await(storageClient.getReference("metadata.dat").getMetadata());
+    metadata = Tasks.await(getReference("metadata.dat").getMetadata());
 
     assertThat(metadata.getCustomMetadata("rand"))
         .isEqualTo(randomMetadata.getCustomMetadata("rand"));
   }
+
+  @NonNull
+  private StorageReference getReference(String filename) {
+    return storageClient.getReference(randomPrefix + "/" + filename);
+  }
 }

firebase-storage/src/test/java/com/google/firebase/storage/DownloadTest.java

@@ -111,9 +111,7 @@ public void streamDownloadStateVerification() throws Exception {
     NetworkLayerMock.ensureNetworkMock("streamDownload", true);
     final Semaphore semaphore = new Semaphore(0);
 
-    StorageReference storage =
-        FirebaseStorage.getInstance()
-            .getReferenceFromUrl("gs://project-5516366556574091405.appspot.com/image.jpg");
+    StorageReference storage = FirebaseStorage.getInstance().getReference("image.jpg");
 
     final AtomicLong bytesDownloaded = new AtomicLong();
     final AtomicLong bytesTransferred = new AtomicLong();

firebase-storage/src/test/java/com/google/firebase/storage/PathingTest.java

@@ -51,10 +51,7 @@ public void setUp() throws Exception {
     app =
         FirebaseApp.initializeApp(
             RuntimeEnvironment.application.getApplicationContext(),
-            new FirebaseOptions.Builder()
-                .setApiKey("AIzaSyCkEhVjf3pduRDt6d1yKOMitrUEke8agEM")
-                .setApplicationId("fooey")
-                .build());
+            new FirebaseOptions.Builder().setApiKey("fooey").setApplicationId("fooey").build());
   }
 
   @After

firebase-storage/src/test/java/com/google/firebase/storage/StorageReferenceTest.java

@@ -76,7 +76,7 @@ public void retainsProperties() throws Exception {
   @Test
   public void defaultInitTest() throws Exception {
     StorageReference ref = FirebaseStorage.getInstance().getReference();
-    Assert.assertEquals("gs://project-5516366556574091405.appspot.com/", ref.toString());
+    Assert.assertEquals("gs://fooey.appspot.com/", ref.toString());
   }
 
   @Test
@@ -88,18 +88,13 @@ public void initWithCustomUriTest() throws Exception {
   @Test
   public void allStorageObjectsAreEqual() throws Exception {
     FirebaseStorage original = FirebaseStorage.getInstance();
-    FirebaseStorage copy =
-        FirebaseStorage.getInstance("gs://project-5516366556574091405.appspot.com/");
+    FirebaseStorage copy = FirebaseStorage.getInstance("gs://fooey.appspot.com/");
     Assert.assertSame(copy, original); // Pointer comparison intended
-    copy = FirebaseStorage.getInstance("gs://project-5516366556574091405.appspot.com");
+    copy = FirebaseStorage.getInstance("gs://fooey.appspot.com");
     Assert.assertSame(copy, original);
-    copy =
-        FirebaseStorage.getInstance(
-            FirebaseApp.getInstance(), "gs://project-5516366556574091405.appspot.com/");
+    copy = FirebaseStorage.getInstance(FirebaseApp.getInstance(), "gs://fooey.appspot.com/");
     Assert.assertSame(copy, original);
-    Assert.assertEquals(
-        "gs://project-5516366556574091405.appspot.com/",
-        copy.getReference().getStorageUri().toString());
+    Assert.assertEquals("gs://fooey.appspot.com/", copy.getReference().getStorageUri().toString());
   }
 
   @Test
@@ -116,7 +111,7 @@ public void initWithBadUriTest() throws Exception {
   @Test
   public void initWithPathTest() throws Exception {
     try {
-      FirebaseStorage.getInstance("gs://project-5516366556574091405.appspot.com/foo");
+      FirebaseStorage.getInstance("gs://fooey.appspot.com/foo");
       Assert.fail("Expected exception");
     } catch (IllegalArgumentException e) {
       Assert.assertEquals("The storage Uri cannot contain a path element.", e.getMessage());
@@ -139,14 +134,13 @@ public void initWithDefaultAndCustomUriTest() throws Exception {
     StorageReference defaultRef = FirebaseStorage.getInstance().getReference();
     StorageReference customRef =
         FirebaseStorage.getInstance("gs://foo-bar.appspot.com/").getReference();
-    Assert.assertEquals("gs://project-5516366556574091405.appspot.com/", defaultRef.toString());
+    Assert.assertEquals("gs://fooey.appspot.com/", defaultRef.toString());
     Assert.assertEquals("gs://foo-bar.appspot.com/", customRef.toString());
   }
 
   @Test(expected = IllegalArgumentException.class)
   public void badInitTest() throws Exception {
-    FirebaseStorage.getInstance()
-        .getReference("gs://project-5516366556574091405.appspot.com/child");
+    FirebaseStorage.getInstance().getReference("gs://fooey.appspot.com/child");
   }
 
   @Test
@@ -161,15 +155,15 @@ public void initWithApp() throws Exception {
         FirebaseApp.initializeApp(
             RuntimeEnvironment.application.getApplicationContext(),
             new FirebaseOptions.Builder()
-                .setApiKey("AIzaSyCkEhVjf3pduRDt6d1yKOMitrUEke8agEM")
+                .setApiKey("fooey")
                 .setApplicationId("fooey")
-                .setStorageBucket("benwu-test2.storage.firebase.com")
+                .setStorageBucket("fooey.storage.firebase.com")
                 .build(),
             "app2");
 
     StorageReference ref =
         FirebaseStorage.getInstance(app2)
-            .getReferenceFromUrl("gs://benwu-test2.storage.firebase.com/child");
+            .getReferenceFromUrl("gs://fooey.storage.firebase.com/child");
 
     Assert.assertEquals("child", ref.getName());
   }
@@ -188,26 +182,24 @@ public void badInitWithApp2() throws Exception {
   @Test
   public void urlUriEquivalence() throws Exception {
     StorageReference ref =
-        FirebaseStorage.getInstance()
-            .getReferenceFromUrl("gs://project-5516366556574091405.appspot.com/child/image.png");
+        FirebaseStorage.getInstance().getReferenceFromUrl("gs://fooey.appspot.com/child/image.png");
     StorageReference ref2 =
         FirebaseStorage.getInstance()
             .getReferenceFromUrl(
-                "https://firebasestorage.googleapis.com/v0/b/project-"
-                    + "5516366556574091405.appspot.com/o/child%2Fimage.png?alt=media&"
+                "https://firebasestorage.googleapis.com/v0/b/"
+                    + "fooey.appspot.com/o/child%2Fimage.png?alt=media&"
                     + "token=42a1b22e-5e56-4337-bd61-f177233b40bc");
 
     Assert.assertEquals(ref, ref2);
     Assert.assertEquals("/child/image.png", ref.getPath());
-    Assert.assertEquals("project-5516366556574091405.appspot.com", ref.getBucket());
+    Assert.assertEquals("fooey.appspot.com", ref.getBucket());
   }
 
   @Test
   public void badGSUriScheme() throws Exception {
     boolean thrown = false;
     try {
-      FirebaseStorage.getInstance()
-          .getReferenceFromUrl("gs2://project-5516366556574091405.appspot.com/child/image.png");
+      FirebaseStorage.getInstance().getReferenceFromUrl("gs2://fooey.appspot.com/child/image.png");
     } catch (IllegalArgumentException e) {
       thrown = true;
     }
@@ -244,7 +236,7 @@ public void badURL1() throws Exception {
     try {
       FirebaseStorage.getInstance()
           .getReferenceFromUrl(
-              "https://www.googleapis.com/v0/b/project-5516366556574091405.appspot"
+              "https://www.googleapis.com/v0/b/fooey.appspot"
                   + ".com/o/child%2Fimage.png?alt=media&token=42a1b22e-5e56-4337-bd61-f177233b40bc");
     } catch (IllegalArgumentException e) {
       thrown = true;

firebase-storage/src/test/java/com/google/firebase/storage/TestUtil.java

@@ -32,9 +32,9 @@ static FirebaseApp createApp() {
     return FirebaseApp.initializeApp(
         RuntimeEnvironment.application.getApplicationContext(),
         new FirebaseOptions.Builder()
-            .setApiKey("AIzaSyCkEhVjf3pduRDt6d1yKOMitrUEke8agEM")
+            .setApiKey("fooey")
             .setApplicationId("fooey")
-            .setStorageBucket("project-5516366556574091405.appspot.com")
+            .setStorageBucket("fooey.appspot.com")
             .build());
     // Point to staging:
     // NetworkRequest.sNetworkRequestUrl = "https://staging-firebasestorage.sandbox.googleapis"
@@ -47,19 +47,19 @@ static void verifyTaskStateChanges(
     ClassLoader classLoader = TestUtil.class.getClassLoader();
 
     System.out.println("Verifying task file.");
-    String filename = "assets/" + testName + "_task.txt";
+    String filename = "activitylogs/" + testName + "_task.txt";
     InputStream inputStream = classLoader.getResourceAsStream(filename);
     verifyTaskStateChanges(inputStream, response.mainTask.toString());
 
     System.out.println("Verifying background file.");
-    filename = "assets/" + testName + "_background.txt";
+    filename = "activitylogs/" + testName + "_background.txt";
     inputStream = classLoader.getResourceAsStream(filename);
     verifyTaskStateChanges(inputStream, response.backgroundTask.toString());
   }
 
   static void verifyTaskStateChanges(String testName, String contents) {
     ClassLoader classLoader = TestUtil.class.getClassLoader();
-    String filename = "assets/" + testName + "_task.txt";
+    String filename = "activitylogs/" + testName + "_task.txt";
 
     InputStream inputStream = classLoader.getResourceAsStream(filename);
     verifyTaskStateChanges(inputStream, contents);