Add more tests.

Author: qdpham13

firebase-config/src/main/java/com/google/firebase/remoteconfig/internal/ConfigRealtimeHttpClient.java

@@ -236,6 +236,7 @@ private URL getUrl() {
     return realtimeURL;
   }
 
+  /** Create HTTP connection and set headers. */
   @SuppressLint("VisibleForTests")
   public HttpURLConnection createRealtimeConnection() throws IOException {
     URL realtimeUrl = getUrl();
@@ -246,7 +247,7 @@ public HttpURLConnection createRealtimeConnection() throws IOException {
     return httpURLConnection;
   }
 
-  // Try to reopen HTTP connection after a random amount of time
+  /** Retries HTTP stream connection asyncly in random time intervals. */
   @SuppressLint("VisibleForTests")
   public synchronized void retryHTTPConnection() {
     if (canMakeHttpStreamConnection() && httpRetriesRemaining > 0) {
@@ -275,7 +276,12 @@ synchronized void stopRealtime() {
     scheduledExecutorService.shutdownNow();
   }
 
-  private synchronized ConfigAutoFetch startAutoFetch(HttpURLConnection httpURLConnection) {
+  /**
+   * Create Autofetch class that listens on HTTP stream for ConfigUpdate messages and calls Fetch
+   * accordingly.
+   */
+  @SuppressLint("VisibleForTests")
+  public synchronized ConfigAutoFetch startAutoFetch(HttpURLConnection httpURLConnection) {
     ConfigUpdateListener retryCallback =
         new ConfigUpdateListener() {
           @Override
@@ -300,6 +306,7 @@ public void onError(Exception error) {
     return new ConfigAutoFetch(httpURLConnection, configFetchHandler, listeners, retryCallback);
   }
 
+  // HTTP status code that the Realtime client should retry on.
   private boolean isStatusCodeRetryable(int statusCode) {
     return statusCode == HttpURLConnection.HTTP_CLIENT_TIMEOUT
         || statusCode == HttpURLConnection.HTTP_BAD_GATEWAY
@@ -323,10 +330,12 @@ public synchronized void beginRealtimeHttpStream() {
 
     int responseCode = 200;
     try {
-      // Create the open the connection.
+      // Create the connection.
       httpURLConnection = createRealtimeConnection();
+      // Open the connection and get response code.
       responseCode = httpURLConnection.getResponseCode();
 
+      // If the connection returned a 200 response code state Autofetch.
       if (responseCode == HttpURLConnection.HTTP_OK) {
         // Reset the retries remaining if we opened the connection without an exception.
         resetRetryParameters();
@@ -349,8 +358,9 @@ public synchronized void beginRealtimeHttpStream() {
     }
   }
 
-  // Pauses Http stream listening
-  synchronized void closeRealtimeHttpStream() {
+  /** Closes HTTP stream. */
+  @SuppressLint("VisibleForTests")
+  public synchronized void closeRealtimeHttpStream() {
     if (httpURLConnection != null) {
       this.httpURLConnection.disconnect();
 

firebase-config/src/test/java/com/google/firebase/remoteconfig/FirebaseRemoteConfigTest.java

@@ -30,8 +30,11 @@
 import static org.mockito.ArgumentMatchers.eq;
 import static org.mockito.Matchers.any;
 import static org.mockito.Mockito.doAnswer;
+import static org.mockito.Mockito.doNothing;
+import static org.mockito.Mockito.doReturn;
 import static org.mockito.Mockito.doThrow;
 import static org.mockito.Mockito.never;
+import static org.mockito.Mockito.spy;
 import static org.mockito.Mockito.times;
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
@@ -141,7 +144,7 @@ public final class FirebaseRemoteConfigTest {
   @Mock private ConfigMetadataClient metadataClient;
 
   @Mock private ConfigRealtimeHandler mockConfigRealtimeHandler;
-  @Mock private ConfigRealtimeHttpClient mockConfigRealtimeHttpClient;
+  @Mock private ConfigAutoFetch mockConfigAutoFetch;
   @Mock private ConfigUpdateListenerRegistration mockRealtimeRegistration;
   @Mock private HttpURLConnection mockHttpURLConnection;
   @Mock private ConfigUpdateListener mockListener;
@@ -167,6 +170,7 @@ public final class FirebaseRemoteConfigTest {
   private FetchResponse realtimeFetchedContainerResponse;
   private ConfigContainer realtimeFetchedContainer;
   private ConfigAutoFetch configAutoFetch;
+  private ConfigRealtimeHttpClient configRealtimeHttpClient;
 
   private FetchResponse firstFetchedContainerResponse;
 
@@ -271,6 +275,14 @@ public void setUp() throws Exception {
     listeners.add(mockListener);
     configAutoFetch =
         new ConfigAutoFetch(mockHttpURLConnection, mockFetchHandler, listeners, mockRetryListener);
+    configRealtimeHttpClient =
+        new ConfigRealtimeHttpClient(
+            firebaseApp,
+            mockFirebaseInstallations,
+            mockFetchHandler,
+            context,
+            "firebase",
+            listeners);
   }
 
   @Test
@@ -1206,11 +1218,53 @@ public void realtime_stream_autofetch_failure() {
   }
 
   @Test
-  public void realtime_checkStatusCode_beforeRetryStream() throws Exception {
-    when(mockConfigRealtimeHttpClient.createRealtimeConnection()).thenReturn(mockHttpURLConnection);
+  public void realtime_redirectStatusCode_noRetries() throws Exception {
+    ConfigRealtimeHttpClient configRealtimeHttpClientSpy = spy(configRealtimeHttpClient);
+    doReturn(mockHttpURLConnection).when(configRealtimeHttpClientSpy).createRealtimeConnection();
+    doNothing().when(configRealtimeHttpClientSpy).closeRealtimeHttpStream();
+    when(mockHttpURLConnection.getResponseCode()).thenReturn(301);
+    configRealtimeHttpClientSpy.beginRealtimeHttpStream();
+    verify(configRealtimeHttpClientSpy, never()).startAutoFetch(any());
+    verify(configRealtimeHttpClientSpy, never()).retryHTTPConnection();
+  }
+
+  @Test
+  public void realtime_okStatusCode_startAutofetchAndRetries() throws Exception {
+    ConfigRealtimeHttpClient configRealtimeHttpClientSpy = spy(configRealtimeHttpClient);
+    doReturn(mockHttpURLConnection).when(configRealtimeHttpClientSpy).createRealtimeConnection();
+    doReturn(mockConfigAutoFetch).when(configRealtimeHttpClientSpy).startAutoFetch(any());
+    doNothing().when(configRealtimeHttpClientSpy).retryHTTPConnection();
+    doNothing().when(configRealtimeHttpClientSpy).closeRealtimeHttpStream();
+    when(mockHttpURLConnection.getResponseCode()).thenReturn(200);
+
+    configRealtimeHttpClientSpy.beginRealtimeHttpStream();
+    verify(mockConfigAutoFetch).listenForNotifications();
+    verify(configRealtimeHttpClientSpy).retryHTTPConnection();
+  }
+
+  @Test
+  public void realtime_badGatewayStatusCode_noAutofetchButRetries() throws Exception {
+    ConfigRealtimeHttpClient configRealtimeHttpClientSpy = spy(configRealtimeHttpClient);
+    doReturn(mockHttpURLConnection).when(configRealtimeHttpClientSpy).createRealtimeConnection();
+    doNothing().when(configRealtimeHttpClientSpy).retryHTTPConnection();
+    doNothing().when(configRealtimeHttpClientSpy).closeRealtimeHttpStream();
     when(mockHttpURLConnection.getResponseCode()).thenReturn(502);
-    mockConfigRealtimeHttpClient.beginRealtimeHttpStream();
-    verify(mockConfigRealtimeHttpClient, never()).retryHTTPConnection();
+
+    configRealtimeHttpClientSpy.beginRealtimeHttpStream();
+    verify(configRealtimeHttpClientSpy, never()).startAutoFetch(any());
+    verify(configRealtimeHttpClientSpy).retryHTTPConnection();
+  }
+
+  @Test
+  public void realtime_exceptionThrown_noAutofetchButRetries() throws Exception {
+    ConfigRealtimeHttpClient configRealtimeHttpClientSpy = spy(configRealtimeHttpClient);
+    doThrow(IOException.class).when(configRealtimeHttpClientSpy).createRealtimeConnection();
+    doNothing().when(configRealtimeHttpClientSpy).retryHTTPConnection();
+    doNothing().when(configRealtimeHttpClientSpy).closeRealtimeHttpStream();
+
+    configRealtimeHttpClientSpy.beginRealtimeHttpStream();
+    verify(configRealtimeHttpClientSpy, never()).startAutoFetch(any());
+    verify(configRealtimeHttpClientSpy).retryHTTPConnection();
   }
 
   private static void loadCacheWithConfig(