co.cask.cdap.test

Class TestBase

java.lang.Object

co.cask.cdap.test.TestBase

public class TestBase
extends Object

Base class to inherit from for unit-test. It provides testing functionality for Application. To clean App Fabric state, you can use the clear() method.

Custom configurations for CDAP can be set by using ClassRule and TestConfiguration.

See Also:

TestConfiguration

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
TestBase()

Method Summary

Methods

Modifier and Type	Method and Description
protected static void	addAppArtifact(co.cask.cdap.proto.Id.Artifact artifactId, Class<?> appClass) Build an application artifact from the specified class and then add it.
protected static void	addAppArtifact(co.cask.cdap.proto.Id.Artifact artifactId, Class<?> appClass, Manifest manifest) Build an application artifact from the specified class and then add it.
protected static void	addAppArtifact(co.cask.cdap.proto.Id.Artifact artifactId, Class<?> appClass, String... exportPackages) Build an application artifact from the specified class and then add it.
protected static void	addArtifact(co.cask.cdap.proto.Id.Artifact artifactId, File artifactFile) Add the specified artifact.
protected <T extends DatasetAdmin> T	addDatasetInstance(co.cask.cdap.proto.Id.Namespace namespace, String datasetTypeName, String datasetInstanceName) Adds an instance of dataset.
protected static <T extends DatasetAdmin> T	addDatasetInstance(co.cask.cdap.proto.Id.Namespace namespace, String datasetTypeName, String datasetInstanceName, DatasetProperties props) Adds an instance of a dataset.
protected <T extends DatasetAdmin> T	addDatasetInstance(String datasetTypeName, String datasetInstanceName) Adds an instance of dataset.
protected static <T extends DatasetAdmin> T	addDatasetInstance(String datasetTypeName, String datasetInstanceName, DatasetProperties props) Adds an instance of a dataset.
protected static void	addPluginArtifact(co.cask.cdap.proto.Id.Artifact artifactId, co.cask.cdap.proto.Id.Artifact parent, Class<?> pluginClass, Class<?>... pluginClasses) Build an artifact from the specified plugin classes and then add it.
protected static void	addPluginArtifact(co.cask.cdap.proto.Id.Artifact artifactId, co.cask.cdap.proto.Id.Artifact parent, Set<PluginClass> additionalPlugins, Class<?> pluginClass, Class<?>... pluginClasses) Build an artifact from the specified plugin classes and then add it.
protected static void	addPluginArtifact(co.cask.cdap.proto.Id.Artifact artifactId, Set<co.cask.cdap.proto.artifact.ArtifactRange> parentArtifacts, Class<?> pluginClass, Class<?>... pluginClasses) Build an artifact from the specified plugin classes and then add it.
void	afterTest() By default after each test finished, it will stop all apps started during the test.
void	beforeTest()
protected static void	clear() Clear the state of app fabric, by removing all deployed applications, Datasets and Streams.
protected static void	createNamespace(co.cask.cdap.proto.Id.Namespace namespace) Creates a Namespace.
protected static void	deleteNamespace(co.cask.cdap.proto.Id.Namespace namespace) Deletes a Namespace.
protected static ApplicationManager	deployApplication(Class<? extends Application> applicationClz, Config appConfig, File... bundleEmbeddedJars)
protected static ApplicationManager	deployApplication(Class<? extends Application> applicationClz, File... bundleEmbeddedJars) Deploys an Application.
protected static ApplicationManager	deployApplication(co.cask.cdap.proto.Id.Application appId, co.cask.cdap.proto.artifact.AppRequest appRequest) Deploys an Application.
protected static ApplicationManager	deployApplication(co.cask.cdap.proto.Id.Namespace namespace, Class<? extends Application> applicationClz, Config appConfig, File... bundleEmbeddedJars)
protected static ApplicationManager	deployApplication(co.cask.cdap.proto.Id.Namespace namespace, Class<? extends Application> applicationClz, File... bundleEmbeddedJars) Deploys an Application.
protected static void	deployDatasetModule(co.cask.cdap.proto.Id.Namespace namespace, String moduleName, Class<? extends DatasetModule> datasetModule) Deploys DatasetModule.
protected static void	deployDatasetModule(String moduleName, Class<? extends DatasetModule> datasetModule) Deploys DatasetModule.
static void	finish()
protected <T> DataSetManager<T>	getDataset(co.cask.cdap.proto.Id.Namespace namespace, String datasetInstanceName) Gets Dataset manager of Dataset instance of type
protected <T> DataSetManager<T>	getDataset(String datasetInstanceName) Gets Dataset manager of Dataset instance of type
protected MetricsManager	getMetricsManager()
protected Connection	getQueryClient() Returns a JDBC connection that allows to run SQL queries over data sets.
protected Connection	getQueryClient(co.cask.cdap.proto.Id.Namespace namespace) Returns a JDBC connection that allows to run SQL queries over data sets.
protected StreamManager	getStreamManager(co.cask.cdap.proto.Id.Namespace namespace, String streamName) Returns a StreamManager for the specified stream in the specified namespace
protected StreamManager	getStreamManager(String streamName) Returns a StreamManager for the specified stream in the default namespace
protected co.cask.tephra.TransactionManager	getTxService()
static void	initialize()

Methods inherited from class java.lang.Object

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

Field Detail

tmpFolder

public static org.junit.rules.TemporaryFolder tmpFolder

Constructor Detail

TestBase

public TestBase()

Method Detail

initialize

public static void initialize()
                       throws Exception

Throws:

Exception

beforeTest

public void beforeTest()
                throws Exception

Throws:

Exception

afterTest

public void afterTest()
               throws Exception

By default after each test finished, it will stop all apps started during the test. Sub-classes can override this method to provide different behavior.

Throws:

Exception

finish

public static void finish()
                   throws Exception

Throws:

Exception

getMetricsManager

protected MetricsManager getMetricsManager()

createNamespace

protected static void createNamespace(co.cask.cdap.proto.Id.Namespace namespace)
                               throws Exception

Creates a Namespace.

Parameters:

namespace - the namespace to create

Throws:

Exception

deleteNamespace

protected static void deleteNamespace(co.cask.cdap.proto.Id.Namespace namespace)
                               throws Exception

Deletes a Namespace.

Parameters:

namespace - the namespace to create

Throws:

Exception

deployApplication

protected static ApplicationManager deployApplication(co.cask.cdap.proto.Id.Namespace namespace,
                                   Class<? extends Application> applicationClz,
                                   File... bundleEmbeddedJars)

Deploys an Application. The Flows and other programs defined in the application must be in the same or children package as the application.

Parameters:

applicationClz - The application class

Returns:

An ApplicationManager to manage the deployed application.

deployApplication

protected static ApplicationManager deployApplication(co.cask.cdap.proto.Id.Namespace namespace,
                                   Class<? extends Application> applicationClz,
                                   Config appConfig,
                                   File... bundleEmbeddedJars)

deployApplication

protected static ApplicationManager deployApplication(Class<? extends Application> applicationClz,
                                   File... bundleEmbeddedJars)

Deploys an Application. The Flows and other programs defined in the application must be in the same or children package as the application.

Parameters:

applicationClz - The application class

Returns:

An ApplicationManager to manage the deployed application.

deployApplication

protected static ApplicationManager deployApplication(Class<? extends Application> applicationClz,
                                   Config appConfig,
                                   File... bundleEmbeddedJars)

deployApplication

protected static ApplicationManager deployApplication(co.cask.cdap.proto.Id.Application appId,
                                   co.cask.cdap.proto.artifact.AppRequest appRequest)
                                               throws Exception

Deploys an Application. The application artifact must already exist.

Parameters:

appId - the id of the application to create

appRequest - the application create or update request

Returns:

An ApplicationManager to manage the deployed application

Throws:

Exception

addArtifact

protected static void addArtifact(co.cask.cdap.proto.Id.Artifact artifactId,
               File artifactFile)
                           throws Exception

Add the specified artifact.

Parameters:

artifactId - the id of the artifact to add

artifactFile - the contents of the artifact. Must be a valid jar file containing apps or plugins

Throws:

Exception

addAppArtifact

protected static void addAppArtifact(co.cask.cdap.proto.Id.Artifact artifactId,
                  Class<?> appClass)
                              throws Exception

Build an application artifact from the specified class and then add it.

Parameters:

artifactId - the id of the artifact to add

appClass - the application class to build the artifact from

Throws:

Exception

addAppArtifact

protected static void addAppArtifact(co.cask.cdap.proto.Id.Artifact artifactId,
                  Class<?> appClass,
                  String... exportPackages)
                              throws Exception

Build an application artifact from the specified class and then add it.

Parameters:

artifactId - the id of the artifact to add

appClass - the application class to build the artifact from

exportPackages - the packages to export and place in the manifest of the jar to build. This should include packages that contain classes that plugins for the application will implement.

Throws:

Exception

addAppArtifact

protected static void addAppArtifact(co.cask.cdap.proto.Id.Artifact artifactId,
                  Class<?> appClass,
                  Manifest manifest)
                              throws Exception

Build an application artifact from the specified class and then add it.

Parameters:

artifactId - the id of the artifact to add

appClass - the application class to build the artifact from

manifest - the manifest to use when building the jar

Throws:

Exception

addPluginArtifact

protected static void addPluginArtifact(co.cask.cdap.proto.Id.Artifact artifactId,
                     co.cask.cdap.proto.Id.Artifact parent,
                     Class<?> pluginClass,
                     Class<?>... pluginClasses)
                                 throws Exception

Build an artifact from the specified plugin classes and then add it. The jar created will include all classes in the same package as the give classes, plus any dependencies of the given classes. If another plugin in the same package as the given plugin requires a different set of dependent classes, you must include both plugins. For example, suppose you have two plugins, com.company.myapp.functions.functionX and com.company.myapp.function.functionY, with functionX having one set of dependencies and functionY having another set of dependencies. If you only add functionX, functionY will also be included in the created jar since it is in the same package. However, only functionX's dependencies will be traced and added to the jar, so you will run into issues when the platform tries to register functionY. In this scenario, you must be certain to include specify both functionX and functionY when calling this method.

Parameters:

artifactId - the id of the artifact to add

parent - the parent artifact it extends

pluginClass - the plugin class to build the jar from

pluginClasses - any additional plugin classes that should be included in the jar

Throws:

Exception

addPluginArtifact

protected static void addPluginArtifact(co.cask.cdap.proto.Id.Artifact artifactId,
                     co.cask.cdap.proto.Id.Artifact parent,
                     Set<PluginClass> additionalPlugins,
                     Class<?> pluginClass,
                     Class<?>... pluginClasses)
                                 throws Exception

Build an artifact from the specified plugin classes and then add it. The jar created will include all classes in the same package as the give classes, plus any dependencies of the given classes. If another plugin in the same package as the given plugin requires a different set of dependent classes, you must include both plugins. For example, suppose you have two plugins, com.company.myapp.functions.functionX and com.company.myapp.function.functionY, with functionX having one set of dependencies and functionY having another set of dependencies. If you only add functionX, functionY will also be included in the created jar since it is in the same package. However, only functionX's dependencies will be traced and added to the jar, so you will run into issues when the platform tries to register functionY. In this scenario, you must be certain to include specify both functionX and functionY when calling this method.

Parameters:

artifactId - the id of the artifact to add

parent - the parent artifact it extends

additionalPlugins - any plugin classes that need to be explicitly declared because they cannot be found by inspecting the jar. This is true for 3rd party plugins, such as jdbc drivers

pluginClass - the plugin class to build the jar from

pluginClasses - any additional plugin classes that should be included in the jar

Throws:

Exception

addPluginArtifact

protected static void addPluginArtifact(co.cask.cdap.proto.Id.Artifact artifactId,
                     Set<co.cask.cdap.proto.artifact.ArtifactRange> parentArtifacts,
                     Class<?> pluginClass,
                     Class<?>... pluginClasses)
                                 throws Exception

Build an artifact from the specified plugin classes and then add it. The jar created will include all classes in the same package as the give classes, plus any dependencies of the given classes. If another plugin in the same package as the given plugin requires a different set of dependent classes, you must include both plugins. For example, suppose you have two plugins, com.company.myapp.functions.functionX and com.company.myapp.function.functionY, with functionX having one set of dependencies and functionY having another set of dependencies. If you only add functionX, functionY will also be included in the created jar since it is in the same package. However, only functionX's dependencies will be traced and added to the jar, so you will run into issues when the platform tries to register functionY. In this scenario, you must be certain to include specify both functionX and functionY when calling this method.

Parameters:

artifactId - the id of the artifact to add

parentArtifacts - the parent artifacts it extends

pluginClass - the plugin class to build the jar from

pluginClasses - any additional plugin classes that should be included in the jar

Throws:

Exception

clear

protected static void clear()

Clear the state of app fabric, by removing all deployed applications, Datasets and Streams. This method could be called between two unit tests, to make them independent.

deployDatasetModule

protected static void deployDatasetModule(co.cask.cdap.proto.Id.Namespace namespace,
                       String moduleName,
                       Class<? extends DatasetModule> datasetModule)
                                   throws Exception

Deploys DatasetModule.

Parameters:

moduleName - name of the module

datasetModule - module class

Throws:

Exception

deployDatasetModule

protected static void deployDatasetModule(String moduleName,
                       Class<? extends DatasetModule> datasetModule)
                                   throws Exception

Deploys DatasetModule.

Parameters:

moduleName - name of the module

datasetModule - module class

Throws:

Exception

addDatasetInstance

protected static <T extends DatasetAdmin> T addDatasetInstance(co.cask.cdap.proto.Id.Namespace namespace,
                                            String datasetTypeName,
                                            String datasetInstanceName,
                                            DatasetProperties props)
                                                    throws Exception

Adds an instance of a dataset.

Type Parameters:

T - type of the dataset admin

Parameters:

datasetTypeName - dataset type name

datasetInstanceName - instance name

props - properties

Throws:

Exception

addDatasetInstance

protected static <T extends DatasetAdmin> T addDatasetInstance(String datasetTypeName,
                                            String datasetInstanceName,
                                            DatasetProperties props)
                                                    throws Exception

Adds an instance of a dataset.

Type Parameters:

T - type of the dataset admin

Parameters:

datasetTypeName - dataset type name

datasetInstanceName - instance name

props - properties

Throws:

Exception

addDatasetInstance

protected final <T extends DatasetAdmin> T addDatasetInstance(co.cask.cdap.proto.Id.Namespace namespace,
                                            String datasetTypeName,
                                            String datasetInstanceName)
                                                   throws Exception

Adds an instance of dataset.

Type Parameters:

T - type of the dataset admin

Parameters:

datasetTypeName - dataset type name

datasetInstanceName - instance name

Throws:

Exception

addDatasetInstance

protected final <T extends DatasetAdmin> T addDatasetInstance(String datasetTypeName,
                                            String datasetInstanceName)
                                                   throws Exception

Adds an instance of dataset.

Type Parameters:

T - type of the dataset admin

Parameters:

datasetTypeName - dataset type name

datasetInstanceName - instance name

Throws:

Exception

getDataset

protected final <T> DataSetManager<T> getDataset(co.cask.cdap.proto.Id.Namespace namespace,
                               String datasetInstanceName)
                                      throws Exception

Gets Dataset manager of Dataset instance of type

Parameters:

datasetInstanceName - - instance name of dataset

Returns:

Dataset Manager of Dataset instance of type

Throws:

Exception

getDataset

protected final <T> DataSetManager<T> getDataset(String datasetInstanceName)
                                      throws Exception

Gets Dataset manager of Dataset instance of type

Parameters:

datasetInstanceName - - instance name of dataset

Returns:

Dataset Manager of Dataset instance of type

Throws:

Exception

getQueryClient

protected final Connection getQueryClient(co.cask.cdap.proto.Id.Namespace namespace)
                                   throws Exception

Returns a JDBC connection that allows to run SQL queries over data sets.

Throws:

Exception

getQueryClient

protected final Connection getQueryClient()
                                   throws Exception

Returns a JDBC connection that allows to run SQL queries over data sets.

Throws:

Exception

getStreamManager

protected final StreamManager getStreamManager(String streamName)

Returns a StreamManager for the specified stream in the default namespace

Parameters:

streamName - the specified stream

Returns:

StreamManager for the specified stream in the default namespace

getStreamManager

protected final StreamManager getStreamManager(co.cask.cdap.proto.Id.Namespace namespace,
                             String streamName)

Returns a StreamManager for the specified stream in the specified namespace

Parameters:

streamName - the specified stream

Returns:

StreamManager for the specified stream in the specified namespace

getTxService

protected co.cask.tephra.TransactionManager getTxService()