1:57 p.m.
Author: pete.muir(a)jboss.org
Date: 2009-07-24 14:57:25 -0400 (Fri, 24 Jul 2009)
New Revision: 3203
Removed:
tck/trunk/doc/reference/en-US/part-setup.xml
Modified:
tck/trunk/doc/reference/en-US/executing.xml
tck/trunk/doc/reference/en-US/master.xml
tck/trunk/doc/reference/en-US/part-background.xml
tck/trunk/doc/reference/en-US/part-test-harness.xml
Log:
Create an executing chapter for the harness guide
Modified: tck/trunk/doc/reference/en-US/executing.xml
===================================================================
--- tck/trunk/doc/reference/en-US/executing.xml 2009-07-24 18:45:06 UTC (rev 3202)
+++ tck/trunk/doc/reference/en-US/executing.xml 2009-07-24 18:57:25 UTC (rev 3203)
@@ -17,9 +17,12 @@
phase of the Maven 2 life cycle. The execution happens within a TCK
runner project (as opposed to the TCK project itself). Web Beans
includes a TCK runner project that executes the CDI TCK on the
- Web Beans running inside JBoss AS 5.1. To execute the
- CDI TCK on your own JSR-299 implementation, you could modify the TCK
- runner project included with Web Beans to use your JSR-299
+ Web Beans
+ running inside JBoss AS 5.1. To execute the
+ CDI TCK on your own JSR-299
+ implementation, you could modify the TCK
+ runner project included with
+ Web Beans to use your JSR-299
implementation as described in
<xref linkend="configuration" />
</para>
@@ -29,7 +32,8 @@
<title>Running the Tests In Standalone Mode</title>
<para>
To execute the TCK test suite against the Web Beans, first switch
- to the jboss-tck-runner directory in the extracted Web Beans
+ to
+ the jboss-tck-runner directory in the extracted Web Beans
distribution:
</para>
@@ -55,7 +59,9 @@
<title>Running the Tests In the Container</title>
<para>
To execute the test suite using in-container mode with the JBoss TCK
- runner, you first have to setup JBoss AS as described in <xref
linkend="tck-in-jboss-as"/>.
+ runner, you first have to setup JBoss AS as described in
+ <xref linkend="tck-in-jboss-as" />
+ .
</para>
<para>
Then, execute the TCK runner:
@@ -93,9 +99,11 @@
</para>
<para>
Since in-container tests are executed in a remote JVM, the results
- of the test must be communicated back to the runner over a
+ of
+ the test must be communicated back to the runner over a
container-supported protocol. The JBoss Test Harness provides
- servlet-based communication over HTTP as described in <xref
linkend="incontainer-communication"/>
+ servlet-based communication over HTTP as described in
+ <xref linkend="incontainer-communication" />
</para>
</section>
<section>
@@ -110,44 +118,21 @@
this type of inspection by "dumping" the generated artifact to disk.
</para>
<para>
- If the
+ This behavior is activated in the jboss-tck-runner project by appending
+ the
<literal>dumpArtifacts</literal>
- is defined as a system property or defined in the classpath resource
- META-INF/jboss-test-harness.properties and has a value of
- <literal>true</literal>
- , the JBoss Test Harness will write the artifact to an output directory
- prior to deploying it to the server. This behavior is activated in the
- jboss-tck-runner project by appending the
- <literal>dumpArtifacts</literal>
command line property to the end of the command that invokes the Maven
test phase.
</para>
- <programlisting>mvn test -Dincontainer
-DdumpArtifacts</programlisting>
- <para>
- If you only want to write the artifacts to disk, and avoid executing
- the test suite, you can simply execute the main method of the class
- <literal>org.jboss.testharness.api.TCK</literal>
- . This execution is configured as a Maven profile that is activated
- when the
- <literal>dumpArtifacts</literal>
- command line property is defined:
- </para>
<programlisting>mvn test-compile -DdumpArtifacts</programlisting>
<para>
- The output directory where the artifacts are written is defined by the
- property
- <literal>org.jboss.testharness.outputDirectory</literal>
- . The jboss-tck-runner project is configured to dump the artifacts to
- the target/jsr299-artifacts directory.
+ The output directory where the artifacts are written is configured to
+ dump the artifacts to the
+ <literal>target/jsr299-artifacts</literal>
+ directory.
</para>
<para>
- Once the artifact is written to disk, you have an option of manually
- deploying it to the container. You can execute the tests in the artfact
- by requesting the context path of the application in the browser. If
- you want to execute an individual test method, specify the method name
- in the
- <literal>methodName</literal>
- request parameter (e.g., ?methodName=testMethodName).
+ You can read more about this in <xref
linkend="dumping-test-artifacts"/>.
</para>
</section>
</chapter>
Modified: tck/trunk/doc/reference/en-US/master.xml
===================================================================
--- tck/trunk/doc/reference/en-US/master.xml 2009-07-24 18:45:06 UTC (rev 3202)
+++ tck/trunk/doc/reference/en-US/master.xml 2009-07-24 18:57:25 UTC (rev 3203)
@@ -4,7 +4,6 @@
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="Book_Info.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="Book_Preface.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="part-background.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="part-setup.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="part-execution.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="part-test-harness.xml" />
</book>
Modified: tck/trunk/doc/reference/en-US/part-background.xml
===================================================================
--- tck/trunk/doc/reference/en-US/part-background.xml 2009-07-24 18:45:06 UTC (rev 3202)
+++ tck/trunk/doc/reference/en-US/part-background.xml 2009-07-24 18:57:25 UTC (rev 3203)
@@ -2,14 +2,22 @@
<!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ ]>
<part>
<title>Getting Acquainted with the TCK</title>
-
+
<partintro>
<para>
- The CDI TCK must be used to ensure that your implementation
- conforms to the CDI specification. This part introduces the TCK,
- gives some background about its purpose and states the requirements for
- passing the TCK.
+ The CDI TCK must be used to ensure that your implementation conforms
+ to the CDI specification. This part introduces the TCK, gives some
+ background about its purpose and states the requirements for passing
+ the TCK.
</para>
+ <para>
+ In this part you will learn where to obtain the JSR-299 TCK and
+ supporting software. You are then presented with recommendations of how
+ to organize and configure the software so that you are ready to execute
+ the TCK.
+ </para>
</partintro>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="introduction.xml" />
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="installation.xml" />
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="configuration.xml" />
</part>
Deleted: tck/trunk/doc/reference/en-US/part-setup.xml
===================================================================
--- tck/trunk/doc/reference/en-US/part-setup.xml 2009-07-24 18:45:06 UTC (rev 3202)
+++ tck/trunk/doc/reference/en-US/part-setup.xml 2009-07-24 18:57:25 UTC (rev 3203)
@@ -1,14 +0,0 @@
-<?xml version='1.0' encoding='UTF-8'?>
-<!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ ]>
-<part>
- <title>Installation and Setup</title>
- <partintro>
- <para>
- In this part you learn where to obtain the JSR-299 TCK and supporting software.
- You are then presented with recommendations of how to organize and
- configure the software so that you are ready to execute the TCK.
- </para>
- </partintro>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="installation.xml" />
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="configuration.xml" />
-</part>
Modified: tck/trunk/doc/reference/en-US/part-test-harness.xml
===================================================================
--- tck/trunk/doc/reference/en-US/part-test-harness.xml 2009-07-24 18:45:06 UTC (rev
3202)
+++ tck/trunk/doc/reference/en-US/part-test-harness.xml 2009-07-24 18:57:25 UTC (rev
3203)
@@ -11,4 +11,5 @@
</partintro>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="harness/introduction.xml" />
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="harness/configuration.xml" />
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="harness/executing.xml" />
</part>