svn commit: r698811 - in /incubator/nmaven/trunk/site/versioned/src/site: apt/developer-guide/ apt/developer-guide/integration-tests.apt apt/index.apt site.xml

[brettporter]

Author: brett
Date: Wed Sep 24 21:13:10 2008
New Revision: 698811

URL: http://svn.apache.org/viewvc?rev=698811&view=rev
Log:
[NMAVEN-186] add a section about running the integration tests

Added:
    incubator/nmaven/trunk/site/versioned/src/site/apt/developer-guide/
    incubator/nmaven/trunk/site/versioned/src/site/apt/developer-guide/integration-tests.apt
Modified:
    incubator/nmaven/trunk/site/versioned/src/site/apt/index.apt
    incubator/nmaven/trunk/site/versioned/src/site/site.xml

Added: incubator/nmaven/trunk/site/versioned/src/site/apt/developer-guide/integration-tests.apt
URL: http://svn.apache.org/viewvc/incubator/nmaven/trunk/site/versioned/src/site/apt/developer-guide/integration-tests.apt?rev=698811&view=auto
==============================================================================
--- incubator/nmaven/trunk/site/versioned/src/site/apt/developer-guide/integration-tests.apt (added)
+++ incubator/nmaven/trunk/site/versioned/src/site/apt/developer-guide/integration-tests.apt Wed Sep 24 21:13:10 2008
@@ -0,0 +1,46 @@
+ ----
+ Writing and Running Integration Tests
+ ----
+
+Writing and Running Integration Tests
+
+  The integration test suite is one of the best ways to ensure ongoing compatibility of NMaven with various types of
+  projects.
+
+* Running Integration Tests During the Build
+
+  The default way to run the integration tests for the current version is during the overall build, like this when
+  run from the top level of the checkout:
+
+----
+mvn clean install -Prun-its
+----
+
+  If there are any failures, you will find them in <<<components/maven-dotnet-core-it-runner/target/surefire-reports>>>.
+  The individual projects will be in <<<%TEMP%/it-path-name>>>. Within that directory you will find <<<log.txt>>> that
+  contains the actual build output.
+
+* Running Integration Tests Standalone
+
+  During development, you may wish to run the suite for a different version to the current one. To do this, switch to
+  the <<<core-integration-tests>>> directory and run the following command:
+
+----
+mvn test -Dtest=IntegrationTestSuite -Dnmaven.version=0.15
+----
+
+  If the <<<nmaven.version>>> is omitted, the latest release version will be used.
+
+  When running the tests standalone, the individual projects will be found in <<<target/test-classes/it-path-name>>>
+  where <<<it-path-name>>> will be replaced by the test's resource directory.
+
+  If you'd prefer to run just one or more tests, you can use the test argument as above to select the tests to run.
+  For example:
+
+----
+mvn test -Dtest=MavenITmng0000CSharpCompileLibrary
+----
+
+~~TODO: running from an IDE
+~~TODO: writing an integration test
+

Modified: incubator/nmaven/trunk/site/versioned/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/incubator/nmaven/trunk/site/versioned/src/site/apt/index.apt?rev=698811&r1=698810&r2=698811&view=diff
==============================================================================
--- incubator/nmaven/trunk/site/versioned/src/site/apt/index.apt (original)
+++ incubator/nmaven/trunk/site/versioned/src/site/apt/index.apt Wed Sep 24 21:13:10 2008
@@ -54,4 +54,17 @@
 
  * {{{mail-lists.html} Post to Mailing List}}
 
+Developing NMaven
+
+  For more information on getting involved in the development of NMaven, refer to the following information:
+
+    * {{{developer-guide/integration-tests.html} Writing Integration Tests}}
+
+~~    * {{{developer-guide/tasks.html} Work to be Done}}
+
+~~    * {{{developer-guide/contributing.html} How to Contribute}}
+
+~~    * {{{developer-guide/index.html} Developer's Guide}}
+
+
 

Modified: incubator/nmaven/trunk/site/versioned/src/site/site.xml
URL: http://svn.apache.org/viewvc/incubator/nmaven/trunk/site/versioned/src/site/site.xml?rev=698811&r1=698810&r2=698811&view=diff
==============================================================================
--- incubator/nmaven/trunk/site/versioned/src/site/site.xml (original)
+++ incubator/nmaven/trunk/site/versioned/src/site/site.xml Wed Sep 24 21:13:10 2008
@@ -25,5 +25,9 @@
       <item name="Testing with NUnit" href="user-guide/testing.html" />
       <item name="Assemblies" href="user-guide/assemblies.html" />
     </menu>
+
+    <menu name="Developer's Guide">
+      <item name="Integration Tests" href="developer-guide/integration-tests.html" />
+    </menu>
   </body>
 </project>