Skip to content
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

Jump to bottom

Add Integration Tests to Support restrictedToPublished Query Param in Branding Resolver Endpoint #20889

Merged
merged 6 commits into from
Aug 13, 2024
Merged

Add Integration Tests to Support restrictedToPublished Query Param in Branding Resolver Endpoint #20889

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
15247b7
Add integration tests to support restrictedToPublished query param in…
dhaura Aug 12, 2024
a4186fd
Merge branch 'master' into DP-add-retrictedToPublished-integration-tests
dhaura Aug 12, 2024
bf8e403
Update test comments.
dhaura Aug 12, 2024
426224d
Merge remote-tracking branch 'origin/DP-add-retrictedToPublished-inte…
dhaura Aug 12, 2024
38e6465
Replace ampersand with a constant.
dhaura Aug 12, 2024
9602d48
Merge branch 'master' into DP-add-retrictedToPublished-integration-tests
dhaura Aug 13, 2024
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
119 changes: 113 additions & 6 deletions .../server/branding/preference/management/v1/AppBrandingPreferenceManagementSuccessTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,7 @@ public void testResolveL2AppBrandingAfterRootAppBrandingAddition() throws Except
}

@Test(dependsOnMethods = {"testResolveL2AppBrandingAfterRootAppBrandingAddition"})
public void testUpdateRootAppBrandingPreference() throws Exception {
public void testUpdateUnpublishedRootAppBrandingPreference() throws Exception {

String body = readResource(UPDATE_ROOT_APP_BRANDING_RESOURCE_FILE)
.replace(APP_ID_PLACEHOLDER, rootAppId);
Expand All @@ -288,7 +288,7 @@ public void testUpdateRootAppBrandingPreference() throws Exception {
assertBrandingPreferences(UPDATE_ROOT_APP_BRANDING_RESOURCE_FILE, response);
}

@Test(dependsOnMethods = {"testUpdateRootAppBrandingPreference"})
@Test(dependsOnMethods = {"testUpdateUnpublishedRootAppBrandingPreference"})
public void testGetRootAppBrandingAfterRootAppBrandingUpdate() throws Exception {

Response response = getResponseOfGet(BRANDING_PREFERENCE_API_BASE_PATH + String.format
Expand Down Expand Up @@ -322,6 +322,24 @@ public void testResolveRootAppBrandingAfterRootAppBrandingUpdate() throws Except
}

@Test(dependsOnMethods = {"testResolveRootAppBrandingAfterRootAppBrandingUpdate"})
public void testResolveRootAppBrandingRestrictedToPublishedAfterRootAppBrandingUpdate() throws Exception {

// Resolve the branding preference by setting the restrictToPublished query parameter to true.
Response response = getResponseOfGet(BRANDING_PREFERENCE_RESOLVE_PATH +
String.format(PREFERENCE_COMPONENT_WITH_QUERY_PARAM + AMPERSAND + RESTRICTED_TO_PUBLISHED_QUERY_PARAM,
APPLICATION_TYPE, rootAppId, DEFAULT_LOCALE, TRUE));
response.then()
.log().ifValidationFails()
.assertThat()
.statusCode(HttpStatus.SC_OK)
.body("type", equalTo(ORGANIZATION_TYPE))
.body("name", equalTo(tenant))
.body("locale", equalTo(DEFAULT_LOCALE));

assertBrandingPreferences(ADD_ROOT_ORG_BRANDING_RESOURCE_FILE, response);
}

@Test(dependsOnMethods = {"testResolveRootAppBrandingRestrictedToPublishedAfterRootAppBrandingUpdate"})
public void testResolveL1AppBrandingAfterRootAppBrandingUpdate() throws Exception {

Response response = getResolvedAppBrandingInOrg(level1OrgId, level1AppId);
Expand All @@ -337,6 +355,22 @@ public void testResolveL1AppBrandingAfterRootAppBrandingUpdate() throws Exceptio
}

@Test(dependsOnMethods = {"testResolveL1AppBrandingAfterRootAppBrandingUpdate"})
public void testResolveL1AppBrandingRestrictedToPublishedAfterRootAppBrandingUpdate() throws Exception {

// Resolve the branding preference by setting the restrictToPublished query parameter to true.
Response response = getResolvedAppBrandingRestrictedToPublishedInOrg(level1OrgId, level1AppId);
response.then()
.log().ifValidationFails()
.assertThat()
.statusCode(HttpStatus.SC_OK)
.body("type", equalTo(ORGANIZATION_TYPE))
.body("name", equalTo(tenant))
.body("locale", equalTo(DEFAULT_LOCALE));

assertBrandingPreferences(ADD_ROOT_ORG_BRANDING_RESOURCE_FILE, response);
}

@Test(dependsOnMethods = {"testResolveL1AppBrandingRestrictedToPublishedAfterRootAppBrandingUpdate"})
public void testResolveL2AppBrandingAfterRootAppBrandingUpdate() throws Exception {

Response response = getResolvedAppBrandingInOrg(level2OrgId, level2AppId);
Expand All @@ -352,6 +386,22 @@ public void testResolveL2AppBrandingAfterRootAppBrandingUpdate() throws Exceptio
}

@Test(dependsOnMethods = {"testResolveL2AppBrandingAfterRootAppBrandingUpdate"})
public void testResolveL2AppBrandingRestrictedToPublishedAfterRootAppBrandingUpdate() throws Exception {

// Resolve the branding preference by setting the restrictToPublished query parameter to true.
Response response = getResolvedAppBrandingRestrictedToPublishedInOrg(level2OrgId, level2AppId);
response.then()
.log().ifValidationFails()
.assertThat()
.statusCode(HttpStatus.SC_OK)
.body("type", equalTo(ORGANIZATION_TYPE))
.body("name", equalTo(tenant))
.body("locale", equalTo(DEFAULT_LOCALE));

assertBrandingPreferences(ADD_ROOT_ORG_BRANDING_RESOURCE_FILE, response);
}

@Test(dependsOnMethods = {"testResolveL2AppBrandingRestrictedToPublishedAfterRootAppBrandingUpdate"})
public void testResolveL1AppBrandingAfterL1OrgBrandingAddition() throws Exception {

addOrgBrandingPreference(level1OrgId, ADD_L1_ORG_BRANDING_RESOURCE_FILE);
Expand Down Expand Up @@ -437,7 +487,7 @@ public void testResolveL2AppBrandingAfterL1AppBrandingAddition() throws Exceptio
}

@Test(dependsOnMethods = {"testResolveL2AppBrandingAfterL1AppBrandingAddition"})
public void testUpdateL1AppBrandingPreference() throws Exception {
public void testUpdateUnpublishedL1AppBrandingPreference() throws Exception {

RestAssured.basePath = buildTenantedBasePathForOrg(tenant);
String body = readResource(UPDATE_L1_APP_BRANDING_RESOURCE_FILE)
Expand All @@ -455,7 +505,7 @@ public void testUpdateL1AppBrandingPreference() throws Exception {
assertBrandingPreferences(UPDATE_L1_APP_BRANDING_RESOURCE_FILE, response);
}

@Test(dependsOnMethods = {"testUpdateL1AppBrandingPreference"})
@Test(dependsOnMethods = {"testUpdateUnpublishedL1AppBrandingPreference"})
public void testResolveL1AppBrandingAfterL1AppBrandingUpdate() throws Exception {

Response response = getResolvedAppBrandingInOrg(level1OrgId, level1AppId);
Expand All @@ -470,6 +520,22 @@ public void testResolveL1AppBrandingAfterL1AppBrandingUpdate() throws Exception
assertBrandingPreferences(UPDATE_L1_APP_BRANDING_RESOURCE_FILE, response);
}

@Test(dependsOnMethods = {"testResolveL1AppBrandingAfterL1AppBrandingUpdate"})
public void testResolveL1AppBrandingRestrictedToPublishedAfterL1AppBrandingUpdate() throws Exception {

// Resolve the branding preference by setting the restrictToPublished query parameter to true.
Response response = getResolvedAppBrandingRestrictedToPublishedInOrg(level1OrgId, level1AppId);
response.then()
.log().ifValidationFails()
.assertThat()
.statusCode(HttpStatus.SC_OK)
.body("type", equalTo(ORGANIZATION_TYPE))
.body("name", equalTo(level1OrgId))
.body("locale", equalTo(DEFAULT_LOCALE));

assertBrandingPreferences(ADD_L1_ORG_BRANDING_RESOURCE_FILE, response);
}

@Test(dependsOnMethods = {"testResolveL1AppBrandingAfterL1AppBrandingUpdate"})
public void testResolveL2AppBrandingAfterL1AppBrandingUpdate() throws Exception {

Expand All @@ -486,6 +552,22 @@ public void testResolveL2AppBrandingAfterL1AppBrandingUpdate() throws Exception
}

@Test(dependsOnMethods = {"testResolveL2AppBrandingAfterL1AppBrandingUpdate"})
public void testResolveL2AppBrandingRestrictedToPublishedAfterL1AppBrandingUpdate() throws Exception {

// Resolve the branding preference by setting the restrictToPublished query parameter to true.
Response response = getResolvedAppBrandingRestrictedToPublishedInOrg(level2OrgId, level2AppId);
response.then()
.log().ifValidationFails()
.assertThat()
.statusCode(HttpStatus.SC_OK)
.body("type", equalTo(ORGANIZATION_TYPE))
.body("name", equalTo(level1OrgId))
.body("locale", equalTo(DEFAULT_LOCALE));

assertBrandingPreferences(ADD_L1_ORG_BRANDING_RESOURCE_FILE, response);
}

@Test(dependsOnMethods = {"testResolveL2AppBrandingRestrictedToPublishedAfterL1AppBrandingUpdate"})
public void testResolveL2AppBrandingAfterL2OrgBrandingAddition() throws Exception {

addOrgBrandingPreference(level2OrgId, ADD_L2_ORG_BRANDING_RESOURCE_FILE);
Expand Down Expand Up @@ -541,7 +623,7 @@ public void testResolveL2AppBrandingAfterL2AppBrandingAddition() throws Exceptio
}

@Test(dependsOnMethods = {"testResolveL2AppBrandingAfterL2AppBrandingAddition"})
public void testUpdateL2AppBrandingPreference() throws Exception {
public void testUpdateUnpublishedL2AppBrandingPreference() throws Exception {

RestAssured.basePath = buildTenantedBasePathForOrg(tenant);
String body = readResource(UPDATE_L2_APP_BRANDING_RESOURCE_FILE)
Expand All @@ -560,7 +642,7 @@ public void testUpdateL2AppBrandingPreference() throws Exception {
assertBrandingPreferences(UPDATE_L2_APP_BRANDING_RESOURCE_FILE, response);
}

@Test(dependsOnMethods = {"testUpdateL2AppBrandingPreference"})
@Test(dependsOnMethods = {"testUpdateUnpublishedL2AppBrandingPreference"})
public void testResolveL2AppBrandingAfterL2AppBrandingUpdate() throws Exception {

Response response = getResolvedAppBrandingInOrg(level2OrgId, level2AppId);
Expand All @@ -576,6 +658,22 @@ public void testResolveL2AppBrandingAfterL2AppBrandingUpdate() throws Exception
}

@Test(dependsOnMethods = {"testResolveL2AppBrandingAfterL2AppBrandingUpdate"})
public void testResolveL2AppBrandingRestrictedToPublishedAfterL2AppBrandingUpdate() throws Exception {

// Resolve the branding preference by setting the restrictToPublished query parameter to true.
Response response = getResolvedAppBrandingRestrictedToPublishedInOrg(level2OrgId, level2AppId);
response.then()
.log().ifValidationFails()
.assertThat()
.statusCode(HttpStatus.SC_OK)
.body("type", equalTo(ORGANIZATION_TYPE))
.body("name", equalTo(level2OrgId))
.body("locale", equalTo(DEFAULT_LOCALE));

assertBrandingPreferences(ADD_L2_ORG_BRANDING_RESOURCE_FILE, response);
}

@Test(dependsOnMethods = {"testResolveL2AppBrandingRestrictedToPublishedAfterL2AppBrandingUpdate"})
public void testDeleteL2AppBrandingPreference() throws Exception {

RestAssured.basePath = buildTenantedBasePathForOrg(tenant);
Expand Down Expand Up @@ -875,6 +973,15 @@ private Response getResolvedAppBrandingInOrg(String orgId, String appId)
DEFAULT_LOCALE), orgMgtRestClient.switchM2MToken(orgId));
}

private Response getResolvedAppBrandingRestrictedToPublishedInOrg(String orgId, String appId)
throws Exception {

RestAssured.basePath = PATH_SEPARATOR + ORGANIZATION_PATH + orgId + PATH_SEPARATOR + API_SERVER_BASE_PATH;
return getResponseOfGetWithOAuth2(BRANDING_PREFERENCE_RESOLVE_PATH +
String.format(PREFERENCE_COMPONENT_WITH_QUERY_PARAM + AMPERSAND + RESTRICTED_TO_PUBLISHED_QUERY_PARAM,
APPLICATION_TYPE, appId, DEFAULT_LOCALE, TRUE), orgMgtRestClient.switchM2MToken(orgId));
}

private String buildTenantedBasePathForOrg(String tenantDomain) {

if (tenantDomain.equals(MultitenantConstants.SUPER_TENANT_DOMAIN_NAME)) {
Expand Down
3 changes: 3 additions & 0 deletions ...st/api/server/branding/preference/management/v1/BrandingPreferenceManagementTestBase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,12 @@ public class BrandingPreferenceManagementTestBase extends RESTAPIServerTestBase
public static final String TYPE_QUERY_PARAM = "type=%s";
public static final String LOCALE_QUERY_PARAM = "locale=%s";
public static final String SCREEN_QUERY_PARAM = "screen=%s";
public static final String RESTRICTED_TO_PUBLISHED_QUERY_PARAM = "restrictToPublished=%s";
public static final String CONTENT_TYPE_ATTRIBUTE = "Content-Type";
public static final String AUTHORIZATION_ATTRIBUTE = "Authorization";
public static final String ORG_NAME_PLACEHOLDER = "organization-name";
public static final String TRUE = "true";
public static final String AMPERSAND = "&";

public static final String ADD_ROOT_ORG_BRANDING_RESOURCE_FILE = "add-root-org-branding-preference.json";
public static final String UPDATE_ROOT_ORG_BRANDING_RESOURCE_FILE = "update-root-org-branding-preference.json";
Expand Down