From webbeans-commits at lists.jboss.org Fri Jul 24 10:13:27 2009 Content-Type: multipart/mixed; boundary="===============7602484865449170271==" MIME-Version: 1.0 From: webbeans-commits at lists.jboss.org To: weld-commits at lists.jboss.org Subject: [webbeans-commits] Webbeans SVN: r3195 - tck/trunk/doc/reference/en-US. Date: Fri, 24 Jul 2009 10:13:27 -0400 Message-ID: <200907241413.n6OEDR0q021917@svn01.web.mwc.hst.phx2.redhat.com> --===============7602484865449170271== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: pete.muir(a)jboss.org Date: 2009-07-24 10:13:27 -0400 (Fri, 24 Jul 2009) New Revision: 3195 Modified: tck/trunk/doc/reference/en-US/installation.xml Log: Remove a lot of JBoss / Web Beans specific info, it's not really relevant Modified: tck/trunk/doc/reference/en-US/installation.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- tck/trunk/doc/reference/en-US/installation.xml 2009-07-24 13:43:07 UTC = (rev 3194) +++ tck/trunk/doc/reference/en-US/installation.xml 2009-07-24 14:13:27 UTC = (rev 3195) @@ -4,62 +4,63 @@ Installation 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 syste= m.
Obtaining the Software - You can obtain the JSR-299 TCK project from the - = JBoss SVN repository - or you can download a release from the + You can obtain a release of the CDI TCK project from the from the download page on Seam Framework website. The JSR-299 TCK is distributed as a ZIP - file, which contains a multi-module Maven 2 project, the test sui= te, - 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. + file, which contains the TCK artifacts (the test suite binary and + source, porting package API binary and source, the test suite + descriptor, the audit source and report) in + /artifacts + , the TCK library dependencies in + /lib + and documentation in + /lib + . - The TCK project downloads additional required libraries from t= he - 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. - The JSR-299: Contexts and Dependency Injection for Java EE 1.0 - reference implementation (RI) is Web Beans. You can obtain the la= test - Web Beans release from the - download page - on Seam Framework website. Web Beans includes a TCK runner that - executes the TCK on the JSR-299 RI by deploying the test artifact= s to - JBoss AS 5.1. + You can also download the currnet source code from + = JBoss SVN repository + . - - - The JSR-299 RI (Web Beans) is not required for running the - JSR-299 TCK, but it can be useful as a reference for familiari= zing - yourself with the TCK before testing your own JSR-299 - implementation. - - + The TCK project is available in the JBoss Maven 2 repository as + org.jboss.jsr299.tck:jsr299-tck-impl + ; the POM defines all dependencies required to run the TCK. + + Executing the TCK requires a Java EE 5 or better runtime environm= ent (i.e., application server), to which the test artifacts are deplo= yed 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 A= S 5.1 - connector provided with the JBoss Test Harness, alleviating the - requirement of implementing the - org.jboss.jsr299.tck.spi.Containers - SPI from the TCK porting package. You can download JBoss AS 5.1 f= rom + implementation. + + + The JSR-299: Contexts and Dependency Injection for Java EE 1.0 + reference implementation (RI) project is named Web Beans. You can + obtain the latest Web Beans release from the + download page + on Seam Framework website. Web Beans includes a TCK runner that + executes the TCK using Web Beans as the CDI implementation and JB= oss AS + as the Java EE runtime. You can download JBoss AS 5.1 from the JBoss AS project page . + + + Web Beans is not required for running the CDI TCK, but it can = be + used as a reference for familiarizing yourself with the TCK be= fore + testing your own CDI implementation. + + Naturally, to execute Java programs, you must have a Java SE runt= ime - environment. The TCK requires Java SE 1.5 or better, which you can - obtain from the + environment. The TCK requires Java 5 or better, which you can obt= ain + from the Java Software website. @@ -70,17 +71,17 @@ = 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 + you have to "install" are the runtime environments. The + remaining software is merely extracted in a workspace directory o= f your choice. - - The TCK requires the following two Java runtime environments:<= /para> + + + The TCK requires the following two Java runtime environments: + - Java SE 5.0 or better + Java 5 or better @@ -90,74 +91,55 @@ - You can download Java SE from the - Java Software - web site. - Refer to the instructions that accompany - the software for how - to install it on your system. - You should be sure that the - JAVA_HOME - environment variable is assigned to the location of the Java SE - software before you consider the installation complete. + You should refer to vendor instructions for how to install the + runtime. + + + If you are using JBoss AS, it's recommended that you set the + JBOSS_HOME + environment variable to the location of the JBoss AS software. + + - 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 Te= st - Harness. At the time of writing, JBoss AS 5.1 is the only support= ed - application server (table showing supported versions?) and is the= refore - the recommend Java EE runtime environment. + 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 distrib= ution, + extract it into a sibling folder named webbeans. The resulting fo= lder + structure is shown here: - - 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 - JBOSS_HOME - environment variable to the location of the JBoss AS software. - - - 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: - jsr299/ webbeans/ tck/ - - This arrangement becomes important later on when executing tests = in - Eclipse. - -
- Web Beans deployer + - 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. + This layout is assumed through all descriptions in this refere= nce + guide. + + + - 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. + Web Beans is built as a modular library, and as such can be + retro-fitted to Java EE 5 products as required. Red Hat Middle= ware + 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). T= his + allows you to run the CDI TCK in JBoss 5.1. - To install the web beans deployer, first make sure the + CDI is an integral part of Java EE 6 and above, and as such Ja= va + EE 6 runtimes are expected to bundle a CDI implementation. + + + To perform the upgrade to JBoss AS 5.1: = + + + Change to the webbeans directory. + + + Make sure the jboss.home property in the local.build.properties file in the jboss-as directory references a JBoss AS 5.1 installation: @@ -173,68 +155,21 @@ repository on demand. The versions of the libraries fetched are defined in the build.properties files in that directory. -
-
- Maven 2 and Maven 2 artifacts + + - As - mentioned earlier, because the JSR-299 RI and TCK are built wi= th - 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 + If decide to use Maven 2 to execute the tests (as Web Beans do= es + with JBoss AS), you need to install Maven You can documention = on how + to install Maven 2 in the Maven: The Definitive Guide - book published by Sonatype. It merely entails extracting the - distribution and putting the bin directory in the user's = PATH - environment variable. + book published by Sonatype. - export PATH=3D"<maven2_install_dir>/bi= n:$PATH" - - The TCK runner, introduced in section 4.2, is organized as a Mave= n 2 = - project (herein referred to as a Maven project). Therefore, it ex= pects = - to retrieve all dependent artifacts (JAR files) from the local Ma= ven = - repository. If the artifact is missing from the local repository,= it = - will be fetched remotely from the JBoss Maven repository and cach= ed in = - the local repository. - - - One option for executing the TCK the first time is to allow Maven= fetch - all required dependencies. If you want to use your own implementa= tion = - 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 implemen= t a = - project the executes the TCK runner from scratch. This guide assu= mes = - the use of the Maven project structure. - - - If your JSR-299 implementation uses a Maven project structure, yo= u can = - have Maven install the artifact into your local Maven repository = in the = - normal way: - - mvn install - - If you are not using a Maven project structure, you can install e= ach = - artifact into your local Maven respository using the install goal: - - mvn install:install-file \ --Dfile=3Djsr299-impl.jar \ --DgroupId=3Dcom.company.jsr299 \ --DartifactId=3Djsf299-impl \ --Dversion=3D1.0 \ --Dpackaging=3Djar - - You can use this command template for installing any JAR file you= need = - into your local Maven respository. - - - - The JSR-299 implementation doesn't have to be on the clas= spath = - 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 t= he = - classpath when executing the test suite in standalone mode. + + Maven will retrieve all TCK and Web Beans dependencies from th= e = + JBoss Maven repository. - +
Eclipse plugins @@ -256,10 +191,10 @@ Eclipse page. - Another essential plugin is m2eclipse. Both the TCK project and t= he = + 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 need to have support for Maven 2 project, which the = + Eclipse, you may wish to have support for Maven 2 project, which = the = m2eclipse plugin provides. Instructions for using the m2eclipse u= pdate = site to add the m2eclipse plugin to Eclipse are provided on the = m2eclipse home page. Sonatype, the company that maintains the m2e= clipse = @@ -267,6 +202,5 @@ reference guide = dedicated to the plugin on their website. -
-
+ --===============7602484865449170271==--