{"type":"doc","content":[{"type":"heading","attrs":{"level":2},"content":[{"text":"Test Framework for Plugins","type":"text"}]},{"type":"paragraph","content":[{"text":"The Test Framework provides methods to create and deploy JAR files as artifacts. This lets you test the creation of multiple applications from the same artifact, as well as the use of plugin artifacts.","type":"text"}]},{"type":"paragraph","content":[{"text":"To add an artifact containing an application class:","type":"text"}]},{"type":"codeBlock","content":[{"text":"// Add the artifact for a Data Pipeline app\naddAppArtifact(new ArtifactId(NamespaceId.DEFAULT.getNamespace(), \"data-pipeline\", \"3.5.0\"),\n DataPipelineApp.class,\n BatchSource.class.getPackage().getName(),\n Action.class.getPackage().getName(),\n PipelineConfigurable.class.getPackage().getName(),\n \"org.apache.avro.mapred\", \"org.apache.avro\", \"org.apache.avro.generic\");","type":"text"}]},{"type":"paragraph","content":[{"text":"The first argument is the ","type":"text"},{"text":"id","type":"text","marks":[{"type":"code"}]},{"text":" of the artifact; the second is the application class; and the remainder of the arguments are packages that should be included in the ","type":"text"},{"text":"Export-Packages","type":"text","marks":[{"type":"code"}]},{"text":" manifest attribute bundled in the JAR. The framework will trace the dependencies of the specified application class to create a JAR with those dependencies. This will mimic what happens when you actually build your application JAR using maven.","type":"text"}]},{"type":"paragraph","content":[{"text":"An application can then be deployed using that artifact:","type":"text"}]},{"type":"codeBlock","content":[{"text":"// Create application create request\nETLBatchConfig etlConfig = new ETLBatchConfig(\"* * * * *\", source, sink, transformList);\nAppRequest appRequest = new AppRequest<>(new ArtifactSummary(\"etlbatch\", \"3.5.0\"), etlConfig);\nApplicationId appId = NamespaceId.DEFAULT.app(\"KVToKV\");\n\n// Deploy the application\nApplicationManager appManager = deployApplication(appId, appRequest);","type":"text"}]},{"type":"paragraph","content":[{"text":"Plugins extending the artifact can also be added:","type":"text"}]},{"type":"codeBlock","content":[{"text":"// Add some test plugins\naddPluginArtifact(new ArtifactId(NamespaceId.DEFAULT.getNamespace(), \"spark-plugins\", \"1.0.0\"),\n APP_ARTIFACT_ID,\n NaiveBayesTrainer.class, NaiveBayesClassifier.class);","type":"text"}]},{"type":"paragraph","content":[{"text":"The first argument is the ","type":"text"},{"text":"id","type":"text","marks":[{"type":"code"}]},{"text":" of the plugin artifact; the second is the parent artifact it is extending; and the remainder of the arguments are classes that should be bundled in the JAR. The packages of all these classes are included in the ","type":"text"},{"text":"Export-Packages","type":"text","marks":[{"type":"code"}]},{"text":" manifest attribute bundled in the JAR. When adding a plugin artifact this way, it is important to include all classes in your plugin packages, even if they are not used in your test case. This is to ensure that the JAR can trace all required dependencies to correctly build the JAR.","type":"text"}]},{"type":"paragraph","content":[{"text":"The examples are taken from the ","type":"text"},{"text":"DataPipelineTest","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"HydratorTestBase","type":"text","marks":[{"type":"code"}]},{"text":" classes of CDAP pipelines.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"CDAP Pipelines Test Module","type":"text"}]},{"type":"paragraph","content":[{"text":"Additional information on unit testing with CDAP is in the Developer Manual section on ","type":"text"},{"text":"Testing a CDAP Application","type":"text","marks":[{"type":"link","attrs":{"__confluenceMetadata":{"isRenamedTitle":true,"linkType":"page","contentTitle":"Testing a CDAP Application","versionAtSave":"5"},"href":"/wiki/spaces/DOCS/pages/480346820"}}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"In addition, CDAP provides a ","type":"text"},{"text":"hydrator-test","type":"text","marks":[{"type":"code"}]},{"text":" module that contains several mock plugins for you to use in tests with your custom plugins. To use the module, add a dependency to your ","type":"text"},{"text":"pom.xml","type":"text","marks":[{"type":"code"}]},{"text":":","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n io.cdap.cdap\n hydrator-test\n ${cdap.version}\n test\n","type":"text"}]},{"type":"paragraph","content":[{"text":"Then extend the ","type":"text"},{"text":"HydratorTestBase","type":"text","marks":[{"type":"code"}]},{"text":" class, and create a method that will setup up the application artifact and mock plugins, as well as the artifact containing your custom plugins:","type":"text"}]},{"type":"codeBlock","content":[{"text":"/**\n * Unit tests for our plugins.\n */\npublic class PipelineTest extends HydratorTestBase {\n private static final ArtifactSummary APP_ARTIFACT = new ArtifactSummary(\"cdap-data-pipeline\", \"1.0.0\");\n @ClassRule\n public static final TestConfiguration CONFIG = new TestConfiguration(\"explore.enabled\", false);\n\n @BeforeClass\n public static void setupTestClass() throws Exception {\n ArtifactId parentArtifact = NamespaceId.DEFAULT.artifact(APP_ARTIFACT.getName(), APP_ARTIFACT.getVersion());\n\n // Add the data pipeline artifact and mock plugins.\n setupBatchArtifacts(parentArtifact, DataPipelineApp.class);\n\n // Add our plugins artifact with the data pipeline artifact as its parent.\n // This will make our plugins available to the data pipeline.\n addPluginArtifact(NamespaceId.DEFAULT.artifact(\"example-plugins\", \"1.0.0\"),\n parentArtifact,\n TextFileSetSource.class,\n TextFileSetSink.class,\n WordCountAggregator.class,\n WordCountCompute.class,\n WordCountSink.class);\n }","type":"text"}]},{"type":"paragraph","content":[{"text":"You can then add test cases as you see fit. The ","type":"text"},{"text":"cdap-data-pipeline-plugins-archetype","type":"text","marks":[{"type":"code"}]},{"text":" includes an example of this unit test.","type":"text"}]}],"version":1}

Browser not supported