allow to filter authorization by URL

zeitlinger · zeitlinger · commit 833310e1c940 · 2019-09-04T16:11:32.000+02:00
diff --git a/modules/swagger-parser-core/src/main/java/io/swagger/v3/parser/core/models/AuthorizationValue.java b/modules/swagger-parser-core/src/main/java/io/swagger/v3/parser/core/models/AuthorizationValue.java
@@ -1,15 +1,24 @@
 package io.swagger.v3.parser.core.models;
 
+import java.net.URL;
+import java.util.List;
+
 public class AuthorizationValue {
     private String value, type, keyName;
+    private List<URL> urls;
 
     public AuthorizationValue() {
     }
 
-    public AuthorizationValue(String keyName, String value, String type) {
+    public AuthorizationValue(String keyName, String value, String type, List<URL> urls) {
         this.setKeyName(keyName);
         this.setValue(value);
         this.setType(type);
+        this.setUrls(urls);
+    }
+
+    public AuthorizationValue(String keyName, String value, String type) {
+        this(keyName, value, type, null);
     }
 
     public AuthorizationValue value(String value) {
@@ -27,6 +36,11 @@ public AuthorizationValue keyName(String keyName) {
         return this;
     }
 
+    public AuthorizationValue urls(List<URL> urls) {
+        this.urls = urls;
+        return this;
+    }
+
     public String getValue() {
         return value;
     }
@@ -51,13 +65,22 @@ public void setKeyName(String keyName) {
         this.keyName = keyName;
     }
 
+    public List<URL> getUrls() {
+        return urls;
+    }
+
+    public void setUrls(List<URL> urls) {
+        this.urls = urls;
+    }
+
     @Override
     public int hashCode() {
         final int prime = 31;
         int result = 1;
         result = prime * result + ((keyName == null) ? 0 : keyName.hashCode());
         result = prime * result + ((type == null) ? 0 : type.hashCode());
         result = prime * result + ((value == null) ? 0 : value.hashCode());
+        result = prime * result + ((urls == null) ? 0 : urls.hashCode());
         return result;
     }
 
@@ -94,6 +117,13 @@ public boolean equals(Object obj) {
         } else if (!value.equals(other.value)) {
             return false;
         }
+        if (urls == null) {
+            if (other.urls != null) {
+                return false;
+            }
+        } else if (!urls.equals(other.urls)) {
+            return false;
+        }
         return true;
     }
 }
diff --git a/modules/swagger-parser-v3/src/main/java/io/swagger/v3/parser/OpenAPIV3Parser.java b/modules/swagger-parser-v3/src/main/java/io/swagger/v3/parser/OpenAPIV3Parser.java
@@ -13,10 +13,10 @@
 import io.swagger.v3.parser.util.RemoteUrl;
 import io.swagger.v3.parser.util.ResolverFully;
 import org.apache.commons.io.FileUtils;
-import javax.net.ssl.SSLHandshakeException;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import javax.net.ssl.SSLHandshakeException;
 import java.net.URI;
 import java.nio.charset.Charset;
 import java.nio.file.Files;
@@ -127,7 +127,7 @@ private ObjectMapper getRightMapper(String data) {
       }
       return mapper;
     }
-    
+
     public SwaggerParseResult readWithInfo(String location, List<AuthorizationValue> auths) {
         String data;
 
@@ -175,7 +175,7 @@ public SwaggerParseResult readContents(String swaggerAsString, List<Authorizatio
         SwaggerParseResult result = new SwaggerParseResult();
         if(swaggerAsString != null && !"".equals(swaggerAsString.trim())) {
             ObjectMapper mapper = getRightMapper(swaggerAsString);
-            
+
             if(auth == null) {
                 auth = new ArrayList<>();
             }
@@ -217,7 +217,7 @@ public SwaggerParseResult readContents(String swaggerAsString, List<Authorizatio
      * Locates extensions on the current thread class loader and then, if it differs
      * from this class classloader (as in OSGi), locates extensions from this
      * class classloader as well.
-     * 
+     *
      * @return a list of extensions
      */
     public static List<SwaggerParserExtension> getExtensions() {
@@ -262,6 +262,7 @@ protected List<AuthorizationValue> transform(List<AuthorizationValue> input) {
             v.setKeyName(value.getKeyName());
             v.setValue(value.getValue());
             v.setType(value.getType());
+            v.setUrls(value.getUrls());
 
             output.add(v);
         }
diff --git a/modules/swagger-parser-v3/src/main/java/io/swagger/v3/parser/util/RemoteUrl.java b/modules/swagger-parser-v3/src/main/java/io/swagger/v3/parser/util/RemoteUrl.java
@@ -115,10 +115,12 @@ public static String urlToString(String url, List<AuthorizationValue> auths) thr
                 final List<AuthorizationValue> header = new ArrayList<>();
                 if (auths != null && auths.size() > 0) {
                     for (AuthorizationValue auth : auths) {
-                        if ("query".equals(auth.getType())) {
-                            appendValue(inUrl, auth, query);
-                        } else if ("header".equals(auth.getType())) {
-                            appendValue(inUrl, auth, header);
+                        if (auth.getUrls() == null || auth.getUrls().contains(inUrl)) {
+                            if ("query".equals(auth.getType())) {
+                                appendValue(inUrl, auth, query);
+                            } else if ("header".equals(auth.getType())) {
+                                appendValue(inUrl, auth, header);
+                            }
                         }
                     }
                 }
diff --git a/modules/swagger-parser-v3/src/test/java/io/swagger/v3/parser/util/RemoteUrlTest.java b/modules/swagger-parser-v3/src/test/java/io/swagger/v3/parser/util/RemoteUrlTest.java
@@ -2,22 +2,26 @@
 
 import com.github.tomakehurst.wiremock.WireMockServer;
 import com.github.tomakehurst.wiremock.client.WireMock;
+import com.github.tomakehurst.wiremock.verification.LoggedRequest;
 import io.swagger.v3.parser.core.models.AuthorizationValue;
 import org.testng.annotations.AfterMethod;
 import org.testng.annotations.BeforeMethod;
 import org.testng.annotations.Test;
 
+import java.net.URL;
 import java.util.Arrays;
+import java.util.Collections;
+import java.util.List;
 
 import static com.github.tomakehurst.wiremock.client.WireMock.aResponse;
 import static com.github.tomakehurst.wiremock.client.WireMock.equalTo;
 import static com.github.tomakehurst.wiremock.client.WireMock.get;
 import static com.github.tomakehurst.wiremock.client.WireMock.getRequestedFor;
 import static com.github.tomakehurst.wiremock.client.WireMock.stubFor;
 import static com.github.tomakehurst.wiremock.client.WireMock.urlEqualTo;
-import static com.github.tomakehurst.wiremock.client.WireMock.urlPathEqualTo;
 import static com.github.tomakehurst.wiremock.client.WireMock.verify;
 import static org.testng.Assert.assertEquals;
+import static org.testng.Assert.assertFalse;
 
 public class RemoteUrlTest {
 
@@ -76,6 +80,45 @@ public void testAuthorizationHeader() throws Exception {
         );
     }
 
+    @Test
+    public void testAuthorizationHeaderWithMatchingUrl() throws Exception {
+
+        final String expectedBody = setupStub();
+
+        final String headerName = "Authorization";
+        final String headerValue = "foobar";
+        String url = getUrl();
+        final AuthorizationValue authorizationValue = new AuthorizationValue(headerName, headerValue, "header",
+            Collections.singletonList(new URL(url)));
+        final String actualBody = RemoteUrl.urlToString(url, Arrays.asList(authorizationValue));
+
+        assertEquals(actualBody, expectedBody);
+
+        verify(getRequestedFor(urlEqualTo("/v2/pet/1"))
+                        .withHeader("Accept", equalTo(EXPECTED_ACCEPTS_HEADER))
+                        .withHeader(headerName, equalTo(headerValue))
+        );
+    }
+
+    @Test
+    public void testAuthorizationHeaderWithNonMatchingUrl() throws Exception {
+
+        final String expectedBody = setupStub();
+
+        final String headerValue = "foobar";
+        String url = getUrl();
+        String authorization = "Authorization";
+        final AuthorizationValue authorizationValue = new AuthorizationValue(authorization,
+            headerValue, "header", Collections.singletonList(new URL("http://foo.com")));
+        final String actualBody = RemoteUrl.urlToString(url, Arrays.asList(authorizationValue));
+
+        assertEquals(actualBody, expectedBody);
+
+        List<LoggedRequest> requests = WireMock.findAll(getRequestedFor(urlEqualTo("/v2/pet/1")));
+        assertEquals(1, requests.size());
+        assertFalse(requests.get(0).containsHeader(authorization));
+    }
+
     private String getUrl() {
         return String.format("http://%s:%d/v2/pet/1", LOCALHOST, WIRE_MOCK_PORT);
     }

Original file line number	Diff line number	Diff line change
`@@ -115,10 +115,12 @@ public static String urlToString(String url, List<AuthorizationValue> auths) thr`
`115`	`115`	`final List<AuthorizationValue> header = new ArrayList<>();`
`116`	`116`	`if (auths != null && auths.size() > 0) {`
`117`	`117`	`for (AuthorizationValue auth : auths) {`
`118`		`- if ("query".equals(auth.getType())) {`
`119`		`- appendValue(inUrl, auth, query);`
`120`		`- } else if ("header".equals(auth.getType())) {`
`121`		`- appendValue(inUrl, auth, header);`
	`118`	`+ if (auth.getUrls() == null \|\| auth.getUrls().contains(inUrl)) {`
	`119`	`+ if ("query".equals(auth.getType())) {`
	`120`	`+ appendValue(inUrl, auth, query);`
	`121`	`+ } else if ("header".equals(auth.getType())) {`
	`122`	`+ appendValue(inUrl, auth, header);`
	`123`	`+ }`
`122`	`124`	`}`
`123`	`125`	`}`
`124`	`126`	`}`