co.cask.cdap.test

Class IntegrationTestBase

java.lang.Object

co.cask.cdap.test.IntegrationTestBase

public abstract class IntegrationTestBase
extends Object

Abstract class for writing Integration tests for CDAP. Provides utility methods to use in Integration tests. Users should extend this class in their test classes.

Field Summary

Fields

Modifier and Type	Field and Description
static org.junit.rules.TemporaryFolder	TEMP_FOLDER

Constructor Summary

Constructors

Constructor and Description
IntegrationTestBase()

Method Summary

Methods

Modifier and Type	Method and Description
protected ArtifactManager	addAppArtifact(ArtifactId artifactId, Class<?> appClass)
protected void	checkSystemServices()
protected Id.Namespace	createNamespace(String name) Deprecated.
protected ApplicationManager	deployApplication(ApplicationId appId, AppRequest appRequest)
protected ApplicationManager	deployApplication(Class<? extends Application> applicationClz)
protected ApplicationManager	deployApplication(Id.Namespace namespace, Class<? extends Application> applicationClz, File... bundleEmbeddedJars) Deprecated.
protected ApplicationManager	deployApplication(NamespaceId namespace, Class<? extends Application> applicationClz, File... bundleEmbeddedJars)
protected co.cask.cdap.security.authentication.client.AccessToken	fetchAccessToken() Uses BasicAuthenticationClient to fetch AccessToken - this implementation can be overridden if desired.
protected co.cask.cdap.security.authentication.client.AccessToken	fetchAccessToken(String username, String password)
protected co.cask.cdap.security.authentication.client.AccessToken	getAccessToken() CDAP access token for making requests to secure CDAP instances.
protected ApplicationClient	getApplicationClient()
protected ApplicationManager	getApplicationManager(ApplicationId applicationId)
protected ClientConfig	getClientConfig()
protected ClientConfig	getClientConfig(co.cask.cdap.security.authentication.client.AccessToken accessToken)
protected static NamespaceId	getConfiguredNamespace()
protected DatasetClient	getDatasetClient()
protected String	getInstanceURI() Reads the CDAP instance URI from the system property "instanceUri".
protected MetaClient	getMetaClient()
protected MetricsClient	getMetricsClient()
protected MonitorClient	getMonitorClient()
protected NamespaceClient	getNamespaceClient()
protected ProgramClient	getProgramClient()
protected RESTClient	getRestClient()
protected StreamClient	getStreamClient()
protected TestManager	getTestManager()
protected TestManager	getTestManager(ClientConfig clientConfig, RESTClient restClient)
protected void	registerForDeletion(NamespaceId firstNamespace, NamespaceId... additionalNamespaces) Call this method to register namespaces for deletion at the end of the test case.
void	setUp()
void	tearDown()

Methods inherited from class java.lang.Object

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

Field Detail

TEMP_FOLDER

public static final org.junit.rules.TemporaryFolder TEMP_FOLDER

Constructor Detail

IntegrationTestBase

public IntegrationTestBase()

Method Detail

setUp

public void setUp()
           throws Exception

Throws:

Exception

tearDown

public void tearDown()
              throws Exception

Throws:

Exception

registerForDeletion

protected void registerForDeletion(NamespaceId firstNamespace,
                       NamespaceId... additionalNamespaces)

Call this method to register namespaces for deletion at the end of the test case.

getConfiguredNamespace

protected static NamespaceId getConfiguredNamespace()

Returns:

the namespace that has been configured as default, for test cases.

checkSystemServices

protected void checkSystemServices()
                            throws TimeoutException,
                                   InterruptedException

Throws:

TimeoutException

InterruptedException

fetchAccessToken

protected co.cask.cdap.security.authentication.client.AccessToken fetchAccessToken()
                                                                            throws IOException,
                                                                                   TimeoutException,
                                                                                   InterruptedException

Uses BasicAuthenticationClient to fetch AccessToken - this implementation can be overridden if desired.

Returns:

AccessToken

Throws:

IOException

TimeoutException - if a timeout occurs while getting an access token

InterruptedException

fetchAccessToken

protected co.cask.cdap.security.authentication.client.AccessToken fetchAccessToken(String username,
                                                                       String password)
                                                                            throws IOException,
                                                                                   TimeoutException,
                                                                                   InterruptedException

Throws:

IOException

TimeoutException

InterruptedException

getTestManager

protected TestManager getTestManager()

getTestManager

protected TestManager getTestManager(ClientConfig clientConfig,
                         RESTClient restClient)

getInstanceURI

protected String getInstanceURI()

Reads the CDAP instance URI from the system property "instanceUri". "instanceUri" should be specified in the format [host]:[port]. Defaults to "localhost:11015".

getAccessToken

@Nullable
protected co.cask.cdap.security.authentication.client.AccessToken getAccessToken()

CDAP access token for making requests to secure CDAP instances.

getClientConfig

protected ClientConfig getClientConfig()

getClientConfig

protected ClientConfig getClientConfig(@Nullable
                           co.cask.cdap.security.authentication.client.AccessToken accessToken)

getRestClient

protected RESTClient getRestClient()

getMetaClient

protected MetaClient getMetaClient()

getNamespaceClient

protected NamespaceClient getNamespaceClient()

getMetricsClient

protected MetricsClient getMetricsClient()

getMonitorClient

protected MonitorClient getMonitorClient()

getApplicationClient

protected ApplicationClient getApplicationClient()

getProgramClient

protected ProgramClient getProgramClient()

getStreamClient

protected StreamClient getStreamClient()

getDatasetClient

protected DatasetClient getDatasetClient()

createNamespace

@Deprecated
protected Id.Namespace createNamespace(String name)
                                throws Exception

Deprecated.

Throws:

Exception

deployApplication

@Deprecated
protected ApplicationManager deployApplication(Id.Namespace namespace,
                                              Class<? extends Application> applicationClz,
                                              File... bundleEmbeddedJars)
                                        throws IOException

Deprecated.

Throws:

IOException

deployApplication

protected ApplicationManager deployApplication(NamespaceId namespace,
                                   Class<? extends Application> applicationClz,
                                   File... bundleEmbeddedJars)
                                        throws IOException

Throws:

IOException

deployApplication

protected ApplicationManager deployApplication(Class<? extends Application> applicationClz)
                                        throws IOException

Throws:

IOException

deployApplication

protected ApplicationManager deployApplication(ApplicationId appId,
                                   AppRequest appRequest)
                                        throws Exception

Throws:

Exception

addAppArtifact

protected ArtifactManager addAppArtifact(ArtifactId artifactId,
                             Class<?> appClass)
                                  throws Exception

Throws:

Exception

getApplicationManager

protected ApplicationManager getApplicationManager(ApplicationId applicationId)
                                            throws Exception

Throws:

Exception