This is an automated email from the ASF dual-hosted git repository.
cstamas pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven.git
The following commit(s) were added to refs/heads/master by this push:
new 12ff71079e [MNG-8594] Add atFile option (#2131)
12ff71079e is described below
commit 12ff71079e54aeaaf7a93f3faa8fcb1dcde6aa1e
Author: Tamas Cservenak <ta...@cservenak.net>
AuthorDate: Wed Feb 26 18:31:44 2025 +0100
[MNG-8594] Add atFile option (#2131)
Where user can create ad-hoc command line parms. The difference between
.mvn/maven.conf and this file is that this file allows goals as well. The CLI
and atFile are merged, in this order, hence, goals in atFile will come AFTER
goals specified on CLI, if CLI has them.
Source order (first wins for options, while goals are collected/aggregated
from sources):
* CLI
* atFile (if specified, may have goals that are appended)
* maven.config (if present, may not have goals)
Note: option is called `af` or long `at-file` for similarity with `javac
@file`, but commons CLI does not support options without leading hyphen.
---
https://issues.apache.org/jira/browse/MNG-8594
---
.../org/apache/maven/api/cli/mvn/MavenOptions.java | 7 +++
.../apache/maven/cling/invoker/LayeredOptions.java | 4 +-
.../cling/invoker/mvn/CommonsCliMavenOptions.java | 15 +++++
.../cling/invoker/mvn/LayeredMavenOptions.java | 5 ++
.../maven/cling/invoker/mvn/MavenParser.java | 25 ++++++++-
.../apache/maven/it/MavenITmng8594AtFileTest.java | 64 ++++++++++++++++++++++
.../org/apache/maven/it/TestSuiteOrdering.java | 1 +
.../src/test/resources/mng-8594/cmd.txt | 3 +
.../src/test/resources/mng-8594/pom.xml | 34 ++++++++++++
9 files changed, 156 insertions(+), 2 deletions(-)
diff --git
a/api/maven-api-cli/src/main/java/org/apache/maven/api/cli/mvn/MavenOptions.java
b/api/maven-api-cli/src/main/java/org/apache/maven/api/cli/mvn/MavenOptions.java
index 21f241750e..2387105a3a 100644
---
a/api/maven-api-cli/src/main/java/org/apache/maven/api/cli/mvn/MavenOptions.java
+++
b/api/maven-api-cli/src/main/java/org/apache/maven/api/cli/mvn/MavenOptions.java
@@ -207,6 +207,13 @@ public interface MavenOptions extends Options {
@Nonnull
Optional<Boolean> ignoreTransitiveRepositories();
+ /**
+ * Specifies "@file"-like file, to load up command line from. It may
contain goals as well. Format is one parameter
+ * per line (similar to {@code maven.conf}) and {@code '#'} (hash) marked
comment lines are allowed. Goals, if
+ * present, are appended, to those specified on CLI input, if any.
+ */
+ Optional<String> atFile();
+
/**
* Returns the list of goals and phases to execute.
*
diff --git
a/impl/maven-cli/src/main/java/org/apache/maven/cling/invoker/LayeredOptions.java
b/impl/maven-cli/src/main/java/org/apache/maven/cling/invoker/LayeredOptions.java
index 4d9d7b6c09..2f9c367c47 100644
---
a/impl/maven-cli/src/main/java/org/apache/maven/cling/invoker/LayeredOptions.java
+++
b/impl/maven-cli/src/main/java/org/apache/maven/cling/invoker/LayeredOptions.java
@@ -181,7 +181,9 @@ protected Optional<Map<String, String>>
collectMapIfPresentOrEmpty(
Optional<Map<String, String>> up = getter.apply(option);
if (up.isPresent()) {
had++;
- items.putAll(up.get());
+ for (Map.Entry<String, String> entry : up.get().entrySet()) {
+ items.putIfAbsent(entry.getKey(), entry.getValue());
+ }
}
}
return had == 0 ? Optional.empty() : Optional.of(Map.copyOf(items));
diff --git
a/impl/maven-cli/src/main/java/org/apache/maven/cling/invoker/mvn/CommonsCliMavenOptions.java
b/impl/maven-cli/src/main/java/org/apache/maven/cling/invoker/mvn/CommonsCliMavenOptions.java
index 0ba2e6e0ab..180d756e4d 100644
---
a/impl/maven-cli/src/main/java/org/apache/maven/cling/invoker/mvn/CommonsCliMavenOptions.java
+++
b/impl/maven-cli/src/main/java/org/apache/maven/cling/invoker/mvn/CommonsCliMavenOptions.java
@@ -238,6 +238,14 @@ public Optional<Boolean> ignoreTransitiveRepositories() {
return Optional.empty();
}
+ @Override
+ public Optional<String> atFile() {
+ if (commandLine.hasOption(CLIManager.AT_FILE)) {
+ return Optional.of(commandLine.getOptionValue(CLIManager.AT_FILE));
+ }
+ return Optional.empty();
+ }
+
@Override
public Optional<List<String>> goals() {
if (!commandLine.getArgList().isEmpty()) {
@@ -273,6 +281,7 @@ protected static class CLIManager extends
CommonsCliOptions.CLIManager {
public static final String CACHE_ARTIFACT_NOT_FOUND = "canf";
public static final String STRICT_ARTIFACT_DESCRIPTOR_POLICY = "sadp";
public static final String IGNORE_TRANSITIVE_REPOSITORIES = "itr";
+ public static final String AT_FILE = "af";
@Override
protected void prepareOptions(org.apache.commons.cli.Options options) {
@@ -375,6 +384,12 @@ protected void
prepareOptions(org.apache.commons.cli.Options options) {
.longOpt("ignore-transitive-repositories")
.desc("If set, Maven will ignore remote repositories
introduced by transitive dependencies.")
.build());
+ options.addOption(Option.builder(AT_FILE)
+ .longOpt("at-file")
+ .hasArg()
+ .desc(
+ "If set, Maven will load command line options from
the specified file and merge with CLI specified ones.")
+ .build());
}
}
}
diff --git
a/impl/maven-cli/src/main/java/org/apache/maven/cling/invoker/mvn/LayeredMavenOptions.java
b/impl/maven-cli/src/main/java/org/apache/maven/cling/invoker/mvn/LayeredMavenOptions.java
index 353f795913..d88e08b047 100644
---
a/impl/maven-cli/src/main/java/org/apache/maven/cling/invoker/mvn/LayeredMavenOptions.java
+++
b/impl/maven-cli/src/main/java/org/apache/maven/cling/invoker/mvn/LayeredMavenOptions.java
@@ -154,6 +154,11 @@ public Optional<Boolean> ignoreTransitiveRepositories() {
return
returnFirstPresentOrEmpty(MavenOptions::ignoreTransitiveRepositories);
}
+ @Override
+ public Optional<String> atFile() {
+ return returnFirstPresentOrEmpty(MavenOptions::atFile);
+ }
+
@Override
public Optional<List<String>> goals() {
return collectListIfPresentOrEmpty(MavenOptions::goals);
diff --git
a/impl/maven-cli/src/main/java/org/apache/maven/cling/invoker/mvn/MavenParser.java
b/impl/maven-cli/src/main/java/org/apache/maven/cling/invoker/mvn/MavenParser.java
index 7de8e0d518..fd030ba185 100644
---
a/impl/maven-cli/src/main/java/org/apache/maven/cling/invoker/mvn/MavenParser.java
+++
b/impl/maven-cli/src/main/java/org/apache/maven/cling/invoker/mvn/MavenParser.java
@@ -37,7 +37,17 @@ public class MavenParser extends BaseParser {
protected List<Options> parseCliOptions(LocalContext context) {
ArrayList<Options> result = new ArrayList<>();
// CLI args
- result.add(parseMavenCliOptions(context.parserRequest.args()));
+ MavenOptions cliOptions =
parseMavenCliOptions(context.parserRequest.args());
+ result.add(cliOptions);
+ // atFile option
+ if (cliOptions.atFile().isPresent()) {
+ Path file = context.cwd.resolve(cliOptions.atFile().orElseThrow());
+ if (Files.isRegularFile(file)) {
+ result.add(parseMavenAtFileOptions(file));
+ } else {
+ throw new IllegalArgumentException("Specified file does not
exists (" + file + ")");
+ }
+ }
// maven.config; if exists
Path mavenConfig = context.rootDirectory != null ?
context.rootDirectory.resolve(".mvn/maven.config") : null;
if (mavenConfig != null && Files.isRegularFile(mavenConfig)) {
@@ -54,6 +64,19 @@ protected MavenOptions parseMavenCliOptions(List<String>
args) {
}
}
+ protected MavenOptions parseMavenAtFileOptions(Path atFile) {
+ try (Stream<String> lines = Files.lines(atFile,
Charset.defaultCharset())) {
+ List<String> args =
+ lines.filter(arg -> !arg.isEmpty() &&
!arg.startsWith("#")).toList();
+ return parseArgs("atFile", args);
+ } catch (ParseException e) {
+ throw new IllegalArgumentException(
+ "Failed to parse arguments from file (" + atFile + "): " +
e.getMessage(), e.getCause());
+ } catch (IOException e) {
+ throw new IllegalStateException("Error reading config file: " +
atFile, e);
+ }
+ }
+
protected MavenOptions parseMavenConfigOptions(Path configFile) {
try (Stream<String> lines = Files.lines(configFile,
Charset.defaultCharset())) {
List<String> args =
diff --git
a/its/core-it-suite/src/test/java/org/apache/maven/it/MavenITmng8594AtFileTest.java
b/its/core-it-suite/src/test/java/org/apache/maven/it/MavenITmng8594AtFileTest.java
new file mode 100644
index 0000000000..a0ad34011e
--- /dev/null
+++
b/its/core-it-suite/src/test/java/org/apache/maven/it/MavenITmng8594AtFileTest.java
@@ -0,0 +1,64 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you 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.apache.maven.it;
+
+import java.nio.file.Path;
+import java.util.List;
+
+import org.junit.jupiter.api.Test;
+
+import static org.junit.Assert.assertTrue;
+
+/**
+ * This is a test set for <a
href="https://issues.apache.org/jira/browse/MNG-8594";>MNG-8594</a>.
+ */
+class MavenITmng8594AtFileTest extends AbstractMavenIntegrationTestCase {
+
+ MavenITmng8594AtFileTest() {
+ super("[4.0.0-rc-3-SNAPSHOT,)");
+ }
+
+ /**
+ * Verify Maven picks up params/goals from atFile.
+ */
+ @Test
+ void testIt() throws Exception {
+ Path basedir =
extractResources("/mng-8594").getAbsoluteFile().toPath();
+
+ Verifier verifier = newVerifier(basedir.toString());
+ verifier.addCliArgument("-af");
+ verifier.addCliArgument("cmd.txt");
+ verifier.addCliArgument("-Dcolor1=green");
+ verifier.addCliArgument("-Dcolor2=blue");
+ verifier.addCliArgument("clean");
+ verifier.execute();
+ verifier.verifyErrorFreeLog();
+
+ // clean did run
+ verifier.verifyTextInLog("(default-clean) @ root");
+ // validate bound plugin did run
+ verifier.verifyTextInLog("(eval) @ root");
+
+ // validate properties
+ List<String> properties = verifier.loadLines("target/pom.properties");
+
assertTrue(properties.contains("session.executionProperties.color1=green")); //
CLI only
+
assertTrue(properties.contains("session.executionProperties.color2=blue")); //
both
+
assertTrue(properties.contains("session.executionProperties.color3=yellow"));
// cmd.txt only
+ }
+}
diff --git
a/its/core-it-suite/src/test/java/org/apache/maven/it/TestSuiteOrdering.java
b/its/core-it-suite/src/test/java/org/apache/maven/it/TestSuiteOrdering.java
index a303f19ca3..101ddd853e 100644
--- a/its/core-it-suite/src/test/java/org/apache/maven/it/TestSuiteOrdering.java
+++ b/its/core-it-suite/src/test/java/org/apache/maven/it/TestSuiteOrdering.java
@@ -100,6 +100,7 @@ public TestSuiteOrdering() {
* the tests are to finishing. Newer tests are also more likely to
fail, so this is
* a fail fast technique as well.
*/
+ suite.addTestSuite(MavenITmng8594AtFileTest.class);
suite.addTestSuite(MavenITmng8561SourceRootTest.class);
suite.addTestSuite(MavenITmng8523ModelPropertiesTest.class);
suite.addTestSuite(MavenITmng8527ConsumerPomTest.class);
diff --git a/its/core-it-suite/src/test/resources/mng-8594/cmd.txt
b/its/core-it-suite/src/test/resources/mng-8594/cmd.txt
new file mode 100644
index 0000000000..2d638e72a6
--- /dev/null
+++ b/its/core-it-suite/src/test/resources/mng-8594/cmd.txt
@@ -0,0 +1,3 @@
+validate
+-Dcolor2=gray
+-Dcolor3=yellow
\ No newline at end of file
diff --git a/its/core-it-suite/src/test/resources/mng-8594/pom.xml
b/its/core-it-suite/src/test/resources/mng-8594/pom.xml
new file mode 100644
index 0000000000..fa94de4747
--- /dev/null
+++ b/its/core-it-suite/src/test/resources/mng-8594/pom.xml
@@ -0,0 +1,34 @@
+<?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/maven-v4_0_0.xsd";>
+
+ <modelVersion>4.0.0</modelVersion>
+
+ <groupId>org.apache.maven.it.mng8594</groupId>
+ <artifactId>root</artifactId>
+ <version>1.0.0</version>
+
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.its.plugins</groupId>
+ <artifactId>maven-it-plugin-expression</artifactId>
+ <version>2.1-SNAPSHOT</version>
+ <configuration>
+ <outputFile>target/pom.properties</outputFile>
+ <expressions>
+ <expression>session/executionProperties</expression>
+ </expressions>
+ </configuration>
+ <executions>
+ <execution>
+ <id>eval</id>
+ <goals>
+ <goal>eval</goal>
+ </goals>
+ <phase>validate</phase>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+</project>
