This is an automated email from the ASF dual-hosted git repository. slachiewicz pushed a commit to branch maven-3.9.x in repository https://gitbox.apache.org/repos/asf/maven.git
commit 0ad46162a1b6bc1007aea69acab71449896f7494 Author: Slawomir Jaranowski <[email protected]> AuthorDate: Sun Jul 12 15:17:45 2026 +0200 [MNG-5913] Allow defining aliases for existing server configurations in settings.xml * [MNG-5913] Allow defining aliases for existing server configurations in settings.xml Add the next tag aliases to the server in settings.xml Additional server will be created in memory by SettingsBuilder, so the generated configuration should be transparent to other as Settings#getServers() will return complete list. Based on commit 09b2dfc9151030e026a993f234c8e9c507c2d198 #2333 (cherry picked from commit 713b643b19179dd9364e170ebcefd4a2840a8f9f) Backport to maven-3.9.x: needed by the next commit, which adds <repositoryOrigins> to the same 1.3.0 settings model. Adapted for 3.9.x: DefaultSettingsBuilder keeps 3.9's imports; DefaultSettingsBuilderFactoryTest imports assertEquals, which 3.10.x already had. --- .../settings/building/DefaultSettingsBuilder.java | 19 ++++ .../validation/DefaultSettingsValidator.java | 17 ++++ .../DefaultSettingsBuilderFactoryTest.java | 113 ++++++++++++++++++++- .../validation/DefaultSettingsValidatorTest.java | 52 ++++++++++ .../settings/factory/settings-servers-1.xml | 37 +++++++ .../settings/factory/settings-servers-2.xml | 49 +++++++++ .../settings/factory/settings-servers-3.xml | 40 ++++++++ maven-settings/pom.xml | 5 +- maven-settings/src/main/mdo/settings.mdo | 12 +++ 9 files changed, 341 insertions(+), 3 deletions(-) diff --git a/maven-settings-builder/src/main/java/org/apache/maven/settings/building/DefaultSettingsBuilder.java b/maven-settings-builder/src/main/java/org/apache/maven/settings/building/DefaultSettingsBuilder.java index 3addf78ea5..a52481eef0 100644 --- a/maven-settings-builder/src/main/java/org/apache/maven/settings/building/DefaultSettingsBuilder.java +++ b/maven-settings-builder/src/main/java/org/apache/maven/settings/building/DefaultSettingsBuilder.java @@ -26,12 +26,16 @@ import java.io.IOException; import java.io.StringReader; import java.io.StringWriter; +import java.util.ArrayList; import java.util.Collections; import java.util.List; import java.util.Map; +import java.util.stream.Collectors; +import java.util.stream.Stream; import org.apache.maven.building.FileSource; import org.apache.maven.building.Source; +import org.apache.maven.settings.Server; import org.apache.maven.settings.Settings; import org.apache.maven.settings.TrackableBase; import org.apache.maven.settings.io.SettingsParseException; @@ -181,6 +185,7 @@ private Settings readSettings( } settingsValidator.validate(settings, problems); + settings.setServers(new ArrayList<>(serversByIds(settings.getServers()))); return settings; } @@ -250,4 +255,18 @@ public Object execute(String expression, Object value) { return result; } + + private List<Server> serversByIds(List<Server> servers) { + return servers.stream() + .flatMap(server -> Stream.concat( + Stream.of(server), server.getAliases().stream().map(id -> serverAlias(server, id)))) + .collect(Collectors.toList()); + } + + private Server serverAlias(Server server, String id) { + Server alias = server.clone(); + alias.setId(id); + alias.setAliases(Collections.emptyList()); + return alias; + } } diff --git a/maven-settings-builder/src/main/java/org/apache/maven/settings/validation/DefaultSettingsValidator.java b/maven-settings-builder/src/main/java/org/apache/maven/settings/validation/DefaultSettingsValidator.java index 3706775f73..5d32a14055 100644 --- a/maven-settings-builder/src/main/java/org/apache/maven/settings/validation/DefaultSettingsValidator.java +++ b/maven-settings-builder/src/main/java/org/apache/maven/settings/validation/DefaultSettingsValidator.java @@ -93,6 +93,23 @@ public void validate(Settings settings, SettingsProblemCollector problems) { "must be unique but found duplicate server with id " + server.getId()); } } + + for (int i = 0; i < servers.size(); i++) { + Server server = servers.get(i); + for (int a = 0; a < server.getAliases().size(); a++) { + String alias = server.getAliases().get(a); + validateStringNotEmpty( + problems, "servers.server[" + i + "].aliases[" + a + "]", alias, server.getId()); + if (!serverIds.add(alias)) { + addViolation( + problems, + Severity.WARNING, + "servers.server[" + i + "].aliases[" + a + "]", + server.getId(), + "must be unique across all server ids and aliases but found duplicate alias " + alias); + } + } + } } List<Mirror> mirrors = settings.getMirrors(); diff --git a/maven-settings-builder/src/test/java/org/apache/maven/settings/building/DefaultSettingsBuilderFactoryTest.java b/maven-settings-builder/src/test/java/org/apache/maven/settings/building/DefaultSettingsBuilderFactoryTest.java index 7aadfcb070..8ef3b03500 100644 --- a/maven-settings-builder/src/test/java/org/apache/maven/settings/building/DefaultSettingsBuilderFactoryTest.java +++ b/maven-settings-builder/src/test/java/org/apache/maven/settings/building/DefaultSettingsBuilderFactoryTest.java @@ -19,10 +19,17 @@ package org.apache.maven.settings.building; import java.io.File; +import java.util.Arrays; +import java.util.List; +import java.util.Properties; +import org.apache.maven.settings.Server; +import org.apache.maven.settings.Settings; import org.junit.jupiter.api.Test; +import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertTrue; /** * @author Benjamin Bentmann @@ -35,15 +42,117 @@ private File getSettings(String name) { @Test public void testCompleteWiring() throws Exception { + Properties properties = new Properties(); + properties.setProperty("user.home", "/home/user"); + SettingsBuilder builder = new DefaultSettingsBuilderFactory().newInstance(); assertNotNull(builder); DefaultSettingsBuildingRequest request = new DefaultSettingsBuildingRequest(); - request.setSystemProperties(System.getProperties()); + request.setSystemProperties(properties); request.setUserSettingsFile(getSettings("simple")); SettingsBuildingResult result = builder.build(request); assertNotNull(result); - assertNotNull(result.getEffectiveSettings()); + Settings settings = result.getEffectiveSettings(); + assertNotNull(settings); + + String localRepository = settings.getLocalRepository(); + assertTrue(localRepository.equals("/home/user/.m2/repository") + || localRepository.endsWith("\\home\\user\\.m2\\repository")); + } + + @Test + public void testSettingsWithServers() throws Exception { + SettingsBuilder builder = new DefaultSettingsBuilderFactory().newInstance(); + assertNotNull(builder); + + DefaultSettingsBuildingRequest request = new DefaultSettingsBuildingRequest(); + request.setSystemProperties(System.getProperties()); + request.setUserSettingsFile(getSettings("settings-servers-1")); + + Settings settings = builder.build(request).getEffectiveSettings(); + + List<Server> servers = settings.getServers(); + assertEquals(2, servers.size()); + + Server server1 = getServerById(servers, "server-1"); + assertEquals("username1", server1.getUsername()); + assertEquals("password1", server1.getPassword()); + + Server server2 = getServerById(servers, "server-2"); + assertEquals("username2", server2.getUsername()); + assertEquals("password2", server2.getPassword()); + } + + @Test + public void testSettingsWithServersAndAliases() throws Exception { + SettingsBuilder builder = new DefaultSettingsBuilderFactory().newInstance(); + assertNotNull(builder); + + DefaultSettingsBuildingRequest request = new DefaultSettingsBuildingRequest(); + request.setSystemProperties(System.getProperties()); + request.setUserSettingsFile(getSettings("settings-servers-2")); + + Settings settings = builder.build(request).getEffectiveSettings(); + + List<Server> servers = settings.getServers(); + assertEquals(6, servers.size()); + + Server server1 = getServerById(servers, "server-1"); + assertEquals("username1", server1.getUsername()); + assertEquals("password1", server1.getPassword()); + assertEquals(Arrays.asList("server-11", "server-12"), server1.getAliases()); + + Server server11 = getServerById(servers, "server-11"); + assertEquals("username1", server11.getUsername()); + assertEquals("password1", server11.getPassword()); + assertTrue(server11.getAliases().isEmpty()); + + Server server12 = getServerById(servers, "server-12"); + assertEquals("username1", server12.getUsername()); + assertEquals("password1", server12.getPassword()); + assertTrue(server12.getAliases().isEmpty()); + + Server server2 = getServerById(servers, "server-2"); + assertEquals("username2", server2.getUsername()); + assertEquals("password2", server2.getPassword()); + assertEquals(Arrays.asList("server-21"), server2.getAliases()); + + Server server21 = getServerById(servers, "server-21"); + assertEquals("username2", server21.getUsername()); + assertEquals("password2", server21.getPassword()); + assertTrue(server21.getAliases().isEmpty()); + + Server server3 = getServerById(servers, "server-3"); + assertEquals("username3", server3.getUsername()); + assertEquals("password3", server3.getPassword()); + assertTrue(server3.getAliases().isEmpty()); + } + + private Server getServerById(List<Server> servers, String id) { + return servers.stream() + .filter(s -> s.getId().equals(id)) + .findFirst() + .orElseThrow( + () -> new IllegalStateException("Server with id " + id + " not found on list: " + servers)); + } + + @Test + public void testSettingsWithDuplicateServersIds() throws Exception { + SettingsBuilder builder = new DefaultSettingsBuilderFactory().newInstance(); + assertNotNull(builder); + + DefaultSettingsBuildingRequest request = new DefaultSettingsBuildingRequest(); + request.setSystemProperties(System.getProperties()); + request.setUserSettingsFile(getSettings("settings-servers-3")); + + SettingsBuildingResult result = builder.build(request); + + List<SettingsProblem> problems = result.getProblems(); + assertEquals(1, problems.size()); + assertEquals( + "'servers.server[0].aliases[0]' for server-1 must be unique across all server ids and aliases but found duplicate alias server-2", + problems.get(0).getMessage()); } } diff --git a/maven-settings-builder/src/test/java/org/apache/maven/settings/validation/DefaultSettingsValidatorTest.java b/maven-settings-builder/src/test/java/org/apache/maven/settings/validation/DefaultSettingsValidatorTest.java index ea91fe7388..628ecc6ea4 100644 --- a/maven-settings-builder/src/test/java/org/apache/maven/settings/validation/DefaultSettingsValidatorTest.java +++ b/maven-settings-builder/src/test/java/org/apache/maven/settings/validation/DefaultSettingsValidatorTest.java @@ -214,6 +214,58 @@ public void testValidateProxy() throws Exception { assertContains(problems.messages.get(0), "'proxies.proxy.host' for default is missing"); } + @Test + void testValidateServerIdAlias() { + Settings settings = new Settings(); + Server server = new Server(); + server.setId("server-1"); + server.addAlias("server-1"); + settings.addServer(server); + + SimpleProblemCollector problems = new SimpleProblemCollector(); + validator.validate(settings, problems); + assertEquals(1, problems.messages.size()); + assertContains( + problems.messages.get(0), + "'servers.server[0].aliases[0]' for server-1 must be unique across all server ids and aliases but found duplicate alias server-1"); + } + + @Test + void testMultipleUsageOfAliases() { + Settings settings = new Settings(); + + Server server1 = new Server(); + server1.setId("server-1"); + server1.addAlias("alias-1"); + settings.addServer(server1); + + Server server2 = new Server(); + server2.setId("server-2"); + server2.addAlias("alias-1"); + settings.addServer(server2); + + SimpleProblemCollector problems = new SimpleProblemCollector(); + validator.validate(settings, problems); + assertEquals(1, problems.messages.size()); + assertContains( + problems.messages.get(0), + "'servers.server[1].aliases[0]' for server-2 must be unique across all server ids and aliases but found duplicate alias alias-1"); + } + + @Test + void testValidateServerIdAliasesWithEmptyValue() { + Settings settings = new Settings(); + Server server = new Server(); + server.setId("server-1"); + server.addAlias(""); + settings.addServer(server); + + SimpleProblemCollector problems = new SimpleProblemCollector(); + validator.validate(settings, problems); + assertEquals(1, problems.messages.size()); + assertContains(problems.messages.get(0), "'servers.server[0].aliases[0]' for server-1 is missing"); + } + private static class SimpleProblemCollector implements SettingsProblemCollector { private final List<String> messages = new ArrayList<>(); diff --git a/maven-settings-builder/src/test/resources/settings/factory/settings-servers-1.xml b/maven-settings-builder/src/test/resources/settings/factory/settings-servers-1.xml new file mode 100644 index 0000000000..7076749943 --- /dev/null +++ b/maven-settings-builder/src/test/resources/settings/factory/settings-servers-1.xml @@ -0,0 +1,37 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- +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. +--> + +<settings> + <localRepository>${user.home}/.m2/repository</localRepository> + <servers> + <server> + <id>server-1</id> + <username>username1</username> + <password>password1</password> + </server> + <server> + <id>server-2</id> + <username>username2</username> + <password>password2</password> + </server> + </servers> + +</settings> diff --git a/maven-settings-builder/src/test/resources/settings/factory/settings-servers-2.xml b/maven-settings-builder/src/test/resources/settings/factory/settings-servers-2.xml new file mode 100644 index 0000000000..a8464a49a3 --- /dev/null +++ b/maven-settings-builder/src/test/resources/settings/factory/settings-servers-2.xml @@ -0,0 +1,49 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- +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. +--> + +<settings> + <localRepository>${user.home}/.m2/repository</localRepository> + <servers> + <server> + <id>server-1</id> + <aliases> + <alias>server-11</alias> + <alias>server-12</alias> + </aliases> + <username>username1</username> + <password>password1</password> + </server> + <server> + <id>server-2</id> + <aliases> + <alias>server-21</alias> + </aliases> + <username>username2</username> + <password>password2</password> + </server> + <server> + <id>server-3</id> + <username>username3</username> + <password>password3</password> + </server> + </servers> + +</settings> diff --git a/maven-settings-builder/src/test/resources/settings/factory/settings-servers-3.xml b/maven-settings-builder/src/test/resources/settings/factory/settings-servers-3.xml new file mode 100644 index 0000000000..e0a13454e2 --- /dev/null +++ b/maven-settings-builder/src/test/resources/settings/factory/settings-servers-3.xml @@ -0,0 +1,40 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- +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. +--> + +<settings> + <localRepository>${user.home}/.m2/repository</localRepository> + <servers> + <server> + <id>server-1</id> + <aliases> + <alias>server-2</alias> + </aliases> + <username>username1</username> + <password>password1</password> + </server> + <server> + <id>server-2</id> + <username>username2</username> + <password>password2</password> + </server> + </servers> + +</settings> diff --git a/maven-settings/pom.xml b/maven-settings/pom.xml index 3a951ddb4f..6dcf38bb36 100644 --- a/maven-settings/pom.xml +++ b/maven-settings/pom.xml @@ -44,7 +44,10 @@ under the License. <groupId>org.codehaus.modello</groupId> <artifactId>modello-maven-plugin</artifactId> <configuration> - <version>1.2.0</version> + <version>1.3.0</version> + <pluralExceptions> + <aliases>alias</aliases> + </pluralExceptions> <models> <model>src/main/mdo/settings.mdo</model> </models> diff --git a/maven-settings/src/main/mdo/settings.mdo b/maven-settings/src/main/mdo/settings.mdo index ebc6ce8127..575a42c87f 100644 --- a/maven-settings/src/main/mdo/settings.mdo +++ b/maven-settings/src/main/mdo/settings.mdo @@ -581,6 +581,18 @@ ]]> </description> </field> + <field> + <name>aliases</name> + <version>1.3.0+</version> + <description>List of additional server aliases. For each alias, an additional server entry will be generated + with the same configuration as the original one, but with the ID replaced by the alias + and with an empty aliases list. + This is useful when the same credentials should be used for multiple servers.</description> + <association> + <type>String</type> + <multiplicity>*</multiplicity> + </association> + </field> </fields> </class> <class>
