[jboss-svn-commits] JBoss Common SVN: r4801 - arquillian/trunk/doc/reference/src/main/docbook/en-US.
jboss-svn-commits at lists.jboss.org
jboss-svn-commits at lists.jboss.org
Tue Jul 27 13:35:00 EDT 2010
Author: aslak
Date: 2010-07-27 13:34:59 -0400 (Tue, 27 Jul 2010)
New Revision: 4801
Added:
arquillian/trunk/doc/reference/src/main/docbook/en-US/container_osgi-embedded-4-2.xml
arquillian/trunk/doc/reference/src/main/docbook/en-US/extension_performance.xml
arquillian/trunk/doc/reference/src/main/docbook/en-US/extension_reference.xml
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/examples.xml
arquillian/trunk/doc/reference/src/main/docbook/en-US/execution.xml
arquillian/trunk/doc/reference/src/main/docbook/en-US/gettingstarted.xml
arquillian/trunk/doc/reference/src/main/docbook/en-US/master.xml
Log:
ARQ-214 Updated docs with Alpha3 changes.
Added: arquillian/trunk/doc/reference/src/main/docbook/en-US/container_osgi-embedded-4-2.xml
===================================================================
--- arquillian/trunk/doc/reference/src/main/docbook/en-US/container_osgi-embedded-4-2.xml (rev 0)
+++ arquillian/trunk/doc/reference/src/main/docbook/en-US/container_osgi-embedded-4-2.xml 2010-07-27 17:34:59 UTC (rev 4801)
@@ -0,0 +1,90 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+ "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" []>
+
+<section id="container.osgi-embedded-42">
+
+ <title>OSGi 4.2 - Embedded</title>
+
+ <para id="container.osgi-embedded-42.description">
+ A DeployableContainer implementation that can run and connect to a embedded(same JVM)
+ OSGi container. This implementation has lifecycle support, so the container will be started and stopped as part of
+ the test run.
+ </para>
+
+ <table id="container.osgi-embedded-42.injection" frame="all">
+ <title>Container Injection Support Matrix</title>
+ <tgroup cols="5">
+ <colspec colnum="1" colname="ejb" colwidth="1*" />
+ <colspec colnum="2" colname="ejb_local" colwidth="2*" />
+ <colspec colnum="3" colname="inject_cdi" colwidth="2*" />
+ <colspec colnum="4" colname="inject_mc" colwidth="2*" />
+ <colspec colnum="5" colname="persistence" colwidth="3*" />
+ <thead>
+ <row>
+ <entry>@EJB</entry>
+ <entry>@EJB (no-interface)</entry>
+ <entry>@Inject (JSR-330)</entry>
+ <entry>@Inject (MC)</entry>
+ <entry>@PersistenceContext @PersistenceUnit</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry></entry>
+ <entry></entry>
+ <entry>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/fact_good.png" format="PNG"
+ align="center" scalefit="0" />
+ </imageobject>
+ </mediaobject>
+ </entry>
+ <entry></entry>
+ <entry></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <note>
+ @javax.inject.Inject is used for injection. Support injection of Bundle and Bundle context.
+ </note>
+
+ <programlisting role="XML"><![CDATA[<profile>
+ <id>osgi-embedded-4.2</id>
+ <dependencies>
+ <dependency>
+ <groupId>org.jboss.arquillian.container</groupId>
+ <artifactId>arquillian-osgi-embedded-4.2</artifactId>
+ <version>1.0.0.Alpha3</version>
+ </dependency>
+ <dependency>
+ <groupId>org.osgi</groupId>
+ <artifactId>org.osgi.core</artifactId>
+ <version>4.2.0</version>
+ </dependency>
+ <dependency>
+ <groupId>org.osgi</groupId>
+ <artifactId>org.osgi.compendium</artifactId>
+ <version>4.2.0</version>
+ </dependency>
+ <dependency>
+ <groupId>org.jboss.osgi.framework</groupId>
+ <artifactId>jboss-osgi-framework-core</artifactId>
+ <version>1.0.0.Alpha6</version>
+ </dependency>
+ <dependency>
+ <groupId>org.jboss.osgi.resolver</groupId>
+ <artifactId>jbosgi-resolver-felix</artifactId>
+ <version>3.0.1</version>
+ </dependency>
+ <dependency>
+ <groupId>org.jboss.logging</groupId>
+ <artifactId>jboss-logging-log4j</artifactId>
+ <version>2.1.0.GA</version>
+ </dependency>
+ </dependencies>
+</profile>]]></programlisting>
+</section>
\ No newline at end of file
Modified: arquillian/trunk/doc/reference/src/main/docbook/en-US/containers.xml
===================================================================
--- arquillian/trunk/doc/reference/src/main/docbook/en-US/containers.xml 2010-07-27 15:30:46 UTC (rev 4800)
+++ arquillian/trunk/doc/reference/src/main/docbook/en-US/containers.xml 2010-07-27 17:34:59 UTC (rev 4801)
@@ -225,7 +225,7 @@
<arquillian xmlns="http://jboss.com/arquillian"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xmlns:jboss="urn:arq:org.jboss.arquillian.jbossas.remote60">
+ xmlns:jboss="urn:arq:org.jboss.arquillian.container.jbossas.remote_6">
<engine>
<deploymentExportPath>/tmp</deploymentExportPath>
Modified: arquillian/trunk/doc/reference/src/main/docbook/en-US/enrichment.xml
===================================================================
--- arquillian/trunk/doc/reference/src/main/docbook/en-US/enrichment.xml 2010-07-27 15:30:46 UTC (rev 4800)
+++ arquillian/trunk/doc/reference/src/main/docbook/en-US/enrichment.xml 2010-07-27 17:34:59 UTC (rev 4801)
@@ -109,7 +109,7 @@
<title>Active scopes</title>
<para>
- When running your tests the embedded Weld SE container, Arquillian activates scopes as follows:
+ When running your tests the embedded Weld EE container, Arquillian activates scopes as follows:
</para>
<itemizedlist>
Modified: arquillian/trunk/doc/reference/src/main/docbook/en-US/examples.xml
===================================================================
--- arquillian/trunk/doc/reference/src/main/docbook/en-US/examples.xml 2010-07-27 15:30:46 UTC (rev 4800)
+++ arquillian/trunk/doc/reference/src/main/docbook/en-US/examples.xml 2010-07-27 17:34:59 UTC (rev 4801)
@@ -7,19 +7,19 @@
<para>
The following examples demonstrate the use of Arquillian. Currently Arquillian is distributed as a Maven only
project, so you'll need to grab the examples from SVN. You can choose between a
- <ulink url="http://anonsvn.jboss.org/repos/common/arquillian/tags/1.0.0.Alpha1/examples/junit">JUnit example</ulink> and a
- <ulink url="http://anonsvn.jboss.org/repos/common/arquillian/tags/1.0.0.Alpha1/examples/testng">TestNG example</ulink>. In this
+ <ulink url="http://anonsvn.jboss.org/repos/common/arquillian/tags/1.0.0.Alpha3/examples/junit">JUnit example</ulink> and a
+ <ulink url="http://anonsvn.jboss.org/repos/common/arquillian/tags/1.0.0.Alpha3/examples/testng">TestNG example</ulink>. In this
tutorial we show you how to use both.
</para>
- <programlisting><![CDATA[svn co http://anonsvn.jboss.org/repos/common/arquillian/trunk/examples/testng/ arquillian-example-testng
-svn co http://anonsvn.jboss.org/repos/common/arquillian/trunk/examples/junit/ arquillian-example-junit]]></programlisting>
+ <programlisting><![CDATA[svn co http://anonsvn.jboss.org/repos/common/arquillian/tags/1.0.0.Alpha3/examples/testng/ arquillian-example-testng
+svn co http://anonsvn.jboss.org/repos/common/arquillian/tags/1.0.0.Alpha3/examples/junit arquillian-example-junit]]></programlisting>
<para>
Running these tests from the command line is easy. The examples run against all the servers supported
by Arquillian (of course, you must choose a container that is capable of deploying EJBs for these tests).
To run the test, we'll use Maven. For this tutorial, we'll use JBoss AS 6 (currently at Milestone 3), for
- which we use the <literal>jbossas-remote-60</literal> profile.
+ which we use the <literal>jbossas-remote-6</literal> profile.
</para>
<para>
@@ -35,10 +35,10 @@
</para>
<programlisting><![CDATA[$ cd arquillian-example-testng/
-$ mvn test -Pjbossas-remote-60
+$ mvn test -Pjbossas-remote-6
$ cd ../arquillian-example-junit/
-$ mvn test -Pjbossas-remote-60]]></programlisting>
+$ mvn test -Pjbossas-remote-6]]></programlisting>
<para>
You can also run the tests in an IDE. We'll show you how to run the tests in Eclipse, with m2eclipse installed, next.
@@ -61,7 +61,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 we did on the command line. We'll
go ahead and activate the profile globally for the project (we also need the <literal>default</literal> profile, read the note above for more). Right click on the project and select Properties.
- Select the Maven property sheet and in the first form field, enter <literal>jbossas-remote-60</literal>; you also need
+ Select the Maven property sheet and in the first form field, enter <literal>jbossas-remote-6</literal>; you also need
to tell Maven to not resolve dependencies from the workspace (this interferes with resource loading):
</para>
@@ -126,7 +126,7 @@
public class InjectionTestCase {
@Deployment
public static JavaArchive createTestArchive() {
- return ShrinkWrap.create("test.jar", JavaArchive.class)
+ return ShrinkWrap.create(JavaArchive.class, "test.jar")
.addClasses(GreetingManager.class, GreetingManagerBean.class);
}
@@ -165,7 +165,7 @@
import org.jboss.shrinkwrap.api.ShrinkWrap;
import org.jboss.shrinkwrap.api.ArchivePaths;
import org.jboss.shrinkwrap.api.spec.JavaArchive;
-import org.jboss.shrinkwrap.impl.base.asset.ByteArrayAsset;
+import org.jboss.shrinkwrap.api.asset.EmptyAsset;
import org.junit.Assert;
import org.junit.Test;
import org.junit.runner.RunWith;
@@ -177,10 +177,9 @@
{
@Deployment
public static JavaArchive createTestArchive() {
- return ShrinkWrap.create("test.jar", JavaArchive.class)
+ return ShrinkWrap.create(JavaArchive.class, "test.jar")
.addClasses(GreetingManager.class, GreetingManagerBean.class)
- .addManifestResource(new ByteArrayAsset(new byte[0])),
- ArchivePaths.create("beans.xml"));
+ .addManifestResource(EmptyAsset.INSTANCE, ArchivePaths.create("beans.xml"));
}
@Inject GreetingManager greetingManager;
@@ -252,7 +251,7 @@
<programlisting role="JAVA"><![CDATA[public class UserRepositoryTest extends Arquillian {
@Deployment
public static JavaArchive createTestArchive() {
- return ShrinkWrap.create("test.jar", JavaArchive.class)
+ return ShrinkWrap.create(JavaArchive.class, "test.jar")
.addClasses(User.class, UserRepository.class, UserRepositoryBean.class)
.addManifestResource(
"test-persistence.xml",
@@ -307,7 +306,7 @@
public class InjectionTestCase {
@Deployment
public static JavaArchive createTestArchive() {
- return ShrinkWrap.create("test.jar", JavaArchive.class)
+ return ShrinkWrap.create(JavaArchive.class, "test.jar")
.addClasses(MessageEcho.class, QueueRequestor.class);
}
Modified: arquillian/trunk/doc/reference/src/main/docbook/en-US/execution.xml
===================================================================
--- arquillian/trunk/doc/reference/src/main/docbook/en-US/execution.xml 2010-07-27 15:30:46 UTC (rev 4800)
+++ arquillian/trunk/doc/reference/src/main/docbook/en-US/execution.xml 2010-07-27 17:34:59 UTC (rev 4801)
@@ -90,7 +90,7 @@
</itemizedlist>
<para>
- Consult the <ulink url="http://docs.jboss.org/shrinkwrap/1.0.0-alpha-9/">ShrinkWrap API</ulink> to discover all the options you have available for constructing the test archive.
+ Consult the <ulink url="http://docs.jboss.org/shrinkwrap/1.0.0-alpha-11/">ShrinkWrap API</ulink> to discover all the options you have available for constructing the test archive.
</para>
</section>
@@ -236,16 +236,14 @@
Here is an overview of the expected output of the packaging process when you provide a <literal>@Deployment</literal>.
</para>
<table frame="all">
- <title>EEDeploymentPackager rules</title>
- <tgroup cols="4">
+ <title>Servlet Protocol 2.5 rules</title>
+ <tgroup cols="3">
<colspec colnum="1" colname="name" colwidth="2*"/>
- <colspec colnum="2" colname="type" colwidth="1*"/>
- <colspec colnum="3" colname="compliance" colwidth="2*"/>
- <colspec colnum="4" colname="artifactId" colwidth="5*"/>
+ <colspec colnum="2" colname="output" colwidth="2*"/>
+ <colspec colnum="3" colname="artifactId" colwidth="6*"/>
<thead>
<row>
<entry>@Deployment</entry>
- <entry>Servlet EE v.</entry>
<entry>Output</entry>
<entry>Action</entry>
</row>
@@ -253,13 +251,11 @@
<tbody>
<row>
<entry>JavaArchive</entry>
- <entry>EE 5</entry>
<entry>EnterpriseArchive</entry>
<entry>Create a new <literal>EnterpriseArchive</literal>, add <literal>@Deployment</literal> and <literal>ServletProtocol</literal> as module, the other <literal>Auxiliary Archives</literal> as libraries.</entry>
</row>
<row>
<entry>WebArchive</entry>
- <entry>EE 5</entry>
<entry>Exception</entry>
<entry>
Can not merge two <literal>WebArchives</literal> and both packaged in a <literal>EnterpriseArchive</literal> will result in isolation issues.
@@ -271,34 +267,47 @@
</row>
<row>
<entry>EnterpriseArchive</entry>
- <entry>EE 5</entry>
<entry>EnterpriseArchive</entry>
<entry>Same as <literal>JavaArchive</literal>, but using the <literal>@Deployment</literal> defined <literal>EnterpriseArchive</literal> instead of creating a new.</entry>
</row>
+ </tbody>
+ </tgroup>
+ </table>
+ <table frame="all">
+ <title>Servlet Protocol 3.0 rules</title>
+ <tgroup cols="3">
+ <colspec colnum="1" colname="name" colwidth="2*"/>
+ <colspec colnum="2" colname="output" colwidth="2*"/>
+ <colspec colnum="3" colname="artifactId" colwidth="6*"/>
+ <thead>
<row>
+ <entry>@Deployment</entry>
+ <entry>Output</entry>
+ <entry>Action</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
<entry>JavaArchive</entry>
- <entry>EE 6</entry>
<entry>WebArchive</entry>
<entry>Creates a new <literal>WebArchive</literal>, adds <literal>@Deployment</literal> and <literal>Auxiliary Archives</literal> as libraries.</entry>
</row>
<row>
<entry>WebArchive</entry>
- <entry>EE 6</entry>
<entry>WebArchive</entry>
<entry>Adds <literal>@Deployment</literal> and <literal>Auxiliary Archives</literal> as libraries.</entry>
</row>
<row>
<entry>EnterpriseArchive</entry>
- <entry>EE 6</entry>
<entry>EnterpriseArchive</entry>
- <entry>Finds the protocol <literal>JavaArchive</literal> based on name(<filename>arquillian-protocol.jar</filename>), wraps this jar in a <literal>WebArchive</literal> and adds it as a module. The other <literal>Auxiliary Archives</literal> are added as libraries.</entry>
+ <entry>Creates a new <literal>WebArchive</literal>, adds <literal>@Deployment</literal> and <literal>Auxiliary Archives</literal> as libraries.</entry>
</row>
</tbody>
</tgroup>
</table>
<note>
<para>
- In Alpha-2 Arquillian only has one protocol implementation for communicating with remote servers, the servlet protocol.
+ In Alpha3 Arquillian only has one type of protocol implementation for communicating with remote servers, the servlet protocol.
So the reason for the big difference in packaging between EE 5 and EE 6 containers is mainly due to the support of
Web Fragments in the EE 6 specification. Web Fragments lets Arquillian add it self to the <literal>@Deployment</literal>
without drastically changing it, but it also means it has to be a <literal>WebArchive</literal> in the deployment.
Added: arquillian/trunk/doc/reference/src/main/docbook/en-US/extension_performance.xml
===================================================================
--- arquillian/trunk/doc/reference/src/main/docbook/en-US/extension_performance.xml (rev 0)
+++ arquillian/trunk/doc/reference/src/main/docbook/en-US/extension_performance.xml 2010-07-27 17:34:59 UTC (rev 4801)
@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+ "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" []>
+
+<section id="extension.performance">
+
+ <title>Performance</title>
+
+ <para id="extension.performance.description">
+ </para>
+
+ Code example
+ <programlisting role="JAVA"><![CDATA[]]></programlisting>
+
+ Maven setup example
+ <programlisting role="XML"><![CDATA[]]></programlisting>
+</section>
\ No newline at end of file
Added: arquillian/trunk/doc/reference/src/main/docbook/en-US/extension_reference.xml
===================================================================
--- arquillian/trunk/doc/reference/src/main/docbook/en-US/extension_reference.xml (rev 0)
+++ arquillian/trunk/doc/reference/src/main/docbook/en-US/extension_reference.xml 2010-07-27 17:34:59 UTC (rev 4801)
@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+ "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" []>
+
+<chapter id="extension.reference">
+ <title>Complete Extension Reference</title>
+
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="extension_performance.xml" />
+ <!-- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="extension_jsfunit.xml" /> -->
+
+</chapter>
Modified: arquillian/trunk/doc/reference/src/main/docbook/en-US/gettingstarted.xml
===================================================================
--- arquillian/trunk/doc/reference/src/main/docbook/en-US/gettingstarted.xml 2010-07-27 15:30:46 UTC (rev 4800)
+++ arquillian/trunk/doc/reference/src/main/docbook/en-US/gettingstarted.xml 2010-07-27 17:34:59 UTC (rev 4801)
@@ -56,7 +56,7 @@
<programlisting role="XML"><![CDATA[<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
- <version>4.6</version>
+ <version>4.8.1</version>
<scope>test</scope>
</dependency>
@@ -162,7 +162,7 @@
<programlisting role="JAVA"><![CDATA[@Deployment
public static JavaArchive createTestArchive() {
- return ShrinkWrap.create("test.jar", JavaArchive.class)
+ return ShrinkWrap.create(JavaArchive.class, "test.jar")
.addClasses(TemperatureConverter.class)
.addManifestResource(
new ByteArrayAsset("<beans/>".getBytes()),
@@ -192,10 +192,10 @@
@Deployment
public static JavaArchive createTestArchive() {
- return ShrinkWrap.create("test.jar", JavaArchive.class)
+ return ShrinkWrap.create(JavaArchive.class, "test.jar")
.addClasses(TemperatureConverter.class)
.addManifestResource(
- new ByteArrayAsset("<beans/>".getBytes()),
+ EmptyAsset.INSTANCE,
ArchivePaths.create("beans.xml"));
}
@@ -224,10 +224,10 @@
@Deployment
public static JavaArchive createTestArchive() {
- return ShrinkWrap.create("test.jar", JavaArchive.class)
+ return ShrinkWrap.create(JavaArchive.class, "test.jar")
.addClasses(TemperatureConverter.class)
.addManifestResource(
- new ByteArrayAsset("<beans/>".getBytes()),
+ EmptyAsset.INSTANCE,,
ArchivePaths.create("beans.xml"));
}
@@ -295,6 +295,12 @@
<artifactId>arquillian-jbossas-remote-6</artifactId>
<version>${arquillian.version}</version>
</dependency>
+ <dependency>
+ <groupId>org.jboss.jbossas</groupId>
+ <artifactId>jboss-as-client</artifactId>
+ <version>6.0.0.20100429-M3</version>
+ <type>pom</type>
+ </dependency>
</dependencies>
</profile>
</profiles>]]></programlisting>
@@ -361,7 +367,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>jbossas-remote-60</literal>; you also need
+ Select the Maven property sheet and in the first form field, enter <literal>jbossas-remote-6</literal>; you also need
to tell Maven to not resolve depedencies from the workspace (this interferes with resource loading):
</para>
@@ -413,7 +419,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>jbossas-remote-60</literal> profile as shown here:
+ use to set the active Maven profile. Select the <literal>jbossas-remote-6</literal> profile as shown here:
</para>
<mediaobject>
Modified: arquillian/trunk/doc/reference/src/main/docbook/en-US/master.xml
===================================================================
--- arquillian/trunk/doc/reference/src/main/docbook/en-US/master.xml 2010-07-27 15:30:46 UTC (rev 4800)
+++ arquillian/trunk/doc/reference/src/main/docbook/en-US/master.xml 2010-07-27 17:34:59 UTC (rev 4801)
@@ -20,6 +20,8 @@
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="container_reference.xml" />
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="extension_reference.xml" />
+
<!--
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="scenarios.xml" />
-->
More information about the jboss-svn-commits
mailing list