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 21f241750e26..2387105a3a24 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 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 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 4d9d7b6c09ee..2f9c367c4786 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> collectMapIfPresentOrEmpty( Optional> up = getter.apply(option); if (up.isPresent()) { had++; - items.putAll(up.get()); + for (Map.Entry 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 0ba2e6e0ab5a..180d756e4d73 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 ignoreTransitiveRepositories() { return Optional.empty(); } + @Override + public Optional atFile() { + if (commandLine.hasOption(CLIManager.AT_FILE)) { + return Optional.of(commandLine.getOptionValue(CLIManager.AT_FILE)); + } + return Optional.empty(); + } + @Override public Optional> 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 353f795913a4..d88e08b04721 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 ignoreTransitiveRepositories() { return returnFirstPresentOrEmpty(MavenOptions::ignoreTransitiveRepositories); } + @Override + public Optional atFile() { + return returnFirstPresentOrEmpty(MavenOptions::atFile); + } + @Override public Optional> 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 7de8e0d51889..fd030ba1858c 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 parseCliOptions(LocalContext context) { ArrayList 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 args) { } } + protected MavenOptions parseMavenAtFileOptions(Path atFile) { + try (Stream lines = Files.lines(atFile, Charset.defaultCharset())) { + List 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 lines = Files.lines(configFile, Charset.defaultCharset())) { List 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 000000000000..a0ad34011e01 --- /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 MNG-8594. + */ +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 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 a303f19ca3dd..101ddd853ea4 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 000000000000..2d638e72a64a --- /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 000000000000..fa94de4747bc --- /dev/null +++ b/its/core-it-suite/src/test/resources/mng-8594/pom.xml @@ -0,0 +1,34 @@ + + + + 4.0.0 + + org.apache.maven.it.mng8594 + root + 1.0.0 + + + + + org.apache.maven.its.plugins + maven-it-plugin-expression + 2.1-SNAPSHOT + + target/pom.properties + + session/executionProperties + + + + + eval + + eval + + validate + + + + + +