co.cask.cdap.test

Class ConfigurableTestBase

java.lang.Object

co.cask.cdap.test.ConfigurableTestBase

Direct Known Subclasses:

TestBase

Deprecated.

Unit-test classes should inherit from TestBase.

@Deprecated
public class ConfigurableTestBase
extends Object

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

See Also:

TestBase

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
ConfigurableTestBase() Deprecated.

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) Deprecated. 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) Deprecated. Adds an instance of a dataset.
protected <T extends DatasetAdmin> T	addDatasetInstance(String datasetTypeName, String datasetInstanceName) Deprecated. Adds an instance of dataset.
protected static <T extends DatasetAdmin> T	addDatasetInstance(String datasetTypeName, String datasetInstanceName, DatasetProperties props) Deprecated. Adds an instance of a dataset.
protected static void	addTemplatePluginJson(co.cask.cdap.proto.Id.ApplicationTemplate templateId, String fileName, String type, String name, String description, String className, PluginPropertyField... fields) Deprecated. Add a template plugin configuration file.
protected static void	addTemplatePlugins(co.cask.cdap.proto.Id.ApplicationTemplate templateId, String jarName, Class<?> pluginClz, Class<?>... classes) Deprecated. Adds a plugins jar usable by the given template.
void	afterTest() Deprecated. By default after each test finished, it will stop all apps started during the test.
void	beforeTest() Deprecated.
protected static void	clear() Deprecated. Clear the state of app fabric, by removing all deployed applications, Datasets and Streams.
protected static AdapterManager	createAdapter(co.cask.cdap.proto.Id.Adapter adapterId, co.cask.cdap.proto.AdapterConfig adapterConfig) Deprecated. Creates an adapter.
protected static void	createNamespace(co.cask.cdap.proto.Id.Namespace namespace) Deprecated. Creates a Namespace.
protected static void	deleteNamespace(co.cask.cdap.proto.Id.Namespace namespace) Deprecated. Deletes a Namespace.
protected static ApplicationManager	deployApplication(Class<? extends Application> applicationClz, Config appConfig, File... bundleEmbeddedJars) Deprecated.
protected static ApplicationManager	deployApplication(Class<? extends Application> applicationClz, File... bundleEmbeddedJars) Deprecated. Deploys an Application.
protected static ApplicationManager	deployApplication(co.cask.cdap.proto.Id.Namespace namespace, Class<? extends Application> applicationClz, Config appConfig, File... bundleEmbeddedJars) Deprecated.
protected static ApplicationManager	deployApplication(co.cask.cdap.proto.Id.Namespace namespace, Class<? extends Application> applicationClz, File... bundleEmbeddedJars) Deprecated. Deploys an Application.
protected static void	deployDatasetModule(co.cask.cdap.proto.Id.Namespace namespace, String moduleName, Class<? extends DatasetModule> datasetModule) Deprecated. Deploys DatasetModule.
protected static void	deployDatasetModule(String moduleName, Class<? extends DatasetModule> datasetModule) Deprecated. Deploys DatasetModule.
protected static void	deployTemplate(co.cask.cdap.proto.Id.Namespace namespace, co.cask.cdap.proto.Id.ApplicationTemplate templateId, Class<? extends ApplicationTemplate> templateClz, String... exportPackages) Deprecated. Deploys an ApplicationTemplate.
static void	finish() Deprecated.
protected <T> DataSetManager<T>	getDataset(co.cask.cdap.proto.Id.Namespace namespace, String datasetInstanceName) Deprecated. Gets Dataset manager of Dataset instance of type
protected <T> DataSetManager<T>	getDataset(String datasetInstanceName) Deprecated. Gets Dataset manager of Dataset instance of type
protected Connection	getQueryClient() Deprecated. Returns a JDBC connection that allows to run SQL queries over data sets.
protected Connection	getQueryClient(co.cask.cdap.proto.Id.Namespace namespace) Deprecated. 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) Deprecated. Returns a StreamManager for the specified stream in the specified namespace
protected StreamManager	getStreamManager(String streamName) Deprecated. Returns a StreamManager for the specified stream in the default namespace
protected co.cask.tephra.TransactionManager	getTxService() Deprecated.
protected static void	initTestBase(Map<String,String> additionalConfiguration) Deprecated. Use TestConfiguration instead.

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

Deprecated.

Constructor Detail

ConfigurableTestBase

public ConfigurableTestBase()

Deprecated.

Method Detail

beforeTest

public void beforeTest()
                throws Exception

Deprecated.

Throws:

Exception

afterTest

public void afterTest()
               throws Exception

Deprecated.

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

initTestBase

@Deprecated
protected static void initTestBase(@Nullable
                           Map<String,String> additionalConfiguration)
                            throws Exception

Deprecated. Use TestConfiguration instead.

This should be called by the subclasses to initialize the test base.

Throws:

Exception

finish

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

Deprecated.

Throws:

co.cask.cdap.common.NotFoundException

co.cask.cdap.common.NamespaceCannotBeDeletedException

createNamespace

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

Deprecated.

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

Deprecated.

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)

Deprecated.

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)

Deprecated.

deployApplication

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

Deprecated.

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)

Deprecated.

createAdapter

protected static AdapterManager createAdapter(co.cask.cdap.proto.Id.Adapter adapterId,
                           co.cask.cdap.proto.AdapterConfig adapterConfig)
                                       throws Exception

Deprecated.

Creates an adapter.

Parameters:

adapterId - The id of the adapter to create

adapterConfig - The configuration for the adapter

Returns:

An AdapterManager to manage the deployed adapter.

Throws:

Exception - if there was an exception deploying the adapter.

deployTemplate

protected static void deployTemplate(co.cask.cdap.proto.Id.Namespace namespace,
                  co.cask.cdap.proto.Id.ApplicationTemplate templateId,
                  Class<? extends ApplicationTemplate> templateClz,
                  String... exportPackages)
                              throws IOException

Deprecated.

Deploys an ApplicationTemplate.

Parameters:

namespace - The namespace to deploy to

templateId - The id of the template. Must match the name set in Application.configure(ApplicationConfigurer, ApplicationContext)

templateClz - The template class

exportPackages - The list of packages that should be visible to template plugins. For example, if your plugins implement an interface com.company.api.myinterface that is in your template, you will want to include 'com.company.api' in the list of export pacakges.

Throws:

IOException

addTemplatePlugins

protected static void addTemplatePlugins(co.cask.cdap.proto.Id.ApplicationTemplate templateId,
                      String jarName,
                      Class<?> pluginClz,
                      Class<?>... classes)
                                  throws IOException

Deprecated.

Adds a plugins jar usable by the given template. Only supported in unit tests. Plugins added will not be visible until a call to deployTemplate(Id.Namespace, Id.ApplicationTemplate, Class, String...) is made. The jar created will include all classes in the same package as the given plugin class, plus any dependencies of the that class and given additional 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 functionY in the list of classes when specifying functionX as the plugin class.

Parameters:

templateId - The id of the template to add the plugin for

jarName - The name to use for the plugin jar

pluginClz - A plugin class to add to the jar. Any other class that shares the same package will be included in the jar.

classes - Additional plugin classes whose dependencies should be added to the jar.

Throws:

IOException

addTemplatePluginJson

protected static void addTemplatePluginJson(co.cask.cdap.proto.Id.ApplicationTemplate templateId,
                         String fileName,
                         String type,
                         String name,
                         String description,
                         String className,
                         PluginPropertyField... fields)
                                     throws IOException

Deprecated.

Add a template plugin configuration file.

Parameters:

templateId - the id of the template to add the plugin config for

fileName - the name of the config file. The name should match the plugin jar file that it is for. For example, if you added a plugin named hsql-jdbc-1.0.0.jar, the config file must be named hsql-jdbc-1.0.0.json

type - the type of plugin

name - the name of the plugin

description - the description for the plugin

className - the class name of the plugin

fields - the fields the plugin uses

Throws:

IOException

clear

protected static void clear()

Deprecated.

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

Deprecated.

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

Deprecated.

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

Deprecated.

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

Deprecated.

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

Deprecated.

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

Deprecated.

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

Deprecated.

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

Deprecated.

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

Deprecated.

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

Throws:

Exception

getQueryClient

protected final Connection getQueryClient()
                                   throws Exception

Deprecated.

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

Throws:

Exception

getStreamManager

protected final StreamManager getStreamManager(String streamName)

Deprecated.

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)

Deprecated.

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()

Deprecated.