Respect CompilerConfiguration.sourceFiles in EclipseJavaCompiler (#233)

Just like JavacCompiler does, to avoid "FilerException: Source file already created" during annotation processing when running mvn without clean after changing code.
codehaus-plexus · Jul 15, 2022 · f0efd60 · f0efd60
1 parent e136e4c
commit f0efd60
Show file tree

Hide file tree

Showing 9 changed files with 269 additions and 51 deletions.
diff --git a/plexus-compiler-its/src/main/it/eclipse-compiler-mapstruct/invoker.properties b/plexus-compiler-its/src/main/it/eclipse-compiler-mapstruct/invoker.properties
@@ -0,0 +1,27 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+# 
+#   http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+invoker.java.version = 1.8+
+
+# without-dummy profile is used to have compiler plugin do actual compilation in the second run
+invoker.name.1 = Initial build
+invoker.goals.1 = clean compile -Pwithout-dummy
+invoker.buildResult.1 = success
+
+invoker.name.2 = Subsequent build without clean
+invoker.goals.2 = compile
+invoker.buildResult.2 = success
diff --git a/plexus-compiler-its/src/main/it/eclipse-compiler-mapstruct/pom.xml b/plexus-compiler-its/src/main/it/eclipse-compiler-mapstruct/pom.xml
@@ -0,0 +1,98 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ~ Licensed to the Apache Software Foundation (ASF) under one
+  ~ or more contributor license agreements.  See the NOTICE file
+  ~ distributed with this work for additional information
+  ~ regarding copyright ownership.  The ASF licenses this file
+  ~ to you under the Apache License, Version 2.0 (the
+  ~ "License"); you may not use this file except in compliance
+  ~ with the License.  You may obtain a copy of the License at
+  ~
+  ~   http://www.apache.org/licenses/LICENSE-2.0
+  ~
+  ~ Unless required by applicable law or agreed to in writing,
+  ~ software distributed under the License is distributed on an
+  ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+  ~ KIND, either express or implied.  See the License for the
+  ~ specific language governing permissions and limitations
+  ~ under the License.
+  -->
+
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+
+  <groupId>org.codehaus.plexus.compiler.it</groupId>
+  <artifactId>simple-javac</artifactId>
+  <version>1.0-SNAPSHOT</version>
+
+  <name>Test for default configuration</name>
+
+  <properties>
+    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
+    <maven.compiler.source>1.8</maven.compiler.source>
+    <maven.compiler.target>1.8</maven.compiler.target>
+
+    <org.mapstruct.version>1.5.2.Final</org.mapstruct.version>
+  </properties>
+
+  <dependencies>
+    <dependency>
+      <groupId>org.mapstruct</groupId>
+      <artifactId>mapstruct</artifactId>
+      <version>${org.mapstruct.version}</version>
+    </dependency>
+  </dependencies>
+
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-compiler-plugin</artifactId>
+        <version>3.10.1</version>
+        <configuration>
+          <compilerId>eclipse</compilerId>
+        </configuration>
+        <dependencies>
+          <dependency>
+            <groupId>org.codehaus.plexus</groupId>
+            <artifactId>plexus-compiler-api</artifactId>
+            <version>@pom.version@</version>
+          </dependency>
+          <dependency>
+            <groupId>org.codehaus.plexus</groupId>
+            <artifactId>plexus-compiler-eclipse</artifactId>
+            <version>@pom.version@</version>
+          </dependency>
+          <dependency>
+            <groupId>org.mapstruct</groupId>
+            <artifactId>mapstruct-processor</artifactId>
+            <version>${org.mapstruct.version}</version>
+          </dependency>
+        </dependencies>
+      </plugin>
+    </plugins>
+  </build>
+
+  <profiles>
+    <profile>
+      <id>without-dummy</id>
+      <build>
+        <plugins>
+          <plugin>
+            <groupId>org.apache.maven.plugins</groupId>
+            <artifactId>maven-compiler-plugin</artifactId>
+            <configuration>
+              <excludes>
+                <exclude>**/Dummy.java</exclude>
+              </excludes>
+            </configuration>
+          </plugin>
+        </plugins>
+      </build>
+    </profile>
+  </profiles>
+
+</project>
diff --git a/plexus-compiler-its/src/main/it/eclipse-compiler-mapstruct/src/main/java/Car.java b/plexus-compiler-its/src/main/it/eclipse-compiler-mapstruct/src/main/java/Car.java
@@ -0,0 +1,24 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ * 
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+public class Car
+{
+    public String make;
+    public int numberOfSeats;
+}
diff --git a/plexus-compiler-its/src/main/it/eclipse-compiler-mapstruct/src/main/java/CarDto.java b/plexus-compiler-its/src/main/it/eclipse-compiler-mapstruct/src/main/java/CarDto.java
@@ -0,0 +1,24 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ * 
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+public class CarDto
+{
+    public String make;
+    public int seatCount;
+}
diff --git a/plexus-compiler-its/src/main/it/eclipse-compiler-mapstruct/src/main/java/CarMapper.java b/plexus-compiler-its/src/main/it/eclipse-compiler-mapstruct/src/main/java/CarMapper.java
@@ -0,0 +1,32 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ * 
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import org.mapstruct.Mapper;
+import org.mapstruct.Mapping;
+import org.mapstruct.factory.Mappers;
+
+@Mapper
+public interface CarMapper
+{
+
+    CarMapper INSTANCE = Mappers.getMapper( CarMapper.class );
+
+    @Mapping( source = "numberOfSeats", target = "seatCount" )
+    CarDto carToCarDto( Car car );
+}
diff --git a/plexus-compiler-its/src/main/it/eclipse-compiler-mapstruct/src/main/java/Dummy.java b/plexus-compiler-its/src/main/it/eclipse-compiler-mapstruct/src/main/java/Dummy.java
@@ -0,0 +1,23 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ * 
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+public class Dummy
+{
+
+}
diff --git a/plexus-compiler-its/src/main/it/eclipse-compiler-mapstruct/verify.groovy b/plexus-compiler-its/src/main/it/eclipse-compiler-mapstruct/verify.groovy
@@ -0,0 +1,26 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+def mapperImplClass = new File( basedir, "target/classes/CarMapperImpl.class" )
+assert mapperImplClass.exists()
+
+def dummyClass = new File( basedir, "target/classes/Dummy.class" )
+assert dummyClass.exists()
+
+File buildLog = new File( basedir, 'build.log' )
+assert buildLog.text.count( "Changes detected - recompiling the module!" ) == 2
diff --git a/...piler-eclipse/src/main/java/org/codehaus/plexus/compiler/eclipse/EclipseJavaCompiler.java b/...piler-eclipse/src/main/java/org/codehaus/plexus/compiler/eclipse/EclipseJavaCompiler.java
@@ -37,15 +37,12 @@
 import java.nio.charset.IllegalCharsetNameException;
 import java.nio.charset.UnsupportedCharsetException;
 import java.util.ArrayList;
-import java.util.HashSet;
+import java.util.Arrays;
 import java.util.Iterator;
-import java.util.LinkedHashSet;
 import java.util.List;
 import java.util.Locale;
 import java.util.Map.Entry;
 import java.util.ServiceLoader;
-import java.util.Set;
-
 import org.codehaus.plexus.compiler.AbstractCompiler;
 import org.codehaus.plexus.compiler.Compiler;
 import org.codehaus.plexus.compiler.CompilerConfiguration;
@@ -54,7 +51,6 @@
 import org.codehaus.plexus.compiler.CompilerOutputStyle;
 import org.codehaus.plexus.compiler.CompilerResult;
 import org.codehaus.plexus.component.annotations.Component;
-import org.codehaus.plexus.util.DirectoryScanner;
 import org.codehaus.plexus.util.StringUtils;
 import org.eclipse.jdt.core.compiler.CompilationProgress;
 import org.eclipse.jdt.core.compiler.batch.BatchCompiler;
@@ -169,14 +165,12 @@ public CompilerResult performCompile( CompilerConfiguration config )
         args.add( config.getOutputLocation() );
 
         // Annotation processors defined?
-        List<String> extraSourceDirs = new ArrayList<>();
         if ( !isPreJava1_6( config ) )
         {
             File generatedSourcesDir = config.getGeneratedSourcesDirectory();
             if ( generatedSourcesDir != null )
             {
                 generatedSourcesDir.mkdirs();
-                extraSourceDirs.add( generatedSourcesDir.getAbsolutePath() );
 
                 //-- option to specify where annotation processor is to generate its output
                 args.add( "-s" );
@@ -247,24 +241,7 @@ public CompilerResult performCompile( CompilerConfiguration config )
         }
 
         // Collect sources
-        Set<String> allSources = new HashSet<>();
-        for ( String source : config.getSourceLocations() )
-        {
-            File srcFile = new File( source );
-            if ( srcFile.exists() )
-            {
-                Set<String> ss = getSourceFilesForSourceRoot( config, source );
-                allSources.addAll( ss );
-            }
-        }
-        for ( String extraSrcDir : extraSourceDirs )
-        {
-            File extraDir = new File( extraSrcDir );
-            if ( extraDir.isDirectory() )
-            {
-                addExtraSources( extraDir, allSources );
-            }
-        }
+        List<String> allSources = Arrays.asList( getSourceFiles( config ) );
         List<CompilerMessage> messageList = new ArrayList<>();
         if ( allSources.isEmpty() )
         {
@@ -504,9 +481,9 @@ static boolean isReplaceProcessorPath( CompilerConfiguration config )
         return false;
     }
 
-    static Set<String> resortSourcesToPutModuleInfoFirst( Set<String> allSources )
+    static List<String> resortSourcesToPutModuleInfoFirst( List<String> allSources )
     {
-        Set<String> resorted = new LinkedHashSet<>( allSources.size() );
+        List<String> resorted = new ArrayList<>( allSources.size() );
 
         for ( String mi : allSources )
         {
@@ -654,18 +631,6 @@ private JavaCompiler getEcj()
         return null;
     }
 
-    private void addExtraSources( File dir, Set<String> allSources )
-    {
-        DirectoryScanner scanner = new DirectoryScanner();
-        scanner.setBasedir( dir.getAbsolutePath() );
-        scanner.setIncludes( new String[]{ "**/*.java" } );
-        scanner.scan();
-        for ( String file : scanner.getIncludedFiles() )
-        {
-            allSources.add( new File( dir, file ).getAbsolutePath() );
-        }
-    }
-
     private CompilerMessage.Kind convert( Diagnostic.Kind kind )
     {
         if ( kind == null )