Changeset 19651 in josm for trunk/test

Timestamp:

2026-10-22T16:46:16+02:00 (11 days ago)

Author:

stoecker

Message:

fix #24907 - patch by wangi - Trailing slash in API breaks OAuth and links - better normalization

Location:

trunk

Files:

• . (modified) (1 prop)
• test/unit/org/openstreetmap/josm/data/preferences/JosmUrlsTest.java (modified) (1 diff)
• test/unit/org/openstreetmap/josm/io/OsmApiTest.java (modified) (3 diffs)

trunk

@@ -25 +25 @@
 target
 failed.png
+dependency-reduced-pom.xml

@@ -25 +25 @@
 target
 failed.png
+dependency-reduced-pom.xml

trunk/test/unit/org/openstreetmap/josm/data/preferences/JosmUrlsTest.java

@@ -20 +20 @@
         assertEquals("https://api06.dev.openstreetmap.org/user", Config.getUrls().getBaseUserUrl());
     }
+
+    /**
+     * An API URL entered with a trailing slash must give the same web site URLs as one without, so that
+     * "History (web)" and the other links to the server are built from the web site and not from the API path.
+     */
+    @Test
+    void testApiUrlWithTrailingSlash() {
+        Config.getPref().put("osm-server.url", "https://api06.dev.openstreetmap.org/api/");
+        assertEquals("https://api06.dev.openstreetmap.org", Config.getUrls().getOSMWebsiteDependingOnSelectedApi());
+        assertEquals("https://api06.dev.openstreetmap.org", Config.getUrls().getBaseBrowseUrl());
+        assertEquals("https://api06.dev.openstreetmap.org/user", Config.getUrls().getBaseUserUrl());
+    }
+
+    /**
+     * The default API URL is recognized even when it is entered with a trailing slash, so the links point to
+     * the OSM web site rather than to the API host.
+     */
+    @Test
+    void testDefaultApiUrlWithTrailingSlash() {
+        Config.getPref().put("osm-server.url", Config.getUrls().getDefaultOsmApiUrl() + '/');
+        assertEquals(Config.getUrls().getOSMWebsite(), Config.getUrls().getOSMWebsiteDependingOnSelectedApi());
+    }
 }

trunk/test/unit/org/openstreetmap/josm/io/OsmApiTest.java

@@ -3 +3 @@
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNull;
+import static org.junit.jupiter.api.Assertions.assertSame;
 
 import java.io.ByteArrayInputStream;
@@ -11 +13 @@
 import org.openstreetmap.josm.data.osm.User;
 import org.openstreetmap.josm.gui.progress.NullProgressMonitor;
+import org.openstreetmap.josm.spi.preferences.Config;
+import org.openstreetmap.josm.testutils.annotations.BasicPreferences;
 
 /**
  * Unit tests of {@link OsmApi} class.
  */
+@BasicPreferences
+@org.openstreetmap.josm.testutils.annotations.OsmApi
 class OsmApiTest {
     /**
@@ -37 +43 @@
         assertEquals(User.getAnonymous(), cs2.getUser());
     }
+
+    /**
+     * Unit test of {@link OsmApi#normalizeApiUrl}: white space and trailing slashes are removed.
+     */
+    @Test
+    void testNormalizeApiUrl() {
+        assertEquals("https://example.com/api", OsmApi.normalizeApiUrl("https://example.com/api"));
+        assertEquals("https://example.com/api", OsmApi.normalizeApiUrl("https://example.com/api/"));
+        assertEquals("https://example.com/api", OsmApi.normalizeApiUrl("https://example.com/api///"));
+        assertEquals("https://example.com/api", OsmApi.normalizeApiUrl("  https://example.com/api/\t"));
+        assertEquals("https://example.com", OsmApi.normalizeApiUrl("https://example.com/"));
+        assertEquals("", OsmApi.normalizeApiUrl("   "));
+        assertNull(OsmApi.normalizeApiUrl(null));
+        // the slashes of the scheme must not be eaten
+        assertEquals("https://", OsmApi.normalizeApiUrl("https://"));
+    }
+
+    /**
+     * A URL which only differs by a trailing slash is the same API, and is stored without the slash.
+     */
+    @Test
+    void testGetOsmApiIgnoresTrailingSlash() {
+        OsmApi api = OsmApi.getOsmApi("https://example.com/api/");
+        assertEquals("https://example.com/api", api.getServerUrl());
+        assertSame(api, OsmApi.getOsmApi("https://example.com/api"));
+        assertSame(api, OsmApi.getOsmApi(" https://example.com/api// "));
+    }
+
+    /**
+     * An API URL stored with a trailing slash is used without it, so that code comparing it to a known URL or
+     * deriving another URL from it works. Non-regression test for the OAuth and "History (web)" breakage.
+     */
+    @Test
+    void testTrailingSlashInPreference() {
+        Config.getPref().put("osm-server.url", "https://example.com/api/");
+        assertEquals("https://example.com/api", OsmApi.getOsmApi().getServerUrl());
+        assertEquals("https://example.com/api/", OsmApi.getOsmApi().getBaseUrl());
+    }
 }

@@ -25 +25 @@
 target
 failed.png
+dependency-reduced-pom.xml