This is an automated email from the ASF dual-hosted git repository.
gnodet pushed a commit to branch button-starfish
in repository https://gitbox.apache.org/repos/asf/maven.git
The following commit(s) were added to refs/heads/button-starfish by this push:
new caaf766347 [ISSUE-10329] Document behaviour of UrlNormalizer
caaf766347 is described below
commit caaf7663475be40750b9adcea45cbf4ace2be2d1
Author: Guillaume Nodet <[email protected]>
AuthorDate: Wed Jun 17 15:28:55 2026 +0200
[ISSUE-10329] Document behaviour of UrlNormalizer
Add detailed Javadoc to UrlNormalizer interface explaining its
string-based URL normalization behavior, and add comprehensive
tests for DefaultUrlNormalizer covering null/edge cases, HTTP URLs,
parent directory resolution, double slashes, and URL structure
preservation.
Closes #10329
Co-Authored-By: Claude Opus 4.6 <[email protected]>
---
.../maven/api/services/model/UrlNormalizer.java | 9 ++-
.../maven/impl/DefaultUrlNormalizerTest.java | 69 ++++++++++++++++++++++
2 files changed, 77 insertions(+), 1 deletion(-)
diff --git
a/api/maven-api-spi/src/main/java/org/apache/maven/api/services/model/UrlNormalizer.java
b/api/maven-api-spi/src/main/java/org/apache/maven/api/services/model/UrlNormalizer.java
index 8ee4e470ac..52eb87e0f1 100644
---
a/api/maven-api-spi/src/main/java/org/apache/maven/api/services/model/UrlNormalizer.java
+++
b/api/maven-api-spi/src/main/java/org/apache/maven/api/services/model/UrlNormalizer.java
@@ -19,7 +19,14 @@
package org.apache.maven.api.services.model;
/**
- * Normalizes URLs by resolving relative references.
+ * Simplifies URLs by removing parent directory references ("/../") and
collapsing path segments.
+ * This performs purely string-based normalization without full URL parsing or
validation.
+ *
+ * <p>The normalization process iteratively removes "/../" segments by
eliminating the preceding path segment,
+ * effectively resolving relative path traversals.
+ *
+ * <p>This does not guarantee that the resulting URL is valid or reachable; it
simply
+ * produces a more canonical representation of the input string.
*
* @since 4.0.0
*/
diff --git
a/impl/maven-impl/src/test/java/org/apache/maven/impl/DefaultUrlNormalizerTest.java
b/impl/maven-impl/src/test/java/org/apache/maven/impl/DefaultUrlNormalizerTest.java
new file mode 100644
index 0000000000..1ea3fa0078
--- /dev/null
+++
b/impl/maven-impl/src/test/java/org/apache/maven/impl/DefaultUrlNormalizerTest.java
@@ -0,0 +1,69 @@
+/*
+ * 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.impl;
+
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNull;
+
+class DefaultUrlNormalizerTest {
+
+ private final DefaultUrlNormalizer sut = new DefaultUrlNormalizer();
+
+ @Test
+ void normalizeShouldHandleNullAndEdgeCases() {
+ assertNull(sut.normalize(null));
+ assertEquals("", sut.normalize(""));
+ assertEquals("/", sut.normalize("/../"));
+ assertEquals("", sut.normalize("a/../"));
+ assertEquals("b", sut.normalize("a/../b"));
+ assertEquals("b/d", sut.normalize("a/../b/c/../d"));
+ assertEquals("b/c/d", sut.normalize("a/../b/c/d"));
+ assertEquals("b/c", sut.normalize("a/../b/c"));
+ assertEquals("b/", sut.normalize("a/../b/c/../"));
+ assertEquals("../", sut.normalize("../"));
+ }
+
+ @Test
+ void normalizeShouldPreserveHttpUrlTrailingSlash() {
+ assertEquals("https://example.com/path";,
sut.normalize("https://example.com/path";));
+ assertEquals("https://example.com/path/";,
sut.normalize("https://example.com/path/";));
+ }
+
+ @Test
+ void normalizeShouldCollapseParentReferencesInUrl() {
+ assertEquals("https://example.com/child";,
sut.normalize("https://example.com/parent/../child";));
+ assertEquals("https://example.com/child";,
sut.normalize("https://example.com/grand/parent/../../child";));
+ }
+
+ @Test
+ void normalizeHandlesDoubleSlashesAfterParent() {
+ assertEquals("https://example.com//child";,
sut.normalize("https://example.com/parent/..//child";));
+ assertEquals("https://example.com/child";,
sut.normalize("https://example.com/parent//../child";));
+ }
+
+ @Test
+ void normalizeShouldPreserveOriginalUrlStructure() {
+ assertEquals("file:////some/server",
sut.normalize("file:////some/server"));
+ assertEquals("https://example.com/a%20b/c%20d";,
sut.normalize("https://example.com/a%20b/c%20d";));
+ assertEquals("https://example.com/a b/c d",
sut.normalize("https://example.com/a b/c d"));
+ assertEquals("ht!tps:/bad_url", sut.normalize("ht!tps:/bad_url"));
+ }
+}
