co.cask.cdap.test

Class TestBase

java.lang.Object

co.cask.cdap.test.TestBase

public class TestBase
extends Object

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

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 <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.
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, File... bundleEmbeddedJars) Deploys an Application.
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 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.
static void	init()

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

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

init

public static void init()
                 throws Exception

Throws:

Exception

finish

public static final void finish()
                         throws co.cask.cdap.common.exception.NotFoundException,
                                NamespaceCannotBeDeletedException

Throws:

co.cask.cdap.common.exception.NotFoundException

NamespaceCannotBeDeletedException

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 Procedures 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,
                                   File... bundleEmbeddedJars)

Deploys an Application. The Flows and Procedures 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.

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 othe module

datasetModule - module class

Throws:

Exception

deployDatasetModule

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

Deploys DatasetModule.

Parameters:

moduleName - name othe 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