Skip to content

Commit 0e572a9

Browse files
slawekjaranowskislawekjaranowski
committed
[MINVOKER-307] Support @{..} syntax in mavenOpts
1 parent 89b9633 commit 0e572a9

File tree

5 files changed

+165
-6
lines changed

5 files changed

+165
-6
lines changed

‎pom.xml

+9
Original file line numberDiff line numberDiff line change
@@ -264,6 +264,11 @@ under the License.
264264
<artifactId>junit-jupiter-api</artifactId>
265265
<scope>test</scope>
266266
</dependency>
267+
<dependency>
268+
<groupId>org.junit.jupiter</groupId>
269+
<artifactId>junit-jupiter-params</artifactId>
270+
<scope>test</scope>
271+
</dependency>
267272
<dependency>
268273
<groupId>org.mockito</groupId>
269274
<artifactId>mockito-core</artifactId>
@@ -377,6 +382,10 @@ under the License.
377382
</execution>
378383
</executions>
379384
</plugin>
385+
<plugin>
386+
<groupId>org.eclipse.sisu</groupId>
387+
<artifactId>sisu-maven-plugin</artifactId>
388+
</plugin>
380389
</plugins>
381390
</build>
382391

‎src/main/java/org/apache/maven/plugins/invoker/AbstractInvokerMojo.java

+8-1
Original file line numberDiff line numberDiff line change
@@ -410,6 +410,10 @@ public abstract class AbstractInvokerMojo extends AbstractMojo {
410410
/**
411411
* The <code>MAVEN_OPTS</code> environment variable to use when invoking Maven. This value can be overridden for
412412
* individual integration tests by using {@link #invokerPropertiesFile}.
413+
* <br>
414+
* Since the version <b>3.7.0</b> using an alternate syntax for mavenOpts, <code>@{...}</code>
415+
* allows late replacement of properties when the plugin is executed,
416+
* so properties that have been modified by other plugins will be picked up correctly.
413417
*
414418
* @since 1.2
415419
*/
@@ -739,6 +743,9 @@ public abstract class AbstractInvokerMojo extends AbstractMojo {
739743
@Component
740744
private ToolchainManagerPrivate toolchainManagerPrivate;
741745

746+
@Component
747+
private InterpolatorUtils interpolatorUtils;
748+
742749
/**
743750
* Invokes Maven on the configured test projects.
744751
*
@@ -2376,7 +2383,7 @@ private InvokerProperties getInvokerProperties(final File projectDirectory, Prop
23762383
invokerProperties.setDefaultGoals(goals);
23772384
invokerProperties.setDefaultProfiles(profiles);
23782385
invokerProperties.setDefaultMavenExecutable(mavenExecutable);
2379-
invokerProperties.setDefaultMavenOpts(mavenOpts);
2386+
invokerProperties.setDefaultMavenOpts(interpolatorUtils.interpolateAtPattern(mavenOpts));
23802387
invokerProperties.setDefaultTimeoutInSeconds(timeoutInSeconds);
23812388
invokerProperties.setDefaultEnvironmentVariables(environmentVariables);
23822389
invokerProperties.setDefaultUpdateSnapshots(updateSnapshots);

‎src/main/java/org/apache/maven/plugins/invoker/InterpolatorUtils.java

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
/*
2+
* Licensed to the Apache Software Foundation (ASF) under one
3+
* or more contributor license agreements. See the NOTICE file
4+
* distributed with this work for additional information
5+
* regarding copyright ownership. The ASF licenses this file
6+
* to you under the Apache License, Version 2.0 (the
7+
* "License"); you may not use this file except in compliance
8+
* with the License. You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing,
13+
* software distributed under the License is distributed on an
14+
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
* KIND, either express or implied. See the License for the
16+
* specific language governing permissions and limitations
17+
* under the License.
18+
*/
19+
package org.apache.maven.plugins.invoker;
20+
21+
import javax.inject.Inject;
22+
import javax.inject.Named;
23+
24+
import org.apache.maven.plugin.MojoExecutionException;
25+
import org.apache.maven.project.MavenProject;
26+
import org.codehaus.plexus.interpolation.InterpolationException;
27+
import org.codehaus.plexus.interpolation.Interpolator;
28+
import org.codehaus.plexus.interpolation.MapBasedValueSource;
29+
import org.codehaus.plexus.interpolation.RegexBasedInterpolator;
30+
31+
/**
32+
* Helper component for interpolating values.
33+
*/
34+
@Named
35+
class InterpolatorUtils {
36+
37+
private final Interpolator atInterpolator;
38+
39+
/**
40+
* A default constructor.
41+
*
42+
* @param mavenProject a MavenProject
43+
*/
44+
@Inject
45+
InterpolatorUtils(MavenProject mavenProject) {
46+
atInterpolator = new RegexBasedInterpolator("[@\\$]\\{(.+?)", "}");
47+
atInterpolator.addValueSource(new MapBasedValueSource(mavenProject.getProperties()));
48+
}
49+
50+
public String interpolateAtPattern(String value) throws MojoExecutionException {
51+
52+
if (value == null || !(value.contains("@{") || value.contains("${"))) {
53+
return value;
54+
}
55+
56+
try {
57+
return atInterpolator.interpolate(value);
58+
} catch (InterpolationException e) {
59+
throw new MojoExecutionException(e.getMessage(), e);
60+
}
61+
}
62+
}

‎src/test/java/org/apache/maven/plugins/invoker/InterpolatorUtilsTest.java

+71
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
/*
2+
* Licensed to the Apache Software Foundation (ASF) under one
3+
* or more contributor license agreements. See the NOTICE file
4+
* distributed with this work for additional information
5+
* regarding copyright ownership. The ASF licenses this file
6+
* to you under the Apache License, Version 2.0 (the
7+
* "License"); you may not use this file except in compliance
8+
* with the License. You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing,
13+
* software distributed under the License is distributed on an
14+
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
* KIND, either express or implied. See the License for the
16+
* specific language governing permissions and limitations
17+
* under the License.
18+
*/
19+
package org.apache.maven.plugins.invoker;
20+
21+
import java.util.Properties;
22+
import java.util.stream.Stream;
23+
24+
import org.apache.maven.project.MavenProject;
25+
import org.junit.jupiter.api.extension.ExtendWith;
26+
import org.junit.jupiter.params.ParameterizedTest;
27+
import org.junit.jupiter.params.provider.Arguments;
28+
import org.junit.jupiter.params.provider.MethodSource;
29+
import org.mockito.Mock;
30+
import org.mockito.junit.jupiter.MockitoExtension;
31+
32+
import static org.assertj.core.api.Assertions.assertThat;
33+
import static org.mockito.Mockito.when;
34+
35+
@ExtendWith(MockitoExtension.class)
36+
class InterpolatorUtilsTest {
37+
38+
@Mock
39+
private MavenProject mavenProject;
40+
41+
static Stream<Arguments> testAtInterpolate() {
42+
return Stream.of(
43+
Arguments.of(null, null),
44+
Arguments.of("test", "test"),
45+
Arguments.of("test@test", "test@test"),
46+
Arguments.of("test$test", "test$test"),
47+
Arguments.of("@{test}", "testInProps"),
48+
Arguments.of("${test}", "testInProps"),
49+
Arguments.of("test @{test} test", "test testInProps test"),
50+
Arguments.of("test ${test} test", "test testInProps test"),
51+
Arguments.of("@{test} @{test}", "testInProps testInProps"),
52+
Arguments.of("${test} ${test}", "testInProps testInProps"),
53+
Arguments.of("@{test} ${test}", "testInProps testInProps"));
54+
}
55+
56+
@ParameterizedTest
57+
@MethodSource
58+
void testAtInterpolate(String input, String expected) throws Exception {
59+
// given
60+
Properties properties = new Properties();
61+
properties.put("test", "testInProps");
62+
when(mavenProject.getProperties()).thenReturn(properties);
63+
InterpolatorUtils interpolatorUtils = new InterpolatorUtils(mavenProject);
64+
65+
// when
66+
String output = interpolatorUtils.interpolateAtPattern(input);
67+
68+
// then
69+
assertThat(output).isEqualTo(expected);
70+
}
71+
}

‎src/test/java/org/apache/maven/plugins/invoker/InvokerMojoTest.java

+15-5
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,13 @@ private MavenProject getMavenProject() {
4949
@Test
5050
void testSingleInvokerTest() throws Exception {
5151
// given
52+
MavenProject mavenProject = getMavenProject();
5253
InvokerMojo invokerMojo = new InvokerMojo();
5354
String dirPath = getBasedir() + "/src/test/resources/unit";
5455
setVariableValueToObject(invokerMojo, "projectsDirectory", new File(dirPath));
5556
setVariableValueToObject(invokerMojo, "invokerPropertiesFile", "invoker.properties");
56-
setVariableValueToObject(invokerMojo, "project", getMavenProject());
57+
setVariableValueToObject(invokerMojo, "project", mavenProject);
58+
setVariableValueToObject(invokerMojo, "interpolatorUtils", new InterpolatorUtils(mavenProject));
5759
setVariableValueToObject(invokerMojo, "invokerTest", "*dummy*");
5860
setVariableValueToObject(invokerMojo, "settings", new Settings());
5961

@@ -67,11 +69,13 @@ void testSingleInvokerTest() throws Exception {
6769
@Test
6870
void testMultiInvokerTest() throws Exception {
6971
// given
72+
MavenProject mavenProject = getMavenProject();
7073
InvokerMojo invokerMojo = new InvokerMojo();
7174
String dirPath = getBasedir() + "/src/test/resources/unit";
7275
setVariableValueToObject(invokerMojo, "projectsDirectory", new File(dirPath));
7376
setVariableValueToObject(invokerMojo, "invokerPropertiesFile", "invoker.properties");
74-
setVariableValueToObject(invokerMojo, "project", getMavenProject());
77+
setVariableValueToObject(invokerMojo, "project", mavenProject);
78+
setVariableValueToObject(invokerMojo, "interpolatorUtils", new InterpolatorUtils(mavenProject));
7579
setVariableValueToObject(invokerMojo, "invokerTest", "*dummy*,*terpolatio*");
7680
setVariableValueToObject(invokerMojo, "settings", new Settings());
7781

@@ -85,11 +89,13 @@ void testMultiInvokerTest() throws Exception {
8589
@Test
8690
void testFullPatternInvokerTest() throws Exception {
8791
// given
92+
MavenProject mavenProject = getMavenProject();
8893
InvokerMojo invokerMojo = new InvokerMojo();
8994
String dirPath = getBasedir() + "/src/test/resources/unit";
9095
setVariableValueToObject(invokerMojo, "projectsDirectory", new File(dirPath));
9196
setVariableValueToObject(invokerMojo, "invokerPropertiesFile", "invoker.properties");
92-
setVariableValueToObject(invokerMojo, "project", getMavenProject());
97+
setVariableValueToObject(invokerMojo, "project", mavenProject);
98+
setVariableValueToObject(invokerMojo, "interpolatorUtils", new InterpolatorUtils(mavenProject));
9399
setVariableValueToObject(invokerMojo, "invokerTest", "*");
94100
setVariableValueToObject(invokerMojo, "settings", new Settings());
95101

@@ -106,11 +112,13 @@ void testFullPatternInvokerTest() throws Exception {
106112
@Test
107113
void testSetupInProjectList() throws Exception {
108114
// given
115+
MavenProject mavenProject = getMavenProject();
109116
InvokerMojo invokerMojo = new InvokerMojo();
110117
String dirPath = getBasedir() + "/src/test/resources/unit";
111118
setVariableValueToObject(invokerMojo, "projectsDirectory", new File(dirPath));
112119
setVariableValueToObject(invokerMojo, "invokerPropertiesFile", "invoker.properties");
113-
setVariableValueToObject(invokerMojo, "project", getMavenProject());
120+
setVariableValueToObject(invokerMojo, "project", mavenProject);
121+
setVariableValueToObject(invokerMojo, "interpolatorUtils", new InterpolatorUtils(mavenProject));
114122
setVariableValueToObject(invokerMojo, "settings", new Settings());
115123
setVariableValueToObject(invokerMojo, "setupIncludes", Collections.singletonList("dum*/pom.xml"));
116124

@@ -134,11 +142,13 @@ void testSetupInProjectList() throws Exception {
134142
@Test
135143
void testSetupProjectIsFiltered() throws Exception {
136144
// given
145+
MavenProject mavenProject = getMavenProject();
137146
InvokerMojo invokerMojo = new InvokerMojo();
138147
String dirPath = getBasedir() + "/src/test/resources/unit";
139148
setVariableValueToObject(invokerMojo, "projectsDirectory", new File(dirPath));
140149
setVariableValueToObject(invokerMojo, "invokerPropertiesFile", "invoker.properties");
141-
setVariableValueToObject(invokerMojo, "project", getMavenProject());
150+
setVariableValueToObject(invokerMojo, "project", mavenProject);
151+
setVariableValueToObject(invokerMojo, "interpolatorUtils", new InterpolatorUtils(mavenProject));
142152
setVariableValueToObject(invokerMojo, "settings", new Settings());
143153
setVariableValueToObject(invokerMojo, "setupIncludes", Collections.singletonList("dum*/pom.xml"));
144154
setVariableValueToObject(invokerMojo, "invokerTest", "*project-dir*");

0 commit comments

Comments
 (0)