Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,18 @@
*/
package org.apache.maven.api.services.model;

/**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Weird that we have an interface here. We don't really need it for anything, but that's tangential to this PR.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Personally I agree that having an interface with 1 implementation is not as pure as it can be, though this is indeed a topic that is beyond the scope of this PR.

I think the same discussion lives in #10328

If there is a consensus on what path we are taking, we can act accordingly for this (and perhaps more) classes.

* Provide a service of {@link UrlNormalizer} that simplifies URL strings by removing parent directory
* references ("/../") and collapsing path segments. This implementation 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>Note that this implementation does not guarantee that the resulting URL is valid or reachable; it simply
* produces a more canonical representation of the input string.
*
*/
public interface UrlNormalizer {

/**
Expand Down
Original file line number Diff line number Diff line change
@@ -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"));
}
}