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.

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

Add API resource management integration tests #17497

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
package org.wso2.identity.integration.test.api.access.mgt;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

License headers?


import org.apache.commons.codec.binary.Base64;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;
import org.testng.annotations.AfterClass;
import org.testng.annotations.BeforeClass;
import org.wso2.carbon.automation.engine.context.AutomationContext;
import org.wso2.carbon.automation.engine.context.TestUserMode;
import org.wso2.carbon.identity.application.common.model.APIResource;
import org.wso2.carbon.identity.application.common.model.Scope;
import org.wso2.carbon.integration.common.utils.mgt.ServerConfigurationManager;
import org.wso2.identity.integration.test.rest.api.common.RESTTestBase;

import java.io.IOException;

import javax.xml.xpath.XPathExpressionException;

public class APIAccessManagementBaseTestCase extends RESTTestBase {

public static final String SERVER_URL = "https://localhost:9853";
public static final String API_RESOURCE_ENDPOINT = "/api/server/v1/api-resources";
public static final String API_RESOURCE_SCOPE_ENDPOINT = "/api/server/v1/scopes";
public static final String APPLICATION_ENDPOINT = "/api/server/v1/applications";
public static final String BUSINESS_API_FILTER_QUERY = "?filter=type+eq+BUSINESS";
public static final String API_ID_ATTRIBUTE = "id";
public static final String API_NAME_ATTRIBUTE = "name";
public static final String API_DESCRIPTION_ATTRIBUTE = "description";
public static final String API_IDENTIFIER_ATTRIBUTE = "identifier";
public static final String API_IS_REQUIRED_AUTHORIZATION_ATTRIBUTE = "requiresAuthorization";
public static final String API_SCOPE_ATTRIBUTE = "scopes";
public static final String API_SCOPE_ID_ATTRIBUTE = "id";
public static final String API_SCOPE_NAME_ATTRIBUTE = "name";
public static final String API_SCOPE_DISPLAY_NAME_ATTRIBUTE = "displayName";
public static final String API_SCOPE_DESCRIPTION_ATTRIBUTE = "description";

protected CloseableHttpClient client;
protected String adminUsername;
protected String password;
protected String tenant;

private ServerConfigurationManager serverConfigurationManager;

public APIAccessManagementBaseTestCase(TestUserMode userMode) throws XPathExpressionException {

AutomationContext context = new AutomationContext("IDENTITY", userMode);
this.adminUsername = context.getContextTenant().getTenantAdmin().getUserName();
this.password = context.getContextTenant().getTenantAdmin().getPassword();
this.tenant = context.getContextTenant().getDomain();
}

@BeforeClass(alwaysRun = true)
public void init() throws Exception {

super.init();
client = HttpClients.createDefault();
}

@AfterClass(alwaysRun = true)
public void testConclude() throws Exception {

super.conclude();
}

protected HttpResponse createAPIResource(APIResource apiResource) throws JSONException, IOException {

HttpPost request = new HttpPost(SERVER_URL + API_RESOURCE_ENDPOINT);
request.setHeader("Content-Type", "application/json");
request.setHeader("Authorization", getAuthzHeader());
JSONObject rootObject = new JSONObject();
rootObject.put(API_NAME_ATTRIBUTE, apiResource.getName());
rootObject.put(API_IDENTIFIER_ATTRIBUTE, apiResource.getIdentifier());
rootObject.put(API_DESCRIPTION_ATTRIBUTE, apiResource.getDescription());
rootObject.put(API_IS_REQUIRED_AUTHORIZATION_ATTRIBUTE, apiResource.isAuthorizationRequired());
JSONArray scopeArray = new JSONArray();
for (Scope scope : apiResource.getScopes()) {
JSONObject scopeObject = new JSONObject();
scopeObject.put(API_SCOPE_NAME_ATTRIBUTE, scope.getName());
scopeObject.put(API_SCOPE_DISPLAY_NAME_ATTRIBUTE, scope.getDisplayName());
scopeObject.put(API_SCOPE_DESCRIPTION_ATTRIBUTE, scope.getDescription());
scopeArray.put(scopeObject);
}
rootObject.put(API_SCOPE_ATTRIBUTE, scopeArray);
StringEntity entity = new StringEntity(rootObject.toString());
request.setEntity(entity);
return client.execute(request);
}

protected HttpResponse getAPIResource(String apiId) throws IOException {

HttpGet request = new HttpGet(SERVER_URL + API_RESOURCE_ENDPOINT + "/" + apiId);
request.setHeader("Content-Type", "application/json");
request.setHeader("Authorization", getAuthzHeader());
return client.execute(request);
}

protected String getAuthzHeader() {

return "Basic " + Base64.encodeBase64String((adminUsername + ":" + password).getBytes()).trim();
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
package org.wso2.identity.integration.test.api.access.mgt;

import org.apache.http.HttpResponse;
import org.json.JSONException;
import org.testng.annotations.AfterClass;
import org.testng.annotations.BeforeClass;
import org.testng.annotations.DataProvider;
import org.testng.annotations.Factory;
import org.testng.annotations.Test;
import org.wso2.carbon.automation.engine.context.TestUserMode;
import org.wso2.carbon.identity.application.common.model.APIResource;
import org.wso2.carbon.identity.application.common.model.Scope;

import java.io.IOException;
import java.util.ArrayList;
import java.util.List;

import static org.testng.Assert.assertEquals;
import static org.testng.Assert.assertNotNull;

public class APIResourceManagementFailureTestCase extends APIAccessManagementBaseTestCase {

private static final String API_1_NAME = "Booking API";
private static final String API_1_DESCRIPTION = "This is a test API created by an integration test";
private static final String API_1_IDENTIFIER = "/bookings";
private static final boolean API_REQUIRES_AUTHORIZATION = true;
private static final String SCOPE_1_DISPLAY_NAME = "Read Bookings";
private static final String SCOPE_1_DESCRIPTION = "Read all the bookings in the system";

@BeforeClass(alwaysRun = true)
public void init() throws Exception {

super.init();
}

@AfterClass(alwaysRun = true)
public void testConclude() {

super.conclude();
}

@DataProvider(name = "APIResourceMgtConfigProvider")
public static Object[][] APIResourceMgtConfigProvider() {

return new Object[][]{
{TestUserMode.SUPER_TENANT_ADMIN}
};
}

@Factory(dataProvider = "APIResourceMgtConfigProvider")
public APIResourceManagementFailureTestCase(TestUserMode userMode) throws Exception {

super(userMode);
}

@Test(priority = 0)
public void addAPIWithInvalidScope() throws JSONException, IOException {

List<Scope> scopeList = new ArrayList<>();

Scope scope1 = new Scope.ScopeBuilder()
.name(null)
.displayName(SCOPE_1_DISPLAY_NAME)
.description(SCOPE_1_DESCRIPTION)
.build();

scopeList.add(scope1);

APIResource apiResource = new APIResource.APIResourceBuilder()
.name(API_1_NAME)
.identifier(API_1_IDENTIFIER)
.description(API_1_DESCRIPTION)
.requiresAuthorization(API_REQUIRES_AUTHORIZATION)
.scopes(scopeList)
.build();

HttpResponse response = createAPIResource(apiResource);
assertNotNull(response, "API resource creation request failed");
assertEquals(response.getStatusLine().getStatusCode(), 409, "Expected status code not received");
}

@Test(priority = 1)
public void addInvalidAPIResource() throws JSONException, IOException {

APIResource apiResource = new APIResource.APIResourceBuilder()
.name(API_1_NAME)
.identifier(null)
.description(API_1_DESCRIPTION)
.requiresAuthorization(API_REQUIRES_AUTHORIZATION)
.scopes(new ArrayList<>())
.build();

HttpResponse response = createAPIResource(apiResource);
assertNotNull(response, "API resource creation request failed");
assertEquals(response.getStatusLine().getStatusCode(), 400, "Expected status code not received");
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,182 @@
package org.wso2.identity.integration.test.api.access.mgt;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.http.HttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.util.EntityUtils;
import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;
import org.testng.annotations.AfterClass;
import org.testng.annotations.BeforeClass;
import org.testng.annotations.DataProvider;
import org.testng.annotations.Factory;
import org.testng.annotations.Test;
import org.wso2.carbon.automation.engine.context.TestUserMode;
import org.wso2.carbon.identity.application.common.model.APIResource;
import org.wso2.carbon.identity.application.common.model.Scope;

import java.io.IOException;
import java.util.ArrayList;
import java.util.List;

import static org.testng.Assert.assertEquals;
import static org.testng.Assert.assertNotNull;

public class APIResourceManagementTestCase extends APIAccessManagementBaseTestCase {

private static final Log LOG = LogFactory.getLog(APIResourceManagementTestCase.class);
private static final String API_1_NAME = "Booking API";
private static final String API_2_NAME = "Flight API";
private static final String API_1_DESCRIPTION = "This is a test API created by an integration test";
private static final String API_2_DESCRIPTION = "This is a test API created by an integration test";
private static final String API_1_IDENTIFIER = "/bookings";
private static final String API_2_IDENTIFIER = "/flights";
private static final boolean API_REQUIRES_AUTHORIZATION = true;
private static final String SCOPE_1_NAME = "read_bookings";
private static final String SCOPE_1_DISPLAY_NAME = "Read Bookings";
private static final String SCOPE_1_DESCRIPTION = "Read all the bookings in the system";
private static final String SCOPE_2_NAME = "write_bookings";
private static final String SCOPE_2_DISPLAY_NAME = "Write Bookings";
private static final String SCOPE_2_DESCRIPTION = "Write bookings to the system";
private String apiResourceId;
private String scope1Id;
private String scope2Id;

@BeforeClass(alwaysRun = true)
public void init() throws Exception {

super.init();
}

@AfterClass(alwaysRun = true)
public void testConclude() {

super.conclude();
}

@DataProvider(name = "APIResourceMgtConfigProvider")
public static Object[][] APIResourceMgtConfigProvider() {

return new Object[][]{
{TestUserMode.SUPER_TENANT_ADMIN}
};
}

@Factory(dataProvider = "APIResourceMgtConfigProvider")
public APIResourceManagementTestCase(TestUserMode userMode) throws Exception {

super(userMode);
}

@Test
public void testAddAPIResource() throws Exception {

List<Scope> scopeList = new ArrayList<>();

Scope scope1 = new Scope.ScopeBuilder()
.name(SCOPE_1_NAME)
.displayName(SCOPE_1_DISPLAY_NAME)
.description(SCOPE_1_DESCRIPTION)
.build();

Scope scope2 = new Scope.ScopeBuilder()
.name(SCOPE_2_NAME)
.displayName(SCOPE_2_DISPLAY_NAME)
.description(SCOPE_2_DESCRIPTION)
.build();

scopeList.add(scope1);
scopeList.add(scope2);

APIResource apiResource = new APIResource.APIResourceBuilder()
.name(API_1_NAME)
.identifier(API_1_IDENTIFIER)
.description(API_1_DESCRIPTION)
.requiresAuthorization(API_REQUIRES_AUTHORIZATION)
.scopes(scopeList)
.build();

HttpResponse response = createAPIResource(apiResource);
assertNotNull(response, "API resource creation failed");
assertEquals(response.getStatusLine().getStatusCode(), 201, "API resource creation failed");
JSONObject responseObj = new JSONObject(EntityUtils.toString(response.getEntity()));
EntityUtils.consume(response.getEntity());
apiResourceId = responseObj.getString(API_ID_ATTRIBUTE);
JSONArray scopeArray = responseObj.getJSONArray(API_SCOPE_ATTRIBUTE);
for (int i = 0; i < scopeArray.length(); i++) {
JSONObject scopeObj = (JSONObject) scopeArray.get(i);
if (scopeObj.getString(API_SCOPE_NAME_ATTRIBUTE).equals(SCOPE_1_NAME)) {
scope1Id = scopeObj.getString(API_SCOPE_ID_ATTRIBUTE);
} else if (scopeObj.getString(API_SCOPE_NAME_ATTRIBUTE).equals(SCOPE_2_NAME)) {
scope2Id = scopeObj.getString(API_SCOPE_ID_ATTRIBUTE);
}
}
HttpResponse getResponse = getAPIResource(apiResourceId);
assertNotNull(getResponse, "API resource retrieval failed");
assertEquals(getResponse.getStatusLine().getStatusCode(), 200, "API resource retrieval failed");
JSONObject getResponseObj = new JSONObject(EntityUtils.toString(getResponse.getEntity()));
EntityUtils.consume(getResponse.getEntity());
assertEquals(getResponseObj.getString(API_ID_ATTRIBUTE), apiResourceId, "API resource retrieval failed");
}

@Test(dependsOnMethods = "testAddAPIResource")
public void testAddDuplicateAPIResource() throws JSONException, IOException {

APIResource apiResource = new APIResource.APIResourceBuilder()
.name(API_1_NAME)
.identifier(API_1_IDENTIFIER)
.description(API_1_DESCRIPTION)
.requiresAuthorization(API_REQUIRES_AUTHORIZATION)
.scopes(new ArrayList<>())
.build();

HttpResponse response = createAPIResource(apiResource);
assertNotNull(response, "API resource creation request failed");
assertEquals(response.getStatusLine().getStatusCode(), 409, "Expected status code not received");
}

@Test(dependsOnMethods = "testAddDuplicateAPIResource")
public void addAPIWithDuplicateScope() throws JSONException, IOException {

List<Scope> scopeList = new ArrayList<>();

Scope scope1 = new Scope.ScopeBuilder()
.name(SCOPE_1_NAME)
.displayName(SCOPE_1_DISPLAY_NAME)
.description(SCOPE_1_DESCRIPTION)
.build();

scopeList.add(scope1);

APIResource apiResource = new APIResource.APIResourceBuilder()
.name(API_1_NAME)
.identifier(API_1_IDENTIFIER)
.description(API_1_DESCRIPTION)
.requiresAuthorization(API_REQUIRES_AUTHORIZATION)
.scopes(scopeList)
.build();

HttpResponse response = createAPIResource(apiResource);
assertNotNull(response, "API resource creation request failed");
assertEquals(response.getStatusLine().getStatusCode(), 409, "Expected status code not received");
}

@Test(dependsOnMethods = "testAddAPIResource")
public void getAPIResources() throws JSONException, IOException {

HttpGet request = new HttpGet(SERVER_URL + API_RESOURCE_ENDPOINT + BUSINESS_API_FILTER_QUERY);
request.setHeader("Content-Type", "application/json");
request.setHeader("Authorization", getAuthzHeader());
HttpResponse response = client.execute(request);
assertNotNull(response, "API resource retrieval failed");
assertEquals(response.getStatusLine().getStatusCode(), 200, "API resource retrieval failed");
JSONObject responseObj = new JSONObject(EntityUtils.toString(response.getEntity()));
EntityUtils.consume(response.getEntity());
JSONArray apiResourceArray = responseObj.getJSONArray("apiResources");
assertEquals(apiResourceArray.length(), 1, "API resource count expected to be 1");
JSONObject apiResource = apiResourceArray.getJSONObject(0);
assertEquals(apiResource.getString(API_ID_ATTRIBUTE), apiResourceId, "API resource retrieval failed");
}
}
Loading