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

[APIM][5.x.x] Update Tests for Workflow Config Migration #13296

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from
Draft

[APIM][5.x.x] Update Tests for Workflow Config Migration #13296

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e6951ef
Update tests for workflow config migration
Avishka-Shamendra Nov 7, 2023
7dcf63f
Add EOF new lines
Avishka-Shamendra Nov 16, 2023
15f03cb
Add EOF new lines
Avishka-Shamendra Nov 16, 2023
a244ef6
Update test resources to support workflow config changes
Avishka-Shamendra Nov 21, 2023
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
10 changes: 1 addition & 9 deletions modules/distribution/product/src/main/assembly/bin.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -750,15 +750,7 @@
<include>**/tenant-conf.json</include>
</includes>
</fileSet>
<fileSet>
<directory>
../../p2-profile/product/target/wso2carbon-core-${carbon.kernel.version}/repository/resources/workflowextensions
</directory>
<outputDirectory>wso2am-${pom.version}/repository/resources</outputDirectory>
<includes>
<include>**/default-workflow-extensions.xml</include>
</includes>
</fileSet>


<!--copying runtimes-->
<fileSet>
Expand Down
70 changes: 36 additions & 34 deletions ...end/src/test/java/org/wso2/am/integration/tests/other/APIStateChangeWorkflowTestCase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,16 @@
*/
package org.wso2.am.integration.tests.other;

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

import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.net.MalformedURLException;
import java.net.URISyntaxException;
import java.net.URL;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import javax.xml.xpath.XPathExpressionException;
Expand All @@ -34,11 +34,13 @@
import org.json.JSONException;
import org.json.JSONObject;
import org.json.simple.parser.JSONParser;
import org.json.simple.parser.ParseException;
import org.testng.Assert;
import org.testng.annotations.AfterClass;
import org.testng.annotations.BeforeClass;
import org.testng.annotations.Test;
import org.wso2.am.admin.clients.registry.ResourceAdminServiceClient;
import org.wso2.am.integration.clients.admin.ApiException;
import org.wso2.am.integration.test.utils.APIManagerIntegrationTestException;
import org.wso2.am.integration.test.utils.base.APIMIntegrationConstants;
import org.wso2.am.integration.test.utils.bean.APILifeCycleState;
Expand All @@ -53,7 +55,6 @@
import org.wso2.carbon.automation.engine.annotations.SetEnvironment;
import org.wso2.carbon.automation.test.utils.http.client.HttpResponse;
import org.wso2.carbon.integration.common.utils.exceptions.AutomationUtilException;
import org.wso2.carbon.integration.common.utils.mgt.ServerConfigurationManager;
import org.wso2.carbon.registry.resource.stub.ResourceAdminServiceExceptionException;

/**
Expand All @@ -66,21 +67,19 @@ public class APIStateChangeWorkflowTestCase extends APIManagerLifecycleBaseTest
private String publisherURLHttp;
private String storeURLHttp;
private String userName;
private String originalWFExtentionsXML;
private String newWFExtentionsXML;
private ResourceAdminServiceClient resourceAdminServiceClient;
private APIIdentifier apiIdentifier;
private final String APIM_CONFIG_XML = "api-manager.xml";
private final String DEFAULT_WF_EXTENTIONS_XML_REG_CONFIG_LOCATION =
"/_system/governance/apimgt/applicationdata/workflow-extensions.xml";
private String appName = "sample-application-workflow2";
private static JSONParser parser = new JSONParser();
private ServerConfigurationManager serverConfigurationManager;
private String apiName = "APIStateWf";
private String apiVersion = "1.0.0";
private String wfreferenceId = null;
private String clientId;
private String clientSecrect;
private String clientSecret;
private org.json.simple.JSONObject originalTenantConf;
private static final String UTF_8 = "UTF-8";
private static final String TENANT_CONFIG_PATH = "artifacts/AM/configFiles/tenantConf/tenant-conf.json";
private static final String WORKFLOW_CONFIG_PATH
= "artifacts/AM/configFiles/workflowapistatechange/tenant-workflow-conf.json";

/*
@DataProvider
Expand All @@ -97,24 +96,29 @@ public APIStateChangeWorkflowTestCase(TestUserMode userMode) {

@BeforeClass(groups = {"noRestart"}, alwaysRun = true)
public void setEnvironment() throws AutomationUtilException, XPathExpressionException, IOException,
APIManagerIntegrationTestException, URISyntaxException, ResourceAdminServiceExceptionException {
APIManagerIntegrationTestException, URISyntaxException, ResourceAdminServiceExceptionException, ApiException, ParseException {
super.init();

String url = getGatewayURLHttp();

publisherURLHttp = getPublisherURLHttp();
storeURLHttp = getStoreURLHttp();
userName = user.getUserName();
resourceAdminServiceClient = new ResourceAdminServiceClient(gatewayContextMgt.getContextUrls().getBackEndUrl(),
createSession(gatewayContextMgt));
// Gets the original workflow-extentions.xml file's content from the registry.
originalWFExtentionsXML = resourceAdminServiceClient
.getTextContent(DEFAULT_WF_EXTENTIONS_XML_REG_CONFIG_LOCATION);
// Gets the new configuration of the workflow-extentions.xml
newWFExtentionsXML = readFile(getAMResourceLocation() + File.separator + "configFiles" + File.separator
+ "workflowapistatechange" + File.separator + "workflow-extentions.xml");
// Updates the content of the workflow-extentions.xml of the registry file, to have the new configurations.
resourceAdminServiceClient.updateTextContent(DEFAULT_WF_EXTENTIONS_XML_REG_CONFIG_LOCATION, newWFExtentionsXML);

originalTenantConf = (org.json.simple.JSONObject) new JSONParser().parse(restAPIAdmin.getTenantConfig());
InputStream tenantConfigStream = getClass().getClassLoader().getResourceAsStream(TENANT_CONFIG_PATH);
assertNotNull("Tenant config stream can not be null", tenantConfigStream);

org.json.simple.JSONObject tenantJsonObject = (org.json.simple.JSONObject) new JSONParser().parse(
new InputStreamReader(tenantConfigStream, UTF_8));

InputStream wfStream = getClass().getClassLoader().getResourceAsStream(WORKFLOW_CONFIG_PATH);
assertNotNull("Workflow stream can not be null", wfStream);
org.json.simple.JSONObject wfJsonObj = (org.json.simple.JSONObject) new JSONParser().parse(
new InputStreamReader(wfStream, UTF_8));

tenantJsonObject.put("Workflows",wfJsonObj);
restAPIAdmin.updateTenantConfig(tenantJsonObject);

APIStoreRestClient apiStore;

Expand Down Expand Up @@ -182,7 +186,7 @@ public void testAPIStateChangeAndApproveWorkflow() throws Exception {
if ("clientId".equals(name)) {
clientId = variable.getString("value");
} else if ("clientSecret".equals(name)) {
clientSecrect = variable.getString("value");
clientSecret = variable.getString("value");
} else if ("scope".equals(name)) {
scope = variable.getString("value");
} else if ("apiCurrentState".equals(name)) {
Expand All @@ -201,10 +205,10 @@ public void testAPIStateChangeAndApproveWorkflow() throws Exception {

}
Assert.assertNotNull(clientId, "clientId should not be null");
Assert.assertNotNull(clientSecrect, "clientSecrect should not be null");
Assert.assertNotNull(clientSecret, "clientSecrect should not be null");
Assert.assertNotNull(scope, "scope should not be null");

HttpResponse resp = completeWorkflowTask(clientId, clientSecrect, scope, apiCurrentState, apiLCAction,
HttpResponse resp = completeWorkflowTask(clientId, clientSecret, scope, apiCurrentState, apiLCAction,
apiNameReq, apiVersionReq, apiProvider, invoker, "APPROVED");
Assert.assertEquals(resp.getResponseCode(), 200, "Invalid status code:" + resp.getResponseCode());

Expand Down Expand Up @@ -266,7 +270,7 @@ public void testAPIStateChangeAndRejectWorkflow() throws Exception {
if ("clientId".equals(name)) {
clientId = variable.getString("value");
} else if ("clientSecret".equals(name)) {
clientSecrect = variable.getString("value");
clientSecret = variable.getString("value");
} else if ("scope".equals(name)) {
scope = variable.getString("value");
} else if ("apiCurrentState".equals(name)) {
Expand All @@ -285,10 +289,10 @@ public void testAPIStateChangeAndRejectWorkflow() throws Exception {

}
Assert.assertNotNull(clientId, "clientId should not be null");
Assert.assertNotNull(clientSecrect, "clientSecrect should not be null");
Assert.assertNotNull(clientSecret, "clientSecrect should not be null");
Assert.assertNotNull(scope, "scope should not be null");

HttpResponse resp = completeWorkflowTask(clientId, clientSecrect, scope, apiCurrentState, apiLCAction,
HttpResponse resp = completeWorkflowTask(clientId, clientSecret, scope, apiCurrentState, apiLCAction,
apiNameReq, apiVersionReq, apiProvider, invoker, "REJECTED");
Assert.assertEquals(resp.getResponseCode(), 200, "Invalid status code:" + resp.getResponseCode());

Expand All @@ -312,7 +316,7 @@ public void testWorkflowCallbackRestAPI() throws Exception {
String workflowCallbackUrl;

// check for token with different scope other than apim:api_workfow
String accessToken = generateAccessToken("default", clientId, clientSecrect);
String accessToken = generateAccessToken("default", clientId, clientSecret);
Map<String, String> authenticationRequestHeaders = new HashMap<String, String>();
authenticationRequestHeaders.put("Authorization", "Bearer " + accessToken);
authenticationRequestHeaders.put("Content-Type", "application/json");
Expand All @@ -325,7 +329,7 @@ public void testWorkflowCallbackRestAPI() throws Exception {
"Status code mismatch when request is done without valid token");

// get the correct scope
accessToken = generateAccessToken("apim:api_workflow", clientId, clientSecrect);
accessToken = generateAccessToken("apim:api_workflow", clientId, clientSecret);
authenticationRequestHeaders = new HashMap<String, String>();
authenticationRequestHeaders.put("Authorization", "Bearer " + accessToken);
authenticationRequestHeaders.put("Content-Type", "application/json");
Expand Down Expand Up @@ -356,10 +360,8 @@ public void testWorkflowCallbackRestAPI() throws Exception {

@AfterClass(alwaysRun = true)
public void cleanUpArtifacts() throws Exception {
restAPIAdmin.updateTenantConfig(originalTenantConf);
super.cleanUp();
// restore the original workflow-extentions.xml content.
resourceAdminServiceClient.updateTextContent(DEFAULT_WF_EXTENTIONS_XML_REG_CONFIG_LOCATION,
originalWFExtentionsXML);
}

private HttpResponse completeWorkflowTask(String clientId, String clientSecrect, String scope,
Expand Down
48 changes: 29 additions & 19 deletions ...end/src/test/java/org/wso2/am/integration/tests/other/SubscriptionWFHTTPRedirectTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@

import org.json.JSONObject;
import org.json.simple.parser.JSONParser;
import org.json.simple.parser.ParseException;
import org.testng.annotations.AfterClass;
import org.testng.annotations.BeforeClass;
import org.testng.annotations.Test;
import org.wso2.am.admin.clients.registry.ResourceAdminServiceClient;
import org.wso2.am.integration.clients.admin.ApiException;
import org.wso2.am.integration.test.utils.APIManagerIntegrationTestException;
import org.wso2.am.integration.test.utils.base.APIMIntegrationConstants;
import org.wso2.am.integration.test.utils.bean.*;
import org.wso2.am.integration.test.utils.clients.APIPublisherRestClient;
import org.wso2.am.integration.test.utils.clients.APIStoreRestClient;
import org.wso2.am.integration.tests.api.lifecycle.APIManagerLifecycleBaseTest;
import org.wso2.carbon.apimgt.api.WorkflowResponse;
import org.wso2.carbon.apimgt.api.model.APIIdentifier;
import org.wso2.carbon.automation.engine.annotations.ExecutionEnvironment;
import org.wso2.carbon.automation.engine.annotations.SetEnvironment;
Expand All @@ -25,9 +25,12 @@

import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.net.URISyntaxException;
import java.net.URL;

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

Expand All @@ -42,17 +45,18 @@ public class SubscriptionWFHTTPRedirectTest extends APIManagerLifecycleBaseTest
private String publisherURLHttp;
private String storeURLHttp;
private String userName;
private String originalWFExtentionsXML;
private String newWFExtentionsXML;
private ResourceAdminServiceClient resourceAdminServiceClient;
private APIIdentifier apiIdentifier;
private final String DEFAULT_WF_EXTENTIONS_XML_REG_CONFIG_LOCATION = "/_system/governance/apimgt/applicationdata/workflow-extensions.xml";
private String appName = "sample-application-workflow2";
private static JSONParser parser = new JSONParser();
private org.json.simple.JSONObject originalTenantConf;
private static final String UTF_8 = "UTF-8";
private static final String TENANT_CONFIG_PATH = "artifacts/AM/configFiles/tenantConf/tenant-conf.json";
private static final String WORKFLOW_CONFIG_PATH
= "artifacts/AM/configFiles/workflowHTTPRedirect/tenant-workflow-conf.json";

@BeforeClass(alwaysRun = true)
public void setEnvironment() throws AutomationUtilException, XPathExpressionException, IOException,
APIManagerIntegrationTestException, URISyntaxException, ResourceAdminServiceExceptionException {
APIManagerIntegrationTestException, URISyntaxException, ResourceAdminServiceExceptionException, ParseException, ApiException {
super.init();

ServerConfigurationManager serverConfigurationManager;
Expand All @@ -67,23 +71,30 @@ public void setEnvironment() throws AutomationUtilException, XPathExpressionExce
publisherURLHttp = getPublisherURLHttp();
storeURLHttp = getStoreURLHttp();
userName = user.getUserName();
resourceAdminServiceClient =
new ResourceAdminServiceClient(gatewayContextMgt.getContextUrls().getBackEndUrl(),
createSession(gatewayContextMgt));
//Gets the original workflow-extentions.xml file's content from the registry.
originalWFExtentionsXML = resourceAdminServiceClient.getTextContent(DEFAULT_WF_EXTENTIONS_XML_REG_CONFIG_LOCATION);
//Gets the new configuration of the workflow-extentions.xml
newWFExtentionsXML = readFile(getAMResourceLocation()
+ File.separator + "configFiles" + File.separator + "workflowHTTPRedirect" + File.separator + "workflow-extentions.xml");

originalTenantConf = (org.json.simple.JSONObject) new JSONParser().parse(restAPIAdmin.getTenantConfig());
InputStream tenantConfigStream = getClass().getClassLoader().getResourceAsStream(TENANT_CONFIG_PATH);
assertNotNull("Tenant config stream can not be null", tenantConfigStream);

org.json.simple.JSONObject tenantJsonObject = (org.json.simple.JSONObject) new JSONParser().parse(
new InputStreamReader(tenantConfigStream, UTF_8));

InputStream wfStream = getClass().getClassLoader().getResourceAsStream(WORKFLOW_CONFIG_PATH);
assertNotNull("Workflow stream can not be null", wfStream);
org.json.simple.JSONObject wfJsonObj = (org.json.simple.JSONObject) new JSONParser().parse(
new InputStreamReader(wfStream, UTF_8));

tenantJsonObject.put("Workflows",wfJsonObj);
//Updates the workflow configuration to have a custom SubscriptionCreation workflow.
restAPIAdmin.updateTenantConfig(tenantJsonObject);

}


@Test(groups = "wso2.am", description = "Test if the custom subscription workflow response returns the redirect URI")
public void testHTTPredirectInSubscriptionWorkflow() throws Exception {

APIStoreRestClient apiStore;
//Updates the content of the workflow-extentions.xml of the registry file, to have the new configurations.
resourceAdminServiceClient.updateTextContent(DEFAULT_WF_EXTENTIONS_XML_REG_CONFIG_LOCATION, newWFExtentionsXML);
String apiName = "HTTPRedirectTestAPI2";
//Just a dummy URL
String url = "http://localhost:9443/carbon";
Expand Down Expand Up @@ -136,9 +147,8 @@ public void testHTTPredirectInSubscriptionWorkflow() throws Exception {

@AfterClass(alwaysRun = true)
public void cleanUpArtifacts() throws Exception {
restAPIAdmin.updateTenantConfig(originalTenantConf);
super.cleanUp();
//restore the original workflow-extentions.xml content.
resourceAdminServiceClient.updateTextContent(DEFAULT_WF_EXTENTIONS_XML_REG_CONFIG_LOCATION, originalWFExtentionsXML);
}

}
Loading
Loading