From webbeans-commits at lists.jboss.org Thu Jul 23 20:27:10 2009 Content-Type: multipart/mixed; boundary="===============5413800460249422621==" MIME-Version: 1.0 From: webbeans-commits at lists.jboss.org To: weld-commits at lists.jboss.org Subject: [webbeans-commits] Webbeans SVN: r3182 - tck/trunk/doc/reference/en-US. Date: Thu, 23 Jul 2009 20:27:10 -0400 Message-ID: <200907240027.n6O0RAnj018729@svn01.web.mwc.hst.phx2.redhat.com> --===============5413800460249422621== 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-23 20:27:10 -0400 (Thu, 23 Jul 2009) New Revision: 3182 Modified: tck/trunk/doc/reference/en-US/Author_Group.xml tck/trunk/doc/reference/en-US/Book_Info.xml tck/trunk/doc/reference/en-US/Book_Preface.xml tck/trunk/doc/reference/en-US/introduction.xml tck/trunk/doc/reference/en-US/master.xml Log: various legal blurb, changes to terms, changes to whats bundled. Modified: tck/trunk/doc/reference/en-US/Author_Group.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/Author_Group.xml 2009-07-23 23:16:44 UTC = (rev 3181) +++ tck/trunk/doc/reference/en-US/Author_Group.xml 2009-07-24 00:27:10 UTC = (rev 3182) @@ -1,5 +1,7 @@ + + Gavin Modified: tck/trunk/doc/reference/en-US/Book_Info.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/Book_Info.xml 2009-07-23 23:16:44 UTC (re= v 3181) +++ tck/trunk/doc/reference/en-US/Book_Info.xml 2009-07-24 00:27:10 UTC (re= v 3182) @@ -1,6 +1,25 @@ - Technology Compatibility Kit Reference Guide for JSR-299: Context= and Dependency Injection for Java EE - + + 2009 + + Red Hat Middleware LLC, and individual contributors listed as + authors. + + + 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. + + Technology Compatibility Kit Reference Guide for JSR-299: Contex= t and + Dependency Injection for Java EE + Specification Lead: Red Hat Middleware LLC + Modified: tck/trunk/doc/reference/en-US/Book_Preface.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/Book_Preface.xml 2009-07-23 23:16:44 UTC = (rev 3181) +++ tck/trunk/doc/reference/en-US/Book_Preface.xml 2009-07-24 00:27:10 UTC = (rev 3182) @@ -13,21 +13,30 @@ The CDI TCK is built atop the JBoss Test Harness, a portable and configurable automated test suite for authoring unit and integration= tests in a Java EE environment. The CDI TCK 1.0.0 uses the JBoss Test - Harness version 1.0.0 to execute the test suite. + Harness + version 1.0.0 to execute the test suite. = + + The CDI TCK is provide under the + Apache Pub= lic License 2.0 + . + +
Who Should Use This Book - This guide is for implementors of the Context and Dependency Inje= ction + This guide is for implementors of the Context and Dependency + Injection for Java EE 1.0 technology to assist in running the test - suite that verifies the compatibility of their implementation. + suite + that verifies the compatibility of their implementation.
- = +
Before You Read This Book - = + Before reading this guide, you should familiarize yourself with t= he Java EE programming model, specifically the Enterprise JavaBeans = (EJB) @@ -39,7 +48,8 @@ The CDI TCK is based on the Context and Dependency Injection for - Java EE technology specification 1.0 (JSR-299). Information about= the + Java EE + technology specification 1.0 (JSR-299). Information about the specification, including links to the specification documents, ca= n be found on the JSR-299 JCP = page @@ -47,19 +57,24 @@ Before running the tests in the CDI TCK, read and become - familiar with the JBoss Test Harness Reference Guide (pending), w= hich - describes how the test harness functions. + familiar + with the JBoss Test Harness Reference Guide (pending), which + describes + how the test harness functions. - = +
- = + How This Book Is Organized If you are running the CDI TCK for the first time, read Chapter - 1 and Chapter 2 completely for the necessary background informati= on - about the TCK and its purpose. Once you have reviewed that materi= al, - perform the steps outlined in the remaining chapters. + 1 and + Chapter 2 completely for the necessary background information + about the + TCK and its purpose. Once you have reviewed that material, + perform the + steps outlined in the remaining chapters. Modified: tck/trunk/doc/reference/en-US/introduction.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/introduction.xml 2009-07-23 23:16:44 UTC = (rev 3181) +++ tck/trunk/doc/reference/en-US/introduction.xml 2009-07-24 00:27:10 UTC = (rev 3182) @@ -13,10 +13,10 @@ A TCK, or Technology Compatibility Kit, is one of the three requi= red pieces for any JSR (the other two being the specification documen= t and the reference implementation). The TCK is a set of tools and test= s to - verify that a licensee's implementation of the Sun technology con= forms - to the specification. The tests are the primary component, but the - tools serve an equally critical role of providing a framework and= /or - set of SPIs for executing the tests. + verify that an implementation of the technology conforms to the + specification. The tests are the primary component, but the tools= serve + an equally critical role of providing a framework and/or set of S= PIs + for executing the tests. The tests in the TCK are derived from assertions in the written @@ -47,24 +47,18 @@ the rules laid out in the specification. - Executing the TCK is a form of compatibility testing. It's - important - to understand that compatibility testing is distinctly - different from - product testing. The TCK is not concerned with - robustness, performance - or ease of use, and therefore cannot vouch for - how well an - implementation meets these criteria. What a TCK can do is - to ensure the - exactness of an implementation as it relates to the - specification. + Executing the TCK is a form of compatibility testing. It's import= ant + to understand that compatibility testing is distinctly different = from + product testing. The TCK is not concerned with robustness, perfor= mance + or ease of use, and therefore cannot vouch for how well an + implementation meets these criteria. What a TCK can do is to ensu= re the + exactness of an implementation as it relates to the specification. Compatibility testing of any feature relies on both a complete specification and a complete reference implementation. The refere= nce implementation demonstrates how each test can be passed and provi= des - additional context to the licensee during development for the + additional context to the implementor during development for the corresponding assertion. = @@ -77,7 +71,7 @@ - Compatibility testing is the means by which Sun ensures + Compatibility testing is the means by which the JCP ensu= res that the Java platform does not become fragmented as it's ported to different operating systems and hardware. @@ -105,7 +99,7 @@ - The JSR-299 specification goes to great lengths to ensure that + The CDI specification goes to great lengths to ensure that programs written for Java EE are compatible and the TCK is rig= orous about enforcing the rules the specification lays down. @@ -114,19 +108,19 @@
=
- About the JSR-299 TCK + About the CDI TCK = - The JSR-299 TCK is designed as a portable, configurable and - automated test suite for verifying the compatibility of a license= e=E2=80=99s - implementation of the JSR-299: Contexts and Dependency Injection = for - Java EE specification. The test suite is built on TestNG and prov= ides a - series of extensions that allow runtime packaging and deployment = of JEE - artifacts for in-container testing. + The CDI TCK is designed as a portable, configurable and automated + test suite for verifying the compatibility of an implementation o= f the + JSR-299: Contexts and Dependency Injection for Java EE specificat= ion. + The test suite is built on TestNG and provides a series of extens= ions + that allow runtime packaging and deployment of JEE artifacts for + in-container testing. - The JSR-299 TCK harness is based on the JBoss Test harness, wh= ich + The CDI TCK harness is based on the JBoss Test harness, which provides most of the aforementioned functionality. @@ -136,50 +130,50 @@ annotations. The artifact produced can be either a WAR or an EAR. - The benefit of the declarative approach is that it allows many of - the tests to be executed in a standalone implementation of JSR-29= 9, - accounting for a boast in developer productivity. However, an - implementation is only valid if all tests pass using the in-conta= iner - execution mode. The standalone mode is merely a developer conveni= ence. + The declarative approach allows many of the tests to be executed = in + a standalone implementation of CDI, accounting for a boast in dev= eloper + productivity. However, an implementation is only valid if all tes= ts + pass using the in-container execution mode. The standalone mode is + merely a developer convenience. =
- JSR-299 TCK Specifications and Requirements + CDI TCK Specifications and Requirements This section lists the applicable requirements and specificati= ons - for the JSR-299 TCK. + for the CDI TCK. Specification requirements - - Software requirements for a JSR-299 implementation are - itemized in section 1.2, "Relationship to other - specifications" in the JSR-299 specification, with - details provided throughout the specification. + - Software requirements for a CDI implementation are ite= mized + in section 1.2, "Relationship to other specifications" i= n the + CDI specification, with details provided throughout the + specification. Contexts and Dependency Injectio= n for Java EE 1.0 API - - The Java API defined in the JSR-299 specification and - provided by the reference implementation. + - The Java API defined in the CDI specification and prov= ided + by the reference implementation. JBoss Test Harness - - The JSR-299 TCK requires version 1.0.0 of the JBoss Te= st - Harness + - The CDI TCK requires version 1.0.0 of the JBoss Test + Harness. The Harness is based on TestNG 5.x. Porting Package - An implementation of SPIs that are required for the te= st - suite to run the in-container tests and at times, consul= t the - JSR-299 implementation + suite to run the in-container tests and at times extend = the + CDI 1.0 API to provide extra information to the TCK @@ -187,41 +181,28 @@ TCK Audit Tool - An itemization of the assertions in the specification documents which are cross referenced by the individual t= ests. - Relevant for producing a test coverage report. + Describes how well the TCK covers the specification. Reference runtime - The designated reference runtimes for compatibility te= sting - of the JSR-299 specification is the Sun Java Platform, - Enterprise Edition (Java EE) 5 - reference implementation (RI). - See details at Java EE 5 + of the CDI specification is the Sun Java Platform, Enter= prise + Edition (Java EE) 6 reference implementation (RI). See d= etails + at Java EE 6 ( - ht= tp://java.sun.com/javaee/5/docs/api/ + ht= tp://java.sun.com/javaee/6/docs/api/ ). - - - Maven 2 - - Although licensees are free to execute the TCK however= they - decide, the recommended approach is to use Maven 2. Both= the - JSR-299 RI and the TCK are build using Maven 2. Furtherm= ore, - the TCK runner used to validate the RI, a resource which= can - be leveraged by licensee to test their own implementatio= ns, is - also Maven 2 project. Therefore, it's highly recomm= ended - to have Maven 2 installed on the system. - -
=
- JSR-299 TCK Components - The JSR-299 TCK includes the following components: + CDI TCK Components + The CDI TCK includes the following components: @@ -240,7 +221,7 @@ Porting Package SPIs - - Extensions to the JSR-299 SPIs to allow testing of a + - Extensions to the CDI SPIs to allow testing of a container. @@ -248,19 +229,12 @@ The test suite , which is a collection of TestNG tests, the TestNG test= suite - descriptor and supplamental files that provide data for = the - automatic running of tests through the JBoss Test harnes= s. + descriptor and supplemental resources that configure CDI= and + other software components. - JBoss TCK Runner - - An implementation of the JBoss Test Harness deployment= APIs - for deploying artifacts to JBoss AS 5.1 - - - - TCK documentation accompanied by release notes identifying updates between versions. @@ -268,46 +242,42 @@ - The JSR-299 TCK has been tested with the following: + The CDI TCK has been tested with the following: + + + Sun Microsystems Inc. will implement the porting package and + test the CDI RI on the Java EE Reference Implementation + + - Java Platform, Standard Edition, Version 5.0 (Java S= E 1.5) - + JBoss AS 5.1.0.GA - - Java Platform, Enterprise Edition, Version 5 referen= ce - implementation (Java EE 5 RI) - - - JBoss AS 5.1? - - The JSR-299 TCK tests run on the following platforms: + The CDI TCK tests run on the following platforms: - Windows XP? + Red Hat Enterprise Linux 5.2 - - RHEL 5.2? -
The JBoss Test Harness - JSR-299 TCK leverages the JBoss Test Harness. The JBoss Test + The CDI TCK leverages the JBoss Test Harness. The JBoss Test Harness is a testing framework based on TestNG that provides a series of extensions that allow runtime packaging and deployme= nt of - Java EE artifacts (EAR or WAR) for in-container testing. It&ap= os;s - important to note that the JBoss Test Harness has no relation = to or - dependency on the JBoss Application Server (AS). + Java EE artifacts (EAR or WAR) for in-container testing. It's + important to note that the JBoss Test Harness has no relation = with, + or dependency on the JBoss Application Server (JBoss AS). - JSR-299 supports Java EE 5, Java EE 6, Java EE 6 Web Profile a= nd - the Embeddable EJB 3.1. Accordingly, the TCK will be able to r= un in - any of these environments, though at the time of writing the - Embedded EJB (EEJB) mode isn't operational. + CDI supports Java EE 5, Java EE 6, Java EE 6 Web Profile and t= he + Embeddable EJB 3.1. The TCK will run on any of these runtimes,= but + is only part of the CTS for Java EE 6, Java EE 6 Web Profile a= nd + Embeddable EJB 3.1 (SUN: Please confirm these are the CTS the = CDI + TCK will run in). @@ -316,10 +286,10 @@ used in this reference guide. This term refers to running t= he test suite in any of the aforementioned environments, whilst standalone - refers to running the tests outside the container via a JSR= -299 + refers to running the tests outside the container via a CDI implementation-specific standalone bootstrap. The standalon= e mode - only runs those tests which don't require EJB, Servlet= or - JSF to be present. + only runs those tests which the CDI RI can run without depl= oyment + in a Java EE container. @@ -451,16 +421,16 @@
The Porting Package - The JSR-299 TCK relies on an implementation of the porting - package to function. The porting package can be divided into t= wo - parts. The first part is comprised of extensions to the JSR-29= 9 SPIs - to allow testing of a container. The second part must contain - implementations of the JBoss Test Harness deployment APIs for - deploying test artifacts to a given container. + The CDI TCK relies on an implementation of the porting package= to + function. The porting package can be divided into two parts. T= he + first part is comprised of extensions to the JSR-299 SPIs to a= llow + testing of a container. The second part must implement he JBos= s Test + Harness artifact deployment APIs for deploying artifacts to th= e Java + EE container. As mentioned earlier, there are times when the tests need to t= ap - directly into the JSR-299 implementation to manipulate behavio= r or + directly into the CDI implementation to manipulate behavior or verify results. The porting package includes a set of SPIs that provide the TCK this level of access without tying the tests t= o a given implementation. @@ -490,24 +460,40 @@ + + Complete JavaDoc describing the requirements for implementation + is provided. + + + To run the full TCK you must additionally implement org.jboss.testharness.spi.Containers - , which handles deploying the test artifact to the container. = If you - wish to run the TCK in standalone mode, you must also implement + , which handles deploying the test artifact to the container. = An + implementations of this API is already available for JBoss AS = 5.1. + Therefore, you only need to implement this part of the porting + package if you wish to use another container. + + + + Red Hat Middleware LLC encourages CDI implementators to + contribute JBoss Test Harness Deployment API implementation= s for + other containers under the ASL license. Please contact the = CDI + TCK lead. = + + + + If you wish to run the TCK in standalone mode, a CDI implement= ation + must provide an implementation of org.jboss.testharness.spi.StandaloneContainers - . Implementations of these APIs are already available for JBos= s AS - 5.1. Therefore, you only need to implement this part of the po= rting - package if you wish to use a container other than JBoss AS 5.1= , for - instance GlassFish V3. + . The CDI RI provides an implementation of this API; see the RI + reference guide. - The default configuration for the TCK is property-based. - Therefore, you specify the implementation class for all of the= se - SPIs in a properties file. There are additional properties for - controlling whether the tests are run in standalone or in-cont= ainer - mode. Optionally, you can use system properties to configure t= he - TCK. Details are provided in section 4.1. + The default configuration for the TCK uses Java properties fil= es. + The implementation class for all of these SPIs is placed in th= is + properties file. Optionally, you can use system properties to + configure the TCK. Details are provided in section 4.1.
@@ -519,12 +505,11 @@ coverage report. - The audit document is provided along with the TCK and each - assertion matches against at least one test. Each assertion is - defined with a reference to a chapter, section and paragraph f= rom - the specification document, making it easy for the licensee to - locate the language in the specification document that support= s the - feature being tested. + The audit document is provided along with the TCK; at least 75% + of assertions are tested. Each assertion is defined with a ref= erence + to a chapter, section and paragraph from the specification doc= ument, + making it easy for the implementor to locate the language in t= he + specification document that supports the feature being tested.
Modified: tck/trunk/doc/reference/en-US/master.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/master.xml 2009-07-23 23:16:44 UTC (rev 3= 181) +++ tck/trunk/doc/reference/en-US/master.xml 2009-07-24 00:27:10 UTC (rev 3= 182) @@ -1,5 +1,5 @@ - + --===============5413800460249422621==--