[webbeans-commits] Webbeans SVN: r3194 - tck/trunk/doc/reference/en-US.
webbeans-commits at lists.jboss.org
webbeans-commits at lists.jboss.org
Fri Jul 24 09:43:08 EDT 2009
Author: pete.muir at jboss.org
Date: 2009-07-24 09:43:07 -0400 (Fri, 24 Jul 2009)
New Revision: 3194
Modified:
tck/trunk/doc/reference/en-US/installation.xml
Log:
ws
Modified: tck/trunk/doc/reference/en-US/installation.xml
===================================================================
--- tck/trunk/doc/reference/en-US/installation.xml 2009-07-24 13:37:30 UTC (rev 3193)
+++ tck/trunk/doc/reference/en-US/installation.xml 2009-07-24 13:43:07 UTC (rev 3194)
@@ -4,16 +4,17 @@
<title>Installation</title>
<para>
This chapter explains how to obtain the TCK and supporting software and
- provides recommendations for how to install/extract it on your system.
+ provides
+ recommendations for how to install/extract it on your system.
</para>
<section>
<title>Obtaining the Software</title>
<para>
- You can obtain the CDI TCK release from the
+ You can obtain the JSR-299 TCK project from the
+ <ulink url="http://anonsvn.jboss.org/repos/webbeans/tck/trunk">JBoss SVN repository</ulink>
+ or you can download a release from the
<ulink url="http://seamframework.org/Download">download page</ulink>
- on Seam Framework website. You can also obtain the latest suite from the
- <ulink url="http://anonsvn.jboss.org/repos/webbeans/tck/trunk">JBoss SVN repository</ulink>
- or you can download a The JSR-299 TCK is distributed as a ZIP
+ on Seam Framework website. The JSR-299 TCK is distributed as a ZIP
file, which contains a multi-module Maven 2 project, the test suite,
the test suite descriptor, the audit document and documentation. At the
time of writing there is no official release of the JSR-299 TCK
@@ -34,10 +35,12 @@
JBoss AS 5.1.
</para>
<note>
- <para>The JSR-299 RI (Web Beans) is not required for running the
+ <para>
+ The JSR-299 RI (Web Beans) is not required for running the
JSR-299 TCK, but it can be useful as a reference for familiarizing
yourself with the TCK before testing your own JSR-299
- implementation.</para>
+ implementation.
+ </para>
</note>
<para>
Executing the TCK requires a Java EE 5 or better runtime environment
@@ -61,19 +64,28 @@
website.
</para>
</section>
+
<section>
<title>Installing the Software</title>
- <para>Installing Java software is a bit of a misnomer. The only software
- you have to "install" are the runtime environments. The
- remaining software is merely extracted in a workspace directory of your
- choice.</para>
+
+ <para>
+ Installing Java software is a bit of a misnomer. The only software
+ you have to
+ "install" are the runtime environments. The
+ remaining software
+ is merely extracted in a workspace directory of your
+ choice.
+ </para>
<para>The TCK requires the following two Java runtime environments:</para>
<itemizedlist>
<listitem>
- <para>Java SE 5.0 or better</para>
+ <para>
+ Java SE 5.0 or better
+ </para>
</listitem>
<listitem>
- <para>Java EE 5 or better (e.g., JBoss AS 5.x or GlassFish V3)
+ <para>
+ Java EE 5 or better (e.g., JBoss AS 5.x or GlassFish V3)
</para>
</listitem>
</itemizedlist>
@@ -89,42 +101,61 @@
environment variable is assigned to the location of the Java SE
software before you consider the installation complete.
</para>
- <para>Which Java EE runtime environment to use is your choice. Keep in
+ <para>
+ Which Java EE runtime environment to use is your choice. Keep in
mind, though, that you must provide a custom connector if the
application server you are using is not supported by the JBoss Test
Harness. At the time of writing, JBoss AS 5.1 is the only supported
application server (table showing supported versions?) and is therefore
- the recommend Java EE runtime environment.</para>
- <para>JBoss
- AS 5.1 can be downloaded from the JBoss AS project page. Refer to the
- instructions that accompany the software to learn how to install it on
- your system. Although not required, it's recommended that you set
+ the recommend Java EE runtime environment.
+ </para>
+ <para>
+ JBoss
+ AS 5.1 can be downloaded from the JBoss AS project page. Refer to
the
+ instructions that accompany the software to learn how to install it
+ on
+ your system. Although not required, it's recommended that you
+ set
+ the
<literal>JBOSS_HOME</literal>
environment variable to the location of the JBoss AS software.
</para>
- <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
- jsr299-related projects. Then, extract the TCK distribution into a
- subfolder named tck. If you have downloaded the Web Beans distribution,
- extract it into a sibling folder named webbeans. The resulting folder
- structure is shown here:</para>
+ <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
+ jsr299-related
+ projects. Then, extract the TCK distribution into a
+ subfolder named tck.
+ If you have downloaded the Web Beans distribution,
+ extract it into a
+ sibling folder named webbeans. The resulting folder
+ structure is shown
+ here:
+ </para>
<programlisting>jsr299/
webbeans/
tck/</programlisting>
- <para>This arrangement becomes important later on when executing tests in
- Eclipse.</para>
+ <para>
+ This arrangement becomes important later on when executing tests in
+ Eclipse.
+ </para>
<section>
<title>Web Beans deployer</title>
- <para>When the TCK test suite is run (using in-container mode), it
+ <para>
+ When the TCK test suite is run (using in-container mode), it
expects to test the JSR-299 implementation provided by the
application server. Therefore, you need to install the JSR-299
- implementation in the application server.</para>
- <para>The JSR-299 RI (Web Beans) includes a JBoss AS integration
+ implementation in the application server.
+ </para>
+ <para>
+ The JSR-299 RI (Web Beans) includes a JBoss AS integration
project that installs a special deployer on JBoss AS 5.x that
activates the JSR-299 RI per application when the application is
deployed. The Web Beans deployer is installed in JBoss AS 5.x from
- the jboss-as directory in the Web Beans distribution.</para>
+ the jboss-as directory in the Web Beans distribution.
+ </para>
<para>
To install the web beans deployer, first make sure the
<literal>jboss.home</literal>
@@ -132,16 +163,21 @@
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>
+ <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
+ <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>
+ defined in the build.properties files in that directory.
+ </para>
</section>
<section>
<title>Maven 2 and Maven 2 artifacts</title>
- <para>As
+ <para>
+ As
mentioned earlier, because the JSR-299 RI and TCK are built with
Maven 2, it's essential to have Maven 2 installed on the
system. You can find documention on how to install Maven 2 in the
@@ -152,27 +188,85 @@
environment variable.
</para>
<programlisting>export PATH="<maven2_install_dir>/bin:$PATH"</programlisting>
- <para>The TCK runner, introduced in section 4.2, is organized as a Maven 2 project (herein referred to as a Maven project). Therefore, it expects to retrieve all dependent artifacts (JAR files) from the local Maven repository. If the artifact is missing from the local repository, it will be fetched remotely from the JBoss Maven repository and cached in the local repository.</para>
- <para>One option for executing the TCK the first time is to allow Maven fetch all required dependencies. If you want to use your own implementation of the TCK porting package, or if you are running the TCK against your own JSR-299 implementation, you need to install the corresponding artifacts into your local Maven repository, at the very least. If you don't want to use Maven at all, you'll need to implement a project the executes the TCK runner from scratch. This guide assumes the use of the Maven project structure.</para>
- <para>If your JSR-299 implementation uses a Maven project structure, you can have Maven install the artifact into your local Maven repository in the normal way:</para>
+ <para>
+ The TCK runner, introduced in section 4.2, is organized as a Maven 2
+ project (herein referred to as a Maven project). Therefore, it expects
+ to retrieve all dependent artifacts (JAR files) from the local Maven
+ repository. If the artifact is missing from the local repository, it
+ will be fetched remotely from the JBoss Maven repository and cached in
+ the local repository.
+ </para>
+ <para>
+ One option for executing the TCK the first time is to allow Maven fetch
+ all required dependencies. If you want to use your own implementation
+ of the TCK porting package, or if you are running the TCK against your
+ own JSR-299 implementation, you need to install the corresponding
+ artifacts into your local Maven repository, at the very least. If you
+ don't want to use Maven at all, you'll need to implement a
+ project the executes the TCK runner from scratch. This guide assumes
+ the use of the Maven project structure.
+ </para>
+ <para>
+ If your JSR-299 implementation uses a Maven project structure, you can
+ have Maven install the artifact into your local Maven repository in the
+ normal way:
+ </para>
<programlisting>mvn install</programlisting>
- <para>If you are not using a Maven project structure, you can install each artifact into your local Maven respository using the install goal:</para>
+ <para>
+ If you are not using a Maven project structure, you can install each
+ artifact into your local Maven respository using the install goal:
+ </para>
<programlisting>mvn install:install-file \
-Dfile=jsr299-impl.jar \
-DgroupId=com.company.jsr299 \
-DartifactId=jsf299-impl \
-Dversion=1.0 \
-Dpackaging=jar</programlisting>
- <para>You can use this command template for installing any JAR file you need into your local Maven respository.</para>
+ <para>
+ You can use this command template for installing any JAR file you need
+ into your local Maven respository.
+ </para>
<note>
- <para>The JSR-299 implementation doesn't have to be on the classpath of the TCK runner when executing the TCK in in-container mode. The JSR-299 implemention is expected to be provided by a compliant Java EE container. However, the implementation does have to be on the classpath when executing the test suite in standalone mode.</para>
+ <para>
+ The JSR-299 implementation doesn't have to be on the classpath
+ of the TCK runner when executing the TCK in in-container mode. The
+ JSR-299 implemention is expected to be provided by a compliant Java
+ EE container. However, the implementation does have to be on the
+ classpath when executing the test suite in standalone mode.
+ </para>
</note>
</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 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>.</para>
- <para>Another essential 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 need 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.</para>
+ <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
+ 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>.
+ </para>
+ <para>
+ Another essential 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 need 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.
+ </para>
</section>
</section>
</chapter>
More information about the weld-commits
mailing list