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	TMP_FOLDER
static org.junit.rules.TemporaryFolder	tmpFolder Deprecated.

Constructor Summary

Constructors

Constructor and Description
TestBase()

Method Summary

Modifier and Type	Method and Description
protected static ArtifactManager	addAppArtifact(co.cask.cdap.proto.id.ArtifactId artifactId, Class<?> appClass) Build an application artifact from the specified class and then add it.
protected static ArtifactManager	addAppArtifact(co.cask.cdap.proto.id.ArtifactId artifactId, Class<?> appClass, Manifest manifest) Build an application artifact from the specified class and then add it.
protected static ArtifactManager	addAppArtifact(co.cask.cdap.proto.id.ArtifactId artifactId, Class<?> appClass, String... exportPackages) 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) Deprecated. since 3.4.0. Use addArtifact(ArtifactId, File).
protected static void	addAppArtifact(co.cask.cdap.proto.Id.Artifact artifactId, Class<?> appClass, Manifest manifest) Deprecated. since 3.4.0. Use addAppArtifact(ArtifactId, Class, Manifest)
protected static void	addAppArtifact(co.cask.cdap.proto.Id.Artifact artifactId, Class<?> appClass, String... exportPackages) Deprecated. since 3.4.0. Use addAppArtifact(ArtifactId, Class, String...)
protected static ArtifactManager	addArtifact(co.cask.cdap.proto.id.ArtifactId artifactId, File artifactFile) Add the specified artifact.
protected static void	addArtifact(co.cask.cdap.proto.Id.Artifact artifactId, File artifactFile) Deprecated. since 3.4.0. Use addArtifact(ArtifactId, File)
protected <T extends DatasetAdmin> T	addDatasetInstance(co.cask.cdap.proto.id.DatasetId datasetId, String datasetTypeName) Adds an instance of dataset.
protected <T extends DatasetAdmin> T	addDatasetInstance(co.cask.cdap.proto.Id.Namespace namespace, String datasetTypeName, String datasetInstanceName) Deprecated. since 4.0.0. Use addDatasetInstance(DatasetId, String) instead.
protected static <T extends DatasetAdmin> T	addDatasetInstance(co.cask.cdap.proto.Id.Namespace namespace, String datasetTypeName, String datasetInstanceName, DatasetProperties props) Deprecated. since 4.0.0. Use addDatasetInstance(String, DatasetId, DatasetProperties) instead.
protected static <T extends DatasetAdmin> T	addDatasetInstance(String datasetTypeName, co.cask.cdap.proto.id.DatasetId datasetId, 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 ArtifactManager	addPluginArtifact(co.cask.cdap.proto.id.ArtifactId artifactId, co.cask.cdap.proto.id.ArtifactId parent, Class<?> pluginClass, Class<?>... pluginClasses) Build an artifact from the specified plugin classes and then add it.
protected static ArtifactManager	addPluginArtifact(co.cask.cdap.proto.id.ArtifactId artifactId, co.cask.cdap.proto.id.ArtifactId parent, Set<PluginClass> additionalPlugins, Class<?> pluginClass, Class<?>... pluginClasses) Build an artifact from the specified plugin classes and then add it.
protected static ArtifactManager	addPluginArtifact(co.cask.cdap.proto.id.ArtifactId artifactId, Set<ArtifactRange> parentArtifacts, 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, Class<?> pluginClass, Class<?>... pluginClasses) Deprecated. since 3.4.0. Use addPluginArtifact(ArtifactId, ArtifactId, Class, Class[])
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) Deprecated. since 3.4.0. Use addPluginArtifact(ArtifactId, ArtifactId, Set, Class, Class[])
protected static void	addPluginArtifact(co.cask.cdap.proto.Id.Artifact artifactId, Set<ArtifactRange> parentArtifacts, Class<?> pluginClass, Class<?>... pluginClasses) Deprecated. since 3.4.0. Use addPluginArtifact(ArtifactId, Set, Class, Class[])
protected void	addSchedule(co.cask.cdap.proto.id.ScheduleId scheduleId, co.cask.cdap.proto.ScheduleDetail scheduleDetail) Add a new schedule to an existing application
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) Deprecated. since 3.4.0. Use getNamespaceAdmin() to perform namespace operations instead.
protected static void	deleteAllApplications(co.cask.cdap.proto.id.NamespaceId namespaceId) Deletes all applications in the specified namespace.
protected void	deleteDatasetInstance(co.cask.cdap.proto.id.DatasetId datasetId) Deletes an instance of dataset.
protected void	deleteDatasetInstance(co.cask.cdap.proto.id.NamespaceId namespaceId, String datasetInstanceName) Deprecated. since 4.0.0. Use deleteDatasetInstance(DatasetId) instead.
protected static void	deleteNamespace(co.cask.cdap.proto.Id.Namespace namespace) Deprecated. since 3.4.0. Use getNamespaceAdmin() to perform namespace operations instead.
protected void	deleteSchedule(co.cask.cdap.proto.id.ScheduleId scheduleId) Delete an existing schedule.
protected static ApplicationManager	deployApplication(co.cask.cdap.proto.id.ApplicationId appId, co.cask.cdap.proto.artifact.AppRequest appRequest) Deploys an Application with version.
protected static ApplicationManager	deployApplication(Class<? extends Application> applicationClz, Config appConfig, File... bundleEmbeddedJars) Deploys an Application.
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) Deprecated. since 4.0.0. Use deployApplication(NamespaceId, Class, Config, File...) instead.
protected static ApplicationManager	deployApplication(co.cask.cdap.proto.Id.Namespace namespace, Class<? extends Application> applicationClz, File... bundleEmbeddedJars) Deprecated. since 4.0.0. Use deployApplication(NamespaceId, Class, File...) instead.
protected static ApplicationManager	deployApplication(co.cask.cdap.proto.id.NamespaceId namespace, Class<? extends Application> applicationClz, Config appConfig, File... bundleEmbeddedJars) Deploys an Application with a config.
protected static ApplicationManager	deployApplication(co.cask.cdap.proto.id.NamespaceId namespace, Class<? extends Application> applicationClz, File... bundleEmbeddedJars) Deploys an Application.
protected static void	deployDatasetModule(co.cask.cdap.proto.id.DatasetModuleId datasetModuleId, Class<? extends DatasetModule> datasetModule) Deploys DatasetModule.
protected static void	deployDatasetModule(co.cask.cdap.proto.Id.Namespace namespace, String moduleName, Class<? extends DatasetModule> datasetModule) Deprecated. since 4.0.0. Use deployDatasetModule(DatasetModuleId, Class) instead.
protected static void	deployDatasetModule(String moduleName, Class<? extends DatasetModule> datasetModule) Deploys DatasetModule.
static void	finish()
protected co.cask.cdap.proto.ApplicationDetail	getAppDetail(co.cask.cdap.proto.id.ApplicationId applicationId) Gets the app detail of an application
protected static co.cask.cdap.security.spi.authorization.Authorizer	getAuthorizer() Returns an Authorizer for performing authorization operations.
protected static co.cask.cdap.common.conf.CConfiguration	getConfiguration() Returns the CConfiguration used in tests.
protected <T> DataSetManager<T>	getDataset(co.cask.cdap.proto.id.DatasetId datasetId) Gets Dataset manager of Dataset instance of type <T>.
protected <T> DataSetManager<T>	getDataset(co.cask.cdap.proto.Id.Namespace namespace, String datasetInstanceName) Deprecated. since 4.0.0. Use getDataset(DatasetId) instead.
protected <T> DataSetManager<T>	getDataset(String datasetInstanceName) Gets Dataset manager of Dataset instance of type <T>.
protected static MessagingAdmin	getMessagingAdmin(co.cask.cdap.proto.id.NamespaceId namespace)
protected static MessagingAdmin	getMessagingAdmin(String namespace) Returns a MessagingAdmin for the given namespace.
protected MessagingContext	getMessagingContext() Returns a MessagingContext for interacting with the messaging system.
protected MetricsManager	getMetricsManager()
protected static co.cask.cdap.common.namespace.NamespaceAdmin	getNamespaceAdmin() Returns a NamespaceAdmin to interact with namespaces.
protected static PreviewManager	getPreviewManager() Returns a PreviewManager to interact with preview.
protected Connection	getQueryClient() Returns a JDBC connection that allows the running of SQL queries over data sets.
protected Connection	getQueryClient(co.cask.cdap.proto.Id.Namespace namespace) Deprecated. since 4.0.0. Use getQueryClient(NamespaceId) instead.
protected Connection	getQueryClient(co.cask.cdap.proto.id.NamespaceId namespace) Returns a JDBC connection that allows the running of SQL queries over data sets.
protected static SecureStore	getSecureStore() Returns a SecureStore to interact with secure storage.
protected static SecureStoreManager	getSecureStoreManager() Returns a SecureStoreManager to interact with secure storage.
protected StreamManager	getStreamManager(co.cask.cdap.proto.Id.Namespace namespace, String streamName) Deprecated. since 4.0.0. Use getStreamManager(StreamId) instead.
protected StreamManager	getStreamManager(co.cask.cdap.proto.id.StreamId streamId) 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 org.apache.tephra.TransactionManager	getTxService()
static void	initialize()
protected void	updateSchedule(co.cask.cdap.proto.id.ScheduleId scheduleId, co.cask.cdap.proto.ScheduleDetail scheduleDetail) Update an existing schedule.

Methods inherited from class java.lang.Object

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

Field Detail

TMP_FOLDER

public static final org.junit.rules.TemporaryFolder TMP_FOLDER

tmpFolder

@Deprecated
public static org.junit.rules.TemporaryFolder tmpFolder

Deprecated.

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

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

Deprecated. since 3.4.0. Use getNamespaceAdmin() to perform namespace operations instead.

Creates a Namespace.

Parameters:

namespace - the namespace to create

Throws:

Exception

deleteNamespace

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

Deprecated. since 3.4.0. Use getNamespaceAdmin() to perform namespace operations instead.

Deletes a Namespace.

Parameters:

namespace - the namespace to delete

Throws:

Exception

deployApplication

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

Deprecated. since 4.0.0. Use deployApplication(NamespaceId, Class, File...) instead.

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

Parameters:

namespace - the namespace to deploy the application to

applicationClz - the application class

bundleEmbeddedJars - any extra jars to bundle in the application jar

Returns:

An ApplicationManager to manage the deployed application.

deployApplication

protected static ApplicationManager deployApplication(co.cask.cdap.proto.id.NamespaceId 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:

namespace - the namespace to deploy the application to

applicationClz - the application class

bundleEmbeddedJars - any extra jars to bundle in the application jar

Returns:

An ApplicationManager to manage the deployed application.

deployApplication

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

Deprecated. since 4.0.0. Use deployApplication(NamespaceId, Class, Config, File...) instead.

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

Parameters:

namespace - the namespace to deploy the application to

applicationClz - the application class

appConfig - the application config

bundleEmbeddedJars - any extra jars to bundle in the application jar

Returns:

An ApplicationManager to manage the deployed application.

deployApplication

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

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

Parameters:

namespace - the namespace to deploy the application to

applicationClz - the application class

appConfig - the application configApp

bundleEmbeddedJars - any extra jars to bundle in the application jar

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 other programs defined in the application must be in the same or children package as the application.

Parameters:

applicationClz - the application class

bundleEmbeddedJars - any extra jars to bundle in the application jar

Returns:

An ApplicationManager to manage the deployed application.

deployApplication

protected static ApplicationManager deployApplication(Class<? extends Application> applicationClz,
                                                      Config appConfig,
                                                      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

appConfig - the application config

bundleEmbeddedJars - any extra jars to bundle in the application jar

Returns:

An ApplicationManager to manage the deployed application.

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

deployApplication

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

Deploys an Application with version. 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

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

Deprecated. since 3.4.0. Use addArtifact(ArtifactId, File)

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

addArtifact

protected static ArtifactManager addArtifact(co.cask.cdap.proto.id.ArtifactId 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

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

Deprecated. since 3.4.0. Use addArtifact(ArtifactId, File).

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 ArtifactManager addAppArtifact(co.cask.cdap.proto.id.ArtifactId 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

Returns:

an ArtifactManager to manage the added artifact

Throws:

Exception

addAppArtifact

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

Deprecated. since 3.4.0. Use addAppArtifact(ArtifactId, Class, String...)

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 ArtifactManager addAppArtifact(co.cask.cdap.proto.id.ArtifactId 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.

Returns:

an ArtifactManager to manage the added artifact

Throws:

Exception

addAppArtifact

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

Deprecated. since 3.4.0. Use addAppArtifact(ArtifactId, Class, Manifest)

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

addAppArtifact

protected static ArtifactManager addAppArtifact(co.cask.cdap.proto.id.ArtifactId 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

Returns:

an ArtifactManager to manage the added artifact

Throws:

Exception

addPluginArtifact

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

Deprecated. since 3.4.0. Use addPluginArtifact(ArtifactId, ArtifactId, Class, Class[])

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 ArtifactManager addPluginArtifact(co.cask.cdap.proto.id.ArtifactId artifactId,
                                                   co.cask.cdap.proto.id.ArtifactId 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

Returns:

ArtifactManager to manage the added plugin artifact

Throws:

Exception

addPluginArtifact

@Deprecated
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

Deprecated. since 3.4.0. Use addPluginArtifact(ArtifactId, ArtifactId, Set, Class, Class[])

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 ArtifactManager addPluginArtifact(co.cask.cdap.proto.id.ArtifactId artifactId,
                                                   co.cask.cdap.proto.id.ArtifactId 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

Returns:

an ArtifactManager to manage the added plugin artifact

Throws:

Exception

addPluginArtifact

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

Deprecated. since 3.4.0. Use addPluginArtifact(ArtifactId, Set, Class, Class[])

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

addPluginArtifact

protected static ArtifactManager addPluginArtifact(co.cask.cdap.proto.id.ArtifactId artifactId,
                                                   Set<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

Returns:

an ArtifactManager to manage the added plugin artifact

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

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

Deprecated. since 4.0.0. Use deployDatasetModule(DatasetModuleId, Class) instead.

Deploys DatasetModule.

Parameters:

namespace - namespace to deploy to

moduleName - name of the module

datasetModule - module class

Throws:

Exception

deployDatasetModule

protected static void deployDatasetModule(co.cask.cdap.proto.id.DatasetModuleId datasetModuleId,
                                          Class<? extends DatasetModule> datasetModule)
                                   throws Exception

Deploys DatasetModule.

Parameters:

datasetModuleId - the module id

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

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

Deprecated. since 4.0.0. Use addDatasetInstance(String, DatasetId, DatasetProperties) instead.

Adds an instance of a dataset.

Type Parameters:

T - type of the dataset admin

Parameters:

namespace - namespace for the dataset

datasetTypeName - dataset type name

datasetInstanceName - instance name

props - properties

Returns:

a DatasetAdmin to manage the dataset instance

Throws:

Exception

addDatasetInstance

protected static <T extends DatasetAdmin> T addDatasetInstance(String datasetTypeName,
                                                               co.cask.cdap.proto.id.DatasetId datasetId,
                                                               DatasetProperties props)
                                                        throws Exception

Adds an instance of a dataset.

Type Parameters:

T - type of the dataset admin

Parameters:

datasetId - the dataset id

datasetTypeName - dataset type name, like "table" or "fileset"

props - properties

Returns:

a DatasetAdmin to manage the dataset instance

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

Returns:

a DatasetAdmin to manage the dataset instance

Throws:

Exception

addDatasetInstance

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

Deprecated. since 4.0.0. Use addDatasetInstance(DatasetId, String) instead.

Adds an instance of dataset.

Type Parameters:

T - type of the dataset admin

Parameters:

namespace - namespace for the dataset

datasetTypeName - dataset type name

datasetInstanceName - instance name

Returns:

a DatasetAdmin to manage the dataset instance

Throws:

Exception

addDatasetInstance

protected final <T extends DatasetAdmin> T addDatasetInstance(co.cask.cdap.proto.id.DatasetId datasetId,
                                                              String datasetTypeName)
                                                       throws Exception

Adds an instance of dataset.

Type Parameters:

T - type of the dataset admin

Parameters:

datasetId - the dataset id

datasetTypeName - dataset type name

Returns:

a DatasetAdmin to manage the dataset instance

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

Returns:

a DatasetAdmin to manage the dataset instance

Throws:

Exception

deleteDatasetInstance

@Deprecated
protected void deleteDatasetInstance(co.cask.cdap.proto.id.NamespaceId namespaceId,
                                                 String datasetInstanceName)
                                          throws Exception

Deprecated. since 4.0.0. Use deleteDatasetInstance(DatasetId) instead.

Deletes an instance of dataset.

Parameters:

namespaceId - namespace for the dataset

datasetInstanceName - instance name

Throws:

Exception

deleteDatasetInstance

protected void deleteDatasetInstance(co.cask.cdap.proto.id.DatasetId datasetId)
                              throws Exception

Deletes an instance of dataset.

Parameters:

datasetId - the dataset to delete

Throws:

Exception

getDataset

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

Deprecated. since 4.0.0. Use getDataset(DatasetId) instead.

Gets Dataset manager of Dataset instance of type <T>.

Parameters:

namespace - namespace for the dataset

datasetInstanceName - instance name of dataset

Returns:

Dataset Manager of Dataset instance of type

Throws:

Exception

getDataset

protected final <T> DataSetManager<T> getDataset(co.cask.cdap.proto.id.DatasetId datasetId)
                                          throws Exception

Gets Dataset manager of Dataset instance of type <T>.

Parameters:

datasetId - the id of the dataset to get

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 <T>.

Parameters:

datasetInstanceName - instance name of dataset

Returns:

Dataset Manager of Dataset instance of type <T>

Throws:

Exception

getAppDetail

protected final co.cask.cdap.proto.ApplicationDetail getAppDetail(co.cask.cdap.proto.id.ApplicationId applicationId)
                                                           throws Exception

Gets the app detail of an application

Parameters:

applicationId - the app id of the application

Returns:

ApplicationDetail of the app

Throws:

Exception

addSchedule

protected final void addSchedule(co.cask.cdap.proto.id.ScheduleId scheduleId,
                                 co.cask.cdap.proto.ScheduleDetail scheduleDetail)
                          throws Exception

Add a new schedule to an existing application

Parameters:

scheduleId - the ID of the schedule to add

scheduleDetail - the ScheduleDetail describing the new schedule.

Throws:

Exception

deleteSchedule

protected final void deleteSchedule(co.cask.cdap.proto.id.ScheduleId scheduleId)
                             throws Exception

Delete an existing schedule.

Parameters:

scheduleId - the ID of the schedule to be deleted

Throws:

Exception

updateSchedule

protected final void updateSchedule(co.cask.cdap.proto.id.ScheduleId scheduleId,
                                    co.cask.cdap.proto.ScheduleDetail scheduleDetail)
                             throws Exception

Update an existing schedule.

Parameters:

scheduleId - the ID of the schedule to add

scheduleDetail - the ScheduleDetail describing the updated schedule.

Throws:

Exception

getQueryClient

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

Deprecated. since 4.0.0. Use getQueryClient(NamespaceId) instead.

Returns a JDBC connection that allows the running of SQL queries over data sets.

Parameters:

namespace - namespace for the connection

Returns:

Connection to use to run queries

Throws:

Exception

getQueryClient

protected final Connection getQueryClient(co.cask.cdap.proto.id.NamespaceId namespace)
                                   throws Exception

Returns a JDBC connection that allows the running of SQL queries over data sets.

Parameters:

namespace - namespace for the connection

Returns:

Connection to use to run queries

Throws:

Exception

getQueryClient

protected final Connection getQueryClient()
                                   throws Exception

Returns a JDBC connection that allows the running of 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

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

Deprecated. since 4.0.0. Use getStreamManager(StreamId) instead.

Returns a StreamManager for the specified stream in the specified namespace

Parameters:

namespace - namespace for the stream

streamName - the specified stream

Returns:

StreamManager for the specified stream in the specified namespace

getStreamManager

protected final StreamManager getStreamManager(co.cask.cdap.proto.id.StreamId streamId)

Returns a StreamManager for the specified stream in the specified namespace

Parameters:

streamId - the stream to get

Returns:

StreamManager for the specified stream in the specified namespace

getMessagingContext

protected final MessagingContext getMessagingContext()

Returns a MessagingContext for interacting with the messaging system.

getMessagingAdmin

protected static MessagingAdmin getMessagingAdmin(String namespace)

Returns a MessagingAdmin for the given namespace.

getMessagingAdmin

protected static MessagingAdmin getMessagingAdmin(co.cask.cdap.proto.id.NamespaceId namespace)

getTxService

protected org.apache.tephra.TransactionManager getTxService()

getNamespaceAdmin

protected static co.cask.cdap.common.namespace.NamespaceAdmin getNamespaceAdmin()

Returns a NamespaceAdmin to interact with namespaces.

getSecureStore

protected static SecureStore getSecureStore()

Returns a SecureStore to interact with secure storage.

getSecureStoreManager

protected static SecureStoreManager getSecureStoreManager()

Returns a SecureStoreManager to interact with secure storage.

getAuthorizer

@Beta
protected static co.cask.cdap.security.spi.authorization.Authorizer getAuthorizer()
                                                                                 throws IOException,
                                                                                        co.cask.cdap.security.authorization.InvalidAuthorizerException

Returns an Authorizer for performing authorization operations.

Throws:

IOException

co.cask.cdap.security.authorization.InvalidAuthorizerException

getPreviewManager

protected static PreviewManager getPreviewManager()

Returns a PreviewManager to interact with preview.

getConfiguration

protected static co.cask.cdap.common.conf.CConfiguration getConfiguration()

Returns the CConfiguration used in tests.

deleteAllApplications

protected static void deleteAllApplications(co.cask.cdap.proto.id.NamespaceId namespaceId)
                                     throws Exception

Deletes all applications in the specified namespace.

Parameters:

namespaceId - the namespace from which to delete all applications

Throws:

Exception