nar:nar-integration-test

Full name:

org.apache.maven.plugins:maven-nar-plugin:2.1-SNAPSHOT:nar-integration-test

Description:

Run integration tests using Surefire. This goal was copied from Maven's surefire plugin to accomodate a few things for the NAR plugin:

1. To test a jar file with its native module we can only run after the package phase, so we use the integration-test phase.

2. We need to set java.library.path to an AOL (architecture-os-linker) specific value, but AOL is only known in the NAR plugin and thus cannot be set from the pom.

3. To have the java.library.path definition picked up by java we need the "pertest" forkmode. To use this goal you need to put the test sources in the regular test directories but disable the running of the tests by the maven-surefire-plugin by setting maven.test.skip.exec to false in your pom.

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Requires dependency resolution of artifacts in scope: test.
  • Binds by default to the lifecycle phase: integration-test.

Required Parameters

Name Type Since Description
architecture String - The Architecture for the nar, Some choices are: "x86", "i386", "amd64", "ppc", "sparc", ... Defaults to a derived value from ${os.arch}
basedir File - The base directory of the project being tested. This can be obtained in your unit test by System.getProperty("basedir").
classesDirectory File - The directory containing generated classes of the project being tested.
failOnError boolean - Fail on compilation/linking error.
Default value is: true.
layout String - Layout to be used for building and unpacking artifacts
Default value is: org.apache.maven.plugin.nar.NarLayout21.
libtool boolean - Set use of libtool. If set to true, the "libtool " will be prepended to the command line for compatible processors.
Default value is: false.
runtime String - Sets the type of runtime library, possible values "dynamic", "static".
Default value is: dynamic.
testClassesDirectory File - The directory containing generated test classes of the project being tested.
testSourceDirectory File 2.2 The test source directory containing test class sources.

Optional Parameters

Name Type Since Description
additionalClasspathElements List 2.4 Additional elements to be appended to the classpath.
aol String - Architecture-OS-Linker name. Defaults to: arch-os-linker.
argLine String 2.1 Arbitrary JVM options to set on the command line.
c C - C Compiler
childDelegation boolean 2.1 When false it makes tests run using the standard classloader delegation instead of the default Maven isolated classloader. Only used when forking (forkMode is not "none").
Setting it to false helps with some problems caused by conflicts between xml parsers in the classpath and the Java 5 provider parser.
Default value is: false.
cpp Cpp - C++ Compiler
debugForkedProcess String 2.4 Attach a debugger to the forked JVM. If set to "true", the process will suspend and wait for a debugger to attach on port 5005. If set to some other string, that string will be appended to the argLine, allowing you to configure arbitrary debuggability options (without overwriting the other options specified in the argLine).
disableXmlReport boolean 2.2 Flag to disable the generation of report files in xml format.
Default value is: false.
enableAssertions boolean 2.3.1 By default, Surefire enables JVM assertions for the execution of your test cases. To disable the assertions, set this flag to false.
Default value is: true.
environmentVariables Map 2.1.3 Additional environments to set on the command line.
excludedGroups String 2.2 (TestNG only) Excluded groups. Any methods/classes/etc with one of the groups specified in this list will specifically not be run. This parameter is overridden if suiteXmlFiles are specified.
excludes List - List of patterns (separated by commas) used to specify the tests that should be excluded in testing. When not specified and when the test parameter is not specified, the default excludes will be **/*$* (which excludes all inner classes). This parameter is ignored if TestNG suiteXmlFiles are specified.
failIfNoTests Boolean 2.4 Set this to "true" to cause a failure if there are no tests to run. Defaults to false.
forkMode String 2.1 Option to specify the forking mode. Can be "never", "once" or "always". "none" and "pertest" are also accepted for backwards compatibility.
Default value is: once.
forkedProcessTimeoutInSeconds int 2.4 Kill the forked test process after a certain number of seconds. If set to 0, wait forever for the process, never timing out.
fortran Fortran - Fortran Compiler
groups String 2.2 (TestNG only) Groups for this test. Only classes/methods/etc decorated with one of the groups specified here will be included in test run, if specified. This parameter is overridden if suiteXmlFiles are specified.
ignore boolean - Ignore errors and failures.
Default value is: false.
includes List - List of patterns (separated by commas) used to specify the tests that should be included in testing. When not specified and when the test parameter is not specified, the default includes will be **/Test*.java **/*Test.java **/*TestCase.java. This parameter is ignored if TestNG suiteXmlFiles are specified.
java Java - Java info for includes and linking
javah Javah - Javah info
junitArtifactName String 2.3.1 Allows you to specify the name of the JUnit artifact. If not set, junit:junit will be used.
Default value is: junit:junit.
jvm String 2.1 Option to specify the jvm (or path to the java executable) to use with the forking options. For the default, the jvm will be the same as the one used to run Maven.
libraries List - List of libraries to create
linker Linker - Linker
maxCores int - Maximum number of Cores/CPU's to use. 0 means unlimited.
os String - The Operating System for the nar. Some choices are: "Windows", "Linux", "MacOSX", "SunOS", ... Defaults to a derived value from ${os.name} FIXME table missing
output String - Name of the output
parallel String 2.2 (TestNG only) When you use the parallel attribute, TestNG will try to run all your test methods in separate threads, except for methods that depend on each other, which will be run in the same thread in order to respect their order of execution.
printSummary boolean - Option to print summary of test suites or just print the test cases that has errors.
Default value is: true.
properties Properties 2.4 List of properties for configuring all TestNG related configurations. This is the new preferred method of configuring TestNG.
redirectTestOutputToFile boolean 2.3 When forking, set this to true to redirect the unit test standard output to a file (found in reportsDirectory/testName-output.txt).
Default value is: false.
remoteRepositories List 2.2 The plugin remote repositories declared in the pom.
reportFormat String - Selects the formatting for the test report to be generated. Can be set as brief or plain.
Default value is: brief.
reportsDirectory File - Base directory where all reports are written to.
skip boolean - Skip running of NAR plugins (any) altogether.
Default value is: false.
skipNar boolean - Skip running of NAR integration test plugin
Default value is: false.
skipNarExec boolean 2.3 DEPRECATED This old parameter is just like skipTests, but bound to the old property maven.test.skip.exec. Use -DskipTests instead; it's shorter.
skipNarTests boolean 2.4 Set this to 'true' to skip running tests, but still compile them. Its use is NOT RECOMMENDED, but quite convenient on occasion.
suiteXmlFiles File[] 2.2 (TestNG only) List of TestNG suite xml file locations, seperated by commas. Note that suiteXmlFiles is incompatible with several other parameters on this plugin, like includes/excludes. This parameter is ignored if the "test" parameter is specified (allowing you to run a single test instead of an entire suite).
systemProperties Properties - List of System properties to pass to the JUnit tests.
targetDirectory File - Target directory for Nar file construction. Defaults to "${project.build.directory}/nar" for "nar-compile" goal Defaults to "${project.build.directory}/test-nar" for "nar-testCompile" goal
test String - Specify this parameter to run individual tests by file name, overriding the includes/excludes parameters. Each pattern you specify here will be used to create an include pattern formatted like **/${test}.java, so you can just type "-Dtest=MyTest" to run a single test called "foo/MyTest.java". This parameter will override the TestNG suiteXmlFiles parameter.
testFailureIgnore boolean - Set this to true to ignore a failure during testing. Its use is NOT RECOMMENDED, but quite convenient on occasion.
testNGArtifactName String 2.3.1 Allows you to specify the name of the TestNG artifact. If not set, org.testng:testng will be used.
Default value is: org.testng:testng.
tests List - List of tests to create
threadCount int 2.2 (TestNG only) The attribute thread-count allows you to specify how many threads should be allocated for this execution. Only makes sense to use in conjunction with parallel.
trimStackTrace boolean 2.2 Whether to trim the stack trace in the reports to just the lines within the test, or show the full trace.
Default value is: true.
unpackDirectory File - Target directory for Nar file unpacking. Defaults to "${targetDirectory}/depenencies"
useFile boolean - Option to generate a file test report or just output the test report to the console.
Default value is: true.
useManifestOnlyJar boolean 2.4.3 By default, Surefire forks your tests using a manifest-only jar; set this parameter to "false" to force it to launch your tests with a plain old Java classpath. (See http://maven.apache.org/plugins/maven-surefire-plugin/examples/class-loading.html for a more detailed explanation of manifest-only jars and their benefits.) Default value is "true". Beware, setting this to "false" may cause your tests to fail on Windows if your classpath is too long.
Default value is: true.
useSystemClassLoader Boolean 2.3 Option to pass dependencies to the system's classloader instead of using an isolated class loader when forking. Prevents problems with JDKs which implement the service provider lookup mechanism by using the system's classloader. Default value is "true".
workingDirectory File 2.1.3 Command line working directory.

Parameter Details

additionalClasspathElements:

Additional elements to be appended to the classpath.
  • Type: java.util.List
  • Since: 2.4
  • Required: No

aol:

Architecture-OS-Linker name. Defaults to: arch-os-linker.
  • Type: java.lang.String
  • Required: No

architecture:

The Architecture for the nar, Some choices are: "x86", "i386", "amd64", "ppc", "sparc", ... Defaults to a derived value from ${os.arch}
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${os.arch}

argLine:

Arbitrary JVM options to set on the command line.
  • Type: java.lang.String
  • Since: 2.1
  • Required: No
  • Expression: ${argLine}

basedir:

The base directory of the project being tested. This can be obtained in your unit test by System.getProperty("basedir").
  • Type: java.io.File
  • Required: Yes
  • Expression: ${basedir}

c:

C Compiler
  • Type: org.apache.maven.plugin.nar.C
  • Required: No

childDelegation:

When false it makes tests run using the standard classloader delegation instead of the default Maven isolated classloader. Only used when forking (forkMode is not "none").
Setting it to false helps with some problems caused by conflicts between xml parsers in the classpath and the Java 5 provider parser.
  • Type: boolean
  • Since: 2.1
  • Required: No
  • Expression: ${childDelegation}
  • Default: false

classesDirectory:

The directory containing generated classes of the project being tested.
  • Type: java.io.File
  • Required: Yes
  • Expression: ${project.build.outputDirectory}

cpp:

C++ Compiler
  • Type: org.apache.maven.plugin.nar.Cpp
  • Required: No

debugForkedProcess:

Attach a debugger to the forked JVM. If set to "true", the process will suspend and wait for a debugger to attach on port 5005. If set to some other string, that string will be appended to the argLine, allowing you to configure arbitrary debuggability options (without overwriting the other options specified in the argLine).
  • Type: java.lang.String
  • Since: 2.4
  • Required: No
  • Expression: ${maven.surefire.debug}

disableXmlReport:

Flag to disable the generation of report files in xml format.
  • Type: boolean
  • Since: 2.2
  • Required: No
  • Expression: ${disableXmlReport}
  • Default: false

enableAssertions:

By default, Surefire enables JVM assertions for the execution of your test cases. To disable the assertions, set this flag to false.
  • Type: boolean
  • Since: 2.3.1
  • Required: No
  • Expression: ${enableAssertions}
  • Default: true

environmentVariables:

Additional environments to set on the command line.
  • Type: java.util.Map
  • Since: 2.1.3
  • Required: No

excludedGroups:

(TestNG only) Excluded groups. Any methods/classes/etc with one of the groups specified in this list will specifically not be run. This parameter is overridden if suiteXmlFiles are specified.
  • Type: java.lang.String
  • Since: 2.2
  • Required: No
  • Expression: ${excludedGroups}

excludes:

List of patterns (separated by commas) used to specify the tests that should be excluded in testing. When not specified and when the test parameter is not specified, the default excludes will be **/*$* (which excludes all inner classes). This parameter is ignored if TestNG suiteXmlFiles are specified.
  • Type: java.util.List
  • Required: No

failIfNoTests:

Set this to "true" to cause a failure if there are no tests to run. Defaults to false.
  • Type: java.lang.Boolean
  • Since: 2.4
  • Required: No
  • Expression: ${failIfNoTests}

failOnError:

Fail on compilation/linking error.
  • Type: boolean
  • Required: Yes
  • Default: true

forkMode:

Option to specify the forking mode. Can be "never", "once" or "always". "none" and "pertest" are also accepted for backwards compatibility.
  • Type: java.lang.String
  • Since: 2.1
  • Required: No
  • Expression: ${forkMode}
  • Default: once

forkedProcessTimeoutInSeconds:

Kill the forked test process after a certain number of seconds. If set to 0, wait forever for the process, never timing out.
  • Type: int
  • Since: 2.4
  • Required: No
  • Expression: ${surefire.timeout}

fortran:

Fortran Compiler
  • Type: org.apache.maven.plugin.nar.Fortran
  • Required: No

groups:

(TestNG only) Groups for this test. Only classes/methods/etc decorated with one of the groups specified here will be included in test run, if specified. This parameter is overridden if suiteXmlFiles are specified.
  • Type: java.lang.String
  • Since: 2.2
  • Required: No
  • Expression: ${groups}

ignore:

Ignore errors and failures.
  • Type: boolean
  • Required: No
  • Expression: ${nar.ignore}
  • Default: false

includes:

List of patterns (separated by commas) used to specify the tests that should be included in testing. When not specified and when the test parameter is not specified, the default includes will be **/Test*.java **/*Test.java **/*TestCase.java. This parameter is ignored if TestNG suiteXmlFiles are specified.
  • Type: java.util.List
  • Required: No

java:

Java info for includes and linking
  • Type: org.apache.maven.plugin.nar.Java
  • Required: No

javah:

Javah info
  • Type: org.apache.maven.plugin.nar.Javah
  • Required: No

junitArtifactName:

Allows you to specify the name of the JUnit artifact. If not set, junit:junit will be used.
  • Type: java.lang.String
  • Since: 2.3.1
  • Required: No
  • Expression: ${junitArtifactName}
  • Default: junit:junit

jvm:

Option to specify the jvm (or path to the java executable) to use with the forking options. For the default, the jvm will be the same as the one used to run Maven.
  • Type: java.lang.String
  • Since: 2.1
  • Required: No
  • Expression: ${jvm}

layout:

Layout to be used for building and unpacking artifacts
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${nar.layout}
  • Default: org.apache.maven.plugin.nar.NarLayout21

libraries:

List of libraries to create
  • Type: java.util.List
  • Required: No

libtool:

Set use of libtool. If set to true, the "libtool " will be prepended to the command line for compatible processors.
  • Type: boolean
  • Required: Yes
  • Default: false

linker:

Linker
  • Type: org.apache.maven.plugin.nar.Linker
  • Required: No

maxCores:

Maximum number of Cores/CPU's to use. 0 means unlimited.
  • Type: int
  • Required: No

os:

The Operating System for the nar. Some choices are: "Windows", "Linux", "MacOSX", "SunOS", ... Defaults to a derived value from ${os.name} FIXME table missing
  • Type: java.lang.String
  • Required: No

output:

Name of the output
  • Type: java.lang.String
  • Required: No
  • Expression: ${project.artifactId}-${project.version}

parallel:

(TestNG only) When you use the parallel attribute, TestNG will try to run all your test methods in separate threads, except for methods that depend on each other, which will be run in the same thread in order to respect their order of execution.
  • Type: java.lang.String
  • Since: 2.2
  • Required: No
  • Expression: ${parallel}

printSummary:

Option to print summary of test suites or just print the test cases that has errors.
  • Type: boolean
  • Required: No
  • Expression: ${surefire.printSummary}
  • Default: true

properties:

List of properties for configuring all TestNG related configurations. This is the new preferred method of configuring TestNG.
  • Type: java.util.Properties
  • Since: 2.4
  • Required: No

redirectTestOutputToFile:

When forking, set this to true to redirect the unit test standard output to a file (found in reportsDirectory/testName-output.txt).
  • Type: boolean
  • Since: 2.3
  • Required: No
  • Expression: ${nar.test.redirectTestOutputToFile}
  • Default: false

remoteRepositories:

The plugin remote repositories declared in the pom.
  • Type: java.util.List
  • Since: 2.2
  • Required: No
  • Expression: ${project.pluginArtifactRepositories}

reportFormat:

Selects the formatting for the test report to be generated. Can be set as brief or plain.
  • Type: java.lang.String
  • Required: No
  • Expression: ${surefire.reportFormat}
  • Default: brief

reportsDirectory:

Base directory where all reports are written to.
  • Type: java.io.File
  • Required: No
  • Expression: ${project.build.directory}/surefire-reports

runtime:

Sets the type of runtime library, possible values "dynamic", "static".
  • Type: java.lang.String
  • Required: Yes
  • Default: dynamic

skip:

Skip running of NAR plugins (any) altogether.
  • Type: boolean
  • Required: No
  • Expression: ${nar.skip}
  • Default: false

skipNar:

Skip running of NAR integration test plugin
  • Type: boolean
  • Required: No
  • Expression: ${skipNar}
  • Default: false

skipNarExec:

DEPRECATED This old parameter is just like skipTests, but bound to the old property maven.test.skip.exec. Use -DskipTests instead; it's shorter.
  • Type: boolean
  • Since: 2.3
  • Required: No
  • Expression: ${nar.test.skip.exec}

skipNarTests:

Set this to 'true' to skip running tests, but still compile them. Its use is NOT RECOMMENDED, but quite convenient on occasion.
  • Type: boolean
  • Since: 2.4
  • Required: No
  • Expression: ${skipNarTests}

suiteXmlFiles:

(TestNG only) List of TestNG suite xml file locations, seperated by commas. Note that suiteXmlFiles is incompatible with several other parameters on this plugin, like includes/excludes. This parameter is ignored if the "test" parameter is specified (allowing you to run a single test instead of an entire suite).
  • Type: java.io.File[]
  • Since: 2.2
  • Required: No

systemProperties:

List of System properties to pass to the JUnit tests.
  • Type: java.util.Properties
  • Required: No

targetDirectory:

Target directory for Nar file construction. Defaults to "${project.build.directory}/nar" for "nar-compile" goal Defaults to "${project.build.directory}/test-nar" for "nar-testCompile" goal
  • Type: java.io.File
  • Required: No

test:

Specify this parameter to run individual tests by file name, overriding the includes/excludes parameters. Each pattern you specify here will be used to create an include pattern formatted like **/${test}.java, so you can just type "-Dtest=MyTest" to run a single test called "foo/MyTest.java". This parameter will override the TestNG suiteXmlFiles parameter.
  • Type: java.lang.String
  • Required: No
  • Expression: ${test}

testClassesDirectory:

The directory containing generated test classes of the project being tested.
  • Type: java.io.File
  • Required: Yes
  • Expression: ${project.build.testOutputDirectory}

testFailureIgnore:

Set this to true to ignore a failure during testing. Its use is NOT RECOMMENDED, but quite convenient on occasion.
  • Type: boolean
  • Required: No
  • Expression: ${nar.test.failure.ignore}

testNGArtifactName:

Allows you to specify the name of the TestNG artifact. If not set, org.testng:testng will be used.
  • Type: java.lang.String
  • Since: 2.3.1
  • Required: No
  • Expression: ${testNGArtifactName}
  • Default: org.testng:testng

testSourceDirectory:

The test source directory containing test class sources.
  • Type: java.io.File
  • Since: 2.2
  • Required: Yes
  • Expression: ${project.build.testSourceDirectory}

tests:

List of tests to create
  • Type: java.util.List
  • Required: No

threadCount:

(TestNG only) The attribute thread-count allows you to specify how many threads should be allocated for this execution. Only makes sense to use in conjunction with parallel.
  • Type: int
  • Since: 2.2
  • Required: No
  • Expression: ${threadCount}

trimStackTrace:

Whether to trim the stack trace in the reports to just the lines within the test, or show the full trace.
  • Type: boolean
  • Since: 2.2
  • Required: No
  • Expression: ${trimStackTrace}
  • Default: true

unpackDirectory:

Target directory for Nar file unpacking. Defaults to "${targetDirectory}/depenencies"
  • Type: java.io.File
  • Required: No

useFile:

Option to generate a file test report or just output the test report to the console.
  • Type: boolean
  • Required: No
  • Expression: ${surefire.useFile}
  • Default: true

useManifestOnlyJar:

By default, Surefire forks your tests using a manifest-only jar; set this parameter to "false" to force it to launch your tests with a plain old Java classpath. (See http://maven.apache.org/plugins/maven-surefire-plugin/examples/class-loading.html for a more detailed explanation of manifest-only jars and their benefits.) Default value is "true". Beware, setting this to "false" may cause your tests to fail on Windows if your classpath is too long.
  • Type: boolean
  • Since: 2.4.3
  • Required: No
  • Expression: ${surefire.useManifestOnlyJar}
  • Default: true

useSystemClassLoader:

Option to pass dependencies to the system's classloader instead of using an isolated class loader when forking. Prevents problems with JDKs which implement the service provider lookup mechanism by using the system's classloader. Default value is "true".
  • Type: java.lang.Boolean
  • Since: 2.3
  • Required: No
  • Expression: ${surefire.useSystemClassLoader}

workingDirectory:

Command line working directory.
  • Type: java.io.File
  • Since: 2.1.3
  • Required: No
  • Expression: ${basedir}