[webbeans-commits] Webbeans SVN: r3182 - tck/trunk/doc/reference/en-US.
webbeans-commits at lists.jboss.org
webbeans-commits at lists.jboss.org
Thu Jul 23 20:27:10 EDT 2009
Author: pete.muir at 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
===================================================================
--- 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 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE authorgroup PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ ]>
+
+
<authorgroup>
<author>
<firstname>Gavin</firstname>
Modified: tck/trunk/doc/reference/en-US/Book_Info.xml
===================================================================
--- tck/trunk/doc/reference/en-US/Book_Info.xml 2009-07-23 23:16:44 UTC (rev 3181)
+++ tck/trunk/doc/reference/en-US/Book_Info.xml 2009-07-24 00:27:10 UTC (rev 3182)
@@ -1,6 +1,25 @@
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ ]>
<bookinfo>
- <title>Technology Compatibility Kit Reference Guide for JSR-299: Context and Dependency Injection for Java EE</title>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Author_Group.xml"/>
+ <copyright>
+ <year>2009</year>
+ <holder>
+ Red Hat Middleware LLC, and individual contributors listed as
+ authors.
+ </holder>
+ </copyright>
+ <releaseinfo><literallayout>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.</literallayout></releaseinfo>
+
+ <title>Technology Compatibility Kit Reference Guide for JSR-299: Context and
+ Dependency Injection for Java EE</title>
+ <subtitle>Specification Lead: Red Hat Middleware LLC</subtitle>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Author_Group.xml" />
</bookinfo>
Modified: tck/trunk/doc/reference/en-US/Book_Preface.xml
===================================================================
--- 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.
</para>
+ <para>
+ The CDI TCK is provide under the
+ <ulink url="http://www.apache.org/licenses/LICENSE-2.0">Apache Public License 2.0</ulink>
+ .
+ </para>
+
<section id="target-audience">
<title>Who Should Use This Book</title>
<para>
- This guide is for implementors of the Context and Dependency Injection
+ 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.
</para>
</section>
-
+
<section id="before-reading">
<title>Before You Read This Book</title>
-
+
<para>
Before reading this guide, you should familiarize yourself with the
Java EE programming model, specifically the Enterprise JavaBeans (EJB)
@@ -39,7 +48,8 @@
</para>
<para>
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, can be
found on the
<ulink url="http://jcp.org/en/jsr/detail?id=299">JSR-299 JCP page</ulink>
@@ -47,19 +57,24 @@
</para>
<para>
Before running the tests in the CDI TCK, read and become
- familiar with the JBoss Test Harness Reference Guide (pending), which
- describes how the test harness functions.
+ familiar
+ with the JBoss Test Harness Reference Guide (pending), which
+ describes
+ how the test harness functions.
</para>
-
+
</section>
<section id="book-organization">
-
+
<title>How This Book Is Organized</title>
<para>
If you are running the CDI TCK for the first time, read Chapter
- 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.
+ 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.
</para>
<itemizedlist>
<listitem>
Modified: tck/trunk/doc/reference/en-US/introduction.xml
===================================================================
--- 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 required
pieces for any JSR (the other two being the specification document and
the reference implementation). The TCK is a set of tools and tests to
- verify that a licensee's implementation of the Sun 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 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 SPIs
+ for executing the tests.
</para>
<para>
The tests in the TCK are derived from assertions in the written
@@ -47,24 +47,18 @@
the rules laid out in the specification.
</para>
<para>
- 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 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.
</para>
<para>
Compatibility testing of any feature relies on both a complete
specification and a complete reference implementation. The reference
implementation demonstrates how each test can be passed and provides
- additional context to the licensee during development for the
+ additional context to the implementor during development for the
corresponding assertion.
</para>
@@ -77,7 +71,7 @@
<itemizedlist>
<listitem>
<para>
- Compatibility testing is the means by which Sun ensures
+ Compatibility testing is the means by which the JCP ensures
that the Java platform does not become fragmented as it's
ported to different operating systems and hardware.
</para>
@@ -105,7 +99,7 @@
</listitem>
</itemizedlist>
<para>
- 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 rigorous
about enforcing the rules the specification lays down.
</para>
@@ -114,19 +108,19 @@
</section>
<section>
- <title>About the JSR-299 TCK</title>
+ <title>About the CDI TCK</title>
<para>
- The JSR-299 TCK is designed as a portable, configurable and
- automated test suite for verifying the compatibility of a licensee’s
- implementation of the JSR-299: Contexts and Dependency Injection for
- Java EE specification. The test suite is built on TestNG and provides 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 of the
+ JSR-299: Contexts and Dependency Injection for Java EE specification.
+ The test suite is built on TestNG and provides a series of extensions
+ that allow runtime packaging and deployment of JEE artifacts for
+ in-container testing.
</para>
<note>
<para>
- The JSR-299 TCK harness is based on the JBoss Test harness, which
+ The CDI TCK harness is based on the JBoss Test harness, which
provides most of the aforementioned functionality.
</para>
</note>
@@ -136,50 +130,50 @@
annotations. The artifact produced can be either a WAR or an EAR.
</para>
<para>
- The benefit of the declarative approach is that it allows many of
- the tests to be executed in a standalone implementation of JSR-299,
- accounting for a boast in developer productivity. However, an
- implementation is only valid if all tests pass using the in-container
- execution mode. The standalone mode is merely a developer convenience.
+ The declarative approach allows many of the tests to be executed in
+ a standalone implementation of CDI, accounting for a boast in developer
+ productivity. However, an implementation is only valid if all tests
+ pass using the in-container execution mode. The standalone mode is
+ merely a developer convenience.
</para>
<section>
- <title>JSR-299 TCK Specifications and Requirements</title>
+ <title>CDI TCK Specifications and Requirements</title>
<para>
This section lists the applicable requirements and specifications
- for the JSR-299 TCK.
+ for the CDI TCK.
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">Specification requirements</emphasis>
- - 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 itemized
+ in section 1.2, "Relationship to other specifications" in the
+ CDI specification, with details provided throughout the
+ specification.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Contexts and Dependency Injection for
Java EE 1.0 API</emphasis>
- - The Java API defined in the JSR-299 specification and
- provided by the reference implementation.
+ - The Java API defined in the CDI specification and provided
+ by the reference implementation.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">JBoss Test Harness</emphasis>
- - The JSR-299 TCK requires version 1.0.0 of the JBoss Test
- Harness
+ - The CDI TCK requires version 1.0.0 of the JBoss Test
+ Harness. The Harness is based on TestNG 5.x.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Porting Package</emphasis>
- An implementation of SPIs that are required for the test
- suite to run the in-container tests and at times, consult 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
</para>
</listitem>
<listitem>
@@ -187,41 +181,28 @@
<emphasis role="bold">TCK Audit Tool</emphasis>
- An itemization of the assertions in the specification
documents which are cross referenced by the individual tests.
- Relevant for producing a test coverage report.
+ Describes how well the TCK covers the specification.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Reference runtime</emphasis>
- The designated reference runtimes for compatibility testing
- 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, Enterprise
+ Edition (Java EE) 6 reference implementation (RI). See details
+ at Java EE 6
(
- <ulink url="http://java.sun.com/javaee/5/docs/api/">http://java.sun.com/javaee/5/docs/api/
+ <ulink url="http://java.sun.com/javaee/6/docs/api/">http://java.sun.com/javaee/6/docs/api/
</ulink>
).
</para>
</listitem>
- <listitem>
- <para>
- <emphasis role="bold">Maven 2</emphasis>
- - 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. Furthermore,
- the TCK runner used to validate the RI, a resource which can
- be leveraged by licensee to test their own implementations, is
- also Maven 2 project. Therefore, it's highly recommended
- to have Maven 2 installed on the system.
- </para>
- </listitem>
</itemizedlist>
</section>
<section>
- <title>JSR-299 TCK Components</title>
- <para>The JSR-299 TCK includes the following components:</para>
+ <title>CDI TCK Components</title>
+ <para>The CDI TCK includes the following components:</para>
<itemizedlist>
<listitem>
<para>
@@ -240,7 +221,7 @@
<listitem>
<para>
<emphasis role="bold">Porting Package SPIs</emphasis>
- - Extensions to the JSR-299 SPIs to allow testing of a
+ - Extensions to the CDI SPIs to allow testing of a
container.
</para>
</listitem>
@@ -248,19 +229,12 @@
<para>
<emphasis role="bold">The test suite</emphasis>
, 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 harness.
+ descriptor and supplemental resources that configure CDI and
+ other software components.
</para>
</listitem>
<listitem>
<para>
- <emphasis role="bold">JBoss TCK Runner</emphasis>
- - An implementation of the JBoss Test Harness deployment APIs
- for deploying artifacts to JBoss AS 5.1
- </para>
- </listitem>
- <listitem>
- <para>
<emphasis role="bold">TCK documentation</emphasis>
accompanied by release notes identifying updates between
versions.
@@ -268,46 +242,42 @@
</listitem>
</itemizedlist>
<para>
- The JSR-299 TCK has been tested with the following:
+ The CDI TCK has been tested with the following:
</para>
+ <note>
+ <para>
+ Sun Microsystems Inc. will implement the porting package and
+ test the CDI RI on the Java EE Reference Implementation
+ </para>
+ </note>
<itemizedlist>
<listitem>
- <para> Java Platform, Standard Edition, Version 5.0 (Java SE 1.5)
- </para>
+ <para>JBoss AS 5.1.0.GA</para>
</listitem>
- <listitem>
- <para> Java Platform, Enterprise Edition, Version 5 reference
- implementation (Java EE 5 RI)</para>
- </listitem>
- <listitem>
- <para>JBoss AS 5.1?</para>
- </listitem>
</itemizedlist>
- <para>The JSR-299 TCK tests run on the following platforms:</para>
+ <para>The CDI TCK tests run on the following platforms:</para>
<itemizedlist>
<listitem>
- <para>Windows XP?</para>
+ <para>Red Hat Enterprise Linux 5.2</para>
</listitem>
- <listitem>
- <para>RHEL 5.2?</para>
- </listitem>
</itemizedlist>
</section>
<section>
<title>The JBoss Test Harness</title>
<para>
- 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 deployment of
- Java EE artifacts (EAR or WAR) for in-container testing. It'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).
</para>
<para>
- JSR-299 supports Java EE 5, Java EE 6, Java EE 6 Web Profile and
- the Embeddable EJB 3.1. Accordingly, the TCK will be able to run 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 the
+ 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 and
+ Embeddable EJB 3.1 (SUN: Please confirm these are the CTS the CDI
+ TCK will run in).
</para>
<note>
<para>
@@ -316,10 +286,10 @@
used in this reference guide. This term refers to running the
test suite in any of the aforementioned environments, whilst
<emphasis role="italic">standalone</emphasis>
- 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 standalone 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 deployment
+ in a Java EE container.
</para>
</note>
<para>
@@ -451,16 +421,16 @@
<section>
<title>The Porting Package</title>
<para>
- The JSR-299 TCK relies on an implementation of the porting
- package to function. The porting package can be divided into two
- parts. The first part is comprised of extensions to the JSR-299 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. The
+ first part is comprised of extensions to the JSR-299 SPIs to allow
+ testing of a container. The second part must implement he JBoss Test
+ Harness artifact deployment APIs for deploying artifacts to the Java
+ EE container.
</para>
<para>
As mentioned earlier, there are times when the tests need to tap
- directly into the JSR-299 implementation to manipulate behavior 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 to a
given implementation.
@@ -490,24 +460,40 @@
</para>
</listitem>
</itemizedlist>
+
<para>
+ Complete JavaDoc describing the requirements for implementation
+ is provided.
+ </para>
+
+ <para>
To run the full TCK you must additionally implement
<literal>org.jboss.testharness.spi.Containers</literal>
- , 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.
+ </para>
+ <note>
+ <para>
+ Red Hat Middleware LLC encourages CDI implementators to
+ contribute JBoss Test Harness Deployment API implementations for
+ other containers under the ASL license. Please contact the CDI
+ TCK lead.
+ </para>
+ </note>
+ <para>
+ If you wish to run the TCK in standalone mode, a CDI implementation
+ must provide an implementation of
<literal>org.jboss.testharness.spi.StandaloneContainers</literal>
- . Implementations of these APIs are already available for JBoss AS
- 5.1. Therefore, you only need to implement this part of the porting
- 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.
</para>
<para>
- The default configuration for the TCK is property-based.
- Therefore, you specify the implementation class for all of these
- SPIs in a properties file. There are additional properties for
- controlling whether the tests are run in standalone or in-container
- mode. Optionally, you can use system properties to configure the
- TCK. Details are provided in section 4.1.
+ The default configuration for the TCK uses Java properties files.
+ The implementation class for all of these SPIs is placed in this
+ properties file. Optionally, you can use system properties to
+ configure the TCK. Details are provided in section 4.1.
</para>
</section>
<section>
@@ -519,12 +505,11 @@
coverage report.
</para>
<para>
- 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 from
- the specification document, making it easy for the licensee to
- locate the language in the specification document that supports 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 reference
+ to a chapter, section and paragraph from the specification document,
+ making it easy for the implementor to locate the language in the
+ specification document that supports the feature being tested.
</para>
</section>
</section>
Modified: tck/trunk/doc/reference/en-US/master.xml
===================================================================
--- tck/trunk/doc/reference/en-US/master.xml 2009-07-23 23:16:44 UTC (rev 3181)
+++ tck/trunk/doc/reference/en-US/master.xml 2009-07-24 00:27:10 UTC (rev 3182)
@@ -1,5 +1,5 @@
<?xml version='1.0' encoding='UTF-8'?>
-<!-- This document was created with Syntext Serna Free. --><!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ ]>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ ]>
<book lang="en">
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Book_Info.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Book_Preface.xml"/>
More information about the weld-commits
mailing list