Improved unit test error logging (#4075)

Author: shai-almog

maven/core-unittests/src/test/java/com/codename1/io/LogTest.java

@@ -22,7 +22,6 @@
 import static org.mockito.ArgumentMatchers.anyString;
 import static org.mockito.Mockito.doAnswer;
 import static org.mockito.Mockito.mock;
-import static org.mockito.Mockito.verify;
 
 class LogTest {
     private Log originalLog;
@@ -95,20 +94,6 @@ void printRespectsLogLevelAndWritesToWriter() throws IOException {
         assertTrue(systemOutMessages.stream().anyMatch(s -> s.contains("accepted")));
     }
 
-    @Test
-    void logThrowableWritesExceptionDetails() throws IOException {
-        testLog.resetContent();
-        systemOutMessages.clear();
-
-        RuntimeException failure = new RuntimeException("boom");
-        Log.e(failure);
-
-        String content = testLog.getWrittenContent();
-        assertTrue(content.contains("Exception: java.lang.RuntimeException - boom"));
-        assertTrue(content.contains("stack"));
-        verify(mockImplementation).printStackTraceToStream(any(), any());
-    }
-
     @Test
     void setFileURLRecreatesWriter() throws IOException {
         testLog.resetContent();

maven/core-unittests/src/test/java/com/codename1/junit/TestLogger.java

@@ -0,0 +1,41 @@
+package com.codename1.junit;
+
+import com.codename1.io.Log;
+
+import java.util.ArrayList;
+import java.util.List;
+
+public class TestLogger extends Log {
+    private List<Throwable> throwables = new ArrayList<>();
+    private List<String> printed = new ArrayList<>();
+    private static Log original;
+    public static void install() {
+        if(getInstance() instanceof TestLogger) {
+            throw new IllegalStateException("Test logger already installed");
+        }
+        original = getInstance();
+        install(new TestLogger());
+    }
+
+    public static void remove() {
+        install(original);
+    }
+
+    @Override
+    protected void logThrowable(Throwable t) {
+        throwables.add(t);
+    }
+
+    @Override
+    protected void print(String text, int level) {
+        printed.add(text);
+    }
+
+    public static List<String> getPrinted() {
+        return ((TestLogger)getInstance()).printed;
+    }
+
+    public static List<Throwable> getThrowables() {
+        return ((TestLogger)getInstance()).throwables;
+    }
+}

maven/core-unittests/src/test/java/com/codename1/payment/PurchaseTest.java

@@ -4,12 +4,14 @@
 import com.codename1.io.TestImplementationProvider;
 import com.codename1.io.Util;
 import com.codename1.impl.CodenameOneImplementation;
+import com.codename1.junit.TestLogger;
 import com.codename1.ui.Display;
 import com.codename1.util.SuccessCallback;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 
+import java.io.IOException;
 import java.lang.reflect.Field;
 import java.util.ArrayList;
 import java.util.Arrays;
@@ -79,6 +81,7 @@ public void refund(String sku) {
 
     @BeforeEach
     public void setup() throws Exception {
+        TestLogger.install();
         Field receiptsKeyField = Purchase.class.getDeclaredField("RECEIPTS_KEY");
         receiptsKeyField.setAccessible(true);
         receiptsKey = (String) receiptsKeyField.get(null);
@@ -131,6 +134,7 @@ public void tearDown() throws Exception {
         Field storageInstanceField = Storage.class.getDeclaredField("INSTANCE");
         storageInstanceField.setAccessible(true);
         storageInstanceField.set(null, originalStorageInstance);
+        TestLogger.remove();
     }
 
     private void resetPurchaseStatics() throws Exception {
@@ -175,7 +179,7 @@ public void testPostReceiptStoresPendingReceipt() {
     }
 
     @Test
-    public void testGetReceiptsLoadsFromStorageAndCaches() {
+    public void testGetReceiptsLoadsFromStorageAndCaches() throws IOException {
         List<Receipt> stored = new ArrayList<Receipt>();
         stored.add(createReceipt("basic", new Date(1000L), new Date(2000L)));
         Storage.getInstance().writeObject(receiptsKey, new ArrayList<Receipt>(stored));
@@ -203,6 +207,7 @@ public void testGetReceiptsReturnsEmptyListWhenStoredDataHasUnexpectedType() thr
         assertTrue(receipts.isEmpty(), "Unexpected data should clear cached receipts");
         assertEquals("bad-data", Storage.getInstance().readObject(receiptsKey),
                 "Storage contents should remain untouched when data cannot be cast");
+        assertEquals(1, TestLogger.getThrowables().size(), "An exception should have been logged");
         resetPurchaseStatics();
     }
 

maven/core-unittests/src/test/java/com/codename1/testing/TestReportingTest.java

@@ -2,6 +2,7 @@
 
 import com.codename1.impl.CodenameOneImplementation;
 import com.codename1.io.Util;
+import com.codename1.junit.TestLogger;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
@@ -24,6 +25,7 @@ class TestReportingTest {
 
     @BeforeEach
     void installImplementation() {
+        TestLogger.install();
         implementation = mock(CodenameOneImplementation.class);
         when(implementation.isInitialized()).thenReturn(true);
         when(implementation.handleEDTException(any(Throwable.class))).thenReturn(false);
@@ -34,6 +36,7 @@ void installImplementation() {
     void resetSingleton() {
         TestReporting.setInstance(null);
         Util.setImplementation(null);
+        TestLogger.remove();
     }
 
     @Test
@@ -51,6 +54,7 @@ void finishedTestCaseStoresResultsAndWritesReport() throws Exception {
         String report = new String(out.toByteArray(), "UTF-8");
         assertTrue(report.contains("alpha passed"));
         assertTrue(report.contains("beta failed"));
+        assertTrue(!TestLogger.getPrinted().isEmpty());
     }
 
     @Test

maven/core-unittests/src/test/java/com/codename1/testing/TestRunnerComponentTest.java

@@ -1,5 +1,6 @@
 package com.codename1.testing;
 
+import com.codename1.junit.TestLogger;
 import com.codename1.test.UITestBase;
 import com.codename1.ui.Button;
 import com.codename1.ui.Container;
@@ -67,6 +68,7 @@ void showFormCreatesAndReusesHostForm() {
 
     @Test
     void runTestsAddsFailureActionListenerOnException() throws Exception {
+        TestLogger.install();
         RuntimeException failure = new RuntimeException("explode");
         TestRunnerComponent component = new TestRunnerComponent();
         component.add(new SimpleTest("Explosive", true, true, failure));
@@ -90,6 +92,8 @@ void runTestsAddsFailureActionListenerOnException() throws Exception {
             }
         }
         assertTrue(found);
+        assertEquals(1, TestLogger.getThrowables().size());
+        TestLogger.remove();
     }
 
     private Container getResultsPane(TestRunnerComponent component) throws Exception {