Skip to content

[Integration-Test] Enhance pre-update profile action to support modifying user claims #27966

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Lashen1227 wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

[Integration-Test] Enhance pre-update profile action to support modifying user claims #27966

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 18 additions & 3 deletions ...wso2/identity/integration/test/serviceextensions/model/PreUpdateProfileActionRequest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder;

import java.util.List;
import java.util.Objects;

/**
Expand All @@ -34,13 +35,15 @@ public class PreUpdateProfileActionRequest {
private final String flowId;
private final String requestId;
private final PreUpdateProfileEvent event;
private final List<AllowedOperation> allowedOperations;

public PreUpdateProfileActionRequest(Builder builder) {

this.actionType = builder.actionType;
this.flowId = builder.flowId;
this.requestId = builder.requestId;
this.event = builder.event;
this.allowedOperations = builder.allowedOperations;
}

public ActionType getActionType() {
Expand All @@ -63,20 +66,26 @@ public PreUpdateProfileEvent getEvent() {
return event;
}

public List<AllowedOperation> getAllowedOperations() {

return allowedOperations;
}

@Override
public boolean equals(Object o) {

if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
PreUpdateProfileActionRequest that = (PreUpdateProfileActionRequest) o;
return actionType == that.actionType &&
Objects.equals(event, that.event);
Objects.equals(event, that.event) &&
Objects.equals(allowedOperations, that.allowedOperations);
}

@Override
public int hashCode() {

return Objects.hash(actionType, event);
return Objects.hash(actionType, event, allowedOperations);
}

/**
Expand All @@ -89,6 +98,7 @@ public static class Builder {
private String flowId;
private String requestId;
private PreUpdateProfileEvent event;
private List<AllowedOperation> allowedOperations;

public Builder actionType(ActionType actionType) {

Expand All @@ -114,10 +124,15 @@ public Builder event(PreUpdateProfileEvent event) {
return this;
}

public Builder allowedOperations(List<AllowedOperation> allowedOperations) {

this.allowedOperations = allowedOperations;
return this;
}

public PreUpdateProfileActionRequest build() {

return new PreUpdateProfileActionRequest(this);
}
}
}

24 changes: 22 additions & 2 deletions ...tegration/test/serviceextensions/preupdateprofile/PreUpdateProfileActionBaseTestCase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,17 @@ public class PreUpdateProfileActionBaseTestCase extends ActionsBaseTestCase {
protected static final String TEST_USER_GIVEN_NAME = "test_user_given_name";
protected static final String TEST_USER_LASTNAME = "test_user_last_name";
protected static final String TEST_USER_EMAIL = "test.user@gmail.com";
protected static final String TEST_USER_MOBILE_NUMBER = "0771234567";
protected static final String TEST_USER_UPDATED_MOBILE_NUMBER = "0717654329";
protected static final String USER_SYSTEM_SCHEMA_ATTRIBUTE = "urn:scim:wso2:schema";
protected static final String COUNTRY_SCHEMA_NAME = "country";
protected static final String MOBILE_NUMBERS_SCHEMA_NAME = "mobileNumbers";
protected static final String NICK_NAME_USER_SCHEMA_NAME = "nickName";
protected static final String NICK_NAME_CLAIM_URI = "http://wso2.org/claims/nickname";
protected static final String GIVEN_NAME_CLAIM_URI = "http://wso2.org/claims/givenname";
protected static final String LAST_NAME_CLAIM_URI = "http://wso2.org/claims/lastname";
protected static final String COUNTRY_CLAIM_URI = "http://wso2.org/claims/country";
protected static final String MOBILE_NUMBERS_CLAIM_URI = "http://wso2.org/claims/mobileNumbers";
protected static final String PRIMARY_USER_STORE_ID = "UFJJTUFSWQ==";
protected static final String PRIMARY_USER_STORE_NAME = "PRIMARY";
protected static final String PRE_UPDATE_PROFILE_API_PATH = "preUpdateProfile";
Expand Down Expand Up @@ -144,6 +152,13 @@ protected ApplicationResponseModel createApplicationWithGrantTypes(String... gra

protected String createPreUpdateProfileAction(String actionName, String actionDescription) throws IOException {

return createPreUpdateProfileAction(actionName, actionDescription,
Collections.singletonList(NICK_NAME_CLAIM_URI));
}

protected String createPreUpdateProfileAction(String actionName, String actionDescription, List<String> attributes)
throws IOException {

AuthenticationType authentication = new AuthenticationType()
.type(AuthenticationType.TypeEnum.BASIC)
.putPropertiesItem(USERNAME_PROPERTY, MOCK_SERVER_AUTH_BASIC_USERNAME)
Expand All @@ -157,11 +172,17 @@ protected String createPreUpdateProfileAction(String actionName, String actionDe
actionModel.setName(actionName);
actionModel.setDescription(actionDescription);
actionModel.setEndpoint(endpoint);
actionModel.setAttributes(Collections.singletonList(NICK_NAME_CLAIM_URI));
actionModel.setAttributes(attributes);

return createAction(PRE_UPDATE_PROFILE_API_PATH, actionModel);
}

protected List<String> getPreUpdateProfileClaimModificationTestAttributes() {

return Arrays.asList(NICK_NAME_CLAIM_URI, GIVEN_NAME_CLAIM_URI, LAST_NAME_CLAIM_URI, COUNTRY_CLAIM_URI,
MOBILE_NUMBERS_CLAIM_URI);
}

protected String getTokenWithClientCredentialsGrant(String applicationId, String clientId, String clientSecret) throws Exception {

if (!CarbonUtils.isLegacyAuthzRuntimeEnabled()) {
Expand Down Expand Up @@ -241,4 +262,3 @@ protected String getUserAccessToken(String clientId, String clientSecret, String
return jsonResponse.getString("access_token");
}
}

63 changes: 51 additions & 12 deletions ...ration/test/serviceextensions/preupdateprofile/PreUpdateProfileActionSuccessTestCase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.json.simple.JSONArray;
import org.testng.Assert;
import org.testng.annotations.AfterClass;
import org.testng.annotations.BeforeClass;
Expand All @@ -44,8 +45,11 @@
import org.wso2.identity.integration.test.rest.api.user.common.model.UserObject;
import org.wso2.identity.integration.test.restclients.SCIM2RestClient;
import org.wso2.identity.integration.test.serviceextensions.model.UpdatingUserClaim;
import org.wso2.identity.integration.test.serviceextensions.model.UserClaim;
import org.wso2.identity.integration.test.utils.FileUtils;

import java.util.List;

import static org.testng.Assert.assertEquals;
import static org.testng.Assert.assertNotNull;
import static org.testng.Assert.assertNull;
Expand Down Expand Up @@ -112,7 +116,8 @@ public void testInit() throws Exception {
.addEmail(new Email().value(TEST_USER_EMAIL));
userId = scim2RestClient.createUser(userInfo);
currentClaimValue = TEST_USER_GIVEN_NAME;
actionId = createPreUpdateProfileAction(ACTION_NAME, ACTION_DESCRIPTION);
actionId = createPreUpdateProfileAction(ACTION_NAME, ACTION_DESCRIPTION,
getPreUpdateProfileClaimModificationTestAttributes());

userAccessToken = getUserAccessToken(clientId, clientSecret,
TEST_USER1_USERNAME, TEST_USER_PASSWORD);
Expand All @@ -122,7 +127,8 @@ public void testInit() throws Exception {
serviceExtensionMockServer.setupStub(MOCK_SERVER_ENDPOINT_RESOURCE_PATH,
"Basic " + getBase64EncodedString(MOCK_SERVER_AUTH_BASIC_USERNAME,
MOCK_SERVER_AUTH_BASIC_PASSWORD),
FileUtils.readFileInClassPathAsString("actions/response/pre-update-profile-response.json"));
FileUtils.readFileInClassPathAsString(
"actions/response/pre-update-profile-claim-modification-response.json"));
}

@BeforeMethod
Expand Down Expand Up @@ -302,6 +308,13 @@ public void testApplicationUpdateProfileWithRemoveOperation() throws Exception {
PreUpdateProfileEvent.FlowInitiatorType.APPLICATION, PreUpdateProfileEvent.Action.UPDATE);
}

@Test(dependsOnMethods = "testApplicationUpdateProfileWithRemoveOperation",
description = "Verify the pre update profile action response can modify user claims")
public void testActionResponseClaimModificationOperations() throws Exception {

assertClaimModificationOperations();
}

private void assertUpdatingClaimValue(String claimValue) throws Exception {

org.json.simple.JSONObject userObj = scim2RestClient.getUser(userId, null);
Expand All @@ -315,6 +328,20 @@ private void assertRemovingClaimValue() throws Exception {
Assert.assertNull(userObj.get(NICK_NAME_USER_SCHEMA_NAME));
}

private void assertClaimModificationOperations() throws Exception {

org.json.simple.JSONObject userObj = scim2RestClient.getUser(userId, null);
org.json.simple.JSONObject wso2Schema = (org.json.simple.JSONObject) userObj.get(USER_SYSTEM_SCHEMA_ATTRIBUTE);
if (wso2Schema != null) {
Assert.assertNull(wso2Schema.get(COUNTRY_SCHEMA_NAME));
}
Assert.assertNotNull(wso2Schema);
JSONArray mobileNumbers = (JSONArray) wso2Schema.get(MOBILE_NUMBERS_SCHEMA_NAME);
Assert.assertNotNull(mobileNumbers);
Assert.assertTrue(mobileNumbers.contains(TEST_USER_MOBILE_NUMBER));
Assert.assertTrue(mobileNumbers.contains(TEST_USER_UPDATED_MOBILE_NUMBER));
}

private void assertActionRequestPayload(UserItemAddGroupobj.OpEnum operation,String userId, String currentClaimValue,
String updateClaimValue, PreUpdateProfileEvent.FlowInitiatorType initiatorType,
PreUpdateProfileEvent.Action action) throws JsonProcessingException {
Expand All @@ -334,22 +361,34 @@ private void assertActionRequestPayload(UserItemAddGroupobj.OpEnum operation,Str
ProfileUpdatingUser user = actionRequest.getEvent().getProfileUpdatingUser();

assertEquals(user.getId(), userId);
UserClaim userClaim = getClaim(user.getClaims(), NICK_NAME_CLAIM_URI);
if (operation == UserItemAddGroupobj.OpEnum.ADD) {
assertNull(user.getClaims());
assertNull(userClaim);
} else if (operation == UserItemAddGroupobj.OpEnum.REPLACE) {
assertEquals(user.getClaims().get(0).getUri(), NICK_NAME_CLAIM_URI);
assertEquals(((UpdatingUserClaim) user.getClaims().get(0)).getUpdatingValue(), updateClaimValue);
assertEquals(user.getClaims().get(0).getValue(), currentClaimValue);
assertNotNull(userClaim);
assertEquals(((UpdatingUserClaim) userClaim).getUpdatingValue(), updateClaimValue);
assertEquals(userClaim.getValue(), currentClaimValue);
} else if (operation == UserItemAddGroupobj.OpEnum.REMOVE) {
assertEquals(user.getClaims().get(0).getUri(), NICK_NAME_CLAIM_URI);
assertEquals(user.getClaims().get(0).getValue(), currentClaimValue);
assertNotNull(userClaim);
assertEquals(userClaim.getValue(), currentClaimValue);
}

PreUpdateProfileRequest request = actionRequest.getEvent().getRequest();
UserClaim requestClaim = getClaim(request.getClaims(), NICK_NAME_CLAIM_URI);

assertEquals(request.getClaims().get(0).getUri(), NICK_NAME_CLAIM_URI);
assertNull(request.getClaims().get(0).getUpdatingValue());
assertEquals(request.getClaims().get(0).getValue(), updateClaimValue);
assertNotNull(requestClaim);
assertNull(((UpdatingUserClaim) requestClaim).getUpdatingValue());
assertEquals(requestClaim.getValue(), updateClaimValue);
}
}

private UserClaim getClaim(List<? extends UserClaim> claims, String uri) {

if (claims == null) {
return null;
}
return claims.stream()
.filter(claim -> claim != null && uri.equals(claim.getUri()))
.findFirst()
.orElse(null);
}
}
22 changes: 22 additions & 0 deletions ...d/src/test/resources/actions/response/pre-update-profile-claim-modification-response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
{
"actionStatus": "SUCCESS",
"operations": [
{
"op": "add",
"path": "/user/claims[uri=http://wso2.org/claims/country]",
"value": "Sri Lanka"
},
{
"op": "remove",
"path": "/user/claims[uri=http://wso2.org/claims/country]"
},
{
"op": "replace",
"path": "/user/claims[uri=http://wso2.org/claims/mobileNumbers]",
"value": [
"0771234567",
"0717654329"
]
}
]
}