Merge pull request #30 from ZennoLab/requiredActions

supported passing requiredActions to new User

README.md

@@ -45,7 +45,8 @@ The GET request will have to return user data as a JSON response in the form:
       "key": ["value"]
     },
     "roles": ["string"],
-    "groups": ["string"]
+    "groups": ["string"],
+    "requiredActions": ["requiredActions"]
 }
 ```
 
@@ -83,7 +84,8 @@ The response might look like this:
       "likes": ["cats", "dogs", "cookies"]
     },
     "roles": ["admin"],
-    "groups": ["migrated_users"]
+    "groups": ["migrated_users"],
+    "requiredActions": ["CONFIGURE_TOTP", "UPDATE_PASSWORD", "UPDATE_PROFILE", "update_user_locale"]
 }
 ```
 
@@ -173,4 +175,4 @@ automatically map legacy groups to Keycloak groups, by specifying the mapping in
 ### Migrate unmapped groups
 
 This switch can be toggled to decide whether groups which are not defined in the legacy group conversion map should be
- migrated anyway or simply ignored.
+ migrated anyway or simply ignored.

src/main/java/com/danielfrak/code/keycloak/providers/rest/remote/LegacyUser.java

@@ -19,6 +19,7 @@ public class LegacyUser {
     private Map<String, List<String>> attributes;
     private List<String> roles;
     private List<String> groups;
+    private List<String> requiredActions;
 
     public String getId() {
         return id;
@@ -100,6 +101,14 @@ public void setGroups(List<String> groups) {
         this.groups = groups;
     }
 
+    public List<String> getRequiredActions() {
+        return requiredActions;
+    }
+
+    public void setRequiredActions(List<String> requiredActions) {
+        this.requiredActions = requiredActions;
+    }
+
     @Override
     public boolean equals(Object o) {
         if (this == o) {
@@ -119,12 +128,13 @@ public boolean equals(Object o) {
                 Objects.equals(lastName, legacyUser.lastName) &&
                 Objects.equals(attributes, legacyUser.attributes) &&
                 Objects.equals(roles, legacyUser.roles) &&
-                Objects.equals(groups, legacyUser.groups);
+                Objects.equals(groups, legacyUser.groups) &&
+                Objects.equals(requiredActions, legacyUser.requiredActions);
     }
 
     @Override
     public int hashCode() {
         return Objects.hash(id, username, email, firstName, lastName, isEnabled, isEmailVerified, attributes,
-                roles, groups);
+                roles, groups, requiredActions);
     }
 }

src/main/java/com/danielfrak/code/keycloak/providers/rest/remote/UserModelFactory.java

@@ -88,6 +88,11 @@ public UserModel create(LegacyUser legacyUser, RealmModel realm) {
         getGroupModels(legacyUser, realm)
                 .forEach(userModel::joinGroup);
 
+        if (legacyUser.getRequiredActions() != null) {
+            legacyUser.getRequiredActions()
+                .forEach(userModel::addRequiredAction);
+        }
+
         return userModel;
     }
 

src/test/java/com/danielfrak/code/keycloak/providers/rest/remote/LegacyUserTest.java

@@ -81,6 +81,14 @@ void shouldGetAndSetGroups() {
         assertEquals(expectedValue, user.getGroups());
     }
 
+    @Test
+    void shouldGetAndSetRequiredActions() {
+        var user = new LegacyUser();
+        var expectedValue = singletonList("value1");
+        user.setRequiredActions(expectedValue);
+        assertEquals(expectedValue, user.getRequiredActions());
+    }
+
     @Test
     void testEquals() {
         EqualsVerifier.simple().forClass(LegacyUser.class)

src/test/java/com/danielfrak/code/keycloak/providers/rest/remote/TestUserModel.java

@@ -19,6 +19,7 @@ public class TestUserModel implements UserModel {
     private Map<String, List<String>> attributes = new HashMap<>();
     private Set<RoleModel> roles = new HashSet<>();
     private Set<GroupModel> groups = new HashSet<>();
+    private Set<String> requiredActions = new HashSet<>();
     private String federationLink;
 
     public TestUserModel(String username) {
@@ -181,17 +182,17 @@ public Map<String, List<String>> getAttributes() {
 
     @Override
     public Set<String> getRequiredActions() {
-        throw new RuntimeException("Not implemented");
+        return this.requiredActions;
     }
 
     @Override
     public void addRequiredAction(String action) {
-        throw new RuntimeException("Not implemented");
+        this.requiredActions.add(action);
     }
 
     @Override
     public void removeRequiredAction(String action) {
-        throw new RuntimeException("Not implemented");
+        this.requiredActions.remove(action);
     }
 
     @Override

src/test/java/com/danielfrak/code/keycloak/providers/rest/remote/UserModelFactoryTest.java

@@ -465,4 +465,24 @@ void setsFederationLink() {
 
         assertEquals(MODEL_ID, result.getFederationLink());
     }
+
+    @Test
+    void migratesRequiredActions() {
+        final UserProvider userProvider = mock(UserProvider.class);
+        final RealmModel realm = mock(RealmModel.class);
+        final String username = "user";
+
+        when(session.userLocalStorage())
+                .thenReturn(userProvider);
+        when(userProvider.addUser(realm, username))
+                .thenReturn(new TestUserModel(username));
+
+        LegacyUser legacyUser = createLegacyUser(username);
+        legacyUser.setRequiredActions(List.of("CONFIGURE_TOTP", "UPDATE_PASSWORD"));
+
+        var result = userModelFactory.create(legacyUser, realm);
+
+        assertEquals(Set.of("CONFIGURE_TOTP", "UPDATE_PASSWORD"), result.getRequiredActions());
+    }
+
 }