From 19ba3af30a725a9f3edcec3178924d48d2071d3b Mon Sep 17 00:00:00 2001 From: Tamas Cservenak Date: Wed, 26 Feb 2025 11:33:06 +0100 Subject: [PATCH] [MNG-8594] Add atFile option Where user can create ad-hoc command line parms. The difference between .mvn/maven.conf and this file is that this file allws goals as well. The CLI and atFile are merged, in this order, hence, goals in atFile will come AFTER goals specified on CLI. --- https://issues.apache.org/jira/browse/MNG-8594 --- .../maven/api/cli/mvn/MavenOptions.java | 5 ++++ .../invoker/mvn/CommonsCliMavenOptions.java | 14 +++++++++++ .../invoker/mvn/LayeredMavenOptions.java | 5 ++++ .../maven/cling/invoker/mvn/MavenParser.java | 25 ++++++++++++++++++- 4 files changed, 48 insertions(+), 1 deletion(-) 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..e290114dec6c 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,11 @@ public interface MavenOptions extends Options { @Nonnull Optional ignoreTransitiveRepositories(); + /** + * Allows {@code @filename} to read options from file. + */ + 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/mvn/CommonsCliMavenOptions.java b/impl/maven-cli/src/main/java/org/apache/maven/cling/invoker/mvn/CommonsCliMavenOptions.java index 0ba2e6e0ab5a..51f2fe285366 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,11 @@ 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 load and merge command line options from the file as well.") + .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..9e55bb1e7d5a 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 atFile 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 =