Author: pete.muir(a)jboss.org Date: 2009-07-24 09:33:01 -0400 (Fri, 24 Jul 2009) New Revision: 3192 Modified: tck/trunk/doc/reference/en-US/installation.xml tck/trunk/doc/reference/pom.xml Log: attach war version of ref guide Modified: tck/trunk/doc/reference/en-US/installation.xml =================================================================== --- tck/trunk/doc/reference/en-US/installation.xml 2009-07-24 03:31:23 UTC (rev 3191) +++ tck/trunk/doc/reference/en-US/installation.xml 2009-07-24 13:33:01 UTC (rev 3192) @@ -1,57 +1,157 @@ <?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ ]> <chapter id="installation"> - <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.</para> - <section> - <title>Obtaining the Software</title> - <para>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. 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 available, so you need to check out the TCK from the JBoss SVN repository.</para> - <para>The TCK project downloads additional required libraries from the JBoss Maven 2 repository automatically, including the JBoss Test Harness and the JSR-299 API. You may follow this approach when assembling a TCK runner for your JSR-299 implementation.</para> - <para>The JSR-299: Contexts and Dependency Injection for Java EE 1.0 reference implementation (RI) is 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 on the JSR-299 RI by deploying the test artifacts to JBoss AS 5.1.</para> - <note> - <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> - </note> - <para>Executing the TCK requires a Java EE 5 or better runtime environment (i.e., application server), to which the test artifacts are deployed and invoked. The TCK does not depend on any particular Java EE implementation, only that it is compliant. However, if you decide to use JBoss AS 5.1 as the target container, you can use the JBoss AS 5.1 connector provided with the JBoss Test Harness, alleviating the requirement of implementing the <literal>org.jboss.jsr299.tck.spi.Containers</literal> SPI from the TCK porting package. You can download JBoss AS 5.1 from the JBoss AS <ulink url="http://jboss.org/jbossas/downloads">project page</ulink>.</para> - <para>Naturally, to execute Java programs, you must have a Java SE runtime environment. The TCK requires Java SE 1.5 or better, which you can obtain from the <ulink url="http://java.sun.com">Java Software</ulink> 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 &quot;install&quot; 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> - </listitem> - <listitem> - <para>Java EE 5 or better (e.g., JBoss AS 5.x or GlassFish V3)</para> - </listitem> - </itemizedlist> - <para>You can download Java SE from the <ulink url="http://java.sun.com/products">Java Software</ulink> -web site. - Refer to the instructions that accompany -the software for how to install it on your system. -You should be sure that the <literal>JAVA_HOME</literal> 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 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&apos;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&apos;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/ + <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. + </para> + <section> + <title>Obtaining the Software</title> + <para> + You can obtain the CDI TCK 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 + 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 + available, so you need to check out the TCK from the JBoss SVN + repository. + </para> + <para>The TCK project downloads additional required libraries from the + JBoss Maven 2 repository automatically, including the JBoss Test + Harness and the JSR-299 API. You may follow this approach when + assembling a TCK runner for your JSR-299 implementation.</para> + <para> + The JSR-299: Contexts and Dependency Injection for Java EE 1.0 + reference implementation (RI) is 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 on the JSR-299 RI by deploying the test artifacts to + JBoss AS 5.1. + </para> + <note> + <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> + </note> + <para> + Executing the TCK requires a Java EE 5 or better runtime environment + (i.e., application server), to which the test artifacts are deployed + and invoked. The TCK does not depend on any particular Java EE + implementation, only that it is compliant. However, if you decide to + use JBoss AS 5.1 as the target container, you can use the JBoss AS 5.1 + connector provided with the JBoss Test Harness, alleviating the + requirement of implementing the + <literal>org.jboss.jsr299.tck.spi.Containers</literal> + SPI from the TCK porting package. You can download JBoss AS 5.1 from + the JBoss AS + <ulink url="http://jboss.org/jbossas/downloads">project page</ulink> + . + </para> + <para> + Naturally, to execute Java programs, you must have a Java SE runtime + environment. The TCK requires Java SE 1.5 or better, which you can + obtain from the + <ulink url="http://java.sun.com">Java Software</ulink> + 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 &quot;install&quot; 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> + </listitem> + <listitem> + <para>Java EE 5 or better (e.g., JBoss AS 5.x or GlassFish V3) + </para> + </listitem> + </itemizedlist> + <para> + You can download Java SE from the + <ulink url="http://java.sun.com/products">Java Software</ulink> + web site. + Refer to the instructions that accompany + the software for how + to install it on your system. + You should be sure that the + <literal>JAVA_HOME</literal> + 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 + 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&apos;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&apos;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> - <section> - <title>Web Beans deployer</title> - <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 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> - <para>To install the web beans deployer, first 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> - </section> - <section> - <title>Maven 2 and Maven 2 artifacts</title> - <para>As mentioned earlier, because the JSR-299 RI and TCK are built with Maven 2, it&apos;s essential to have Maven 2 installed on the system. You can find documention on how to install Maven 2 in the <ulink url="http://www.sonatype.com/books/maven-book/reference/installation...: The Definitive Guide</ulink> book published by Sonatype. It merely entails extracting the distribution and putting the bin directory in the user&apos;s PATH environment variable.</para> - <programlisting>export PATH=&quot;&lt;maven2_install_dir&gt;/bin:$PATH&quot;</programlisting> + <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 + 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 + 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> + <para> + To install the web beans deployer, first 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> + </section> + <section> + <title>Maven 2 and Maven 2 artifacts</title> + <para>As + mentioned earlier, because the JSR-299 RI and TCK are built with + Maven 2, it&apos;s essential to have Maven 2 installed on the + system. You can find documention on how to install Maven 2 in the + <ulink + url="http://www.sonatype.com/books/maven-book/reference/installation...: The Definitive Guide</ulink> + book published by Sonatype. It merely entails extracting the + distribution and putting the bin directory in the user&apos;s PATH + environment variable. + </para> + <programlisting>export PATH=&quot;&lt;maven2_install_dir&gt;/bin:$PATH&quot;</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&apos;t want to use Maven at all, you&apos;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> Modified: tck/trunk/doc/reference/pom.xml =================================================================== --- tck/trunk/doc/reference/pom.xml 2009-07-24 03:31:23 UTC (rev 3191) +++ tck/trunk/doc/reference/pom.xml 2009-07-24 13:33:01 UTC (rev 3192) @@ -1,21 +1,19 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- - JBoss, Home of Professional Open Source - Copyright 2008, Red Hat Middleware LLC, and individual contributors - by the @authors tag. See the copyright.txt in the distribution for a - full listing of individual contributors. - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. ---> -<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> + <!-- + JBoss, Home of Professional Open Source Copyright 2008, Red Hat Middleware + LLC, and individual contributors by the @authors tag. See the + copyright.txt in the distribution for a full listing of individual + contributors. Licensed under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable + law or agreed to in writing, software distributed under the License is + distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the specific language + governing permissions and limitations under the License. + --> +<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> @@ -86,15 +84,13 @@ <sourceDocumentName>master.xml</sourceDocumentName> <masterTranslation>en-US</masterTranslation> <!-- - <translations> - <translation>it-IT</translation> - <translation>zh-CN</translation> - <translation>zh-TW</translation> - <translation>es-ES</translation> - <translation>ko-KR</translation> - <translation>de-DE</translation> - <translation>pt-BR</translation> - </translations> + <translations> <translation>it-IT</translation> + <translation>zh-CN</translation> + <translation>zh-TW</translation> + <translation>es-ES</translation> + <translation>ko-KR</translation> + <translation>de-DE</translation> + <translation>pt-BR</translation> </translations> --> <imageResource> <directory>${pom.basedir}/en-US</directory> @@ -137,8 +133,7 @@ </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-javadoc-plugin</artifactId> - <version>2.4</version> + <artifactId>maven-enforcer-plugin</artifactId> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> @@ -148,36 +143,35 @@ </configuration> </plugin> <plugin> - <artifactId>maven-antrun-plugin</artifactId> + <groupId>org.codehaus.mojo</groupId> + <artifactId>build-helper-maven-plugin</artifactId> <executions> <execution> - <phase>process-classes</phase> + <id>attach-zip</id> + <phase>package</phase> + <goals> + <goal>attach-artifact</goal> + </goals> <configuration> - <tasks> - <copy file="${basedir}/target/docbook/publish/en-US/pdf/jsr299-tck-reference.pdf" todir="${basedir}" /> - </tasks> + <artifacts> + <artifact> + <file>${project.build.outputDirectory}/${project.artifactId}-${project.version}.war</file> + <type>war</type> + </artifact> + </artifacts> </configuration> - <goals> - <goal>run</goal> - </goals> </execution> </executions> </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-enforcer-plugin</artifactId> - </plugin> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-release-plugin</artifactId> - <configuration> - <arguments>-Dbuild.translations</arguments> - </configuration> - </plugin> </plugins> <pluginManagement> <plugins> <plugin> + <groupId>org.codehaus.mojo</groupId> + <artifactId>build-helper-maven-plugin</artifactId> + <version>1.4</version> + </plugin> + <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-dependency-plugin</artifactId> <version>2.0</version> @@ -225,6 +219,11 @@ </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-javadoc-plugin</artifactId> + <version>2.4</version> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-install-plugin</artifactId> <version>2.2</version> </plugin> @@ -270,7 +269,8 @@ </requireMavenVersion> <requirePluginVersions> <unCheckedPlugins> - <unCheckedPlugin>org.apache.maven.plugins:maven-eclipse-plugin</unCheckedPlugin> + <unCheckedPlugin>org.apache.maven.plugins:maven-eclipse-plugin + </unCheckedPlugin> </unCheckedPlugins> </requirePluginVersions> </rules> @@ -288,19 +288,19 @@ </extension> </extensions> </build> - + <profiles> <profile> <activation> <property> - <name>build.translations</name> + <name>build.translations</name> </property> </activation> <build> <plugins> <plugin> - <groupId>org.jboss.maven.plugins</groupId> - <artifactId>maven-jdocbook-plugin</artifactId> + <groupId>org.jboss.maven.plugins</groupId> + <artifactId>maven-jdocbook-plugin</artifactId> <executions> <execution> <phase>process-resources</phase> @@ -314,8 +314,8 @@ </build> </profile> </profiles> - - <ciManagement> + + <ciManagement> <system>Hudson</system> <url /> @@ -330,16 +330,27 @@ <scm> - <connection>scm:svn:http://anonsvn.jboss.org/repos/webbeans/tck</con... - <developerConnection>scm:svn:https://svn.jboss.org/repos/webbeans/tck&l... + <connection>scm:svn:http://anonsvn.jboss.org/repos/webbeans/tck + </connection> + <developerConnection>scm:svn:https://svn.jboss.org/repos/webbeans/tck + </developerConnection> <url>http://fisheye.jboss.org/browse/WebBeans/tck</url> </scm> - - <distributionManagement> + + <distributionManagement> <repository> - <!-- Copy the dist to the local checkout of the JBoss maven2 repo ${maven.repository.root} --> - <!-- It is anticipated that ${maven.repository.root} be set in user's settings.xml --> - <!-- todo : replace this with direct svn access once the svnkit providers are available --> + <!-- + Copy the dist to the local checkout of the JBoss maven2 repo + ${maven.repository.root} + --> + <!-- + It is anticipated that ${maven.repository.root} be set in user's + settings.xml + --> + <!-- + todo : replace this with direct svn access once the svnkit providers + are available + --> <id>repository.jboss.org</id> <url>file://${maven.repository.root}</url> </repository>