Merge pull request #10741 from vadeg:feature/jvm-arguments
* pr/10741: Polish "Add system properties support using explicit configuration tag" Add system properties support using explicit configuration tagpull/12955/head
Stephane Nicoll
7 years ago
commit
54c0b85608
@ -0,0 +1,39 @@
|
||||
<?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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
<groupId>org.springframework.boot.maven.it</groupId>
|
||||
<artifactId>run-jvmargs</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>
|
||||
<phase>package</phase>
|
||||
<goals>
|
||||
<goal>run</goal>
|
||||
</goals>
|
||||
<configuration>
|
||||
<jvmArguments>-Dfoo="value 1" -Dbar=value2</jvmArguments>
|
||||
<systemPropertyVariables>
|
||||
<property1>value1</property1>
|
||||
<property2/>
|
||||
<property3>${project.artifactId}</property3>
|
||||
<foo>should-be-ignored</foo>
|
||||
</systemPropertyVariables>
|
||||
</configuration>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
</project>
|
||||
@ -0,0 +1,45 @@
|
||||
/*
|
||||
* 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.
|
||||
* 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.
|
||||
*/
|
||||
|
||||
package org.test;
|
||||
|
||||
public class SampleApplication {
|
||||
|
||||
public static void main(String[] args) {
|
||||
String foo = System.getProperty("foo");
|
||||
if (!"value 1".equals(foo)) {
|
||||
throw new IllegalStateException("foo system property mismatch (got [" + foo + "]");
|
||||
}
|
||||
String bar = System.getProperty("bar");
|
||||
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("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");
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,3 @@
|
||||
def file = new File(basedir, "build.log")
|
||||
return file.text.contains("I haz been run")
|
||||
|
||||
@ -0,0 +1,59 @@
|
||||
-----
|
||||
Using System Properties
|
||||
-----
|
||||
Stephane Nicoll
|
||||
-----
|
||||
2018-04-24
|
||||
-----
|
||||
|
||||
System properties can be specified using the <<<systemPropertyVariables>>> attribute.
|
||||
The following sets <<<property1>>> to <<<test>>> and <<<property2>>> to 42:
|
||||
|
||||
---
|
||||
<project>
|
||||
...
|
||||
<build>
|
||||
<properties>
|
||||
<my.value>42</my.value>
|
||||
</properties>
|
||||
...
|
||||
<plugins>
|
||||
...
|
||||
<plugin>
|
||||
<groupId>${project.groupId}</groupId>
|
||||
<artifactId>${project.artifactId}</artifactId>
|
||||
<version>${project.version}</version>
|
||||
<configuration>
|
||||
<systemPropertyVariables>
|
||||
<property1>test</property1>
|
||||
<property2>${my.value}</property2>
|
||||
</profiles>
|
||||
</configuration>
|
||||
...
|
||||
</plugin>
|
||||
...
|
||||
</plugins>
|
||||
...
|
||||
</build>
|
||||
...
|
||||
</project>
|
||||
---
|
||||
|
||||
If the value is empty or not defined (i.e. <<<<my-property/>>>>), 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 <<<List>>> or a <<<URL>>> variable) will cause the
|
||||
variable expression to be passed literally (unevaluated).
|
||||
|
||||
The <<<jvmArguments>>> parameter takes precedence over system properties defined with
|
||||
the mechanism above. In the following example, the value for <<<property1>>> is
|
||||
<<<overridden>>>:
|
||||
|
||||
|
||||
---
|
||||
mvn spring-boot:run -Dspring-boot.jvmArguments="-Dproperty1=overridden"
|
||||
---
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,51 @@
|
||||
/*
|
||||
* 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.
|
||||
* 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.
|
||||
*/
|
||||
|
||||
package org.springframework.boot.maven;
|
||||
|
||||
import org.junit.Test;
|
||||
|
||||
import org.springframework.boot.maven.AbstractRunMojo.SystemPropertyFormatter;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
|
||||
/**
|
||||
* Tests for {@link AbstractRunMojo.SystemPropertyFormatter}.
|
||||
*/
|
||||
public class SystemPropertyFormatterTests {
|
||||
|
||||
@Test
|
||||
public void parseEmpty() {
|
||||
assertThat(SystemPropertyFormatter.format(null, null)).isEqualTo("");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void parseOnlyKey() {
|
||||
assertThat(SystemPropertyFormatter.format("key1", null)).isEqualTo("-Dkey1");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void parseKeyWithValue() {
|
||||
assertThat(SystemPropertyFormatter.format("key1", "value1"))
|
||||
.isEqualTo("-Dkey1=value1");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void parseKeyWithEmptyValue() {
|
||||
assertThat(SystemPropertyFormatter.format("key1", "")).isEqualTo("-Dkey1");
|
||||
}
|
||||
|
||||
}
|
||||
Loading…
Reference in New Issue