Add compilerArguments parameter to process-aot Maven goal

This commit adds a `compilerArguments` parameter to the Maven plugin `process-aot` and `process-test-aot` goals to allow the user to configure the command used to compile the AOT-generated sources. Fixes gh-33012
spring-projects · Nov 14, 2022 · 11652bd · 11652bd
1 parent 4e1efaa
commit 11652bd
Show file tree

Hide file tree

Showing 7 changed files with 220 additions and 4 deletions.
diff --git a/...ls/spring-boot-maven-plugin/src/intTest/java/org/springframework/boot/maven/AotTests.java b/...ls/spring-boot-maven-plugin/src/intTest/java/org/springframework/boot/maven/AotTests.java
@@ -16,6 +16,7 @@
 
 package org.springframework.boot.maven;
 
+import java.io.File;
 import java.io.IOException;
 import java.nio.file.Files;
 import java.nio.file.Path;
@@ -25,12 +26,14 @@
 import org.junit.jupiter.api.extension.ExtendWith;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.contentOf;
 
 /**
  * Integration tests for the Maven plugin's AOT support.
  *
  * @author Stephane Nicoll
  * @author Andy Wilkinson
+ * @author Scott Frederick
  */
 @ExtendWith(MavenBuildExtension.class)
 public class AotTests {
@@ -102,6 +105,21 @@ void whenAotRunsWithArgumentsSourcesAreGenerated(MavenBuild mavenBuild) {
 		});
 	}
 
+	@TestTemplate
+	void whenAotRunsWithJvmArgumentsSourcesAreGenerated(MavenBuild mavenBuild) {
+		mavenBuild.project("aot-jvm-arguments").goals("package").execute((project) -> {
+			Path aotDirectory = project.toPath().resolve("target/spring-aot/main");
+			assertThat(collectRelativePaths(aotDirectory.resolve("sources")))
+					.contains(Path.of("org", "test", "TestProfileConfiguration__BeanDefinitions.java"));
+		});
+	}
+
+	@TestTemplate
+	void whenAotRunsWithInvalidCompilerArgumentsCompileFails(MavenBuild mavenBuild) {
+		mavenBuild.project("aot-compiler-arguments").goals("package").executeAndFail(
+				(project) -> assertThat(buildLog(project)).contains("invalid flag: --invalid-compiler-arg"));
+	}
+
 	@TestTemplate
 	void whenAotRunsSourcesAreCompiled(MavenBuild mavenBuild) {
 		mavenBuild.project("aot").goals("package").execute((project) -> {
@@ -156,4 +174,8 @@ Stream<Path> collectRelativePaths(Path sourceDirectory) {
 		}
 	}
 
+	protected String buildLog(File project) {
+		return contentOf(new File(project, "target/build.log"));
+	}
+
 }
diff --git a/...g-boot-tools/spring-boot-maven-plugin/src/intTest/projects/aot-compiler-arguments/pom.xml b/...g-boot-tools/spring-boot-maven-plugin/src/intTest/projects/aot-compiler-arguments/pom.xml
@@ -0,0 +1,45 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+	<modelVersion>4.0.0</modelVersion>
+	<groupId>org.springframework.boot.maven.it</groupId>
+	<artifactId>aot</artifactId>
+	<version>0.0.1.BUILD-SNAPSHOT</version>
+	<properties>
+		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+		<maven.compiler.source>@java.version@</maven.compiler.source>
+		<maven.compiler.target>@java.version@</maven.compiler.target>
+	</properties>
+	<build>
+		<plugins>
+			<plugin>
+				<groupId>@project.groupId@</groupId>
+				<artifactId>@project.artifactId@</artifactId>
+				<version>@project.version@</version>
+				<executions>
+					<execution>
+						<goals>
+							<goal>process-aot</goal>
+						</goals>
+						<configuration>
+							<compilerArguments>-verbose --invalid-compiler-arg</compilerArguments>
+						</configuration>
+					</execution>
+				</executions>
+			</plugin>
+		</plugins>
+	</build>
+	<dependencies>
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot</artifactId>
+			<version>@project.version@</version>
+		</dependency>
+		<dependency>
+			<groupId>jakarta.servlet</groupId>
+			<artifactId>jakarta.servlet-api</artifactId>
+			<version>@jakarta-servlet.version@</version>
+			<scope>provided</scope>
+		</dependency>
+	</dependencies>
+</project>
diff --git a/...src/intTest/projects/aot-compiler-arguments/src/main/java/org/test/SampleApplication.java b/...src/intTest/projects/aot-compiler-arguments/src/main/java/org/test/SampleApplication.java
@@ -0,0 +1,30 @@
+/*
+ * Copyright 2012-2022 the original author or authors.
+ *
+ * Licensed 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
+ *
+ *      https://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.
+ */
+
+package org.test;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Import;
+
+@Configuration(proxyBeanMethods = false)
+public class SampleApplication {
+
+	public static void main(String[] args) {
+		SpringApplication.run(SampleApplication.class, args);
+	}
+
+}
diff --git a/...spring-boot-tools/spring-boot-maven-plugin/src/intTest/projects/aot-jvm-arguments/pom.xml b/...spring-boot-tools/spring-boot-maven-plugin/src/intTest/projects/aot-jvm-arguments/pom.xml
@@ -0,0 +1,45 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+	<modelVersion>4.0.0</modelVersion>
+	<groupId>org.springframework.boot.maven.it</groupId>
+	<artifactId>aot</artifactId>
+	<version>0.0.1.BUILD-SNAPSHOT</version>
+	<properties>
+		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+		<maven.compiler.source>@java.version@</maven.compiler.source>
+		<maven.compiler.target>@java.version@</maven.compiler.target>
+	</properties>
+	<build>
+		<plugins>
+			<plugin>
+				<groupId>@project.groupId@</groupId>
+				<artifactId>@project.artifactId@</artifactId>
+				<version>@project.version@</version>
+				<executions>
+					<execution>
+						<goals>
+							<goal>process-aot</goal>
+						</goals>
+						<configuration>
+							<jvmArguments>-Dspring.profiles.active=abc</jvmArguments>
+						</configuration>
+					</execution>
+				</executions>
+			</plugin>
+		</plugins>
+	</build>
+	<dependencies>
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot</artifactId>
+			<version>@project.version@</version>
+		</dependency>
+		<dependency>
+			<groupId>jakarta.servlet</groupId>
+			<artifactId>jakarta.servlet-api</artifactId>
+			<version>@jakarta-servlet.version@</version>
+			<scope>provided</scope>
+		</dependency>
+	</dependencies>
+</project>
diff --git a/...ugin/src/intTest/projects/aot-jvm-arguments/src/main/java/org/test/SampleApplication.java b/...ugin/src/intTest/projects/aot-jvm-arguments/src/main/java/org/test/SampleApplication.java
@@ -0,0 +1,31 @@
+/*
+ * Copyright 2012-2022 the original author or authors.
+ *
+ * Licensed 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
+ *
+ *      https://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.
+ */
+
+package org.test;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Import;
+
+@Configuration(proxyBeanMethods = false)
+@Import(TestProfileConfiguration.class)
+public class SampleApplication {
+
+	public static void main(String[] args) {
+		SpringApplication.run(SampleApplication.class, args);
+	}
+
+}
diff --git a/...c/intTest/projects/aot-jvm-arguments/src/main/java/org/test/TestProfileConfiguration.java b/...c/intTest/projects/aot-jvm-arguments/src/main/java/org/test/TestProfileConfiguration.java
@@ -0,0 +1,32 @@
+/*
+ * Copyright 2012-2022 the original author or authors.
+ *
+ * Licensed 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
+ *
+ *      https://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.
+ */
+
+package org.test;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Profile;
+
+@Configuration(proxyBeanMethods = false)
+@Profile("abc")
+class TestProfileConfiguration {
+
+	@Bean
+	public String abc() {
+		return "abc";
+	}
+
+}
diff --git a/...pring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/AbstractAotMojo.java b/...pring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/AbstractAotMojo.java
@@ -51,6 +51,7 @@
  * Abstract base class for AOT processing MOJOs.
  *
  * @author Phillip Webb
+ * @author Scott Frederick
  * @since 3.0.0
  */
 public abstract class AbstractAotMojo extends AbstractDependencyFilterMojo {
@@ -86,6 +87,13 @@ public abstract class AbstractAotMojo extends AbstractDependencyFilterMojo {
 	@Parameter(property = "spring-boot.aot.jvmArguments")
 	private String jvmArguments;
 
+	/**
+	 * Arguments that should be provided to the AOT compile process. On command line, make
+	 * sure to wrap multiple values between quotes.
+	 */
+	@Parameter(property = "spring-boot.aot.compilerArguments")
+	private String compilerArguments;
+
 	@Override
 	public void execute() throws MojoExecutionException, MojoFailureException {
 		if (this.skip) {
@@ -127,6 +135,7 @@ protected final void compileSourceFiles(URL[] classPath, File sourcesDirectory,
 			options.add(ClasspathBuilder.build(Arrays.asList(classPath)));
 			options.add("-d");
 			options.add(outputDirectory.toPath().toAbsolutePath().toString());
+			options.addAll(new RunArguments(this.compilerArguments).getArgs());
 			Iterable<? extends JavaFileObject> compilationUnits = fileManager.getJavaFileObjectsFromPaths(sourceFiles);
 			Errors errors = new Errors();
 			CompilationTask task = compiler.getTask(null, fileManager, errors, options, null, compilationUnits);
@@ -169,10 +178,12 @@ public void report(Diagnostic<? extends JavaFileObject> diagnostic) {
 			if (diagnostic.getKind() == Diagnostic.Kind.ERROR) {
 				this.message.append("\n");
 				this.message.append(diagnostic.getMessage(Locale.getDefault()));
-				this.message.append(" ");
-				this.message.append(diagnostic.getSource().getName());
-				this.message.append(" ");
-				this.message.append(diagnostic.getLineNumber()).append(":").append(diagnostic.getColumnNumber());
+				if (diagnostic.getSource() != null) {
+					this.message.append(" ");
+					this.message.append(diagnostic.getSource().getName());
+					this.message.append(" ");
+					this.message.append(diagnostic.getLineNumber()).append(":").append(diagnostic.getColumnNumber());
+				}
 			}
 		}