Improve error handling in annotation processing

Author: nakamura-to

src/main/java/org/seasar/doma/internal/apt/AptTypeHandleException.java

@@ -1,5 +1,8 @@
 package org.seasar.doma.internal.apt.processor;
 
+import java.io.PrintWriter;
+import java.io.StringWriter;
+import java.io.Writer;
 import java.lang.annotation.Annotation;
 import java.util.function.Consumer;
 import javax.annotation.processing.ProcessingEnvironment;
@@ -47,13 +50,17 @@ protected void handleTypeElement(TypeElement typeElement, Consumer<TypeElement>
       ctx.getNotifier().notify(e);
     } catch (AptIllegalOptionException e) {
       ctx.getNotifier().notify(Kind.ERROR, e.getMessage(), typeElement);
-      throw new AptTypeHandleException(typeElement, e);
+      throw e;
     } catch (AptIllegalStateException e) {
-      ctx.getNotifier().notify(Kind.ERROR, Message.DOMA4039, typeElement, new Object[] {});
-      throw new AptTypeHandleException(typeElement, e);
-    } catch (RuntimeException e) {
-      ctx.getNotifier().notify(Kind.ERROR, Message.DOMA4016, typeElement, new Object[] {});
-      throw new AptTypeHandleException(typeElement, e);
+      String stackTrace = getStackTraceAsString(e);
+      ctx.getNotifier()
+          .notify(Kind.ERROR, Message.DOMA4039, typeElement, new Object[] {stackTrace});
+      throw e;
+    } catch (RuntimeException | AssertionError e) {
+      String stackTrace = getStackTraceAsString(e);
+      ctx.getNotifier()
+          .notify(Kind.ERROR, Message.DOMA4016, typeElement, new Object[] {stackTrace});
+      throw e;
     }
     if (ctx.getOptions().isDebugEnabled()) {
       ctx.getNotifier()
@@ -62,4 +69,10 @@ protected void handleTypeElement(TypeElement typeElement, Consumer<TypeElement>
               new Object[] {getClass().getName(), typeElement.getQualifiedName()});
     }
   }
+
+  private String getStackTraceAsString(Throwable throwable) {
+    Writer stringWriter = new StringWriter();
+    throwable.printStackTrace(new PrintWriter(stringWriter));
+    return stringWriter.toString();
+  }
 }

src/main/java/org/seasar/doma/internal/apt/processor/AbstractProcessor.java

@@ -278,7 +278,7 @@ public enum Message implements MessageResource {
   DOMA4014("Cannot annotate @Dao to anything but interfaces."),
   DOMA4015("Cannot annotate @Entity to anything but classes."),
   DOMA4016(
-      "An unexpected error has occurred. Check the logs for more information. For example, if you use Eclipse, see the error log view."),
+      "An unexpected error has occurred. It may be a bug in the Doma framework. Report the following stacktrace: {0}"),
   DOMA4017("The Dao interface must be a top level interface."),
   DOMA4019("The file[{0}] is not found from the classpath. The absolute path is \"{1}\"."),
   DOMA4020("The SQL file[{0}] is empty."),
@@ -301,7 +301,7 @@ public enum Message implements MessageResource {
   DOMA4038(
       "The type argument[{1}] of EntityListener[{0}] must be supertype of the entity class[{2}]."),
   DOMA4039(
-      "The annotation processing is stopped because of compilation error. Check the error message from the execution environment such as Eclipse and javac."),
+      "The annotation processing is stopped because of compilation error. Check the error message from your execution environment such as Eclipse and javac. Stacktrace: {0}"),
   DOMA4040("The return type must be the array of int that indicates the affected rows count."),
   DOMA4042("The parameter type must be the subtype of java.lang.Iterable."),
   DOMA4043("The type argument of the subtype of java.lang.Iterable must be the entity class."),
@@ -614,8 +614,6 @@ public enum Message implements MessageResource {
   DOMA4298(
       "The class[{0}] is not supported as a persistent type. If you intend to map the class to the external domain class with @ExternalDomain, the configuration may be not enough. Check the class that is annotated with @DomainConverters and the annotation processing option \"doma.domain.converters\"."),
   DOMA4299("The raw type of the class[{0}] cannot be used as a persistent property."),
-  DOMA4300(
-      "The annotation processing for the type[{0}] is failed. Are there any compilation errors that are unrelated to the annotation processing?"),
   DOMA4301(
       "The type argument of the class[{0}] that is a wildcard or type variable cannot be used as a persistent property."),
   DOMA4302("@Id cannot be annotated to the property whose type is annotated with @Embeddable."),

src/main/java/org/seasar/doma/message/Message.java

@@ -197,6 +197,8 @@ public abstract class AptinaTestCase extends TestCase {
 
   Boolean compiledResult;
 
+  boolean compilationAssertion = true;
+
   /** インスタンスを構築します． */
   protected AptinaTestCase() {}
 
@@ -220,6 +222,14 @@ protected void tearDown() throws Exception {
     super.tearDown();
   }
 
+  protected void enableCompilationAssertion() {
+    this.compilationAssertion = true;
+  }
+
+  protected void disableCompilationAssertion() {
+    this.compilationAssertion = false;
+  }
+
   /**
    * ロケールを返します．
    *
@@ -1042,7 +1052,7 @@ List<JavaFileObject> getCompilationUnits() throws IOException {
    * @throws IllegalStateException {@link #compile()} が呼び出されていない場合
    */
   void assertCompiled() throws IllegalStateException {
-    if (compiledResult == null) {
+    if (compilationAssertion && compiledResult == null) {
       throw new IllegalStateException("not compiled");
     }
   }

src/test/java/org/seasar/aptina/unit/AptinaTestCase.java

@@ -0,0 +1,70 @@
+package org.seasar.doma.internal.apt.processor.error;
+
+import org.seasar.doma.internal.apt.AptIllegalStateException;
+import org.seasar.doma.internal.apt.AptTestCase;
+import org.seasar.doma.message.Message;
+
+public class AbstractProcessorTest extends AptTestCase {
+
+  @Override
+  protected void setUp() throws Exception {
+    super.setUp();
+    disableCompilationAssertion();
+    addSourcePath("src/main/java");
+    addSourcePath("src/test/java");
+  }
+
+  @Override
+  protected void tearDown() throws Exception {
+    enableCompilationAssertion();
+    super.tearDown();
+  }
+
+  public void testAptIllegalStateException() throws Exception {
+    Class<?> target = Person.class;
+    addCompilationUnit(target);
+    addProcessor(
+        new MyProcessor(
+            __ -> {
+              throw new AptIllegalStateException("hoge");
+            }));
+    try {
+      compile();
+      fail();
+    } catch (Exception ignored) {
+    }
+    assertMessage(Message.DOMA4039);
+  }
+
+  public void testRuntimeException() throws Exception {
+    Class<?> target = Person.class;
+    addCompilationUnit(target);
+    addProcessor(
+        new MyProcessor(
+            __ -> {
+              throw new NullPointerException("hoge");
+            }));
+    try {
+      compile();
+      fail();
+    } catch (Exception ignored) {
+    }
+    assertMessage(Message.DOMA4016);
+  }
+
+  public void testAssertionError() throws Exception {
+    Class<?> target = Person.class;
+    addCompilationUnit(target);
+    addProcessor(
+        new MyProcessor(
+            __ -> {
+              throw new AssertionError("hoge");
+            }));
+    try {
+      compile();
+      fail();
+    } catch (Exception ignored) {
+    }
+    assertMessage(Message.DOMA4016);
+  }
+}

src/test/java/org/seasar/doma/internal/apt/processor/error/AbstractProcessorTest.java

@@ -0,0 +1,3 @@
+package org.seasar.doma.internal.apt.processor.error;
+
+public @interface MyAnnotation {}

src/test/java/org/seasar/doma/internal/apt/processor/error/MyAnnotation.java

@@ -0,0 +1,33 @@
+package org.seasar.doma.internal.apt.processor.error;
+
+import java.util.Set;
+import java.util.function.Consumer;
+import javax.annotation.processing.RoundEnvironment;
+import javax.annotation.processing.SupportedAnnotationTypes;
+import javax.lang.model.element.TypeElement;
+import javax.lang.model.util.ElementFilter;
+import org.seasar.doma.internal.apt.processor.AbstractProcessor;
+
+@SupportedAnnotationTypes({"org.seasar.doma.internal.apt.processor.error.MyAnnotation"})
+public class MyProcessor extends AbstractProcessor {
+
+  private final Consumer<TypeElement> handler;
+
+  protected MyProcessor(Consumer<TypeElement> handler) {
+    super(MyAnnotation.class);
+    this.handler = handler;
+  }
+
+  @Override
+  public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
+    if (roundEnv.processingOver()) {
+      return true;
+    }
+    for (TypeElement a : annotations) {
+      for (TypeElement t : ElementFilter.typesIn(roundEnv.getElementsAnnotatedWith(a))) {
+        handleTypeElement(t, handler);
+      }
+    }
+    return true;
+  }
+}

src/test/java/org/seasar/doma/internal/apt/processor/error/MyProcessor.java

@@ -0,0 +1,4 @@
+package org.seasar.doma.internal.apt.processor.error;
+
+@MyAnnotation
+public class Person {}