Better exception handling in reporters

Author: isidore

java/org/approvaltests/reporters/GenericDiffReporter.java

@@ -8,6 +8,7 @@
 
 public class GenericDiffReporter implements EnvironmentAwareReporter
 {
+  public static boolean      REPORT_MISSING_FILES  = false;
   protected String           diffProgram;
   protected String           arguments;
   protected String           diffProgramNotFoundMessage;
@@ -52,7 +53,16 @@ public String getCommandLine(String received, String approved)
   @Override
   public boolean isWorkingInThisEnvironment(String forFile)
   {
-    return new File(diffProgram).exists() && isFileExtensionHandled(forFile);
+    return checkFileExists() && isFileExtensionHandled(forFile);
+  }
+  public boolean checkFileExists()
+  {
+    boolean exists = new File(diffProgram).exists();
+    if (REPORT_MISSING_FILES && !exists)
+    {
+      System.out.println(String.format("%s can't find '%s'", this.getClass().getSimpleName(), diffProgram));
+    }
+    return exists;
   }
   public boolean isFileExtensionHandled(String forFile)
   {

java/org/approvaltests/reporters/MultiReporter.java

@@ -1,5 +1,6 @@
 package org.approvaltests.reporters;
 
+import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collection;
 
@@ -19,10 +20,19 @@ public MultiReporter(ApprovalFailureReporter... reporters)
   @Override
   public void report(String received, String approved) throws Exception
   {
+    ArrayList<Throwable> exceptions = new ArrayList<Throwable>();
     for (ApprovalFailureReporter reporter : reporters)
     {
-      reporter.report(received, approved);
+      try
+      {
+        reporter.report(received, approved);
+      }
+      catch (Throwable t)
+      {
+        exceptions.add(t);
+      }
     }
+    MultipleExceptions.rethrowExceptions(exceptions);
   }
   public ApprovalFailureReporter[] getReporters()
   {

java/org/approvaltests/reporters/MultipleExceptions.java

@@ -0,0 +1,43 @@
+package org.approvaltests.reporters;
+
+import java.util.ArrayList;
+
+public class MultipleExceptions extends RuntimeException
+{
+  private ArrayList<Throwable> exceptions;
+  public MultipleExceptions(ArrayList<Throwable> exceptions)
+  {
+    super(getText(exceptions), exceptions.get(0));
+    this.exceptions = exceptions;
+  }
+  public Throwable[] getExceptions()
+  {
+    return exceptions.toArray(new Throwable[0]);
+  }
+  public static void rethrowExceptions(ArrayList<Throwable> exceptions) throws Exception
+  {
+    if (exceptions.size() == 0)
+    {
+      return;
+    }
+    else if (exceptions.size() == 0)
+    {
+      Throwable t = exceptions.get(0);
+      if (t instanceof Exception) { throw ((Exception) t); }
+      throw (Error) t;
+    }
+    else
+    {
+      throw new MultipleExceptions(exceptions);
+    }
+  }
+  private static String getText(ArrayList<Throwable> exceptions)
+  {
+    StringBuffer b = new StringBuffer("Multiple Exceptions Thrown:");
+    for (int i = 0; i < exceptions.size(); i++)
+    {
+      b.append(String.format("\n #%s): %s", i + 1, exceptions.get(i).getMessage()));
+    }
+    return b.toString();
+  }
+}

java/org/approvaltests/reporters/tests/ReporterChainingTest.java

@@ -2,12 +2,28 @@
 
 import junit.framework.TestCase;
 
+import org.approvaltests.Approvals;
 import org.approvaltests.reporters.EnvironmentAwareReporter;
 import org.approvaltests.reporters.FirstWorkingReporter;
 import org.approvaltests.reporters.MultiReporter;
 
 public class ReporterChainingTest extends TestCase
 {
+  public static class ExceptionThrowingReporter implements EnvironmentAwareReporter
+  {
+    public boolean run = false;
+    @Override
+    public void report(String received, String approved) throws Exception
+    {
+      run = true;
+      throw new Error("Error");
+    }
+    @Override
+    public boolean isWorkingInThisEnvironment(String forFile)
+    {
+      return true;
+    }
+  }
   public static class NonWorkingReporter implements EnvironmentAwareReporter
   {
     @Override
@@ -54,4 +70,20 @@ public void testMultiReporter() throws Exception
     assertEquals("Hello", workingReporter.received);
     assertEquals("Hello", workingReporter2.received);
   }
+  public void testMultiReporterWithExceptions() throws Exception
+  {
+    ExceptionThrowingReporter exception1 = new ExceptionThrowingReporter();
+    ExceptionThrowingReporter exception2 = new ExceptionThrowingReporter();
+    MultiReporter reporter = new MultiReporter(exception1, exception2);
+    try
+    {
+      reporter.report("Hello", "world");
+    }
+    catch (Throwable t)
+    {
+      assertEquals(true, exception1.run);
+      assertEquals(true, exception2.run);
+      Approvals.verify(t.getMessage());
+    }
+  }
 }

java/org/approvaltests/reporters/tests/ReporterChainingTest.testMultiReporterWithExceptions.approved.txt

@@ -0,0 +1,3 @@
+Multiple Exceptions Thrown:
+ #1): Error
+ #2): Error

java/org/approvaltests/webpages/WebPageChangeDetector.java

@@ -19,11 +19,11 @@
 
 public class WebPageChangeDetector implements ActionListener
 {
-  private boolean                  keyPressed = false;
-  private URI                      url;
-  private boolean                  validUrl;
-  private Boolean                  filesMatched;
-  private WebPageChangeDetectorGui gui;
+  private boolean                 keyPressed = false;
+  private URI                     url;
+  private boolean                 validUrl;
+  private Boolean                 filesMatched;
+  public WebPageChangeDetectorGui gui;
   public WebPageChangeDetector()
   {
     gui = new WebPageChangeDetectorGui(this);

java/org/approvaltests/webpages/tests/WebPageTest.java

@@ -20,6 +20,6 @@ public void ptestWikipedia() throws Exception
   }
   public void testChangeDetectorUI() throws Exception
   {
-    Approvals.verify(new WebPageChangeDetector());
+    Approvals.verify(new WebPageChangeDetector().gui);
   }
 }