diff --git a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/it/run-disable-fork/verify.groovy b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/it/run-disable-fork/verify.groovy index 93ce0736fa..752e0988f0 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/it/run-disable-fork/verify.groovy +++ b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/it/run-disable-fork/verify.groovy @@ -2,6 +2,6 @@ import static org.junit.Assert.assertTrue def file = new File(basedir, "build.log") assertTrue file.text.contains("I haz been run") -assertTrue file.text.contains("Fork mode disabled, ignoring JVM argument(s) [-Dfoo=bar -Dproperty1=value1 -Dproperty2]") +assertTrue file.text.contains("Fork mode disabled, ignoring JVM argument(s) [-Dproperty1=value1 -Dproperty2 -Dfoo=bar]") assertTrue file.text.contains("Fork mode disabled, ignoring working directory configuration") diff --git a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/it/run-jvm-system-props/pom.xml b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/it/run-jvm-system-props/pom.xml index 318359736c..92f46e8ea6 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/it/run-jvm-system-props/pom.xml +++ b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/it/run-jvm-system-props/pom.xml @@ -27,6 +27,8 @@ value1 + ${project.artifactId} + should-be-ignored diff --git a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/it/run-jvm-system-props/src/main/java/org/test/SampleApplication.java b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/it/run-jvm-system-props/src/main/java/org/test/SampleApplication.java index 165822591e..4932bfc419 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/it/run-jvm-system-props/src/main/java/org/test/SampleApplication.java +++ b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/it/run-jvm-system-props/src/main/java/org/test/SampleApplication.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2017 the original author or authors. + * Copyright 2012-2018 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. @@ -27,17 +27,18 @@ public class SampleApplication { if (!"value2".equals(bar)) { throw new IllegalStateException("bar system property mismatch (got [" + bar + "]"); } - String property1 = System.getProperty("property1"); if (!"value1".equals(property1)) { throw new IllegalStateException("property1 system property mismatch (got [" + property1 + "]"); } - String property2 = System.getProperty("property2"); if (!"".equals(property2)) { - throw new IllegalStateException("property1 system property mismatch (got [" + property2 + "]"); + throw new IllegalStateException("property2 system property mismatch (got [" + property2 + "]"); + } + String property3 = System.getProperty("property3"); + if (!"run-jvmargs".equals(property3)) { + throw new IllegalStateException("property3 system property mismatch (got [" + property3 + "]"); } - System.out.println("I haz been run"); } diff --git a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/AbstractRunMojo.java b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/AbstractRunMojo.java index 2923de3417..2eb74cad2b 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/AbstractRunMojo.java +++ b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/AbstractRunMojo.java @@ -107,6 +107,14 @@ public abstract class AbstractRunMojo extends AbstractDependencyFilterMojo { @Parameter(property = "spring-boot.run.jvmArguments") private String jvmArguments; + /** + * List of JVM system properties to pass to the process. NOTE: the use of system + * properties means that processes will be started by forking a new JVM. + * @since 2.1.0 + */ + @Parameter + private Map systemPropertyVariables; + /** * Arguments that should be passed to the application. On command line use commas to * separate multiple arguments. @@ -171,15 +179,6 @@ public abstract class AbstractRunMojo extends AbstractDependencyFilterMojo { @Parameter(property = "spring-boot.run.skip", defaultValue = "false") private boolean skip; - /** - * List of JVM system properties. System property consists of key and value - * and it will be transformed to -Dkey=value format. - * In case if value is not specified or empty only key will be provided. - * @since 2.0 - */ - @Parameter(property = "spring-boot.run.systemPropertyVariabled") - private Map systemPropertyVariables; - @Override public void execute() throws MojoExecutionException, MojoFailureException { if (this.skip) { @@ -213,7 +212,8 @@ public abstract class AbstractRunMojo extends AbstractDependencyFilterMojo { private boolean hasJvmArgs() { return (this.jvmArguments != null && !this.jvmArguments.isEmpty()) || - (this.systemPropertyVariables != null && !this.systemPropertyVariables.isEmpty()); + (this.systemPropertyVariables != null + && !this.systemPropertyVariables.isEmpty()); } private boolean hasWorkingDirectorySet() { @@ -244,22 +244,10 @@ public abstract class AbstractRunMojo extends AbstractDependencyFilterMojo { getLog().warn("Fork mode disabled, ignoring agent"); } if (hasJvmArgs()) { - String messageTemplate = "Fork mode disabled, ignoring JVM argument(s) [%s%s]"; - String sysPropsStr = ""; - if (this.systemPropertyVariables != null && !this.systemPropertyVariables.isEmpty()) { - sysPropsStr = this.systemPropertyVariables - .entrySet() - .stream() - .map(e -> SystemPropertyFormatter.format(e.getKey(), e.getValue())) - .collect(Collectors.joining(" ")); - } - String message = String.format( - messageTemplate, - this.jvmArguments, - sysPropsStr.isEmpty() ? sysPropsStr : " " + sysPropsStr - ); - - getLog().warn(message); + RunArguments runArguments = resolveJvmArguments(); + getLog().warn("Fork mode disabled, ignoring JVM argument(s) [" + + Arrays.stream(runArguments.asArray()).collect( + Collectors.joining(" ")) + "]"); } if (hasWorkingDirectorySet()) { getLog().warn("Fork mode disabled, ignoring working directory configuration"); @@ -319,19 +307,15 @@ public abstract class AbstractRunMojo extends AbstractDependencyFilterMojo { */ protected RunArguments resolveJvmArguments() { final StringBuilder stringBuilder = new StringBuilder(); - if (this.jvmArguments != null) { - stringBuilder.append(this.jvmArguments); - } if (this.systemPropertyVariables != null) { - String result = this.systemPropertyVariables + stringBuilder.append(this.systemPropertyVariables .entrySet() .stream() .map(e -> SystemPropertyFormatter.format(e.getKey(), e.getValue())) - .collect(Collectors.joining(" ")); - stringBuilder - .append(" ") - .append(result); - + .collect(Collectors.joining(" "))); + } + if (this.jvmArguments != null) { + stringBuilder.append(" ").append(this.jvmArguments); } return new RunArguments(stringBuilder.toString()); } @@ -551,11 +535,12 @@ public abstract class AbstractRunMojo extends AbstractDependencyFilterMojo { } /** - * System properties formatter. + * Format System properties. */ static class SystemPropertyFormatter { private static final String NO_VALUE_FORMAT = "-D%s"; + private static final String KEY_VALUE_FORMAT = NO_VALUE_FORMAT + "=%s"; public static String format(Object key, Object value) { diff --git a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/site/apt/examples/run-system-properties.apt.vm b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/site/apt/examples/run-system-properties.apt.vm new file mode 100644 index 0000000000..c1041e657a --- /dev/null +++ b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/site/apt/examples/run-system-properties.apt.vm @@ -0,0 +1,59 @@ + ----- + Using System Properties + ----- + Stephane Nicoll + ----- + 2018-04-24 + ----- + + System properties can be specified using the <<>> attribute. + The following sets <<>> to <<>> and <<>> to 42: + +--- + + ... + + + 42 + + ... + + ... + + ${project.groupId} + ${project.artifactId} + ${project.version} + + + test + ${my.value} + + + ... + + ... + + ... + + ... + +--- + + If the value is empty or not defined (i.e. <<<>>>), the system property + is set with an empty String as the value. + + Any String typed Maven variable can be passed as system properties. Any attempt to pass + any other Maven variable type (e.g. a <<>> or a <<>> variable) will cause the + variable expression to be passed literally (unevaluated). + + The <<>> parameter takes precedence over system properties defined with + the mechanism above. In the following example, the value for <<>> is + <<>>: + + +--- +mvn spring-boot:run -Dspring-boot.jvmArguments="-Dproperty1=overridden" +--- + + + diff --git a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/site/apt/index.apt b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/site/apt/index.apt index a1f9db3d25..f3e47a5d96 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/site/apt/index.apt +++ b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/site/apt/index.apt @@ -52,6 +52,8 @@ Spring Boot Maven Plugin * {{{./examples/run-debug.html}Debug the application}} + * {{{./examples/run-system-properties.html}Using system properties}} + * {{{./examples/it-random-port.html}Random port for integration tests}} * {{{./examples/it-skip.html}Skip integration tests}} diff --git a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/site/apt/usage.apt.vm b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/site/apt/usage.apt.vm index 3452b1340b..ffa09b3e1f 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/site/apt/usage.apt.vm +++ b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/site/apt/usage.apt.vm @@ -135,12 +135,15 @@ mvn spring-boot:run By default the application is executed directly from the Maven JVM. If you need to run in a forked process you can use the 'fork' option. Forking will also occur if the - 'jvmArguments' or 'agent' options are specified, or if devtools is present. + 'jvmArguments', 'systemPropertyVariables' or 'agent' options are specified, or if + devtools is present. If you need to specify some JVM arguments (i.e. for debugging purposes), you can use the <<>> parameter, see {{{./examples/run-debug.html}Debug the application}} - for more details. As a convenience, the profiles to enable are handled by a specific - property (<<>>), see {{{./examples/run-profiles.html}Specify active profiles}}. + for more details. There is also explicit support + {{{./examples/run-system-properties.html}for system properties}}. As a convenience, the + profiles to enable are handled by a specific property (<<>>), see + {{{./examples/run-profiles.html}Specify active profiles}}. Spring Boot 1.3 has introduced <<>>, a module to improve the development-time experience when working on Spring Boot applications. To enable it, just add the following diff --git a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/site/site.xml b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/site/site.xml index 2ecc646eca..5e1157ab54 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/site/site.xml +++ b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/site/site.xml @@ -11,6 +11,7 @@ + diff --git a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/test/java/org/springframework/boot/maven/SystemPropertyFormatterTests.java b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/test/java/org/springframework/boot/maven/SystemPropertyFormatterTests.java index 97038d636c..50b360980b 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/test/java/org/springframework/boot/maven/SystemPropertyFormatterTests.java +++ b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/test/java/org/springframework/boot/maven/SystemPropertyFormatterTests.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2017 the original author or authors. + * Copyright 2012-2018 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. @@ -16,37 +16,36 @@ package org.springframework.boot.maven; -import org.assertj.core.api.Assertions; import org.junit.Test; import org.springframework.boot.maven.AbstractRunMojo.SystemPropertyFormatter; +import static org.assertj.core.api.Assertions.assertThat; + /** - * Tests for {@link AbstractRunMojo.SystemPropertyFormatter} + * Tests for {@link AbstractRunMojo.SystemPropertyFormatter}. */ public class SystemPropertyFormatterTests { @Test - public void parseEmpty() throws Exception { - Assertions.assertThat(SystemPropertyFormatter.format(null, null)) - .isEqualTo(""); + public void parseEmpty() { + assertThat(SystemPropertyFormatter.format(null, null)).isEqualTo(""); } @Test - public void parseOnlyKey() throws Exception { - Assertions.assertThat(SystemPropertyFormatter.format("key1", null)) - .isEqualTo("-Dkey1"); + public void parseOnlyKey() { + assertThat(SystemPropertyFormatter.format("key1", null)).isEqualTo("-Dkey1"); } @Test - public void parseKeyWithValue() throws Exception { - Assertions.assertThat(SystemPropertyFormatter.format("key1", "value1")) + public void parseKeyWithValue() { + assertThat(SystemPropertyFormatter.format("key1", "value1")) .isEqualTo("-Dkey1=value1"); } @Test - public void parseKeyWithEmptyValue() throws Exception { - Assertions.assertThat(SystemPropertyFormatter.format("key1", "")) - .isEqualTo("-Dkey1"); + public void parseKeyWithEmptyValue() { + assertThat(SystemPropertyFormatter.format("key1", "")).isEqualTo("-Dkey1"); } + }