Refactored OIDC metadata fetcher

[#157639907] https://www.pivotaltracker.com/story/show/157639907

Signed-off-by: Bruce Ricard <bricard@pivotal.io>
Co-authored-by: Bruce Ricard <bricard@pivotal.io>

server/src/main/java/org/cloudfoundry/identity/uaa/provider/oauth/OidcMetadataDiscoverer.java → server/src/main/java/org/cloudfoundry/identity/uaa/provider/oauth/OidcMetadataFetcher.java

@@ -9,37 +9,41 @@
 import java.io.IOException;
 import java.net.URL;
 
-public class OidcMetadataDiscoverer {
+public class OidcMetadataFetcher {
     private final UrlContentCache contentCache;
     private final RestTemplate trustingRestTemplate;
     private final RestTemplate nonTrustingRestTemplate;
 
-    public OidcMetadataDiscoverer(UrlContentCache contentCache,
-                                  RestTemplate trustingRestTemplate,
-                                  RestTemplate nonTrustingRestTemplate
+    public OidcMetadataFetcher(UrlContentCache contentCache,
+                               RestTemplate trustingRestTemplate,
+                               RestTemplate nonTrustingRestTemplate
     ) {
         this.contentCache = contentCache;
         this.trustingRestTemplate = trustingRestTemplate;
         this.nonTrustingRestTemplate = nonTrustingRestTemplate;
     }
 
-    public void performDiscoveryAndUpdateDefinition(OIDCIdentityProviderDefinition definition) throws IOException {
-        if (shouldPerformDiscovery(definition)) {
+    public void fetchMetadataAndUpdateDefinition(OIDCIdentityProviderDefinition definition) throws OidcMetadataFetchingException {
+        if (shouldFetchMetadata(definition)) {
             OidcMetadata oidcMetadata =
-                    performDiscovery(definition.getDiscoveryUrl(), definition.isSkipSslValidation());
+                    fetchMetadata(definition.getDiscoveryUrl(), definition.isSkipSslValidation());
 
             updateIdpDefinition(definition, oidcMetadata);
         }
     }
 
-    private OidcMetadata performDiscovery(URL discoveryUrl, boolean shouldDoSslValidation) throws IOException {
+    private OidcMetadata fetchMetadata(URL discoveryUrl, boolean shouldDoSslValidation) throws OidcMetadataFetchingException {
         byte[] rawContents;
         if (shouldDoSslValidation) {
             rawContents = contentCache.getUrlContent(discoveryUrl.toString(), trustingRestTemplate);
         } else {
             rawContents = contentCache.getUrlContent(discoveryUrl.toString(), nonTrustingRestTemplate);
         }
-        return new ObjectMapper().readValue(rawContents, OidcMetadata.class);
+        try {
+            return new ObjectMapper().readValue(rawContents, OidcMetadata.class);
+        } catch (IOException e) {
+            throw new OidcMetadataFetchingException(e);
+        }
     }
 
     private void updateIdpDefinition(OIDCIdentityProviderDefinition definition, OidcMetadata oidcMetadata) {
@@ -50,7 +54,7 @@ private void updateIdpDefinition(OIDCIdentityProviderDefinition definition, Oidc
         definition.setIssuer(oidcMetadata.getIssuer());
     }
 
-    private boolean shouldPerformDiscovery(OIDCIdentityProviderDefinition definition) {
+    private boolean shouldFetchMetadata(OIDCIdentityProviderDefinition definition) {
         return definition.getDiscoveryUrl() != null && !StringUtils.isBlank(definition.getDiscoveryUrl().toString());
     }
 }

server/src/main/java/org/cloudfoundry/identity/uaa/provider/oauth/OidcMetadataFetchingException.java

@@ -0,0 +1,15 @@
+package org.cloudfoundry.identity.uaa.provider.oauth;
+
+public class OidcMetadataFetchingException extends Exception {
+    public OidcMetadataFetchingException(String message) {
+        super(message);
+    }
+
+    public OidcMetadataFetchingException(String message, Throwable cause) {
+        super(message, cause);
+    }
+
+    public OidcMetadataFetchingException(Throwable cause) {
+        super(cause);
+    }
+}

server/src/test/java/org/cloudfoundry/identity/uaa/provider/oauth/OidcMetadataDiscovererTest.java → server/src/test/java/org/cloudfoundry/identity/uaa/provider/oauth/OidcMetadataFetcherTest.java

@@ -1,5 +1,6 @@
 package org.cloudfoundry.identity.uaa.provider.oauth;
 
+import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import org.cloudfoundry.identity.uaa.cache.ExpiringUrlCache;
 import org.cloudfoundry.identity.uaa.cache.UrlContentCache;
@@ -11,6 +12,7 @@
 import org.springframework.web.client.RestTemplate;
 
 import java.io.IOException;
+import java.net.MalformedURLException;
 import java.net.URI;
 import java.net.URL;
 import java.time.Duration;
@@ -22,8 +24,8 @@
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.when;
 
-class OidcMetadataDiscovererTest {
-    private OidcMetadataDiscoverer metadataDiscoverer;
+class OidcMetadataFetcherTest {
+    private OidcMetadataFetcher metadataDiscoverer;
     private UrlContentCache urlContentCache;
     private RestTemplate restTemplate;
 
@@ -36,16 +38,16 @@ void setUp() {
         urlContentCache = new ExpiringUrlCache(Duration.ofMinutes(2), new TimeServiceImpl(), 2);
         restTemplate = mock(RestTemplate.class, Answers.RETURNS_DEEP_STUBS);
 
-        metadataDiscoverer = new OidcMetadataDiscoverer(urlContentCache, restTemplate, restTemplate);
+        metadataDiscoverer = new OidcMetadataFetcher(urlContentCache, restTemplate, restTemplate);
     }
 
     @Test
-    public void withoutDiscoveryUrl_shouldNotPerformDiscovery() throws IOException {
+    public void withoutDiscoveryUrl_shouldNotPerformDiscovery() throws OidcMetadataFetchingException, MalformedURLException {
         definition = new OIDCIdentityProviderDefinition();
         definition.setAuthUrl(new URL("http://not.updated"));
         definition.setTokenUrl(new URL("http://not.updated"));
 
-        metadataDiscoverer.performDiscoveryAndUpdateDefinition(definition);
+        metadataDiscoverer.fetchMetadataAndUpdateDefinition(definition);
 
         assertThat(definition, is(notNullValue()));
         assertThat(definition.getDiscoveryUrl(), nullValue());
@@ -54,15 +56,15 @@ public void withoutDiscoveryUrl_shouldNotPerformDiscovery() throws IOException {
     }
 
     @Test
-    public void withDiscoveryUrl_shouldPerformDiscovery() throws IOException {
+    public void withDiscoveryUrl_shouldPerformDiscovery() throws OidcMetadataFetchingException, MalformedURLException, JsonProcessingException {
         definition = new OIDCIdentityProviderDefinition();
         definition.setAuthUrl(new URL("http://should.be.updated"));
         definition.setTokenUrl(new URL("http://should.be.updated"));
         definition.setDiscoveryUrl(new URL("http://discovery.com"));
         when(restTemplate.getForObject(any(URI.class), eq(byte[].class)))
                 .thenReturn(objectMapper.writeValueAsBytes(buildOidcMetadata()));
 
-        metadataDiscoverer.performDiscoveryAndUpdateDefinition(definition);
+        metadataDiscoverer.fetchMetadataAndUpdateDefinition(definition);
 
         assertThat(definition, is(notNullValue()));
         assertThat(definition.getAuthUrl().toString(), is("http://authz.endpoint"));
@@ -73,7 +75,7 @@ public void withDiscoveryUrl_shouldPerformDiscovery() throws IOException {
     }
 
     @Test
-    public void withDiscoveryUrl_usesCache() throws IOException {
+    public void withDiscoveryUrl_usesCache() throws OidcMetadataFetchingException, MalformedURLException, JsonProcessingException {
         definition = new OIDCIdentityProviderDefinition();
         definition.setAuthUrl(new URL("http://should.be.updated"));
         definition.setTokenUrl(new URL("http://should.be.updated"));
@@ -84,8 +86,8 @@ public void withDiscoveryUrl_usesCache() throws IOException {
                 .thenReturn(objectMapper.writeValueAsBytes(buildOidcMetadata()))
                 .thenThrow(new RuntimeException("shouldn't have been called more than once"));
 
-        metadataDiscoverer.performDiscoveryAndUpdateDefinition(definition);
-        metadataDiscoverer.performDiscoveryAndUpdateDefinition(definition);
+        metadataDiscoverer.fetchMetadataAndUpdateDefinition(definition);
+        metadataDiscoverer.fetchMetadataAndUpdateDefinition(definition);
     }
 
     private OidcMetadata buildOidcMetadata() {