Changeset 17196 in josm for trunk

Timestamp:

2020-10-13T23:13:00+02:00 (4 years ago)

Author:

simon04

Message:

see #15102 - see #16637 - get rid of real HTTP calls to ​https://www.openstreetmap.org/login in OsmOAuthAuthorizationClientTest, mock them

Location:

trunk

Files:

• src/org/openstreetmap/josm/gui/oauth/OsmOAuthAuthorizationClient.java (modified) (1 diff)
• test/unit/org/openstreetmap/josm/gui/oauth/OsmOAuthAuthorizationClientTest.java (modified) (4 diffs)

trunk/src/org/openstreetmap/josm/gui/oauth/OsmOAuthAuthorizationClient.java

@@ -47 +47 @@
     private HttpClient connection;
 
-    private static class SessionId {
-        private String id;
-        private String token;
-        private String userName;
+    protected static class SessionId {
+        protected String id;
+        protected String token;
+        protected String userName;
     }
 

trunk/test/unit/org/openstreetmap/josm/gui/oauth/OsmOAuthAuthorizationClientTest.java

@@ -2 +2 @@
 package org.openstreetmap.josm.gui.oauth;
 
+import static com.github.tomakehurst.wiremock.client.WireMock.aResponse;
+import static com.github.tomakehurst.wiremock.client.WireMock.get;
+import static com.github.tomakehurst.wiremock.client.WireMock.urlEqualTo;
+import static com.github.tomakehurst.wiremock.core.WireMockConfiguration.options;
+import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertNull;
 
 import java.net.CookieHandler;
 import java.net.CookieManager;
-import java.net.MalformedURLException;
 import java.net.URI;
-import java.net.URL;
 import java.util.Collections;
 
@@ -19 +23 @@
 
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
+
+import com.github.tomakehurst.wiremock.junit.WireMockRule;
 
 /**
@@ -33 +39 @@
 
     /**
+     * HTTP mock.
+     */
+    @Rule
+    public WireMockRule wireMockRule = new WireMockRule(options().dynamicPort());
+
+    /**
      * Unit test of {@link OsmOAuthAuthorizationClient}.
      * @throws OsmOAuthAuthorizationException if OAuth authorization error occurs
      * @throws OsmTransferCanceledException  if OSM transfer error occurs
-     * @throws MalformedURLException in case of invalid URL
      */
     @Test
-    public void testOsmOAuthAuthorizationClient() throws OsmTransferCanceledException, OsmOAuthAuthorizationException, MalformedURLException {
-        OsmOAuthAuthorizationClient client = new OsmOAuthAuthorizationClient(OAuthParameters.createDefault());
+    public void testOsmOAuthAuthorizationClient() throws OsmTransferCanceledException, OsmOAuthAuthorizationException {
+        // request token
+        wireMockRule.stubFor(get(urlEqualTo("/oauth/request_token"))
+                .willReturn(aResponse().withStatus(200).withBody(String.join("&",
+                        "oauth_token=entxUGuwRKV6KyVDF0OWScdGhbqXGMGmosXuiChR",
+                        "oauth_token_secret=nsBD2Hr5lLGDUeNoh3SnLaGsUV1TiPYM4qUr7tPB"))));
+        OsmOAuthAuthorizationClient client = new OsmOAuthAuthorizationClient(OAuthParameters.createDefault(wireMockRule.url("/api")));
+
         OAuthToken requestToken = client.getRequestToken(null);
-        assertNotNull(requestToken);
+        assertEquals("requestToken.key", "entxUGuwRKV6KyVDF0OWScdGhbqXGMGmosXuiChR", requestToken.getKey());
+        assertEquals("requestToken.secret", "nsBD2Hr5lLGDUeNoh3SnLaGsUV1TiPYM4qUr7tPB", requestToken.getSecret());
         String url = client.getAuthoriseUrl(requestToken);
-        assertNotNull(url);
-        System.out.println(new URL(url));
-        //OAuthToken accessToken = client.getAccessToken(null);
-        //assertNotNull(accessToken);
+        assertEquals("url", wireMockRule.url("/oauth/authorize?oauth_token=entxUGuwRKV6KyVDF0OWScdGhbqXGMGmosXuiChR"), url);
+
+        // access token
+        wireMockRule.stubFor(get(urlEqualTo("/oauth/access_token"))
+                .willReturn(aResponse().withStatus(200).withBody(String.join("&",
+                        "oauth_token=eGMGmosXuiChRntxUGuwRKV6KyVDF0OWScdGhbqX",
+                        "oauth_token_secret=nsBUeNor7tPh3SHr5lLaGsGDUD2PYMV1TinL4qUB"))));
+
+        OAuthToken accessToken = client.getAccessToken(null);
+        assertEquals("accessToken.key", "eGMGmosXuiChRntxUGuwRKV6KyVDF0OWScdGhbqX", accessToken.getKey());
+        assertEquals("accessToken.secret", "nsBUeNor7tPh3SHr5lLaGsGDUD2PYMV1TinL4qUB", accessToken.getSecret());
     }
 
@@ -57 +82 @@
      */
     @Test
-    public void testCookieHandling() throws Exception {
+    public void testCookieHandlingMock() throws Exception {
+        wireMockRule.stubFor(get(urlEqualTo("/login?cookie_test=true"))
+                .willReturn(aResponse()
+                        .withStatus(200)
+                        .withHeader("Set-Cookie", "_osm_session=7fe8e2ea36c6b803cb902301b28e0a; path=/; HttpOnly; SameSite=Lax")
+                .withBody("<input type=\"hidden\" " +
+                        "name=\"authenticity_token\" " +
+                        "value=\"fzp6CWJhp6Vns09re3s2Tw==\" />")));
+        final OAuthParameters parameters = OAuthParameters.createDefault(wireMockRule.url("/api"));
+        final OsmOAuthAuthorizationClient client = new OsmOAuthAuthorizationClient(parameters);
+        final OsmOAuthAuthorizationClient.SessionId sessionId = client.fetchOsmWebsiteSessionId();
+        assertNotNull(sessionId);
+        assertEquals("sessionId.id", "7fe8e2ea36c6b803cb902301b28e0a", sessionId.id);
+        assertEquals("sessionId.token", "fzp6CWJhp6Vns09re3s2Tw==", sessionId.token);
+        assertNull("sessionId.userName", sessionId.userName);
+    }
+
+    /**
+     * Unit test for correct cookie handling when logging in to the OSM website.
+     *
+     * https://josm.openstreetmap.de/ticket/12584
+     * @throws Exception if any error occurs
+     */
+    @Test
+    public void testCookieHandlingCookieManager() throws Exception {
+        // emulate Java Web Start behaviour
+        // see https://docs.oracle.com/javase/tutorial/deployment/doingMoreWithRIA/accessingCookies.html
         final OAuthParameters parameters = OAuthParameters.createDefault();
         final OsmOAuthAuthorizationClient client = new OsmOAuthAuthorizationClient(parameters);
-        assertNotNull(client.fetchOsmWebsiteSessionId());
-
-        // emulate Java Web Start behaviour
-        // see https://docs.oracle.com/javase/tutorial/deployment/doingMoreWithRIA/accessingCookies.html
         final CookieManager cm = new CookieManager();
         cm.put(new URI(parameters.getOsmLoginUrl()),