From webbeans-commits at lists.jboss.org Fri Jul 24 12:24:33 2009 Content-Type: multipart/mixed; boundary="===============4284558474363334942==" MIME-Version: 1.0 From: webbeans-commits at lists.jboss.org To: weld-commits at lists.jboss.org Subject: [webbeans-commits] Webbeans SVN: r3199 - in tck/trunk/doc/reference: en-US and 1 other directory. Date: Fri, 24 Jul 2009 12:24:33 -0400 Message-ID: <200907241624.n6OGOXFj014102@svn01.web.mwc.hst.phx2.redhat.com> --===============4284558474363334942== 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 12:24:33 -0400 (Fri, 24 Jul 2009) New Revision: 3199 Added: tck/trunk/doc/reference/en-US/part-background.xml tck/trunk/doc/reference/en-US/part-execution.xml tck/trunk/doc/reference/en-US/part-setup.xml tck/trunk/doc/reference/en-US/part-test-harness.xml Removed: tck/trunk/doc/reference/en-US/part1-background.xml tck/trunk/doc/reference/en-US/part2-setup.xml tck/trunk/doc/reference/en-US/part3-execution.xml Modified: tck/trunk/doc/reference/ tck/trunk/doc/reference/en-US/configuration.xml tck/trunk/doc/reference/en-US/introduction.xml tck/trunk/doc/reference/en-US/master.xml Log: Some renames, split the Test Harness intro out Property changes on: tck/trunk/doc/reference ___________________________________________________________________ Name: svn:externals + = harness https://svn.jboss.org/repos/test-utils/jboss-test-harness/trunk/doc= /reference/en-US/ Modified: tck/trunk/doc/reference/en-US/configuration.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/configuration.xml 2009-07-24 15:37:02 UTC= (rev 3198) +++ tck/trunk/doc/reference/en-US/configuration.xml 2009-07-24 16:24:33 UTC= (rev 3199) @@ -11,7 +11,7 @@ Test Harness negotiates the execution of the tests in the container = is given. -
+
JBoss Test Harness Properties The JBoss Test Harness allows the test suite to be launched in a @@ -275,6 +275,86 @@
+ The Porting Package + + 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 test= ing of + a container. The second part must implement the JBoss Test Harness + artifact deployment APIs for deploying artifacts to the Java EE + container. + + + As mentioned earlier, there are times when the tests need to tap + directly into the CDI implementation to manipulate behavior or ve= rify + 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. + + + The four SPI classes in the JSR-299 TCK are as follows: + + + + + org.jboss.jsr299.tck.spi.Beans + + + + + org.jboss.jsr299.tck.spi.Contexts + + + + + org.jboss.jsr299.tck.spi.EL + + + + + org.jboss.jsr299.tck.spi.Managers + + + + + + 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. An + implementations of this API is already available for JBoss AS 5.1. + Therefore, you only need to implement this part of the porting pa= ckage + if you wish to use another container. + + + + Red Hat Middleware LLC encourages CDI implementators to + contribute JBoss Test Harness Deployment API implementations f= or + other containers under the ASL license. Please contact the CDI= TCK + lead. = + + + + If you wish to run the TCK in standalone mode, a CDI implementati= on + must provide an implementation of + org.jboss.testharness.spi.StandaloneContainers + . The CDI RI provides an implementation of this API; see the RI + reference guide. + + + The default configuration for the TCK uses Java properties files.= The + implementation class for all of these SPIs is placed in this prop= erties + file. Optionally, you can use system properties to configure the = TCK. + Details are provided in + + . + +
+
Setting up the TCK runner project The TCK runner project is the magic that makes everything come 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-24 15:37:02 UTC = (rev 3198) +++ tck/trunk/doc/reference/en-US/introduction.xml 2009-07-24 16:24:33 UTC = (rev 3199) @@ -165,7 +165,10 @@ JBoss Test Harness - The CDI TCK requires version 1.0.0 of the JBoss Test - Harness. The Harness is based on TestNG 5.x. + Harness. The Harness is based on TestNG 5.x. You can rea= d more + about the harness in + + . @@ -235,6 +238,22 @@ + The TCK audit + is used to list out the assertions identified in the JSR= -299 + specification. It matches the assertions to testcases in= the + test suite and produces a coverage report. + + + The audit document is provided along with the TCK; at le= ast + 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 implement= or to + locate the language in the specification document that + supports the feature being tested. + + + + TCK documentation accompanied by release notes identifying updates between versions. @@ -261,256 +280,13 @@ Red Hat Enterprise Linux 5.2 -
-
- The JBoss Test Harness - 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's - important to note that the JBoss Test Harness has no relation = with, - or dependency on the JBoss Application Server (JBoss AS). - - 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). - - - You'll often see the term - in-container - 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 CDI - implementation-specific standalone bootstrap. The standalon= e mode - only runs those tests which the CDI RI can run without depl= oyment - in a Java EE container. - - - - The last thing Java developers want is yet another testing - framework to make their life more complicated. What they do wa= nt is - a good integration with their Integrated Development Environme= nt - (IDE). These days, if a tool doesn't have an IDE plugin, = then - it won't get the attention it deserves. That's why t= he - JBoss Test Harness is built entirely upon TestNG. TestNG is on= e of - the two prominent test frameworks for Java and TestNG plugins = are - available for all major IDEs (with the exception of NetBeans) = and - build tools (Ant and Maven 2). - - - Because it leverages the existing TestNG ecosystem, there is no - need for a special test launcher for the JBoss Test Harness, a= nd in - turn the JSR-299 TCK. You simply use the IDE or build tool of = your - choice. You also get reporting and debugging for free. - - - The JBoss Test Harness supports the following features: - - - - - Test activation via any method supported by the TestNG - configuration descriptor (package, group, class) - - - - - Exclusion of in-container tests in standalone mode - - - - - Exclusion of individual tests labeled as under - investigation - - - - - Integration with any TestNG plugin (Eclipse, IntelliJ, - NetBeans, Ant, Maven) - - - - - Automated reporting capability as provided by TestNG - - - - - Standalone and in-container test mode - - - - - Container pluggability - - - - - Declarative packaging of additional resources and classes - in artifact - - - - - Declarative deployment exception trapping - - - - - Artifact dumping for failure and packaging analysis - - - - - A test is designated by a method annotated with - @org.testng.annotations.Test - in a class which extends - org.jboss.jsr299.tck.AbstractJSR299Test - and is annotated with - @org.jboss.testharness.impl.packaging.Artifact - . - - - The - @Test - annotation is provided by TestNG, the - @Artifact - annotation is provided by the JBoss Test Harness and the - AbstractJSR299Test - is part of the JSR-299 TCK. There is a one-to-one mapping betw= een a - TestNG test class and an artifact. The packaging type is defin= ed by - the - @org.jboss.testharness.impl.packaging.Packaging - annotation on the test class, defaulting to a WAR if not speci= fied. - - - Prior to executing the tests for a given class, the JBoss Test - Harness packages the class as a deployable artifact (EAR or WA= R), - along with any extra resources specified, and deploys the arti= fact - to the container. The test execution and results are negotatie= d via - HTTP communication using a thin layer over the TestNG test lau= ncher. - The test harness can also catch and affirm expected deployment - exceptions. This setup and tear down activity is provided by t= he - super class - org.jboss.jsr299.tck.AbstractJSR299Test - , which all TCK test classes must extend. - - - If the annotation - @org.jboss.testharness.impl.packaging.IntegrationTest - - is not present on the test class, then it means the test class= can - be executed in standalone mode. In standalone mode, the deploy= able - artifact is assembled on the local classpath and the tests exe= cute - in the same JVM as the launcher, just as though it were a regu= lar - TestNG test case. The standalone mode is provided merely for - convenience and efficiency. - - - Chapter 4 details how to run the TCK test suite using the JBoss - Test Harness. -
-
- The Porting Package - - 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 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. - - - The four SPI classes in the JSR-299 TCK are as follows: - - - - - org.jboss.jsr299.tck.spi.Beans - - - - - org.jboss.jsr299.tck.spi.Contexts - - - - - org.jboss.jsr299.tck.spi.EL - - - - - org.jboss.jsr299.tck.spi.Managers - - - - - - 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. = 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 - . The CDI RI provides an implementation of this API; see the RI - reference guide. - - - 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. - -
-
- TCK Audit Tool - - The TCK audit is used to list out the assertions identified in - the JSR-299 specification. It uses Java annotation processing = to - match the assertions to testcases in the test suite and produc= e a - coverage report. - - - 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-24 15:37:02 UTC (rev 3= 198) +++ tck/trunk/doc/reference/en-US/master.xml 2009-07-24 16:24:33 UTC (rev 3= 199) @@ -3,7 +3,8 @@ - - - + + + + Copied: tck/trunk/doc/reference/en-US/part-background.xml (from rev 3198, t= ck/trunk/doc/reference/en-US/part1-background.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/part-background.xml = (rev 0) +++ tck/trunk/doc/reference/en-US/part-background.xml 2009-07-24 16:24:33 U= TC (rev 3199) @@ -0,0 +1,15 @@ + + + + Getting Acquainted with the TCK + = + + + The CDI TCK must be used to ensure that your implementation + conforms to the CDI specification. This part introduces the TCK, + gives some background about its purpose and states the requiremen= ts for + passing the TCK. + + + + Copied: tck/trunk/doc/reference/en-US/part-execution.xml (from rev 3198, tc= k/trunk/doc/reference/en-US/part3-execution.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/part-execution.xml = (rev 0) +++ tck/trunk/doc/reference/en-US/part-execution.xml 2009-07-24 16:24:33 UT= C (rev 3199) @@ -0,0 +1,18 @@ + + + + Executing and Debugging Tests + + + In this part you learn how to execute the JSR-299 TCK on a given + JSR-299 implementation. First, you are walked through the steps + necessary to execute the test suite on the JSR-299 RI (Web Beans)= . Then + you discover how to modify the TCK runner to execute the test sui= te on + your own implementation. Finally, you learn how to debug tests fr= om the + test suite in Eclipse. + + + + + + Copied: tck/trunk/doc/reference/en-US/part-setup.xml (from rev 3198, tck/tr= unk/doc/reference/en-US/part2-setup.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/part-setup.xml (r= ev 0) +++ tck/trunk/doc/reference/en-US/part-setup.xml 2009-07-24 16:24:33 UTC (r= ev 3199) @@ -0,0 +1,14 @@ + + + + Installation and Setup + + + In this part you learn where to obtain the JSR-299 TCK and suppor= ting software. + You are then presented with recommendations of how to organize and + configure the software so that you are ready to execute the TCK. + + + + + Added: tck/trunk/doc/reference/en-US/part-test-harness.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/part-test-harness.xml = (rev 0) +++ tck/trunk/doc/reference/en-US/part-test-harness.xml 2009-07-24 16:24:33= UTC (rev 3199) @@ -0,0 +1,12 @@ + + + + JBoss Test Harness + + + In this part you learn about the JBoss Test Harness. You can view= the + entire JBoss Test Harness Reference Guide at TODO= . + + + + Property changes on: tck/trunk/doc/reference/en-US/part-test-harness.xml ___________________________________________________________________ Name: svn:mime-type + text/plain Deleted: tck/trunk/doc/reference/en-US/part1-background.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/part1-background.xml 2009-07-24 15:37:02 = UTC (rev 3198) +++ tck/trunk/doc/reference/en-US/part1-background.xml 2009-07-24 16:24:33 = UTC (rev 3199) @@ -1,15 +0,0 @@ - - - - Getting Acquainted with the TCK - = - - - The CDI TCK must be used to ensure that your implementation - conforms to the CDI specification. This part introduces the TCK, - gives some background about its purpose and states the requiremen= ts for - passing the TCK. - - - - Deleted: tck/trunk/doc/reference/en-US/part2-setup.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/part2-setup.xml 2009-07-24 15:37:02 UTC (= rev 3198) +++ tck/trunk/doc/reference/en-US/part2-setup.xml 2009-07-24 16:24:33 UTC (= rev 3199) @@ -1,14 +0,0 @@ - - - - Installation and Setup - - - In this part you learn where to obtain the JSR-299 TCK and suppor= ting software. - You are then presented with recommendations of how to organize and - configure the software so that you are ready to execute the TCK. - - - - - Deleted: tck/trunk/doc/reference/en-US/part3-execution.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/part3-execution.xml 2009-07-24 15:37:02 U= TC (rev 3198) +++ tck/trunk/doc/reference/en-US/part3-execution.xml 2009-07-24 16:24:33 U= TC (rev 3199) @@ -1,18 +0,0 @@ - - - - Executing and Debugging Tests - - - In this part you learn how to execute the JSR-299 TCK on a given - JSR-299 implementation. First, you are walked through the steps - necessary to execute the test suite on the JSR-299 RI (Web Beans)= . Then - you discover how to modify the TCK runner to execute the test sui= te on - your own implementation. Finally, you learn how to debug tests fr= om the - test suite in Eclipse. - - - - - - --===============4284558474363334942==--