Tests: Refactor to expose inner AssertionErrors (#122)

* Tests: Refactor to expose inner AssertionErrors

* Tests: Print details when a test fails

* Tests: Disable connectTimeout/DNS/KeepAlive testing on Travis as it is currently unreliable

Author: PLNech

algoliasearch/common.gradle

@@ -48,7 +48,17 @@ android {
     // WARNING: Uncomment this line if you want to use the Debug configuration when developing against this module.
     // Otherwise, **leave it commented out** as we do **not** want to publish the Debug configuration.
     // publishNonDefault true
+
+    testOptions {
+        unitTests.all {
+            testLogging {
+                events "skipped", "failed", "standardOut", "standardError"
+                exceptionFormat "full"
+                outputs.upToDateWhen { false }
+            }
+        }
 }
+    }
 configurations {
     // Configuration solely created to make the Android classpath available when compiling Javadocs.
     // Taken from: <http://stackoverflow.com/questions/29663918/android-gradle-javadoc-annotation-does-not-exists>.
@@ -126,15 +136,15 @@ uploadArchives {
         // Maven Central repository.
         repository(url: "https://oss.sonatype.org/service/local/staging/deploy/maven2/") {
             authentication(
-                userName: project.hasProperty('nexusUsername') ? project['nexusUsername'] : 'FIXME',
-                password: project.hasProperty('nexusPassword') ? project['nexusPassword'] : 'FIXME'
+                    userName: project.hasProperty('nexusUsername') ? project['nexusUsername'] : 'FIXME',
+                    password: project.hasProperty('nexusPassword') ? project['nexusPassword'] : 'FIXME'
             )
         }
         // Maven Central snapshot repository.
         snapshotRepository(url: "https://oss.sonatype.org/content/repositories/snapshots/") {
             authentication(
-                userName: project.hasProperty('nexusUsername') ? project['nexusUsername'] : 'FIXME',
-                password: project.hasProperty('nexusPassword') ? project['nexusPassword'] : 'FIXME'
+                    userName: project.hasProperty('nexusUsername') ? project['nexusUsername'] : 'FIXME',
+                    password: project.hasProperty('nexusPassword') ? project['nexusPassword'] : 'FIXME'
             )
         }
     }
@@ -189,4 +199,4 @@ def editPom(pom) {
             }
         }
     }
-}
+}

algoliasearch/src/test/java/com/algolia/search/saas/AssertCompletionHandler.java

@@ -0,0 +1,56 @@
+package com.algolia.search.saas;
+
+import org.json.JSONObject;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import static junit.framework.Assert.fail;
+
+/**
+ * This class helps coping with assertions in callbacks.
+ * As AssertionErrors are thrown silently when an assertion fails in a callback,
+ * this class wraps a CompletionHandler to check if an assert failed and expose the error through {@link AssertCompletionHandler#checkAssertions()}.
+ */
+abstract class AssertCompletionHandler implements CompletionHandler {
+    private AssertionError error;
+    private final CompletionHandler handler;
+    private final List<AssertCompletionHandler> innerHandlers = new ArrayList<>();
+
+    public AssertCompletionHandler() {
+        this.handler = new CompletionHandler() {
+            @Override public void requestCompleted(JSONObject content, AlgoliaException error) {
+                doRequestCompleted(content, error);
+            }
+        };
+    }
+
+    abstract public void doRequestCompleted(JSONObject content, AlgoliaException error);
+
+    /**
+     * Add an inner handler to be checked as well in {@link AssertCompletionHandler#checkAssertions()}.
+     */
+    public void addInnerHandler(AssertCompletionHandler handler) {
+        innerHandlers.add(handler);
+    }
+
+    /**
+     * Fail if the handler encountered at least one AssertionError.
+     */
+    public void checkAssertions() {
+        if (error != null) {
+            fail("At least one assertion failed: " + error);
+        }
+        for (AssertCompletionHandler h : innerHandlers) {
+            h.checkAssertions();
+        }
+    }
+
+    @Override final public void requestCompleted(JSONObject content, AlgoliaException error) {
+        try {
+            handler.requestCompleted(content, error);
+        } catch (AssertionError e) {
+            this.error = e;
+        }
+    }
+}

algoliasearch/src/test/java/com/algolia/search/saas/BrowseIteratorTest.java

@@ -35,10 +35,7 @@
 
 import java.util.ArrayList;
 import java.util.List;
-import java.util.concurrent.CountDownLatch;
-import java.util.concurrent.TimeUnit;
 
-import static junit.framework.Assert.assertTrue;
 import static junit.framework.Assert.fail;
 
 public class BrowseIteratorTest extends PowerMockTestCase {
@@ -80,48 +77,81 @@ public void tearDown() throws Exception {
 
     @Test
     public void testNominal() throws Exception {
-        final CountDownLatch signal = new CountDownLatch(2);
-
         Query query = new Query();
-        BrowseIterator iterator = new BrowseIterator(index, query, new BrowseIterator.BrowseIteratorHandler() {
+        AssertBrowseHandler handler = new AssertBrowseHandler() {
             @Override
-            public void handleBatch(@NonNull BrowseIterator iterator, JSONObject result, AlgoliaException error) {
-                if (error == null) {
-                    signal.countDown();
-                    if (signal.getCount() > 2) {
-                        fail("Should not reach this point");
-                    }
-                } else {
+            void doHandleBatch(BrowseIterator iterator, JSONObject result, AlgoliaException error) {
+                if (error != null) {
                     fail(error.getMessage());
                 }
             }
-        });
+        };
+        BrowseIterator iterator = new BrowseIterator(index, query, handler);
         iterator.start();
-        assertTrue("No callback was called", signal.await(Helpers.wait, TimeUnit.SECONDS));
+        handler.checkAssertions();
+        handler.checkCalledMax(2);
     }
 
     @Test
     public void testCancel() throws Exception {
-        final CountDownLatch signal = new CountDownLatch(1);
-
         Query query = new Query();
-        BrowseIterator iterator = new BrowseIterator(index, query, new BrowseIterator.BrowseIteratorHandler() {
+        AssertBrowseHandler handler = new AssertBrowseHandler() {
             @Override
-            public void handleBatch(@NonNull BrowseIterator iterator, JSONObject result, AlgoliaException error) {
+            void doHandleBatch(BrowseIterator iterator, JSONObject result, AlgoliaException error) {
                 if (error == null) {
-                    signal.countDown();
-                    if (signal.getCount() == 1) {
+                    if (getCount() == 1) {
                         iterator.cancel();
                     }
-                    else if (signal.getCount() > 1) {
-                        fail("Should not reach this point");
-                    }
                 } else {
                     fail(error.getMessage());
                 }
             }
-        });
+        };
+        BrowseIterator iterator = new BrowseIterator(index, query, handler);
         iterator.start();
-        assertTrue("No callback was called", signal.await(Helpers.wait, TimeUnit.SECONDS));
+        handler.checkAssertions();
+        handler.checkCalledMax(1);
+    }
+
+    private abstract class AssertBrowseHandler implements BrowseIterator.BrowseIteratorHandler {
+
+        private AssertionError error;
+        private int count;
+
+        abstract void doHandleBatch(BrowseIterator iterator, JSONObject result, AlgoliaException error);
+
+        /**
+         * Fail if the handler encountered at least one AssertionError.
+         */
+        public void checkAssertions() {
+            if (error != null) {
+                fail(error.getMessage());
+            }
+        }
+
+        /**
+         * Fail if the handler was called more than a certain amount of time.
+         * @param times the maximum allowed before failing.
+         */
+        public void checkCalledMax(int times) {
+            if (count > times) {
+                fail("The BrowseIterator was called more than " + times + " times.");
+            }
+        }
+
+        @Override
+        public void handleBatch(@NonNull BrowseIterator iterator, JSONObject result, AlgoliaException error) {
+            count++;
+            try {
+
+                doHandleBatch(iterator, result, error);
+            } catch (AssertionError e) {
+                this.error = e;
+            }
+        }
+
+        public int getCount() {
+            return count;
+        }
     }
 }