GH-264 loosening the workspace validation to ease its use

Author: francoisledroff

core/src/main/java/com/adobe/aio/workspace/Workspace.java

@@ -58,6 +58,9 @@ public static Builder builder() {
 
   public void validateAll() {
     validateWorkspaceContext();
+    if (StringUtils.isEmpty(apiKey)) {
+      throw new IllegalStateException("Your `Workspace` is missing an apiKey");
+    }
     if (!isAuthOAuth() && !isAuthJWT()) {
       throw new IllegalStateException("Missing auth configuration, set either jwt or oauth...");
     }
@@ -76,23 +79,12 @@ public void validateWorkspaceContext() throws IllegalStateException {
     if (StringUtils.isEmpty(this.getConsumerOrgId())) {
       throw new IllegalStateException("Your `Workspace` is missing a consumerOrgId");
     }
-    if (StringUtils.isEmpty(apiKey)) {
-      throw new IllegalStateException("Your `Workspace` is missing an apiKey");
-    }
     if (StringUtils.isEmpty(this.getProjectId())) {
       throw new IllegalStateException("Your `Workspace` is missing a projectId");
     }
     if (StringUtils.isEmpty(this.getWorkspaceId())) {
       throw new IllegalStateException("Your `Workspace` is missing a workspaceId");
     }
-    // note that the credentialId is optional
-    // but it might be handy to have it in your `Workspace` POJO,
-    // to avoid confusion when you have multiple credentials,
-    // and to eventually in some Adobe API calls
-
-    if (authContext == null) {
-      throw new IllegalStateException("Missing auth configuration ...");
-    }
   }
 
   public String getProjectUrl() {

core/src/test/java/com/adobe/aio/workspace/WorkspaceTest.java

@@ -15,8 +15,11 @@
 import java.security.KeyPair;
 import java.security.KeyPairGenerator;
 import java.security.PrivateKey;
+import java.util.HashSet;
+import java.util.Set;
 
 import com.adobe.aio.auth.Context;
+import com.adobe.aio.auth.OAuthContext;
 import com.adobe.aio.util.Constants;
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.Test;
@@ -38,22 +41,16 @@ public static void beforeClass() throws Exception {
 
   @Test
   public void successFullBuilder() throws IOException {
-
-    class MockContext implements Context {
-      @Override
-      public void validate() {
-
-      }
-    }
-
+    Set<String> scopes = new HashSet<>();
+    scopes.add("scope1");
     Workspace actual = Workspace.builder()
         .imsUrl(Constants.PROD_IMS_URL)
         .imsOrgId(Workspace.IMS_ORG_ID + TEST_VALUE)
         .apiKey(Workspace.API_KEY + TEST_VALUE)
         .consumerOrgId(Workspace.CONSUMER_ORG_ID + TEST_VALUE)
         .projectId(Workspace.PROJECT_ID + TEST_VALUE)
         .workspaceId(Workspace.WORKSPACE_ID + TEST_VALUE)
-        .authContext(new MockContext())
+        .authContext(new OAuthContext("someClientSecret", scopes))
         .build();
 
     assertEquals(Workspace.IMS_ORG_ID + TEST_VALUE, actual.getImsOrgId());
@@ -63,6 +60,21 @@ public void validate() {
     assertEquals(Workspace.WORKSPACE_ID + TEST_VALUE, actual.getWorkspaceId());
     assertEquals(Constants.PROD_IMS_URL, actual.getImsUrl());
     actual.validateWorkspaceContext();
+    actual.validateAll();
+  }
+
+  @Test
+  public void missingApiKey() {
+    Workspace actual = Workspace.builder()
+            .imsUrl(Constants.PROD_IMS_URL)
+            .imsOrgId(Workspace.IMS_ORG_ID + TEST_VALUE)
+            .consumerOrgId(Workspace.CONSUMER_ORG_ID + TEST_VALUE)
+            .projectId(Workspace.PROJECT_ID + TEST_VALUE)
+            .workspaceId(Workspace.WORKSPACE_ID + TEST_VALUE)
+            .build();
+    actual.validateWorkspaceContext();
+    Exception ex = assertThrows(IllegalStateException.class, actual::validateAll);
+    assertEquals("Your `Workspace` is missing an apiKey", ex.getMessage());
   }
 
   @Test
@@ -81,16 +93,6 @@ public void missingConsumerOrgId() {
     assertEquals("Your `Workspace` is missing a consumerOrgId", ex.getMessage());
   }
 
-  @Test
-  public void missingApiKey() {
-    Workspace actual = Workspace.builder()
-        .imsOrgId(Workspace.IMS_ORG_ID + TEST_VALUE)
-        .consumerOrgId(Workspace.CONSUMER_ORG_ID + TEST_VALUE)
-        .build();
-    Exception ex = assertThrows(IllegalStateException.class, actual::validateWorkspaceContext);
-    assertEquals("Your `Workspace` is missing an apiKey", ex.getMessage());
-  }
-
   @Test
   public void missingProjectId() {
     Workspace actual = Workspace.builder()

ims/src/main/java/com/adobe/aio/util/WorkspaceUtil.java

@@ -72,19 +72,25 @@ public static Workspace.Builder getWorkspaceBuilder(Map<String, String> configMa
                         .projectId(configMap.get(PROJECT_ID))
                         .workspaceId(configMap.get(WORKSPACE_ID))
                         .credentialId(configMap.get(CREDENTIAL_ID));
-        builder.authContext(getAuthContext(configMap));
+        getAuthContext(configMap).ifPresent(builder::authContext);
         return builder;
     }
 
     public static boolean isOAuthConfig(Map<String, String> configMap) {
         return configMap.containsKey(SCOPES);
     }
 
-    public static Context getAuthContext(Map<String, String> configMap) {
+    public static boolean isJwtConfig(Map<String, String> configMap) {
+        return configMap.containsKey(META_SCOPES);
+    }
+
+    public static Optional<Context> getAuthContext(Map<String, String> configMap) {
         if (isOAuthConfig(configMap)) {
-            return getOAuthContextBuilder(configMap).build();
-        } else {
-            return getJwtContextBuilder(configMap).build();
+            return Optional.of(getOAuthContextBuilder(configMap).build());
+        } else if (isJwtConfig(configMap)) {
+            return Optional.of(getJwtContextBuilder(configMap).build());
+        } else  {
+            return Optional.empty();
         }
     }