[jboss-svn-commits] JBoss Common SVN: r4130 - arquillian/trunk/doc/reference/src/main/docbook/en-US.
jboss-svn-commits at lists.jboss.org
jboss-svn-commits at lists.jboss.org
Tue Mar 9 06:04:09 EST 2010
Author: aslak
Date: 2010-03-09 06:04:08 -0500 (Tue, 09 Mar 2010)
New Revision: 4130
Modified:
arquillian/trunk/doc/reference/src/main/docbook/en-US/containers.xml
arquillian/trunk/doc/reference/src/main/docbook/en-US/enrichment.xml
arquillian/trunk/doc/reference/src/main/docbook/en-US/extend.xml
arquillian/trunk/doc/reference/src/main/docbook/en-US/gettingstarted.xml
Log:
ARQ-40 Updated supported container list and container groupIds. Changed doc for EJB Injection enricher and Weld Scopes. Added SPI names
Modified: arquillian/trunk/doc/reference/src/main/docbook/en-US/containers.xml
===================================================================
--- arquillian/trunk/doc/reference/src/main/docbook/en-US/containers.xml 2010-03-09 10:51:55 UTC (rev 4129)
+++ arquillian/trunk/doc/reference/src/main/docbook/en-US/containers.xml 2010-03-09 11:04:08 UTC (rev 4130)
@@ -74,8 +74,8 @@
<id>%artifactId%</id>
<dependencies>
<dependency>
- <groupId>org.jboss.arquillian</groupId>
- <artifactId>arquillian-%artifactId%</artifactId>
+ <groupId>org.jboss.arquillian.container</groupId>
+ <artifactId>%artifactId%</artifactId>
<version>${arquillian.version}</version>
</dependency>
</dependencies>
@@ -101,25 +101,27 @@
<entry>JBoss AS 5.1</entry>
<entry>remote</entry>
<entry>Java EE 5</entry>
- <entry>arquillian-jboss-remote-51</entry>
+ <entry>arquillian-jbossas-remote-51</entry>
</row>
<row>
<entry>JBoss AS 6.0 M1</entry>
<entry>remote</entry>
<entry>Java EE 6</entry>
- <entry>arquillian-jboss-remote-60</entry>
+ <entry>arquillian-jbossas-remote-60</entry>
</row>
+<!--
<row>
<entry>JBoss Embedded AS</entry>
<entry>embedded</entry>
<entry>Java EE 6</entry>
- <entry>arquillian-jboss-embedded</entry>
+ <entry>arquillian-jbossas-embedded-60</entry>
</row>
+-->
<row>
<entry>Embedded GlassFish V3</entry>
<entry>embedded</entry>
<entry>Java EE 6</entry>
- <entry>arquillian-glassfish-embedded</entry>
+ <entry>arquillian-glassfish-embedded-30</entry>
</row>
<row>
<entry>Weld SE</entry>
@@ -127,12 +129,18 @@
<entry>CDI</entry>
<entry>arquillian-weld-embedded</entry>
</row>
+ <row>
+ <entry>Apache OpenEJB</entry>
+ <entry>embedded</entry>
+ <entry>EJB 3.0</entry>
+ <entry>arquillian-openejb</entry>
+ </row>
</tbody>
</tgroup>
</table>
<para>
- Support for other containers is planned, including GlassFish V3, Tomcat and Jetty. We don't have plans to
+ Support for other containers is planned, including GlassFish V3(remote), Tomcat and Jetty. We don't have plans to
provide implementations for Spring or Guice at this time, but we welcome a contribution from the community,
because it's certainly possible.
</para>
Modified: arquillian/trunk/doc/reference/src/main/docbook/en-US/enrichment.xml
===================================================================
--- arquillian/trunk/doc/reference/src/main/docbook/en-US/enrichment.xml 2010-03-09 10:51:55 UTC (rev 4129)
+++ arquillian/trunk/doc/reference/src/main/docbook/en-US/enrichment.xml 2010-03-09 11:04:08 UTC (rev 4130)
@@ -59,23 +59,23 @@
<para>
The <literal>@EJB</literal> annotation performs a JNDI lookup for the EJB session bean reference using the
- following equation:
+ following equation in the specified order:
</para>
-
+
+ <programlisting>"java:global/test.ear/test/" + unqualified interface name + "Bean"</programlisting>
<programlisting>"test/" + unqualified interface name + "Bean/local"</programlisting>
-
+ <programlisting>"test/" + unqualified interface name + "Bean/remote"</programlisting>
+
<para>
- If a local bean is not found, then the enricher attempts a lookup for a remote bean.
+ If no matching beans were found in those locations the injection will fail.
</para>
- <programlisting>"test/" + unqualified interface name + "Bean/remote"</programlisting>
-
- <note>
+ <warning>
<para>
- At the moment, the lookup for an EJB session reference relies on standard JNDI naming conventions
- introduced in Java EE 6 - therefore you need to use a Java EE 6 container.
+ At the moment, the lookup for an EJB session reference relies on a common naming convention of EJB beans.
+ In the future the lookup will rely on the standard JNDI naming conventions established in Java EE 6.
</para>
- </note>
+ </warning>
<para>
In order for CDI injections to work, the test archive defined with ShrinkWrap must be a bean archive. That
@@ -106,7 +106,7 @@
<itemizedlist>
<listitem>
- <para>Application scope - Active during the execution of all tests</para>
+ <para>Application scope - Active for all methods in a test class</para>
</listitem>
<listitem>
<para>Session scope - Active for all methods in a test class</para>
Modified: arquillian/trunk/doc/reference/src/main/docbook/en-US/extend.xml
===================================================================
--- arquillian/trunk/doc/reference/src/main/docbook/en-US/extend.xml 2010-03-09 10:51:55 UTC (rev 4129)
+++ arquillian/trunk/doc/reference/src/main/docbook/en-US/extend.xml 2010-03-09 11:04:08 UTC (rev 4130)
@@ -9,6 +9,18 @@
(SPIs). The following diagram shows how the various SPIs in Arquillian tie into the test execution.
</para>
+<!--
+ <para>
+ For Arquillian to support multiple containers with a wide range of usage patterns,
+ it needs an extensive set of Service Provider Interfaces to do the heavy lifting.
+ </para>
+ <para>
+ We can split the SPIs up in two categories; Client and Container side.
+ Client side SPIs are mostly about interaction and preparation for running inside the Container while the Container side
+ is about how to run the test case.
+ </para>
+-->
+
<mediaobject>
<imageobject>
<imagedata fileref="images/spi-overview-small.png" format="PNG" align="center"/>
@@ -31,27 +43,83 @@
<para></para>
</section>
- <section id="extend.container">
- <title>DeployableContainers</title>
- <para></para>
- </section>
+ <section id="extend.client">
+ <title>Client Side</title>
+
+ <section id="extend.client.deployment.auxiliaryarchivetappender">
+ <title>AuxiliaryArchiveAppender</title>
+ <para>
+ Appending auxiliary archives to the final deployment.
+ </para>
+ </section>
- <section id="extend.testenrichers">
- <title>TestEnrichers</title>
- <para></para>
- </section>
+ <section id="extend.client.deployment.auxiliaryarchiveprocessor">
+ <title>AuxiliarArchiveProcessor</title>
+ <para>
+
+ </para>
+ </section>
- <section id="extend.testrunners">
- <title>TestRunners</title>
- <section id="extend.testrunners.testng">
- <title>TestNG</title>
- <para>..</para>
+ <section id="extend.client.deployment.applicationachivegenerator">
+ <title>ApplicatonArchiveGenerator</title>
+ <para></para>
+
+<!--
+ <section id="extend.client.deployment">
+ <title>@Deployment</title>
+ <para>
+
+ </para>
+ </section>
+-->
</section>
- <section id="extend.testrunners.junit">
- <title>JUnit</title>
- <para>..</para>
+
+ <section id="extend.client.deployment.applicationarchiveprocessor">
+ <title>ApplicationArchiveProcessor</title>
+ <para>
+ A post processor for the Application generated archive. Used for application packaging enhancements.
+ </para>
</section>
+
+ <section id="extend.client.deployment.deploymentpackager">
+ <title>DeploymentPackager</title>
+ <para>Responsible for creating the deployable archive.</para>
+ </section>
+
+ <section id="extend.client.container">
+ <title>DeployableContainers</title>
+ <para>Container integration, life cycle control.</para>
+ </section>
+
+ <section id="extend.client.methodexecutor">
+ <title>ContainerMethodExecutor</title>
+ <para>Communication with the TestRunner inside the Container</para>
+ </section>
+
</section>
+
+ <section id="extend.container">
+ <title>Container Side</title>
+
+ <section id="extend.container.testenrichers">
+ <title>TestEnrichers</title>
+ <para>Instance injection, @EJB/@Resource/@Inject.</para>
+ </section>
+
+ <section id="extend.container.testrunners">
+ <title>TestRunners</title>
+ <para>Execute the test case inside the container</para>
+ <section id="extend.container.testrunners.testng">
+ <title>TestNG</title>
+ <para>..</para>
+ </section>
+ <section id="extend.container.testrunners.junit">
+ <title>JUnit</title>
+ <para>..</para>
+ </section>
+ </section>
+
+ </section>
<!--
vim:et:ts=3:sw=3:tw=120
-->
Modified: arquillian/trunk/doc/reference/src/main/docbook/en-US/gettingstarted.xml
===================================================================
--- arquillian/trunk/doc/reference/src/main/docbook/en-US/gettingstarted.xml 2010-03-09 10:51:55 UTC (rev 4129)
+++ arquillian/trunk/doc/reference/src/main/docbook/en-US/gettingstarted.xml 2010-03-09 11:04:08 UTC (rev 4130)
@@ -288,11 +288,11 @@
<programlisting role="XML"><![CDATA[<profiles>
<profile>
- <id>jboss-remote-60</id>
+ <id>jbossas-remote-60</id>
<dependencies>
<dependency>
- <groupId>org.jboss.arquillian</groupId>
- <artifactId>arquillian-jboss-remote-60</artifactId>
+ <groupId>org.jboss.arquillian.container</groupId>
+ <artifactId>arquillian-jbossas-remote-60</artifactId>
<version>${arquillian.version}</version>
</dependency>
</dependencies>
@@ -306,10 +306,10 @@
<para>
All that's left is to execute the tests. In Maven, that's easy. Simply run the Maven test goal with the
- <literal>jboss-remote-60</literal> profile activated:
+ <literal>jbossas-remote-60</literal> profile activated:
</para>
- <programlisting><![CDATA[mvn test -Pjboss-remote-60]]></programlisting>
+ <programlisting><![CDATA[mvn test -Pjbossas-remote-60]]></programlisting>
<para>
You should see that the two tests pass.
@@ -358,7 +358,7 @@
Once the plugins are installed, import your Maven project into the Eclipse workspace. Before executing the
test, you need to enable the profile for the target container, as you did in the previous section. We'll
go ahead and activate the profile globally for the project. Right click on the project and select Properties.
- Select the Maven property sheet and in the first form field, enter <literal>jboss-remote-60</literal>; you also need
+ Select the Maven property sheet and in the first form field, enter <literal>jbossas-remote-60</literal>; you also need
to tell Maven to not resolve depedencies from the workspace (this interferes with resource loading):
</para>
@@ -412,7 +412,7 @@
<para>
Import your Maven project into NetBeans. Then, look for a select menu in the main toolbar, which you can
- use to set the active Maven profile. Select the <literal>jboss-remote-60</literal> profile as shown here:
+ use to set the active Maven profile. Select the <literal>jbossas-remote-60</literal> profile as shown here:
</para>
<mediaobject>
More information about the jboss-svn-commits
mailing list