Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

A sample project has been created to aid in IT test creation. It can be retrieved using Subversion Git from our source repository in core-it-support/maven-it-sample or directly viewed with your browser via our SVN Git view.

Sample IT Archetype

This project has also been converted into an archetype to make it even easier to use.

It would be helpful to review the archetype plugin documentation here: httphttps://maven.apache.org/plugins/maven-archetype-plugin/Image Removed

The Archetype Plugin doesn't currently know about this archetype, so we created a catalog file to be used.

No Format

mvn archetype:generate -DarchetypeCatalog=http://docs.codehaus.org/download/attachments/1835439/archetype-catalog.xml


No Format

$ mvn archetype:generate -DarchetypeCatalog=http://docs.codehaus.org/download/attachments/1835439/archetype-catalog.xml
[INFO] Scanning for projects...
[INFO] Searching repository for plugin with prefix: 'archetype'.
[INFO] ------------------------------------------------------------------------
[INFO] Building Maven Default Project
[INFO]    task-segment: [archetype:generate] (aggregator-style)
[INFO] ------------------------------------------------------------------------
[INFO] Preparing archetype:generate
[INFO] No goals needed for project - skipping
[INFO] Setting property: classpath.resource.loader.class => 'org.codehaus.plexus.velocity.ContextClassLoaderResourceLoader'.
[INFO] Setting property: velocimacro.messages.on => 'false'.
[INFO] Setting property: resource.loader => 'classpath'.
[INFO] Setting property: resource.manager.logwhenfound => 'false'.
[INFO] [archetype:generate]
Choose archetype:
1: remote -> maven-it-sample-archetype (Archetype for creating a Maven 2 Integration Test)
Choose a number:  (1): 1
[INFO] snapshot org.apache.maven.its:maven-it-sample-archetype:1.0-SNAPSHOT: checking for updates from maven-it-sample-archetype-repo
Downloading: http://people.apache.org/repo/m2-snapshot-repository/org/apache/maven/its/maven-it-sample-archetype/1.0-SNAPSHOT/maven-it-sample-archetype-1.0-20080303.190914-2.jar
9K downloaded
Define value for groupId: : org.apache.maven.its
Define value for artifactId: : my-it
Define value for version: : 1
Define value for package: : org.apache.maven.it
Confirm properties configuration:
groupId: org.apache.maven.its
artifactId: my-it
version: 1
package: org.apache.maven.it
 Y: : Y
[WARNING] org.apache.velocity.runtime.exception.ReferenceException: reference : template = archetype-resources/src/test/resources/mng-xxxx-descriptionOfProblem/checkstyle-test/pom.xml [line 42,column 26] : ${project.build.directory} is not a valid reference.
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESSFUL
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 44 seconds
[INFO] Finished at: Mon Mar 03 19:13:41 GMT 2008
[INFO] Final Memory: 10M/28M
[INFO] ------------------------------------------------------------------------

...

The sample IT project contains the following files: 

No Format

|   pom.xml
|
\---src
    \---test
        +---java
        |   \---org
        |       \---apache
        |           \---maven
        |               \---it
	|                     |   MavenITmngXXXXDescriptionOfProblemTest.java
        |
        \---resources
            \---mng-xxxx
                |   pom.xml
                |   readme.txt
                |
                +---checkstyle-assembly
                |   |   pom.xml
                |   |
                |   +---src
                |      \---main
                |          \---resources
                |                  rule_set.xml
                |                  stc_checks.xml
                |
                |
                |
                \---checkstyle-test
                    |   pom.xml
                    |
                    \---src
                        \---main
                            \---java
                                    Class.java

...

Once your IT is complete, you should be able to execute it:

No Format

>mvn test
[INFO] Scanning for projects...
[INFO] ----------------------------------------------------------------------------
[INFO] Building Maven Integration Tests
[INFO]    task-segment: [test]
[INFO] ----------------------------------------------------------------------------
[INFO] [resources:resources]
[INFO] Using default encoding to copy filtered resources.
[INFO] [compiler:compile]
[INFO] No sources to compile
[INFO] [resources:testResources]
[INFO] Using default encoding to copy filtered resources.
[INFO] [compiler:testCompile]
[INFO] Compiling 1 source file to E:\svn\Maven\maven-it-tests\test\artifact\target\test-classes
[INFO] [surefire:test]
[INFO] Surefire report directory: E:\svn\Maven\maven-it-tests\test\artifact\target\surefire-reports

-------------------------------------------------------
 T E S T S
-------------------------------------------------------
Running org.apache.maven.it.MavenITmngXXXXDescriptionOfProblemTest
mngXXXXDescriptionOfProblem(testitMNGxxxx).. OK
Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 16.802 sec

Results :

Tests run: 1, Failures: 0, Errors: 0, Skipped: 0
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESSFUL
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 25 seconds
[INFO] Finished at: Wed Aug 08 22:47:44 EDT 2007
[INFO] Final Memory: 4M/10M
[INFO] ------------------------------------------------------------------------

...

The sample project maps directly to the core-it-suite structure. Assuming the test has been named uniquely, you can copy the contents of src/test directly over to core-it-suite (don't copy from the root or you'll overwrite the POM). 

No Format

/cygdrive/e/svn/Maven/maven-it-tests/core-it-suite
$ cp ../test/artifact/src . -R -v
`../test/artifact/src/test/java/org/apache/maven/it/MavenITmngXXXXDescriptionOfProblemTest.java' -> `./src/test/java/org/apache/maven/it/MavenITmngXXXXDescriptionOfProblemTest.java'
`../test/artifact/src/test/resources/mng-xxxx/checkstyle-assembly/pom.xml' -> `./src/test/resources/mng-xxxx/checkstyle-assembly/pom.xml'
`../test/artifact/src/test/resources/mng-xxxx/checkstyle-assembly/src/main/resources/rule_set.xml' -> `./src/test/resources/mng-xxxx/checkstyle-assembly/src/main/resources/rule_set.xml'
`../test/artifact/src/test/resources/mng-xxxx/checkstyle-assembly/src/main/resources/stc_checks.xml' -> `./src/test/resources/mng-xxxx/checkstyle-assembly/src/main/resources/stc_checks.xml'
`../test/artifact/src/test/resources/mng-xxxx/checkstyle-assembly/target/classes/rule_set.xml' -> `./src/test/resources/mng-xxxx/checkstyle-assembly/target/classes/rule_set.xml'
`../test/artifact/src/test/resources/mng-xxxx/checkstyle-assembly/target/classes/stc_checks.xml' -> `./src/test/resources/mng-xxxx/checkstyle-assembly/target/classes/stc_checks.xml'
`../test/artifact/src/test/resources/mng-xxxx/checkstyle-test/pom.xml' -> `./src/test/resources/mng-xxxx/checkstyle-test/pom.xml'
`../test/artifact/src/test/resources/mng-xxxx/checkstyle-test/src/main/java/Class.java' -> `./src/test/resources/mng-xxxx/checkstyle-test/src/main/java/Class.java'
`../test/artifact/src/test/resources/mng-xxxx/pom.xml' -> `./src/test/resources/mng-xxxx/pom.xml'
`../test/artifact/src/test/resources/mng-xxxx/readme.txt' -> `./src/test/resources/mng-xxxx/readme.txt'

Now add your test to the test suite by adding a new line to src\test\java\org\apache\maven\it\IntegrationTestSuite.java

No Format

 suite.addTestSuite( MavenITmngXXXXDescriptionOfProblemTest.class );

Now run the suite:

No Format

brianf@sonoma /cygdrive/e/svn/Maven/maven-it-tests/core-it-suite
$ mvn test
[INFO] Scanning for projects...
[INFO] ----------------------------------------------------------------------------
[INFO] Building Maven Integration Tests
[INFO]    task-segment: [test]
[INFO] ----------------------------------------------------------------------------
[INFO] [resources:resources]
[INFO] Using default encoding to copy filtered resources.
[INFO] [compiler:compile]
[INFO] No sources to compile
[INFO] [resources:testResources]
[INFO] Using default encoding to copy filtered resources.
[INFO] [compiler:testCompile]
[INFO] Compiling 124 source files to e:\svn\Maven\maven-it-tests\core-it-suite\target\test-classes
[INFO] [surefire:test]
[INFO] Surefire report directory: e:\svn\Maven\maven-it-tests\core-it-suite\target\surefire-reports
Running integration tests for Maven 2.0.7

-------------------------------------------------------
 T E S T S
-------------------------------------------------------
Running org.apache.maven.it.IntegrationTestSuite
Running integration tests for Maven 2.0.7
0000(testit0000).. Ok
....
got get some coffee, it's gonna be a while
....
MavenITmngXXXXDescriptionOfProblemTest...OK    <-- our test...yeah!

Tests run: 115, Failures: 22, Errors: 3, Skipped: 0, Time elapsed: 534.241 sec <<< FAILURE!

Results :

Failed tests:
  testit0002(org.apache.maven.it.MavenIT0002Test)

Tests in error:
  testit0086(org.apache.maven.it.MavenIT0086Test)
  testit0087(org.apache.maven.it.MavenIT0087Test)
  testit0104(org.apache.maven.it.MavenIT0104Test)

Tests run: 115, Failures: 22, Errors: 3, Skipped: 0

[INFO] ------------------------------------------------------------------------
[ERROR] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] There are test failures.
[INFO] ------------------------------------------------------------------------
[INFO] For more information, run Maven with the -e switch
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 9 minutes 12 seconds
[INFO] Finished at: Wed Aug 08 23:39:48 EDT 2007
[INFO] Final Memory: 4M/12M
[INFO] ------------------------------------------------------------------------

...