[webbeans-commits] Webbeans SVN: r3196 - tck/trunk/doc/reference/en-US.
webbeans-commits at lists.jboss.org
webbeans-commits at lists.jboss.org
Fri Jul 24 10:42:19 EDT 2009
Author: pete.muir at jboss.org
Date: 2009-07-24 10:42:19 -0400 (Fri, 24 Jul 2009)
New Revision: 3196
Modified:
tck/trunk/doc/reference/en-US/installation.xml
Log:
add back the jboss info, but as a "how to run the tck in jboss as tip"
Modified: tck/trunk/doc/reference/en-US/installation.xml
===================================================================
--- tck/trunk/doc/reference/en-US/installation.xml 2009-07-24 14:13:27 UTC (rev 3195)
+++ tck/trunk/doc/reference/en-US/installation.xml 2009-07-24 14:42:19 UTC (rev 3196)
@@ -43,12 +43,7 @@
reference implementation (RI) project is named Web Beans. You can
obtain the latest Web Beans release from the
<ulink url="http://seamframework.org/Download">download page</ulink>
- on Seam Framework website. Web Beans includes a TCK runner that
- executes the TCK using Web Beans as the CDI implementation and JBoss AS
- as the Java EE runtime. You can download JBoss AS 5.1 from
- the JBoss AS
- <ulink url="http://jboss.org/jbossas/downloads">project page</ulink>
- .
+ on Seam Framework website.
</para>
<note>
<para>
@@ -94,13 +89,6 @@
You should refer to vendor instructions for how to install the
runtime.
</para>
- <tip>
- <para>
- If you are using JBoss AS, it's recommended that you set the
- <literal>JBOSS_HOME</literal>
- environment variable to the location of the JBoss AS software.
- </para>
- </tip>
<para>
The rest of the TCK software can simply be extracted. It's
recommended that you create a folder named jsr299 to hold all of the
@@ -109,98 +97,144 @@
extract it into a sibling folder named webbeans. The resulting folder
structure is shown here:
</para>
- <programlisting>jsr299/
- webbeans/
- tck/</programlisting>
- <tip>
+ <note>
<para>
This layout is assumed through all descriptions in this reference
guide.
</para>
- </tip>
+ </note>
+ <programlisting><![CDATA[jsr299/
+ webbeans/
+ tck/]]></programlisting>
<tip>
+ <title>
+ Running the TCK against the CDI RI (Web Beans) and JBoss AS
+ </title>
+
<para>
Web Beans is built as a modular library, and as such can be
- retro-fitted to Java EE 5 products as required. Red Hat Middleware
- LLC bundles Web Beans in it's JBoss AS 5.1 and above releases. JBoss
- AS 5.1 also allows you to upgrade the Web Beans module to the
- current release (though some functionality may be disabled). This
- allows you to run the CDI TCK in JBoss 5.1.
+ retro-fitted to Java EE 5 products as required. JBoss AS 5.1 and
+ above releases bundle Web Beans. JBoss AS 5.1 also allows you to
+ upgrade the Web Beans module to the current release (though some
+ functionality may be disabled).
</para>
+
<para>
- CDI is an integral part of Java EE 6 and above, and as such Java
- EE 6 runtimes are expected to bundle a CDI implementation.
+ To install JBoss AS 5.1 and update to the latest Web Beans
+ release:
</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ First, you should download JBoss AS 5.1 from the JBoss AS
+ <ulink url="http://jboss.org/jbossas/downloads">project page</ulink>
+ .
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Set the
+ <literal>JBOSS_HOME</literal>
+ environment variable to the location of the JBoss AS software.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Change to the webbeans directory.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Make sure the
+ <literal>jboss.home</literal>
+ property in the local.build.properties file in the jboss-as
+ directory references a JBoss AS 5.1 installation:
+ </para>
+ <programlisting>jboss.home=/path/to/jboss-as-5.1</programlisting>
+ </listitem>
+ <listitem>
+ <para>
+ Then, run Ant from the jboss-as directory to install the
+ deployer:
+ </para>
+ <programlisting>ant update</programlisting>
+ <para>
+ The libraries needed by the deployer are fetched from the
+ Maven 2 repository on demand.
+ </para>
+ </listitem>
+ </itemizedlist>
+
<para>
- To perform the upgrade to JBoss AS 5.1:
+ Web Beans includes a TCK runner that executes the TCK using Web
+ Beans as the CDI implementation and JBoss AS as the Java EE runtime.
+ To run the tck:
</para>
- <para>
- Change to the webbeans directory.
- </para>
- <para>
- Make sure the
- <literal>jboss.home</literal>
- property in the local.build.properties file in the jboss-as
- directory references a JBoss AS 5.1 installation:
- </para>
- <programlisting>jboss.home=/path/to/jboss-as-5.1</programlisting>
- <para>
- Then, run Ant from the jboss-as directory to install the
- deployer:
- </para>
- <programlisting>ant update</programlisting>
- <para>
- The libraries needed by the deployer are fetched from the Maven 2
- repository on demand. The versions of the libraries fetched are
- defined in the build.properties files in that directory.
- </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ You need to install Maven. You can find documention on how to
+ install Maven 2 in the
+ <ulink
+ url="http://www.sonatype.com/books/maven-book/reference/installation-sect-maven-install.html">Maven: The Definitive Guide</ulink>
+ book published by Sonatype. Web Beans bundles a copy of Maven
+ in the
+ <code>lib/maven</code>
+ directory.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Next, instruct Maven to run the TCK:
+ </para>
+ <programlisting><![CDATA[cd jboss-tck-runner
+mvn test -Dincontainer]]></programlisting>
+ </listitem>
+ <listitem>
+ <para>
+ TestNG will report, via Maven, the outcome of the run, and
+ report
+ any failures on the console. Details can be found in
+ <code>target/surefire-reports/TestSuite.txt</code>
+ .
+ </para>
+ </listitem>
+ </itemizedlist>
+
</tip>
- <tip>
- <para>
- If decide to use Maven 2 to execute the tests (as Web Beans does
- with JBoss AS), you need to install Maven You can documention on how
- to install Maven 2 in the
- <ulink
- url="http://www.sonatype.com/books/maven-book/reference/installation-sect-maven-install.html">Maven: The Definitive Guide</ulink>
- book published by Sonatype.
- </para>
- <para>
- Maven will retrieve all TCK and Web Beans dependencies from the
- JBoss Maven repository.
- </para>
- </tip>
- </section>
- <section>
+ </section>
+ <section>
<title>Eclipse plugins</title>
<para>
- Eclipse, or any other IDE, is not required to execute or pass the TCK.
- However, executing and debugging tests in the IDE is essential for a
- licensee attempting to get a JSR-299 implementation to pass the tests
- in the TCK test suite. This section introduces two essential Eclipse
+ Eclipse, or any other IDE, is not required to execute or pass the
+ TCK. However an implementor may wish to execute tests in an IDE to aid
+ debugging the tests. This section introduces two essential Eclipse
plugins and points you to resources explaining how to install them.
</para>
<para>
- The TCK is built on the JBoss Test Harness, which is in turn executed
- by TestNG. Therefore, having the TestNG plugin installed in Eclipse is
- essential. Instructions for using the TestNG update site to add the
- TestNG plugin to Eclipse are provided on the TestNG
- <ulink url="http://testng.org/doc/download.html">download page</ulink>.
- You can find a tutorial that explains how to use the TestNG plugin on
- the TestNG
- <ulink url="http://testng.org/doc/eclipse.html">Eclipse page</ulink>.
+ The TCK is built on the JBoss Test Harness, which is in turn built on
+ TestNG. Therefore, having the TestNG plugin installed in Eclipse is
+ essential. Instructions for using the TestNG update site to add the
+ TestNG plugin to Eclipse are provided on the TestNG
+ <ulink url="http://testng.org/doc/download.html">download page</ulink>
+ .
+ You can find a tutorial that explains how to use the TestNG plugin on
+ the TestNG
+ <ulink url="http://testng.org/doc/eclipse.html">Eclipse page</ulink>
+ .
</para>
<para>
- Another useful plugin is m2eclipse. Both the TCK project and the
- TCK runner project (at least the one that ships with the JSR-299 RI)
- are built with Maven 2. Therefore, to work with these projects in
- Eclipse, you may wish to have support for Maven 2 project, which the
- m2eclipse plugin provides. Instructions for using the m2eclipse update
- site to add the m2eclipse plugin to Eclipse are provided on the
- m2eclipse home page. Sonatype, the company that maintains the m2eclipse
- plugin and is a strong supporter of Maven, publishes an entire
- <ulink url="http://www.sonatype.com/books/m2eclipse-book/reference">reference guide</ulink>
- dedicated to the plugin on their website.
+ Another useful plugin is m2eclipse. Both the TCK project and Web Beans
+ are use Maven 2. Therefore, to work with these projects in Eclipse, you
+ may wish to have support for Maven 2 project, which the m2eclipse
+ plugin provides. Instructions for using the m2eclipse update site to
+ add the m2eclipse plugin to Eclipse are provided on the m2eclipse home
+ page. For more, read the m2eclipse
+ <ulink url="http://www.sonatype.com/books/m2eclipse-book/reference">reference guide</ulink>
+ .
</para>
</section>
</chapter>
More information about the weld-commits
mailing list