Fix Util.handleException to rethrow exceptions during unit testing. (#401)

Author: hborisoff

AndroidSDKTests/src/test/java/com/leanplum/LeanplumActionContextTest.java

@@ -47,6 +47,8 @@
 import static org.junit.Assert.assertNull;
 import static org.junit.Assert.assertTrue;
 import static org.mockito.Matchers.any;
+import static org.mockito.Matchers.eq;
+import static org.mockito.Matchers.isNull;
 import static org.mockito.Mockito.never;
 import static org.mockito.Mockito.times;
 import static org.powermock.api.mockito.PowerMockito.doReturn;
@@ -190,7 +192,7 @@ public void testActionArgs() {
     }
 
     @Test
-    public void testValues() {
+    public void testValues() throws Exception {
         ActionContext actionContext = new ActionContext("name", new HashMap<String, Object>() {{
             put("1", true);
             put("2", false);
@@ -215,6 +217,8 @@ public void testValues() {
 
         assertNotNull(actionContext.numberNamed("7"));
         assertNull(actionContext.numberNamed(null));
+
+        resumeLeanplumExceptionHandling();
         assertEquals(0.0, actionContext.numberNamed("6"));
     }
 
@@ -264,10 +268,26 @@ public void testTrack() {
             put("test_2", 10);
         }};
 
-        verifyStatic(times(1));
+        Map<String, String> requestArgs = new HashMap<>();
+        requestArgs.put(Constants.Params.MESSAGE_ID, "messageId");
+
         actionContext.track("test_event", 0.0, map);
-        verifyStatic(never());
+        verifyStatic(times(1));
+        LeanplumInternal.track(
+            eq("test_event"),
+            eq(0.0),
+            isNull(String.class),
+            eq(map),
+            eq(requestArgs));
+
         actionContext.track(null, 0.0, map);
+        verifyStatic(never());
+        LeanplumInternal.track(
+            isNull(String.class),
+            any(Double.class),
+            any(String.class),
+            any(Map.class),
+            any(Map.class));
     }
 
     @Test

AndroidSDKTests/src/test/java/com/leanplum/__setup/AbstractTest.java

@@ -34,12 +34,9 @@
 import com.leanplum.LocationManager;
 import com.leanplum._whitebox.utilities.RequestHelper;
 import com.leanplum._whitebox.utilities.ResponseHelper;
-import com.leanplum._whitebox.utilities.SynchronousExecutor;
-import com.leanplum.callbacks.StartCallback;
 import com.leanplum.internal.Constants;
 import com.leanplum.internal.LeanplumEventDataManager;
 import com.leanplum.internal.LeanplumInternal;
-import com.leanplum.internal.Operation;
 import com.leanplum.internal.OperationQueue;
 import com.leanplum.internal.RequestOld;
 import com.leanplum.internal.ShadowOperationQueue;
@@ -50,6 +47,7 @@
 import org.junit.Before;
 import org.junit.Rule;
 import org.junit.runner.RunWith;
+import org.powermock.api.mockito.PowerMockito;
 import org.powermock.core.classloader.annotations.PowerMockIgnore;
 import org.powermock.core.classloader.annotations.PrepareForTest;
 import org.powermock.modules.junit4.rule.PowerMockRule;
@@ -66,14 +64,13 @@
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
-import java.util.concurrent.CountDownLatch;
-import java.util.concurrent.TimeUnit;
 
 import javax.net.ssl.HttpsURLConnection;
 
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertNotNull;
 import static org.junit.Assert.assertTrue;
+import static org.mockito.Matchers.any;
 import static org.mockito.Matchers.anyString;
 import static org.powermock.api.mockito.PowerMockito.doReturn;
 import static org.powermock.api.mockito.PowerMockito.mock;
@@ -169,13 +166,42 @@ public void before() throws Exception {
     when(httpsURLConnection.getInputStream()).thenReturn(ResponseHelper
         .seedInputStream("/responses/simple_start_response.json"));
 
+    stopLeanplumExceptionHandling();
+
     ShadowOperationQueue shadowOperationQueue = new ShadowOperationQueue();
 
     Field instance = OperationQueue.class.getDeclaredField("instance");
     instance.setAccessible(true);
     instance.set(instance, shadowOperationQueue);
   }
 
+  /**
+   * Leanplum SDK is handling the uncaught exceptions in
+   * {@link Util#handleException(java.lang.Throwable)} but for test purposes uncaught exceptions
+   * need not to be caught. In a lot of tests there are assert statements in the callbacks that are
+   * added in the SDK.
+   */
+  protected void stopLeanplumExceptionHandling() throws Exception {
+    String message = "\n" + "com.leanplum.internal.Util.handleException(Throwable) is called and "
+        + "exception parameter is rethrown intentionally." + "\n"
+        + "Call AbstractTest.resumeLeanplumExceptionHandling() to allow "
+        + "Util.handleException(Throwable) to work normally." + "\n" + "\n"
+        + "Scroll down to see the original stacktrace.";
+
+    PowerMockito.doAnswer(invocation -> {
+      Object[] args = invocation.getArguments();
+      throw new Exception(message, (Throwable) args[0]);
+    }).when(Util.class, "handleException", any(Throwable.class));
+  }
+
+  /**
+   * Use this method to resume normal behaviour for
+   * {@link Util#handleException(java.lang.Throwable)} and catch all uncaught exceptions in SDK.
+   */
+  protected void resumeLeanplumExceptionHandling() throws Exception {
+    PowerMockito.doNothing().when(Util.class, "handleException", any(Throwable.class));
+  }
+
   @After
   public void after() {
     LeanplumTestHelper.tearDown();

AndroidSDKTests/src/test/java/com/leanplum/__setup/LeanplumTestHelper.java

@@ -134,6 +134,10 @@ public static void reset() {
     List onceNoDownloadsHandlers = (List) TestClassUtil.getField(Leanplum.class,
         "onceNoDownloadsHandlers");
     onceNoDownloadsHandlers.clear();
+    List messageDisplayedHandlers =
+        (List) TestClassUtil.getField(Leanplum.class, "messageDisplayedHandlers");
+    messageDisplayedHandlers.clear();
+
     LeanplumInternal.getActionHandlers().clear();
     LeanplumInternal.getUserAttributeChanges().clear();
     Leanplum.countAggregator().getAndClearCounts();

AndroidSDKTests/src/test/java/com/leanplum/internal/FileManagerTest.java

@@ -77,7 +77,7 @@ public void testFileDownload() {
     FileManager.maybeDownloadFile(false, "test.png", "test_default.png", null, new Runnable() {
       @Override
       public void run() {
-        String path = FileManager.fileRelativeToAppBundle("test.png");
+        String path = FileManager.fileRelativeToDocuments("test.png");
         assertTrue(FileManager.fileExistsAtPath(path));
       }
     });

AndroidSDKTests/src/test/java/com/leanplum/internal/UtilTest.java

@@ -1,15 +1,11 @@
 package com.leanplum.internal;
 
-import com.leanplum.__setup.LeanplumTestApp;
+import com.leanplum.__setup.AbstractTest;
 import com.leanplum._whitebox.utilities.ResponseHelper;
 
+import org.junit.Assert;
 import org.junit.Before;
 import org.junit.Test;
-import org.junit.runner.RunWith;
-import org.powermock.core.classloader.annotations.PowerMockIgnore;
-import org.powermock.core.classloader.annotations.PrepareForTest;
-import org.robolectric.RobolectricTestRunner;
-import org.robolectric.annotation.Config;
 
 import java.net.HttpURLConnection;
 
@@ -22,20 +18,7 @@
  *
  * @author Hrishi Amravatkar
  */
-@RunWith(RobolectricTestRunner.class)
-@Config(
-    sdk = 16,
-    application = LeanplumTestApp.class
-)
-@PowerMockIgnore({
-    "org.mockito.*",
-    "org.robolectric.*",
-    "org.json.*",
-    "org.powermock.*",
-    "android.*"
-})
-@PrepareForTest({Util.class})
-public class UtilTest {
+public class UtilTest extends AbstractTest {
 
   /**
    * Runs before every test case.
@@ -81,4 +64,23 @@ public void getGzipEncodedErrorResponseWithContentEndingTest() throws Exception
     assertNotNull(Util.getJsonResponse(mockHttpUrlConnection));
   }
 
+  /**
+   * Test that {@link Util#handleException(Throwable)} is successfully mocked to rethrow the
+   * argument exception.
+   */
+  @Test
+  public void testHandleExceptionMocked() {
+    Assert.assertThrows(Throwable.class, () -> Util.handleException(new Exception()));
+  }
+
+  /**
+   * Test that {@link AbstractTest#resumeLeanplumExceptionHandling()} is returning the default
+   * behaviour of {@link Util#handleException(Throwable)}.
+   */
+  @Test
+  public void testHandleExceptionDefault() throws Exception {
+    resumeLeanplumExceptionHandling();
+    Util.handleException(new Exception());
+  }
+
 }