Fix #862 Add "urn:scim:schemas:extension:slack:guest:1.0" schema support in the SCIM API client (#886)

seratch · web-flow · commit 27ef15df6c5f · 2021-11-13T06:56:14.000+09:00
* Fix #862 Add "urn:scim:schemas:extension:slack:guest:1.0" schema support in the SCIM API client * Disable Types constructor
diff --git a/json-logs/samples/scim/v1/Users/00000000000.json b/json-logs/samples/scim/v1/Users/00000000000.json
@@ -68,5 +68,9 @@
   ],
   "urn:scim:schemas:extension:enterprise:1.0": {
     "manager": {}
+  },
+  "urn:scim:schemas:extension:slack:guest:1.0": {
+    "type": "",
+    "expiration": ""
   }
 }
diff --git a/slack-api-client/src/main/java/com/slack/api/scim/model/Schemas.java b/slack-api-client/src/main/java/com/slack/api/scim/model/Schemas.java
@@ -7,5 +7,6 @@ private Schemas() {
 
     public static final String SCHEMA_CORE = "urn:scim:schemas:core:1.0";
     public static final String SCHEMA_EXTENSION_ENTERPRISE = "urn:scim:schemas:extension:enterprise:1.0";
+    public static final String SCHEMA_EXTENSION_SLACK_GUEST = "urn:scim:schemas:extension:slack:guest:1.0";
 
 }
diff --git a/slack-api-client/src/main/java/com/slack/api/scim/model/User.java b/slack-api-client/src/main/java/com/slack/api/scim/model/User.java
@@ -1,15 +1,22 @@
 package com.slack.api.scim.model;
 
 import com.google.gson.annotations.SerializedName;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
 import lombok.Data;
+import lombok.NoArgsConstructor;
 
 import java.util.Arrays;
 import java.util.List;
 
 @Data
 public class User {
 
-    private List<String> schemas = Arrays.asList(Schemas.SCHEMA_CORE, Schemas.SCHEMA_EXTENSION_ENTERPRISE);
+    private List<String> schemas = Arrays.asList(
+            Schemas.SCHEMA_CORE,
+            Schemas.SCHEMA_EXTENSION_ENTERPRISE,
+            Schemas.SCHEMA_EXTENSION_SLACK_GUEST
+    );
 
     private String id;
     private String externalId;
@@ -37,30 +44,44 @@ public class User {
 
     @SerializedName(Schemas.SCHEMA_EXTENSION_ENTERPRISE)
     private Extension extension;
+    @SerializedName(Schemas.SCHEMA_EXTENSION_SLACK_GUEST)
+    private SlackGuest slackGuest;
 
     private List<Group> groups;
 
     @Data
+    @Builder
+    @NoArgsConstructor
+    @AllArgsConstructor
     public static class Meta {
         private String created;
         private String location;
     }
 
     @Data
+    @Builder
+    @NoArgsConstructor
+    @AllArgsConstructor
     public static class Name {
         private String givenName;
         private String familyName;
         private String honorificPrefix;
     }
 
     @Data
+    @Builder
+    @NoArgsConstructor
+    @AllArgsConstructor
     public static class Email {
         private String value;
         private String type;
         private Boolean primary;
     }
 
     @Data
+    @Builder
+    @NoArgsConstructor
+    @AllArgsConstructor
     public static class Address {
         private String streetAddress;
         private String locality;
@@ -71,26 +92,38 @@ public static class Address {
     }
 
     @Data
+    @Builder
+    @NoArgsConstructor
+    @AllArgsConstructor
     public static class PhoneNumber {
         private String value;
         private String type;
         private Boolean primary;
     }
 
     @Data
+    @Builder
+    @NoArgsConstructor
+    @AllArgsConstructor
     public static class Photo {
         private String value;
         private String type;
     }
 
     @Data
+    @Builder
+    @NoArgsConstructor
+    @AllArgsConstructor
     public static class Role {
         private String value;
         private String type;
         private Boolean primary;
     }
 
     @Data
+    @Builder
+    @NoArgsConstructor
+    @AllArgsConstructor
     public static class Extension {
         private String employeeNumber;
         private String costCenter;
@@ -106,9 +139,36 @@ public static class Manager {
     }
 
     @Data
+    @Builder
+    @NoArgsConstructor
+    @AllArgsConstructor
     public static class Group {
         private String value;
         private String display;
     }
 
+    @Data
+    @Builder
+    @NoArgsConstructor
+    @AllArgsConstructor
+    public static class SlackGuest {
+        public static class Types {
+            private Types() {
+            }
+
+            public static final String MULTI = "multi";
+        }
+
+        /**
+         * This value is mandatory.
+         * possible values: "multi"
+         */
+        private String type;
+        /**
+         * This value is optional.
+         * possible values: ISO 8601 date time string (e.g., "2020-11-30T23:59:59Z")
+         */
+        private String expiration;
+    }
+
 }
diff --git a/slack-api-client/src/test/java/test_locally/api/scim/ModelsTest.java b/slack-api-client/src/test/java/test_locally/api/scim/ModelsTest.java
@@ -0,0 +1,40 @@
+package test_locally.api.scim;
+
+import com.slack.api.SlackConfig;
+import com.slack.api.scim.model.User;
+import com.slack.api.util.json.GsonFactory;
+import org.junit.Test;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+
+public class ModelsTest {
+
+    @Test
+    public void extensions() {
+        assertEquals(User.SlackGuest.Types.MULTI, "multi");
+
+        User user = new User();
+        user.setId("W1234567890");
+        User.Extension enterprise = new User.Extension();
+        enterprise.setDivision("Engineering");
+        user.setExtension(User.Extension.builder()
+                .employeeNumber("123-456")
+                .organization("PDE")
+                .division("Product")
+                .department("Product")
+                .build());
+        user.setSlackGuest(User.SlackGuest.builder()
+                .type("multi")
+                .expiration("2020-11-30T23:59:59Z")
+                .build());
+
+        assertNotNull(user);
+        assertNotNull(user.getExtension().getDivision());
+        assertNotNull(user.getSlackGuest().getType());
+
+        String json = GsonFactory.createCamelCase(SlackConfig.DEFAULT).toJson(user);
+        String expectedJson = "{\"schemas\":[\"urn:scim:schemas:core:1.0\",\"urn:scim:schemas:extension:enterprise:1.0\",\"urn:scim:schemas:extension:slack:guest:1.0\"],\"id\":\"W1234567890\",\"urn:scim:schemas:extension:enterprise:1.0\":{\"employeeNumber\":\"123-456\",\"organization\":\"PDE\",\"division\":\"Product\",\"department\":\"Product\"},\"urn:scim:schemas:extension:slack:guest:1.0\":{\"type\":\"multi\",\"expiration\":\"2020-11-30T23:59:59Z\"}}";
+        assertEquals(expectedJson, json);
+    }
+}
diff --git a/slack-api-client/src/test/java/test_with_remote_apis/scim/ApiTest.java b/slack-api-client/src/test/java/test_with_remote_apis/scim/ApiTest.java
@@ -12,7 +12,11 @@
 import org.junit.Test;
 
 import java.io.IOException;
+import java.text.DateFormat;
+import java.text.SimpleDateFormat;
+import java.time.ZonedDateTime;
 import java.util.Arrays;
+import java.util.Date;
 
 import static org.hamcrest.CoreMatchers.*;
 import static org.hamcrest.MatcherAssert.assertThat;
@@ -30,7 +34,15 @@ public static void tearDown() throws InterruptedException {
 
     String orgAdminToken = System.getenv(Constants.SLACK_SDK_TEST_GRID_ORG_ADMIN_USER_TOKEN);
 
-    private UsersCreateResponse createNewUser() throws IOException, SCIMApiException {
+    private UsersCreateResponse createNewFullUser() throws IOException, SCIMApiException {
+        return createNewUser(true);
+    }
+
+    private UsersCreateResponse createNewGuestUser() throws IOException, SCIMApiException {
+        return createNewUser(false);
+    }
+
+    private UsersCreateResponse createNewUser(boolean isFullMember) throws IOException, SCIMApiException {
         String userName = "user" + System.currentTimeMillis();
         User newUser = new User();
         newUser.setName(new User.Name());
@@ -40,6 +52,15 @@ private UsersCreateResponse createNewUser() throws IOException, SCIMApiException
         User.Email email = new User.Email();
         email.setValue("seratch+" + System.currentTimeMillis() + "@gmail.com");
         newUser.setEmails(Arrays.asList(email));
+        if (!isFullMember) {
+            // guest
+            DateFormat df = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ssXXX");
+            String expiration = df.format(Date.from(ZonedDateTime.now().plusDays(14).toInstant()));
+            newUser.setSlackGuest(User.SlackGuest.builder()
+                    .type(User.SlackGuest.Types.MULTI)
+                    .expiration(expiration)
+                    .build());
+        }
         return slack.scim(orgAdminToken).createUser(req -> req.user(newUser));
     }
 
@@ -101,9 +122,9 @@ public void readUser_dummy() throws IOException {
     }
 
     @Test
-    public void createAndDeleteUser() throws Exception {
+    public void createAndDeleteFullUser() throws Exception {
         if (orgAdminToken != null) {
-            UsersCreateResponse creation = createNewUser();
+            UsersCreateResponse creation = createNewFullUser();
             assertThat(creation.getId(), is(notNullValue()));
 
             UsersReadResponse readResp = slack.scim(orgAdminToken).readUser(req -> req.id(creation.getId()));
@@ -165,6 +186,78 @@ public void createAndDeleteUser() throws Exception {
         }
     }
 
+    @Test
+    public void createAndDeleteGuestUser() throws Exception {
+        if (orgAdminToken != null) {
+            UsersCreateResponse creation = createNewGuestUser();
+            assertThat(creation.getId(), is(notNullValue()));
+
+            UsersReadResponse readResp = slack.scim(orgAdminToken).readUser(req -> req.id(creation.getId()));
+            assertThat(readResp.getId(), is(creation.getId()));
+            assertThat(readResp.getUserName(), is(creation.getUserName()));
+            assertThat(readResp.getSlackGuest().getType(), is(User.SlackGuest.Types.MULTI));
+            assertThat(readResp.getSlackGuest().getExpiration(), is(notNullValue()));
+
+            try {
+                // https://api.slack.com/scim#filter
+                // filter query matching the created data
+                String userName = creation.getUserName();
+                UsersSearchResponse searchResp = slack.scim(orgAdminToken).searchUsers(req -> req.count(1).filter("userName eq \"" + userName + "\""));
+                assertThat(searchResp.getItemsPerPage(), is(1));
+                assertThat(searchResp.getResources().size(), is(1));
+                assertThat(searchResp.getResources().get(0).getId(), is(creation.getId()));
+                assertThat(searchResp.getResources().get(0).getUserName(), is(creation.getUserName()));
+                assertThat(searchResp.getResources().get(0).getSlackGuest(), is(notNullValue()));
+
+                String originalUserName = creation.getUserName();
+
+                User user = new User();
+                user.setUserName(originalUserName + "_ed");
+                slack.scim(orgAdminToken).patchUser(req -> req.id(creation.getId()).user(user));
+
+                readResp = slack.scim(orgAdminToken).readUser(req -> req.id(creation.getId()));
+                assertThat(readResp.getId(), is(creation.getId()));
+                assertThat(readResp.getUserName(), is(originalUserName + "_ed"));
+
+                User modifiedUser = readResp;
+                modifiedUser.setUserName(originalUserName + "_rv");
+                modifiedUser.setNickName(originalUserName + "_rv"); // required
+                slack.scim(orgAdminToken).updateUser(req -> req.id(modifiedUser.getId()).user(modifiedUser));
+
+                readResp = slack.scim(orgAdminToken).readUser(req -> req.id(modifiedUser.getId()));
+                assertThat(readResp.getId(), is(creation.getId()));
+                assertThat(readResp.getUserName(), is(originalUserName + "_rv"));
+                assertThat(readResp.getSlackGuest().getType(), is(User.SlackGuest.Types.MULTI));
+                assertThat(readResp.getSlackGuest().getExpiration(), is(notNullValue()));
+
+            } finally {
+                UsersDeleteResponse deletion = slack.scim(orgAdminToken).deleteUser(req -> req.id(creation.getId()));
+                assertThat(deletion, is(nullValue()));
+
+                // can call twice
+                UsersDeleteResponse deletion2 = slack.scim(orgAdminToken).deleteUser(req -> req.id(creation.getId()));
+                assertThat(deletion2, is(nullValue()));
+
+                // Verify if the deletion is completed (there is some delay)
+                int counter = 0;
+                UsersReadResponse supposedToBeDeleted = null;
+                while (counter < 10) {
+                    Thread.sleep(1000);
+                    supposedToBeDeleted = slack.scim(orgAdminToken).readUser(req -> req.id(creation.getId()));
+                    if (!supposedToBeDeleted.getActive()) {
+                        break;
+                    }
+                }
+                assertThat(supposedToBeDeleted, is(notNullValue()));
+                assertThat(supposedToBeDeleted.getActive(), is(false));
+
+                // can call again
+                UsersDeleteResponse deletion3 = slack.scim(orgAdminToken).deleteUser(req -> req.id(creation.getId()));
+                assertThat(deletion3, is(nullValue()));
+            }
+        }
+    }
+
     @Test
     public void groups() throws IOException, SCIMApiException {
         if (orgAdminToken != null) {
@@ -174,7 +267,7 @@ public void groups() throws IOException, SCIMApiException {
                 newGroup.setDisplayName("Test Group" + System.currentTimeMillis());
 
                 Group.Member member = new Group.Member();
-                UsersCreateResponse newUser = createNewUser();
+                UsersCreateResponse newUser = createNewFullUser();
                 assertThat(newUser.getId(), is(notNullValue()));
                 member.setValue(newUser.getId());
                 newGroup.setMembers(Arrays.asList(member));
@@ -210,7 +303,7 @@ public void groupAndUsers() throws IOException, SCIMApiException {
         if (orgAdminToken != null) {
             Group newGroup = new Group();
             newGroup.setDisplayName("Test Group" + System.currentTimeMillis());
-            UsersCreateResponse newUser = createNewUser();
+            UsersCreateResponse newUser = createNewFullUser();
             assertThat(newUser.getId(), is(notNullValue()));
             try {
                 Group.Member member = new Group.Member();
diff --git a/slack-api-client/src/test/java/test_with_remote_apis/scim/AsyncApiTest.java b/slack-api-client/src/test/java/test_with_remote_apis/scim/AsyncApiTest.java

Original file line number	Diff line number	Diff line change
`@@ -68,5 +68,9 @@`
`68`	`68`	`],`
`69`	`69`	`"urn:scim:schemas:extension:enterprise:1.0": {`
`70`	`70`	`"manager": {}`
	`71`	`+ },`
	`72`	`+ "urn:scim:schemas:extension:slack:guest:1.0": {`
	`73`	`+ "type": "",`
	`74`	`+ "expiration": ""`
`71`	`75`	`}`
`72`	`76`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,5 +7,6 @@ private Schemas() {`
`7`	`7`
`8`	`8`	`public static final String SCHEMA_CORE = "urn:scim:schemas:core:1.0";`
`9`	`9`	`public static final String SCHEMA_EXTENSION_ENTERPRISE = "urn:scim:schemas:extension:enterprise:1.0";`
	`10`	`+ public static final String SCHEMA_EXTENSION_SLACK_GUEST = "urn:scim:schemas:extension:slack:guest:1.0";`
`10`	`11`
`11`	`12`	`}`