Fix Gradle annotation processing configuration and update Doma plugin (#1336)

Author: nakamura-to

doma-processor/src/main/java/org/seasar/doma/internal/apt/DomaProcessor.java

@@ -74,7 +74,8 @@
   Options.METAMODEL_SUFFIX,
   Options.RESOURCES_DIR,
   Options.SQL_VALIDATION,
-  Options.TEST,
+  Options.TEST_INTEGRATION,
+  Options.TEST_UNIT,
   Options.TRACE,
   Options.VERSION_VALIDATION,
 })

doma-processor/src/main/java/org/seasar/doma/internal/apt/Options.java

@@ -32,7 +32,9 @@
 
 public final class Options {
 
-  public static final String TEST = "doma.test";
+  public static final String TEST_UNIT = "doma.test.unit";
+
+  public static final String TEST_INTEGRATION = "doma.test.integration";
 
   public static final String METAMODEL_ENABLED = "doma.metamodel.enabled";
 
@@ -106,7 +108,7 @@ private static Map<String, String> loadConfig(Resources resources, String path)
   }
 
   public boolean isTestEnabled() {
-    String test = getOption(TEST);
+    String test = getOption(TEST_UNIT);
     return Boolean.parseBoolean(test);
   }
 

doma-processor/src/main/java/org/seasar/doma/internal/apt/ProcessingContext.java

@@ -43,11 +43,31 @@ public void init() {
     moreElements = new MoreElements(this, env.getElementUtils());
     moreTypes = new MoreTypes(this, env.getTypeUtils());
     reporter = new Reporter(env.getMessager());
-    resources = new Resources(env.getFiler(), env.getOptions().get(Options.RESOURCES_DIR));
+    resources =
+        new Resources(
+            env.getFiler(),
+            reporter,
+            env.getOptions().get(Options.RESOURCES_DIR),
+            isRunningOnEclipse(env),
+            isDebug(env));
     options = new Options(env.getOptions(), resources);
     initialized = true;
   }
 
+  private boolean isRunningOnEclipse(ProcessingEnvironment env) {
+    var envClassName = env.getClass().getName();
+    var unitTest = env.getOptions().get(Options.TEST_UNIT);
+    var integrationTest = env.getOptions().get(Options.TEST_INTEGRATION);
+    return envClassName.startsWith("org.eclipse.")
+        && !Boolean.parseBoolean(unitTest)
+        && !Boolean.parseBoolean(integrationTest);
+  }
+
+  private boolean isDebug(ProcessingEnvironment env) {
+    var debug = env.getOptions().get(Options.DEBUG);
+    return Boolean.parseBoolean(debug);
+  }
+
   public RoundContext createRoundContext(
       Set<? extends TypeElement> annotationElements, RoundEnvironment roundEnvironment) {
     Objects.requireNonNull(annotationElements);

doma-processor/src/main/java/org/seasar/doma/internal/apt/Resources.java

@@ -32,12 +32,26 @@ public class Resources {
 
   private final Filer filer;
 
+  private final Reporter reporter;
+
   private final String resourcesDir;
 
-  Resources(Filer filer, String resourcesDir) {
-    assertNotNull(filer);
+  private final boolean isRunningOnEclipse;
+
+  private final boolean isDebug;
+
+  Resources(
+      Filer filer,
+      Reporter reporter,
+      String resourcesDir,
+      boolean isRunningOnEclipse,
+      boolean isDebug) {
+    assertNotNull(filer, reporter);
     this.filer = filer;
+    this.reporter = reporter;
     this.resourcesDir = resourcesDir;
+    this.isRunningOnEclipse = isRunningOnEclipse;
+    this.isDebug = isDebug;
   }
 
   public JavaFileObject createSourceFile(CharSequence name, Element... originatingElements)
@@ -47,11 +61,30 @@ public JavaFileObject createSourceFile(CharSequence name, Element... originating
 
   public FileObject getResource(String relativePath) throws IOException {
     assertNotNull(relativePath);
+
+    // Prefer the directory specified by the annotation processor option.
     if (resourcesDir != null) {
       Path path = Paths.get(resourcesDir, relativePath);
       return new FileObjectImpl(path);
     }
-    return filer.getResource(StandardLocation.CLASS_OUTPUT, "", relativePath);
+
+    // Since Eclipse doesn’t support SOURCE_PATH, use CLASS_OUTPUT.
+    if (isRunningOnEclipse) {
+      return filer.getResource(StandardLocation.CLASS_OUTPUT, "", relativePath);
+    }
+
+    // To leverage Gradle’s incremental annotation processing, we recommend using the --source-path
+    // option of javac.
+    try {
+      return filer.getResource(StandardLocation.SOURCE_PATH, "", relativePath);
+    } catch (Exception e) {
+      if (isDebug) {
+        reporter.debug(
+            "Fall back from SOURCE_PATH to CLASS_OUTPUT: " + relativePath + ", exception: " + e);
+      }
+      // If a file cannot be found in SOURCE_PATH, fall back to CLASS_OUTPUT.
+      return filer.getResource(StandardLocation.CLASS_OUTPUT, "", relativePath);
+    }
   }
 
   protected static class FileObjectImpl implements FileObject {

doma-processor/src/main/resources/META-INF/gradle/incremental.annotation.processors

@@ -1,8 +1 @@
-org.seasar.doma.internal.apt.processor.DomainProcessor,isolating
-org.seasar.doma.internal.apt.processor.DataTypeProcessor,isolating
-org.seasar.doma.internal.apt.processor.ExternalDomainProcessor,isolating
-org.seasar.doma.internal.apt.processor.DomainConvertersProcessor,isolating
-org.seasar.doma.internal.apt.processor.EmbeddableProcessor,isolating
-org.seasar.doma.internal.apt.processor.EntityProcessor,isolating
-org.seasar.doma.internal.apt.processor.DaoProcessor,isolating
-org.seasar.doma.internal.apt.processor.ScopeProcessor,isolating
+org.seasar.doma.internal.apt.DomaProcessor,isolating

doma-processor/src/test/java/org/seasar/doma/internal/apt/AptinaTestCase.java

@@ -111,8 +111,9 @@ class AptinaTestCase
 
   @Override
   public void beforeEach(ExtensionContext context) {
+    addOption("-Adoma.test.unit=true");
     addSourcePath("src/test/java");
-    addOption("-Adoma.resources.dir=src/test/resources");
+    addSourcePath("src/test/resources");
     charset = StandardCharsets.UTF_8;
     locale = Locale.ENGLISH;
     TimeZone.setDefault(TimeZone.getTimeZone("GMT+9"));

doma-processor/src/test/java/org/seasar/doma/internal/apt/processor/aggregate/AggregateStrategyProcessorTest.java

@@ -40,8 +40,6 @@ class AggregateStrategyProcessorTest extends AbstractCompilerTest {
 
   @BeforeEach
   void beforeEach() {
-    addOption("-Adoma.test=true");
-
     addProcessor(new DomaProcessor());
     addCompilationUnit(Emp.class);
     addCompilationUnit(Dept.class);

doma-processor/src/test/java/org/seasar/doma/internal/apt/processor/dao/DaoProcessorTest.java

@@ -48,8 +48,6 @@ class DaoProcessorTest extends AbstractCompilerTest {
 
   @BeforeEach
   void beforeEach() {
-    addOption("-Adoma.test=true");
-
     addProcessor(new DomaProcessor());
 
     // Add the dependent entities

doma-processor/src/test/java/org/seasar/doma/internal/apt/processor/dao/aggregate/AggregateStrategyTest.java

@@ -41,8 +41,6 @@ class AggregateStrategyTest extends AbstractCompilerTest {
 
   @BeforeEach
   void beforeEach() {
-    addOption("-Adoma.test=true");
-
     addProcessor(new DomaProcessor());
 
     // Add the dependent entities

doma-processor/src/test/java/org/seasar/doma/internal/apt/processor/dao/experimental/SqlTest.java

@@ -40,7 +40,6 @@ class SqlTest extends AbstractCompilerTest {
 
   @BeforeEach
   void beforeEach() {
-    addOption("-Adoma.test=true");
     addProcessor(new DomaProcessor());
   }