com.simpligility.maven.plugins.android

Class AbstractInstrumentationMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.simpligility.maven.plugins.android.AbstractAndroidMojo

com.simpligility.maven.plugins.android.AbstractInstrumentationMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

InstrumentMojo, InternalIntegrationTestMojo, InternalPreIntegrationTestMojo

public abstract class AbstractInstrumentationMojo
extends AbstractAndroidMojo

AbstractInstrumentationMojo implements running the instrumentation tests.

Author:

hugo.josefson@jayway.com, Manfred Moser - manfred@simpligility.com

Field Summary

Fields

Modifier and Type	Field and Description
protected List<String>	testAnnotations Whether to execute tests which are annotated with the given annotations.
protected List<String>	testClasses Whether to execute test classes which are specified as part of the instrumentation tests.
protected List<String>	testExcludeAnnotations Whether to execute tests which are not annotated with the given annotations.
protected List<String>	testInstrumentationArgs Extra instrumentation arguments.
protected List<String>	testPackages Whether to execute tests only in given packages as part of the instrumentation tests.

Fields inherited from class com.simpligility.maven.plugins.android.AbstractAndroidMojo

aaptExtraArgs, aaptVerbose, adbConnectionTimeout, androidManifestFile, assetsDirectory, attachJar, attachSources, combinedAssets, configurations, customPackage, dependencyGraphBuilder, destinationManifestFile, device, devices, deviceThreads, ENV_ANDROID_HOME, ENV_ANDROID_NDK_HOME, execution, extractedDependenciesDirectory, extractedDependenciesJavaResources, extractedDependenciesJavaSources, finalName, genDirectory, generateApk, ips, nativeLibrariesDirectory, ndkOutputDirectory, proguardFile, project, projectHelper, projectOutputDirectory, release, renameManifestPackage, resourceDirectory, resourceOverlayDirectories, resourceOverlayDirectory, resources, session, sourceDirectory, sourceEncoding, SUPPORTED_PACKAGING_TYPES, targetDirectory, undeployBeforeDeploy

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractInstrumentationMojo()

Method Summary

Modifier and Type	Method and Description
protected static String	buildCommaSeparatedString(List<String> lines) Helper method to build a comma separated string from a list.
protected void	instrument()
protected boolean	isEnableIntegrationTest() Whether or not to execute integration test related goals.

Methods inherited from class com.simpligility.maven.plugins.android.AbstractAndroidMojo

copyFolder, deployApk, deployBuiltApk, deployDependencies, doWithDevices, extractInstrumentationRunnerFromAndroidManifest, extractPackageNameFromAndroidArtifact, extractPackageNameFromAndroidManifest, extractPackageNameFromAndroidManifestXmlTree, extractPackageNameFromApk, getAndroidManifestPackageName, getAndroidNdk, getAndroidSdk, getArtifactResolverHelper, getDependencyResolver, getDirectDependencyArtifacts, getJack, getLibraryUnpackDirectory, getNativeHelper, getRelevantCompileArtifacts, getResourceOverlayDirectories, getTransitiveDependencyArtifacts, getTransitiveDependencyArtifacts, getUnpackedAarClassesJar, getUnpackedApkLibSourceFolder, getUnpackedLibAssetsFolder, getUnpackedLibFolder, getUnpackedLibHelper, getUnpackedLibNativesFolder, getUnpackedLibResourceFolder, getUnpackedLibsDirectory, initAndroidDebugBridge, isAPKBuild, isInstrumentationTest, resolveArtifactToFile, undeployApk, undeployApk, waitForInitialDeviceList

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.maven.plugin.Mojo

execute

Field Detail

testPackages

@Parameter(property="android.test.packages")
protected List<String> testPackages

Whether to execute tests only in given packages as part of the instrumentation tests.

 <packages>
     <package>your.package.name</package>
 </packages>
 

or as e.g. -Dandroid.test.packages=package1,package2

testClasses

@Parameter(property="android.test.classes")
protected List<String> testClasses

Whether to execute test classes which are specified as part of the instrumentation tests.

 <classes>
     <class>your.package.name.YourTestClass</class>
 </classes>
 

or as e.g. -Dandroid.test.classes=class1,class2

testAnnotations

@Parameter(property="android.test.annotations")
protected List<String> testAnnotations

Whether to execute tests which are annotated with the given annotations.

 <annotations>
     <annotation>your.package.name.YourAnnotation</annotation>
 </annotations>
 

or as e.g. -Dandroid.test.annotations=annotation1,annotation2

testExcludeAnnotations

@Parameter(property="android.test.excludeAnnotations")
protected List<String> testExcludeAnnotations

Whether to execute tests which are not annotated with the given annotations.

 <excludeAnnotations>
     <excludeAnnotation>your.package.name.YourAnnotation</excludeAnnotation>
 </excludeAnnotations>
 

or as e.g. -Dandroid.test.excludeAnnotations=annotation1,annotation2

testInstrumentationArgs

@Parameter(property="android.test.instrumentationArgs")
protected List<String> testInstrumentationArgs

Extra instrumentation arguments.

 <instrumentationArgs>
     <instrumentationArg>key value</instrumentationArg>
     <instrumentationArg>key 'value with spaces'</instrumentationArg>
 </instrumentationArgs>
 

or as e.g. -Dandroid.test.instrumentationArgs="key1 value1","key2 'value with spaces'"

Constructor Detail

AbstractInstrumentationMojo

public AbstractInstrumentationMojo()

Method Detail

instrument

protected void instrument()
                   throws org.apache.maven.plugin.MojoExecutionException,
                          org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

isEnableIntegrationTest

protected boolean isEnableIntegrationTest()
                                   throws org.apache.maven.plugin.MojoFailureException,
                                          org.apache.maven.plugin.MojoExecutionException

Whether or not to execute integration test related goals. Reads from configuration parameter enableIntegrationTest, but can be overridden with -Dmaven.test.skip.

Returns:

true if integration test goals should be executed, false otherwise.

Throws:

org.apache.maven.plugin.MojoFailureException

org.apache.maven.plugin.MojoExecutionException

buildCommaSeparatedString

protected static String buildCommaSeparatedString(List<String> lines)

Helper method to build a comma separated string from a list. Blank strings are filtered out

Parameters:

lines - A list of strings

Returns:

Comma separated String from given list