Package org.wso2.am.integration.test.utils.base

Class APIMIntegrationBaseTest

java.lang.Object

org.wso2.am.integration.test.utils.base.APIMIntegrationBaseTest

public class APIMIntegrationBaseTest
extends Object

Base class for all API Manager integration tests Users need to extend this class to write integration tests.

Field Summary

Fields

Modifier and Type	Field	Description
protected org.wso2.carbon.automation.engine.context.AutomationContext	adminContext
protected String	adminURLHttp
protected String	adminURLHttps
protected APIMURLBean	adminUrls
protected AdminDashboardRestClient	apiAdmin
protected APIMTestCaseUtils	apimTestCaseUtils
protected APIPublisherRestClient	apiPublisher
protected APIStoreRestClient	apiStore
protected ApplicationManagementClient	applicationManagementClient
protected org.wso2.carbon.automation.engine.context.AutomationContext	backEndServer
protected APIMURLBean	backEndServerUrl
protected String	executionMode
protected org.wso2.carbon.automation.engine.context.AutomationContext	gatewayContextMgt
protected org.wso2.carbon.automation.engine.context.AutomationContext	gatewayContextWrk
protected String	gatewayHTTPSURL
protected APIMURLBean	gatewayUrlsMgt
protected APIMURLBean	gatewayUrlsWrk
protected IdentityProviderMgtClient	identityProviderMgtClient
protected IdentityProviderMgtServiceClient	identityProviderMgtServiceClient
protected int	inboundWebSocketPort
protected org.wso2.carbon.automation.engine.context.AutomationContext	keyManagerContext
protected String	keyManagerHTTPSURL
protected String	keymanagerSessionCookie
protected String	keymanagerSuperTenantSessionCookie
protected APIMURLBean	keyMangerUrl
protected OAuthAdminServiceClient	oAuthAdminServiceClient
protected int	portOffset
protected org.wso2.carbon.automation.engine.context.AutomationContext	publisherContext
protected String	publisherURLHttp
protected String	publisherURLHttps
protected APIMURLBean	publisherUrls
protected ClaimMetaDataMgtAdminClient	remoteClaimMetaDataMgtAdminClient
protected RemoteUserStoreManagerServiceClient	remoteUserStoreManagerServiceClient
protected RestAPIAdminImpl	restAPIAdmin
protected RestAPIInternalImpl	restAPIInternal
protected RestAPIPublisherImpl	restAPIPublisher
protected RestAPIServiceCatalogImpl	restAPIServiceCatalog
protected RestAPIStoreImpl	restAPIStore
protected org.wso2.carbon.automation.engine.context.AutomationContext	storeContext
protected String	storeURLHttp
protected String	storeURLHttps
protected APIMURLBean	storeUrls
protected org.wso2.carbon.automation.engine.context.AutomationContext	superTenantKeyManagerContext
protected org.apache.axiom.om.OMElement	synapseConfiguration
protected org.wso2.carbon.integration.common.admin.client.TenantManagementServiceClient	tenantManagementServiceClient
protected org.wso2.carbon.automation.engine.context.beans.User	user
protected org.wso2.carbon.integration.common.admin.client.UserManagementClient	userManagementClient
protected org.wso2.carbon.automation.engine.context.TestUserMode	userMode

Constructor Summary

Constructors

Constructor	Description
APIMIntegrationBaseTest()

Method Summary

Modifier and Type	Method	Description
protected void	cleanUp()	Cleaning up the API manager by removing all APIs and applications other than default application
protected String	createAPIProductRevisionAndDeployUsingRest(String apiId, RestAPIPublisherImpl restAPIPublisher)	Create API Product Revision and Deploy to gateway using REST API.
protected String	createAPIRevisionAndDeployUsingRest(String apiId, RestAPIPublisherImpl restAPIPublisher)	Create API Revision and Deploy to gateway using REST API.
protected String	createSession(org.wso2.carbon.automation.engine.context.AutomationContext automationContext)
protected String	getAMResourceLocation()	Get test artifact resources location
protected String	getAPIInvocationURLHttp(String apiContext)
protected String	getAPIInvocationURLHttp(String apiContext, String version)
protected String	getAPIInvocationURLHttps(String apiContext)
protected String	getAPIInvocationURLHttps(String apiContext, String version)	To get the API invocation in https with context and version.
protected String	getAPIProductInvocationURLHttps(String apiContext)	To get the API Productinvocation in https with context and version.
protected int	getAvailablePort(int lowerPortLimit, int upperPortLimit)	Find a free port to start backend WebSocket server in given port range
protected String	getBackendEndServiceEndPointHttp(String serviceName)
protected String	getBackendEndServiceEndPointHttps(String serviceName)
protected String	getGatewayMgtBackendURLHttps()
protected String	getGatewayMgtURLHttp()
protected String	getGatewayMgtURLHttps()
protected String	getGatewayURLHttp()
protected String	getGatewayURLHttps()
protected String	getGatewayURLNhttp()
protected String	getGatewayURLNhttps()
protected String	getKeyManagerURLHttp()
protected String	getKeyManagerURLHttps()
protected String	getPublisherURLHttp()
protected String	getPublisherURLHttps()
protected RestAPIPublisherImpl	getRestAPIPublisherForUser(String user, String pass, String tenantDomain)
protected RestAPIStoreImpl	getRestAPIStoreForAnonymousUser(String tenantDomain)
protected RestAPIStoreImpl	getRestAPIStoreForUser(String user, String pass, String tenantDomain)
protected String	getStoreURLHttp()
protected String	getStoreURLHttps()
protected String	getSuperTenantAPIInvocationURLHttp(String apiContext, String version)
protected static long	getWaitTime()
protected String	getWebSocketAPIInvocationURL(String apiContext, String version)
protected String	getWebSocketTenantAPIInvocationURL(String apiContext, String version, String tenantDomain)
protected void	init()	This method will initialize test environment based on user mode and configuration given at automation.xml
protected void	init(String domainKey, String userKey)	init the object with tenant domain, user key and instance of store,publisher and gateway create context objects and construct URL bean
protected void	init(org.wso2.carbon.automation.engine.context.TestUserMode userMode)	init the object with user mode , create context objects and get session cookies
protected void	loadSynapseConfigurationFromClasspath(String relativeFilePath, org.wso2.carbon.automation.engine.context.AutomationContext automationContext, String sessionCookie)
protected org.apache.http.Header	pickHeader(org.apache.http.Header[] headers, String requiredHeader)
protected String	undeployAndDeleteAPIProductRevisionsUsingRest(String apiId, RestAPIPublisherImpl restAPIPublisher)	Undeploy and Delete API Product Revisions using REST API.
protected String	undeployAndDeleteAPIRevisionsUsingRest(String apiId, RestAPIPublisherImpl restAPIPublisher)	Undeploy and Delete API Revisions using REST API.
protected void	updateSynapseConfiguration(org.apache.axiom.om.OMElement synapseConfig, org.wso2.carbon.automation.engine.context.AutomationContext automationContext, String sessionCookie)	update synapse config to server
protected void	verifyResponse(org.wso2.carbon.automation.test.utils.http.client.HttpResponse httpResponse)
protected void	waitForAPIDeployment()	This method can be used to wait for API deployment sync in distributed and clustered environment APIStatusMonitor will be invoked to get API related data and then verify that data matches with expected response provided.
protected void	waitForAPIDeploymentSync(String apiProvider, String apiName, String apiVersion, String expectedResponse)	This method can be used to wait for API deployment sync in distributed and clustered environment APIStatusMonitor will be invoked to get API related data and then verify that data matches with expected response provided.
protected void	waitForAPIUnDeploymentSync(String apiProvider, String apiName, String apiVersion, String expectedResponse)	This method can be used to wait for API Un-deployment sync in distributed and clustered environment APIStatusMonitor will be invoked to get API related data and then verify that data matches with expected response provided.
protected void	waitForKeyManagerDeployment(String tenantDomain, String keyManagerName)
protected void	waitForKeyManagerUnDeployment(String tenantDomain, String keyManagerName)
protected static void	waitUntilClockHour()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

storeContext

protected org.wso2.carbon.automation.engine.context.AutomationContext storeContext

publisherContext

protected org.wso2.carbon.automation.engine.context.AutomationContext publisherContext

keyManagerContext

protected org.wso2.carbon.automation.engine.context.AutomationContext keyManagerContext

gatewayContextMgt

protected org.wso2.carbon.automation.engine.context.AutomationContext gatewayContextMgt

gatewayContextWrk

protected org.wso2.carbon.automation.engine.context.AutomationContext gatewayContextWrk

backEndServer

protected org.wso2.carbon.automation.engine.context.AutomationContext backEndServer

superTenantKeyManagerContext

protected org.wso2.carbon.automation.engine.context.AutomationContext superTenantKeyManagerContext

adminContext

protected org.wso2.carbon.automation.engine.context.AutomationContext adminContext

synapseConfiguration

protected org.apache.axiom.om.OMElement synapseConfiguration

apimTestCaseUtils

protected APIMTestCaseUtils apimTestCaseUtils

userMode

protected org.wso2.carbon.automation.engine.context.TestUserMode userMode

executionMode

protected String executionMode

storeUrls

protected APIMURLBean storeUrls

publisherUrls

protected APIMURLBean publisherUrls

gatewayUrlsMgt

protected APIMURLBean gatewayUrlsMgt

gatewayUrlsWrk

protected APIMURLBean gatewayUrlsWrk

keyMangerUrl

protected APIMURLBean keyMangerUrl

backEndServerUrl

protected APIMURLBean backEndServerUrl

adminUrls

protected APIMURLBean adminUrls

user

protected org.wso2.carbon.automation.engine.context.beans.User user

apiPublisher

protected APIPublisherRestClient apiPublisher

apiStore

protected APIStoreRestClient apiStore

apiAdmin

protected AdminDashboardRestClient apiAdmin

restAPIPublisher

protected RestAPIPublisherImpl restAPIPublisher

restAPIServiceCatalog

protected RestAPIServiceCatalogImpl restAPIServiceCatalog

restAPIStore

protected RestAPIStoreImpl restAPIStore

restAPIAdmin

protected RestAPIAdminImpl restAPIAdmin

userManagementClient

protected org.wso2.carbon.integration.common.admin.client.UserManagementClient userManagementClient

remoteUserStoreManagerServiceClient

protected RemoteUserStoreManagerServiceClient remoteUserStoreManagerServiceClient

remoteClaimMetaDataMgtAdminClient

protected ClaimMetaDataMgtAdminClient remoteClaimMetaDataMgtAdminClient

identityProviderMgtClient

protected IdentityProviderMgtClient identityProviderMgtClient

oAuthAdminServiceClient

protected OAuthAdminServiceClient oAuthAdminServiceClient

applicationManagementClient

protected ApplicationManagementClient applicationManagementClient

identityProviderMgtServiceClient

protected IdentityProviderMgtServiceClient identityProviderMgtServiceClient

tenantManagementServiceClient

protected org.wso2.carbon.integration.common.admin.client.TenantManagementServiceClient tenantManagementServiceClient

publisherURLHttp

protected String publisherURLHttp

publisherURLHttps

protected String publisherURLHttps

adminURLHttp

protected String adminURLHttp

adminURLHttps

protected String adminURLHttps

keyManagerHTTPSURL

protected String keyManagerHTTPSURL

gatewayHTTPSURL

protected String gatewayHTTPSURL

storeURLHttp

protected String storeURLHttp

storeURLHttps

protected String storeURLHttps

keymanagerSessionCookie

protected String keymanagerSessionCookie

keymanagerSuperTenantSessionCookie

protected String keymanagerSuperTenantSessionCookie

restAPIInternal

protected RestAPIInternalImpl restAPIInternal

inboundWebSocketPort

protected final int inboundWebSocketPort

See Also:

Constant Field Values

portOffset

protected final int portOffset

See Also:

Constant Field Values

Constructor Detail

APIMIntegrationBaseTest

public APIMIntegrationBaseTest()

Method Detail

init

protected void init()
             throws APIManagerIntegrationTestException

This method will initialize test environment based on user mode and configuration given at automation.xml

Throws:

APIManagerIntegrationTestException - - if test configuration init fails

init

protected void init(org.wso2.carbon.automation.engine.context.TestUserMode userMode)
             throws APIManagerIntegrationTestException

init the object with user mode , create context objects and get session cookies

Parameters:

userMode - - user mode to run the tests

Throws:

APIManagerIntegrationTestException - - if test configuration init fails

init

protected void init(String domainKey,
                    String userKey)
             throws APIManagerIntegrationTestException

init the object with tenant domain, user key and instance of store,publisher and gateway create context objects and construct URL bean

Parameters:

domainKey - - tenant domain key

userKey - - tenant user key

Throws:

APIManagerIntegrationTestException - - if test configuration init fails

loadSynapseConfigurationFromClasspath

protected void loadSynapseConfigurationFromClasspath(String relativeFilePath,
                                                     org.wso2.carbon.automation.engine.context.AutomationContext automationContext,
                                                     String sessionCookie)
                                              throws APIManagerIntegrationTestException

Parameters:

relativeFilePath - - file path to load config

Throws:

APIManagerIntegrationTestException - - Throws if load synapse configuration from file path fails

createSession

protected String createSession(org.wso2.carbon.automation.engine.context.AutomationContext automationContext)
                        throws APIManagerIntegrationTestException

Parameters:

automationContext - - automation context instance of given server

Returns:

- created session cookie variable

Throws:

APIManagerIntegrationTestException - - Throws if creating session cookie fails

getAMResourceLocation

protected String getAMResourceLocation()

Get test artifact resources location

Returns:

- absolute patch of test artifact directory

updateSynapseConfiguration

protected void updateSynapseConfiguration(org.apache.axiom.om.OMElement synapseConfig,
                                          org.wso2.carbon.automation.engine.context.AutomationContext automationContext,
                                          String sessionCookie)
                                   throws APIManagerIntegrationTestException

update synapse config to server

Parameters:

synapseConfig - - config to upload

automationContext - - automation context of the server instance

sessionCookie - - logged in session cookie

Throws:

APIManagerIntegrationTestException - - If synapse config update fails

getStoreURLHttp

protected String getStoreURLHttp()

getStoreURLHttps

protected String getStoreURLHttps()

getPublisherURLHttp

protected String getPublisherURLHttp()

getPublisherURLHttps

protected String getPublisherURLHttps()

getGatewayMgtURLHttp

protected String getGatewayMgtURLHttp()

getGatewayMgtBackendURLHttps

protected String getGatewayMgtBackendURLHttps()

getGatewayMgtURLHttps

protected String getGatewayMgtURLHttps()

getGatewayURLHttp

protected String getGatewayURLHttp()

getGatewayURLNhttp

protected String getGatewayURLNhttp()

getGatewayURLHttps

protected String getGatewayURLHttps()

getGatewayURLNhttps

protected String getGatewayURLNhttps()

getKeyManagerURLHttp

protected String getKeyManagerURLHttp()

getKeyManagerURLHttps

protected String getKeyManagerURLHttps()
                                throws XPathExpressionException

Throws:

XPathExpressionException

getAPIInvocationURLHttp

protected String getAPIInvocationURLHttp(String apiContext)
                                  throws XPathExpressionException

Throws:

XPathExpressionException

getAPIInvocationURLHttp

protected String getAPIInvocationURLHttp(String apiContext,
                                         String version)
                                  throws XPathExpressionException

Throws:

XPathExpressionException

getAPIInvocationURLHttps

protected String getAPIInvocationURLHttps(String apiContext,
                                          String version)
                                   throws XPathExpressionException

To get the API invocation in https with context and version.

Parameters:

apiContext - Relevant context of the API.

version - Version of the API.

Returns:

Https url related with api context and version.

Throws:

XPathExpressionException - XPath Express Exception.

getAPIProductInvocationURLHttps

protected String getAPIProductInvocationURLHttps(String apiContext)
                                          throws XPathExpressionException

To get the API Productinvocation in https with context and version.

Parameters:

apiContext - Relevant context of the API Product.

Returns:

Https url related with api context and version.

Throws:

XPathExpressionException - XPath Express Exception.

getWebSocketAPIInvocationURL

protected String getWebSocketAPIInvocationURL(String apiContext,
                                              String version)
                                       throws XPathExpressionException

Throws:

XPathExpressionException

getWebSocketTenantAPIInvocationURL

protected String getWebSocketTenantAPIInvocationURL(String apiContext,
                                                    String version,
                                                    String tenantDomain)
                                             throws XPathExpressionException

Throws:

XPathExpressionException

getAPIInvocationURLHttps

protected String getAPIInvocationURLHttps(String apiContext)
                                   throws XPathExpressionException

Throws:

XPathExpressionException

getBackendEndServiceEndPointHttp

protected String getBackendEndServiceEndPointHttp(String serviceName)

getBackendEndServiceEndPointHttps

protected String getBackendEndServiceEndPointHttps(String serviceName)

getSuperTenantAPIInvocationURLHttp

protected String getSuperTenantAPIInvocationURLHttp(String apiContext,
                                                    String version)
                                             throws XPathExpressionException

Throws:

XPathExpressionException

cleanUp

protected void cleanUp()
                throws Exception

Cleaning up the API manager by removing all APIs and applications other than default application

Throws:

APIManagerIntegrationTestException - - occurred when calling the apis

Exception

verifyResponse

protected void verifyResponse(org.wso2.carbon.automation.test.utils.http.client.HttpResponse httpResponse)
                       throws org.json.JSONException

Throws:

org.json.JSONException

waitForAPIDeployment

protected void waitForAPIDeployment()

This method can be used to wait for API deployment sync in distributed and clustered environment APIStatusMonitor will be invoked to get API related data and then verify that data matches with expected response provided.

waitForAPIDeploymentSync

protected void waitForAPIDeploymentSync(String apiProvider,
                                        String apiName,
                                        String apiVersion,
                                        String expectedResponse)
                                 throws APIManagerIntegrationTestException,
                                        XPathExpressionException

This method can be used to wait for API deployment sync in distributed and clustered environment APIStatusMonitor will be invoked to get API related data and then verify that data matches with expected response provided.

Parameters:

apiProvider - - Provider of the API

apiName - - API name

apiVersion - - API version

expectedResponse - - Expected response

Throws:

APIManagerIntegrationTestException - - Throws if something goes wrong

XPathExpressionException

waitForAPIUnDeploymentSync

protected void waitForAPIUnDeploymentSync(String apiProvider,
                                          String apiName,
                                          String apiVersion,
                                          String expectedResponse)
                                   throws APIManagerIntegrationTestException

This method can be used to wait for API Un-deployment sync in distributed and clustered environment APIStatusMonitor will be invoked to get API related data and then verify that data matches with expected response provided.

Parameters:

apiProvider - - Provider of the API

apiName - - API name

apiVersion - - API version

expectedResponse - - Expected response

Throws:

APIManagerIntegrationTestException - - Throws if something goes wrong

pickHeader

protected org.apache.http.Header pickHeader(org.apache.http.Header[] headers,
                                            String requiredHeader)

getRestAPIPublisherForUser

protected RestAPIPublisherImpl getRestAPIPublisherForUser(String user,
                                                          String pass,
                                                          String tenantDomain)

getRestAPIStoreForUser

protected RestAPIStoreImpl getRestAPIStoreForUser(String user,
                                                  String pass,
                                                  String tenantDomain)

getRestAPIStoreForAnonymousUser

protected RestAPIStoreImpl getRestAPIStoreForAnonymousUser(String tenantDomain)

waitForKeyManagerDeployment

protected void waitForKeyManagerDeployment(String tenantDomain,
                                           String keyManagerName)
                                    throws XPathExpressionException,
                                           UnsupportedEncodingException

Throws:

XPathExpressionException

UnsupportedEncodingException

waitForKeyManagerUnDeployment

protected void waitForKeyManagerUnDeployment(String tenantDomain,
                                             String keyManagerName)
                                      throws XPathExpressionException,
                                             UnsupportedEncodingException

Throws:

XPathExpressionException

UnsupportedEncodingException

createAPIRevisionAndDeployUsingRest

protected String createAPIRevisionAndDeployUsingRest(String apiId,
                                                     RestAPIPublisherImpl restAPIPublisher)
                                              throws ApiException,
                                                     org.json.JSONException,
                                                     APIManagerIntegrationTestException

Create API Revision and Deploy to gateway using REST API.

Parameters:

apiId - - API UUID

restAPIPublisher - - Instance of APIPublisherRestClient

Throws:

ApiException

org.json.JSONException

APIManagerIntegrationTestException

undeployAndDeleteAPIRevisionsUsingRest

protected String undeployAndDeleteAPIRevisionsUsingRest(String apiId,
                                                        RestAPIPublisherImpl restAPIPublisher)
                                                 throws ApiException,
                                                        org.json.JSONException,
                                                        XPathExpressionException,
                                                        APIManagerIntegrationTestException

Undeploy and Delete API Revisions using REST API.

Parameters:

apiId - - API UUID

restAPIPublisher - - Instance of APIPublisherRestClient

Throws:

ApiException

org.json.JSONException

XPathExpressionException

APIManagerIntegrationTestException

createAPIProductRevisionAndDeployUsingRest

protected String createAPIProductRevisionAndDeployUsingRest(String apiId,
                                                            RestAPIPublisherImpl restAPIPublisher)
                                                     throws ApiException,
                                                            org.json.JSONException,
                                                            APIManagerIntegrationTestException

Create API Product Revision and Deploy to gateway using REST API.

Parameters:

apiId - - API UUID

restAPIPublisher - - Instance of APIPublisherRestClient

Throws:

ApiException

org.json.JSONException

APIManagerIntegrationTestException

undeployAndDeleteAPIProductRevisionsUsingRest

protected String undeployAndDeleteAPIProductRevisionsUsingRest(String apiId,
                                                               RestAPIPublisherImpl restAPIPublisher)
                                                        throws ApiException,
                                                               org.json.JSONException,
                                                               XPathExpressionException,
                                                               APIManagerIntegrationTestException

Undeploy and Delete API Product Revisions using REST API.

Parameters:

apiId - - API UUID

restAPIPublisher - - Instance of APIPublisherRestClient

Throws:

ApiException

org.json.JSONException

XPathExpressionException

APIManagerIntegrationTestException

getAvailablePort

protected int getAvailablePort(int lowerPortLimit,
                               int upperPortLimit)

Find a free port to start backend WebSocket server in given port range

Parameters:

lowerPortLimit - from port number

upperPortLimit - to port number

Returns:

Available Port Number

waitUntilClockHour

protected static void waitUntilClockHour()
                                  throws InterruptedException

Throws:

InterruptedException

getWaitTime

protected static long getWaitTime()