allow to filter authorization by URL

Author: zeitlinger

modules/swagger-parser-core/src/main/java/io/swagger/v3/parser/core/models/AuthorizationValue.java

@@ -1,24 +1,26 @@
 package io.swagger.v3.parser.core.models;
 
 import java.net.URL;
-import java.util.List;
+import java.util.Objects;
+import java.util.function.Predicate;
+
 
 public class AuthorizationValue {
     private String value, type, keyName;
-    private List<URL> urls;
+    private Predicate<URL> urlMatcher;
 
     public AuthorizationValue() {
     }
 
-    public AuthorizationValue(String keyName, String value, String type, List<URL> urls) {
+    public AuthorizationValue(String keyName, String value, String type, Predicate<URL> urlMatcher) {
         this.setKeyName(keyName);
         this.setValue(value);
         this.setType(type);
-        this.setUrls(urls);
+        this.setUrlMatcher(urlMatcher);
     }
 
     public AuthorizationValue(String keyName, String value, String type) {
-        this(keyName, value, type, null);
+        this(keyName, value, type, url -> true);
     }
 
     public AuthorizationValue value(String value) {
@@ -36,8 +38,8 @@ public AuthorizationValue keyName(String keyName) {
         return this;
     }
 
-    public AuthorizationValue urls(List<URL> urls) {
-        this.urls = urls;
+    public AuthorizationValue urlMatcher(Predicate<URL> urlMatcher) {
+        setUrlMatcher(urlMatcher);
         return this;
     }
 
@@ -65,12 +67,12 @@ public void setKeyName(String keyName) {
         this.keyName = keyName;
     }
 
-    public List<URL> getUrls() {
-        return urls;
+    public Predicate<URL> getUrlMatcher() {
+        return urlMatcher;
     }
 
-    public void setUrls(List<URL> urls) {
-        this.urls = urls;
+    public void setUrlMatcher(Predicate<URL> urlMatcher) {
+        this.urlMatcher = Objects.requireNonNull(urlMatcher);
     }
 
     @Override
@@ -80,7 +82,7 @@ public int hashCode() {
         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());
+        result = prime * result + urlMatcher.hashCode();
         return result;
     }
 
@@ -117,11 +119,7 @@ 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)) {
+        if (!urlMatcher.equals(other.urlMatcher)) {
             return false;
         }
         return true;

modules/swagger-parser-v3/src/main/java/io/swagger/v3/parser/OpenAPIV3Parser.java

@@ -262,7 +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());
+            v.setUrlMatcher(value.getUrlMatcher());
 
             output.add(v);
         }

modules/swagger-parser-v3/src/main/java/io/swagger/v3/parser/util/RemoteUrl.java

@@ -115,7 +115,7 @@ 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 (auth.getUrls() == null || auth.getUrls().contains(inUrl)) {
+                        if (auth.getUrlMatcher().test(inUrl)) {
                             if ("query".equals(auth.getType())) {
                                 appendValue(inUrl, auth, query);
                             } else if ("header".equals(auth.getType())) {

modules/swagger-parser-v3/src/test/java/io/swagger/v3/parser/util/RemoteUrlTest.java

@@ -8,9 +8,7 @@
 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;
@@ -87,10 +85,9 @@ public void testAuthorizationHeaderWithMatchingUrl() throws Exception {
 
         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));
+            url -> url.toString().startsWith("http://localhost"));
+        final String actualBody = RemoteUrl.urlToString(getUrl(), Arrays.asList(authorizationValue));
 
         assertEquals(actualBody, expectedBody);
 
@@ -106,11 +103,10 @@ 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));
+            headerValue, "header", u -> false);
+        final String actualBody = RemoteUrl.urlToString(getUrl(), Arrays.asList(authorizationValue));
 
         assertEquals(actualBody, expectedBody);