Merge #31682
* gh-31682: Reuse JavaProcessExecutor Reuse SpringApplicationClassFinder Remove AbstractApplicationRunMojo intermediate layer Extract AotGenerateMojo to its own structure Closes gh-31682pull/31928/head
Stephane Nicoll
2 years ago
commit
04c7cb15ce
@ -1,144 +0,0 @@
|
||||
/*
|
||||
* 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.springframework.boot.maven;
|
||||
|
||||
import java.io.File;
|
||||
import java.io.IOException;
|
||||
import java.net.URL;
|
||||
import java.util.ArrayList;
|
||||
import java.util.Arrays;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
|
||||
import org.apache.maven.model.Resource;
|
||||
import org.apache.maven.plugin.MojoExecutionException;
|
||||
import org.apache.maven.plugin.MojoFailureException;
|
||||
import org.apache.maven.plugins.annotations.Parameter;
|
||||
import org.apache.maven.shared.artifact.filter.collection.FilterArtifacts;
|
||||
|
||||
import org.springframework.boot.loader.tools.FileUtils;
|
||||
|
||||
/**
|
||||
* Base class to run a spring application.
|
||||
*
|
||||
* @author Phillip Webb
|
||||
* @author Stephane Nicoll
|
||||
* @author David Liu
|
||||
* @author Daniel Young
|
||||
* @author Dmytro Nosan
|
||||
* @since 3.0.0
|
||||
* @see RunMojo
|
||||
* @see StartMojo
|
||||
*/
|
||||
public abstract class AbstractApplicationRunMojo extends AbstractRunMojo {
|
||||
|
||||
/**
|
||||
* Add maven resources to the classpath directly, this allows live in-place editing of
|
||||
* resources. Duplicate resources are removed from {@code target/classes} to prevent
|
||||
* them to appear twice if {@code ClassLoader.getResources()} is called. Please
|
||||
* consider adding {@code spring-boot-devtools} to your project instead as it provides
|
||||
* this feature and many more.
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@Parameter(property = "spring-boot.run.addResources", defaultValue = "false")
|
||||
private boolean addResources = false;
|
||||
|
||||
/**
|
||||
* Path to agent jars. NOTE: a forked process is required to use this feature.
|
||||
* @since 2.2.0
|
||||
*/
|
||||
@Parameter(property = "spring-boot.run.agents")
|
||||
private File[] agents;
|
||||
|
||||
/**
|
||||
* Flag to say that the agent requires -noverify.
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@Parameter(property = "spring-boot.run.noverify")
|
||||
private boolean noverify = false;
|
||||
|
||||
/**
|
||||
* Flag to include the test classpath when running.
|
||||
* @since 1.3.0
|
||||
*/
|
||||
@Parameter(property = "spring-boot.run.useTestClasspath", defaultValue = "false")
|
||||
private Boolean useTestClasspath;
|
||||
|
||||
@Override
|
||||
protected void run(File workingDirectory, String startClassName, Map<String, String> environmentVariables)
|
||||
throws MojoExecutionException, MojoFailureException {
|
||||
List<String> args = new ArrayList<>();
|
||||
addAgents(args);
|
||||
addJvmArgs(args);
|
||||
addClasspath(args);
|
||||
args.add(startClassName);
|
||||
addArgs(args);
|
||||
run(workingDirectory, args, environmentVariables);
|
||||
}
|
||||
|
||||
/**
|
||||
* Run with a forked VM, using the specified command line arguments.
|
||||
* @param workingDirectory the working directory of the forked JVM
|
||||
* @param args the arguments (JVM arguments and application arguments)
|
||||
* @param environmentVariables the environment variables
|
||||
* @throws MojoExecutionException in case of MOJO execution errors
|
||||
* @throws MojoFailureException in case of MOJO failures
|
||||
*/
|
||||
protected abstract void run(File workingDirectory, List<String> args, Map<String, String> environmentVariables)
|
||||
throws MojoExecutionException, MojoFailureException;
|
||||
|
||||
@Override
|
||||
protected URL[] getClassPathUrls() throws MojoExecutionException {
|
||||
try {
|
||||
List<URL> urls = new ArrayList<>();
|
||||
addUserDefinedDirectories(urls);
|
||||
addResources(urls);
|
||||
addProjectClasses(urls);
|
||||
FilterArtifacts filters = (this.useTestClasspath ? getFilters() : getFilters(new TestArtifactFilter()));
|
||||
addDependencies(urls, filters);
|
||||
return urls.toArray(new URL[0]);
|
||||
}
|
||||
catch (IOException ex) {
|
||||
throw new MojoExecutionException("Unable to build classpath", ex);
|
||||
}
|
||||
}
|
||||
|
||||
private void addAgents(List<String> args) {
|
||||
if (this.agents != null) {
|
||||
if (getLog().isInfoEnabled()) {
|
||||
getLog().info("Attaching agents: " + Arrays.asList(this.agents));
|
||||
}
|
||||
for (File agent : this.agents) {
|
||||
args.add("-javaagent:" + agent);
|
||||
}
|
||||
}
|
||||
if (this.noverify) {
|
||||
args.add("-noverify");
|
||||
}
|
||||
}
|
||||
|
||||
private void addResources(List<URL> urls) throws IOException {
|
||||
if (this.addResources) {
|
||||
for (Resource resource : this.project.getResources()) {
|
||||
File directory = new File(resource.getDirectory());
|
||||
urls.add(directory.toURI().toURL());
|
||||
FileUtils.removeDuplicatesFromOutputDirectory(this.classesDirectory, directory);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,135 @@
|
||||
/*
|
||||
* 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.springframework.boot.maven;
|
||||
|
||||
import java.io.File;
|
||||
import java.net.URISyntaxException;
|
||||
import java.net.URL;
|
||||
import java.util.ArrayList;
|
||||
import java.util.Arrays;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import java.util.Objects;
|
||||
|
||||
/**
|
||||
* Helper class to build the command-line arguments of a java process.
|
||||
*
|
||||
* @author Stephane Nicoll
|
||||
*/
|
||||
final class CommandLineBuilder {
|
||||
|
||||
private final List<String> options = new ArrayList<>();
|
||||
|
||||
private final List<URL> classpathElements = new ArrayList<>();
|
||||
|
||||
private final String mainClass;
|
||||
|
||||
private final List<String> arguments = new ArrayList<>();
|
||||
|
||||
private CommandLineBuilder(String mainClass) {
|
||||
this.mainClass = mainClass;
|
||||
}
|
||||
|
||||
static CommandLineBuilder forMainClass(String mainClass) {
|
||||
return new CommandLineBuilder(mainClass);
|
||||
}
|
||||
|
||||
CommandLineBuilder withJvmArguments(String... jvmArguments) {
|
||||
if (jvmArguments != null) {
|
||||
this.options.addAll(Arrays.stream(jvmArguments).filter(Objects::nonNull).toList());
|
||||
}
|
||||
return this;
|
||||
}
|
||||
|
||||
CommandLineBuilder withSystemProperties(Map<String, String> systemProperties) {
|
||||
if (systemProperties != null) {
|
||||
systemProperties.entrySet().stream().map((e) -> SystemPropertyFormatter.format(e.getKey(), e.getValue()))
|
||||
.forEach(this.options::add);
|
||||
}
|
||||
return this;
|
||||
}
|
||||
|
||||
CommandLineBuilder withClasspath(URL... elements) {
|
||||
this.classpathElements.addAll(Arrays.asList(elements));
|
||||
return this;
|
||||
}
|
||||
|
||||
CommandLineBuilder withArguments(String... arguments) {
|
||||
if (arguments != null) {
|
||||
this.arguments.addAll(Arrays.stream(arguments).filter(Objects::nonNull).toList());
|
||||
}
|
||||
return this;
|
||||
}
|
||||
|
||||
List<String> build() {
|
||||
List<String> commandLine = new ArrayList<>();
|
||||
if (!this.options.isEmpty()) {
|
||||
commandLine.addAll(this.options);
|
||||
}
|
||||
if (!this.classpathElements.isEmpty()) {
|
||||
commandLine.add("-cp");
|
||||
commandLine.add(ClasspathBuilder.build(this.classpathElements));
|
||||
}
|
||||
commandLine.add(this.mainClass);
|
||||
if (!this.arguments.isEmpty()) {
|
||||
commandLine.addAll(this.arguments);
|
||||
}
|
||||
return commandLine;
|
||||
}
|
||||
|
||||
static class ClasspathBuilder {
|
||||
|
||||
static String build(List<URL> classpathElements) {
|
||||
StringBuilder classpath = new StringBuilder();
|
||||
for (URL element : classpathElements) {
|
||||
if (classpath.length() > 0) {
|
||||
classpath.append(File.pathSeparator);
|
||||
}
|
||||
classpath.append(toFile(element));
|
||||
}
|
||||
return classpath.toString();
|
||||
}
|
||||
|
||||
private static File toFile(URL element) {
|
||||
try {
|
||||
return new File(element.toURI());
|
||||
}
|
||||
catch (URISyntaxException ex) {
|
||||
throw new IllegalArgumentException(ex);
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* Format System properties.
|
||||
*/
|
||||
private static class SystemPropertyFormatter {
|
||||
|
||||
static String format(String key, String value) {
|
||||
if (key == null) {
|
||||
return "";
|
||||
}
|
||||
if (value == null || value.isEmpty()) {
|
||||
return String.format("-D%s", key);
|
||||
}
|
||||
return String.format("-D%s=\"%s\"", key, value);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,102 @@
|
||||
/*
|
||||
* 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.springframework.boot.maven;
|
||||
|
||||
import java.io.File;
|
||||
import java.io.IOException;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import java.util.function.Consumer;
|
||||
|
||||
import org.apache.maven.execution.MavenSession;
|
||||
import org.apache.maven.plugin.MojoExecutionException;
|
||||
import org.apache.maven.toolchain.Toolchain;
|
||||
import org.apache.maven.toolchain.ToolchainManager;
|
||||
|
||||
import org.springframework.boot.loader.tools.JavaExecutable;
|
||||
import org.springframework.boot.loader.tools.RunProcess;
|
||||
|
||||
/**
|
||||
* Ease the execution of a Java process using Maven's toolchain support.
|
||||
*
|
||||
* @author Stephane Nicoll
|
||||
*/
|
||||
class JavaProcessExecutor {
|
||||
|
||||
private static final int EXIT_CODE_SIGINT = 130;
|
||||
|
||||
private final MavenSession mavenSession;
|
||||
|
||||
private final ToolchainManager toolchainManager;
|
||||
|
||||
private final Consumer<RunProcess> runProcessCustomizer;
|
||||
|
||||
JavaProcessExecutor(MavenSession mavenSession, ToolchainManager toolchainManager) {
|
||||
this(mavenSession, toolchainManager, null);
|
||||
}
|
||||
|
||||
private JavaProcessExecutor(MavenSession mavenSession, ToolchainManager toolchainManager,
|
||||
Consumer<RunProcess> runProcessCustomizer) {
|
||||
this.mavenSession = mavenSession;
|
||||
this.toolchainManager = toolchainManager;
|
||||
this.runProcessCustomizer = runProcessCustomizer;
|
||||
}
|
||||
|
||||
JavaProcessExecutor withRunProcessCustomizer(Consumer<RunProcess> customizer) {
|
||||
Consumer<RunProcess> combinedCustomizer = (this.runProcessCustomizer != null)
|
||||
? this.runProcessCustomizer.andThen(customizer) : customizer;
|
||||
return new JavaProcessExecutor(this.mavenSession, this.toolchainManager, combinedCustomizer);
|
||||
}
|
||||
|
||||
int run(File workingDirectory, List<String> args, Map<String, String> environmentVariables)
|
||||
throws MojoExecutionException {
|
||||
RunProcess runProcess = new RunProcess(workingDirectory, getJavaExecutable());
|
||||
try {
|
||||
int exitCode = runProcess.run(true, args, environmentVariables);
|
||||
if (!hasTerminatedSuccessfully(exitCode)) {
|
||||
throw new MojoExecutionException("Process terminated with exit code: " + exitCode);
|
||||
}
|
||||
return exitCode;
|
||||
}
|
||||
catch (IOException ex) {
|
||||
throw new MojoExecutionException("Process execution failed", ex);
|
||||
}
|
||||
}
|
||||
|
||||
RunProcess runAsync(File workingDirectory, List<String> args, Map<String, String> environmentVariables)
|
||||
throws MojoExecutionException {
|
||||
try {
|
||||
RunProcess runProcess = new RunProcess(workingDirectory, getJavaExecutable());
|
||||
runProcess.run(false, args, environmentVariables);
|
||||
return runProcess;
|
||||
}
|
||||
catch (IOException ex) {
|
||||
throw new MojoExecutionException("Process execution failed", ex);
|
||||
}
|
||||
}
|
||||
|
||||
private boolean hasTerminatedSuccessfully(int exitCode) {
|
||||
return (exitCode == 0 || exitCode == EXIT_CODE_SIGINT);
|
||||
}
|
||||
|
||||
private String getJavaExecutable() {
|
||||
Toolchain toolchain = this.toolchainManager.getToolchainFromBuildContext("jdk", this.mavenSession);
|
||||
String javaExecutable = (toolchain != null) ? toolchain.findTool("java") : null;
|
||||
return (javaExecutable != null) ? javaExecutable : new JavaExecutable().toString();
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,50 @@
|
||||
/*
|
||||
* 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.springframework.boot.maven;
|
||||
|
||||
import java.io.File;
|
||||
import java.io.IOException;
|
||||
|
||||
import org.apache.maven.plugin.MojoExecutionException;
|
||||
|
||||
import org.springframework.boot.loader.tools.MainClassFinder;
|
||||
|
||||
/**
|
||||
* Find a single Spring Boot Application class match based on directory.
|
||||
*
|
||||
* @author Stephane Nicoll
|
||||
* @see MainClassFinder
|
||||
*/
|
||||
abstract class SpringBootApplicationClassFinder {
|
||||
|
||||
private static final String SPRING_BOOT_APPLICATION_CLASS_NAME = "org.springframework.boot.autoconfigure.SpringBootApplication";
|
||||
|
||||
static String findSingleClass(File classesDirectory) throws MojoExecutionException {
|
||||
try {
|
||||
String mainClass = MainClassFinder.findSingleMainClass(classesDirectory,
|
||||
SPRING_BOOT_APPLICATION_CLASS_NAME);
|
||||
if (mainClass != null) {
|
||||
return mainClass;
|
||||
}
|
||||
throw new MojoExecutionException("Unable to find a suitable main class, please add a 'mainClass' property");
|
||||
}
|
||||
catch (IOException ex) {
|
||||
throw new MojoExecutionException(ex.getMessage(), ex);
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,78 @@
|
||||
/*
|
||||
* 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.springframework.boot.maven;
|
||||
|
||||
import java.util.Map;
|
||||
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import org.springframework.boot.maven.sample.ClassWithMainMethod;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
|
||||
/**
|
||||
* Tests for {@link CommandLineBuilder}.
|
||||
*
|
||||
* @author Stephane Nicoll
|
||||
*/
|
||||
class CommandLineBuilderTests {
|
||||
|
||||
public static final String CLASS_NAME = ClassWithMainMethod.class.getName();
|
||||
|
||||
@Test
|
||||
void buildWithNullJvmArgumentsIsIgnored() {
|
||||
assertThat(CommandLineBuilder.forMainClass(CLASS_NAME).withJvmArguments((String[]) null).build())
|
||||
.containsExactly(CLASS_NAME);
|
||||
}
|
||||
|
||||
@Test
|
||||
void buildWithNullIntermediateJvmArgumentIsIgnored() {
|
||||
assertThat(CommandLineBuilder.forMainClass(CLASS_NAME).withJvmArguments("-verbose:class", null, "-verbose:gc")
|
||||
.build()).containsExactly("-verbose:class", "-verbose:gc", CLASS_NAME);
|
||||
}
|
||||
|
||||
@Test
|
||||
void buildWithJvmArgument() {
|
||||
assertThat(CommandLineBuilder.forMainClass(CLASS_NAME).withJvmArguments("-verbose:class").build())
|
||||
.containsExactly("-verbose:class", CLASS_NAME);
|
||||
}
|
||||
|
||||
@Test
|
||||
void buildWithNullSystemPropertyIsIgnored() {
|
||||
assertThat(CommandLineBuilder.forMainClass(CLASS_NAME).withSystemProperties(null).build())
|
||||
.containsExactly(CLASS_NAME);
|
||||
}
|
||||
|
||||
@Test
|
||||
void buildWithSystemProperty() {
|
||||
assertThat(CommandLineBuilder.forMainClass(CLASS_NAME).withSystemProperties(Map.of("flag", "enabled")).build())
|
||||
.containsExactly("-Dflag=\"enabled\"", CLASS_NAME);
|
||||
}
|
||||
|
||||
@Test
|
||||
void buildWithNullArgumentsIsIgnored() {
|
||||
assertThat(CommandLineBuilder.forMainClass(CLASS_NAME).withArguments((String[]) null).build())
|
||||
.containsExactly(CLASS_NAME);
|
||||
}
|
||||
|
||||
@Test
|
||||
void buildWithNullIntermediateArgumentIsIgnored() {
|
||||
assertThat(CommandLineBuilder.forMainClass(CLASS_NAME).withArguments("--test", null, "--another").build())
|
||||
.containsExactly(CLASS_NAME, "--test", "--another");
|
||||
}
|
||||
|
||||
}
|
||||
Loading…
Reference in New Issue