[jboss-svn-commits] JBoss Common SVN: r4803 - 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 15:05:16 EDT 2010
Author: aslak
Date: 2010-07-27 15:05:16 -0400 (Tue, 27 Jul 2010)
New Revision: 4803
Modified:
arquillian/trunk/doc/reference/src/main/docbook/en-US/container_glassfish-remote-3.xml
arquillian/trunk/doc/reference/src/main/docbook/en-US/container_jbossas-managed-5.1.xml
arquillian/trunk/doc/reference/src/main/docbook/en-US/container_jbossas-managed-6.xml
arquillian/trunk/doc/reference/src/main/docbook/en-US/container_jetty-embedded-6.1.xml
arquillian/trunk/doc/reference/src/main/docbook/en-US/container_jetty-embedded-7.xml
arquillian/trunk/doc/reference/src/main/docbook/en-US/container_reference.xml
arquillian/trunk/doc/reference/src/main/docbook/en-US/container_tomcat-embedded-6.xml
arquillian/trunk/doc/reference/src/main/docbook/en-US/intro.xml
Log:
ARQ-214 Added new Mission Statement and updated Configuration namespace
Modified: arquillian/trunk/doc/reference/src/main/docbook/en-US/container_glassfish-remote-3.xml
===================================================================
--- arquillian/trunk/doc/reference/src/main/docbook/en-US/container_glassfish-remote-3.xml 2010-07-27 19:02:14 UTC (rev 4802)
+++ arquillian/trunk/doc/reference/src/main/docbook/en-US/container_glassfish-remote-3.xml 2010-07-27 19:05:16 UTC (rev 4803)
@@ -72,15 +72,15 @@
<title>Configuration</title>
<para>
- Namespace: urn:arq:org.jboss.arquillian.glassfish.remote_3
+ Namespace: urn:arq:org.jboss.arquillian.container.glassfish.remote_3
</para>
<table frame="all">
<title>Container Configuration Options</title>
<tgroup cols="4">
- <colspec colnum="1" colname="name" colwidth="2*" />
+ <colspec colnum="1" colname="name" colwidth="3*" />
<colspec colnum="2" colname="type" colwidth="1*" />
- <colspec colnum="3" colname="default" colwidth="3*" />
- <colspec colnum="4" colname="description" colwidth="4*" />
+ <colspec colnum="3" colname="default" colwidth="4*" />
+ <colspec colnum="4" colname="description" colwidth="2*" />
<thead>
<row>
<entry>Name</entry>
Modified: arquillian/trunk/doc/reference/src/main/docbook/en-US/container_jbossas-managed-5.1.xml
===================================================================
--- arquillian/trunk/doc/reference/src/main/docbook/en-US/container_jbossas-managed-5.1.xml 2010-07-27 19:02:14 UTC (rev 4802)
+++ arquillian/trunk/doc/reference/src/main/docbook/en-US/container_jbossas-managed-5.1.xml 2010-07-27 19:05:16 UTC (rev 4803)
@@ -101,6 +101,12 @@
<entry>$JAVA_HOME</entry>
<entry>The Java runtime to use to start the server.</entry>
</row>
+ <row>
+ <entry>javaVmArguments</entry>
+ <entry>String</entry>
+ <entry>-Xmx512m -XX:MaxPermSize=128m</entry>
+ <entry>JVM arguments used to start the server.</entry>
+ </row>
</tbody>
</tgroup>
</table>
Modified: arquillian/trunk/doc/reference/src/main/docbook/en-US/container_jbossas-managed-6.xml
===================================================================
--- arquillian/trunk/doc/reference/src/main/docbook/en-US/container_jbossas-managed-6.xml 2010-07-27 19:02:14 UTC (rev 4802)
+++ arquillian/trunk/doc/reference/src/main/docbook/en-US/container_jbossas-managed-6.xml 2010-07-27 19:05:16 UTC (rev 4803)
@@ -115,6 +115,12 @@
<entry>$JAVA_HOME</entry>
<entry>The Java runtime to use to start the server.</entry>
</row>
+ <row>
+ <entry>javaVmArguments</entry>
+ <entry>String</entry>
+ <entry>-Xmx512m -XX:MaxPermSize=128m</entry>
+ <entry>JVM arguments used to start the server.</entry>
+ </row>
</tbody>
</tgroup>
</table>
Modified: arquillian/trunk/doc/reference/src/main/docbook/en-US/container_jetty-embedded-6.1.xml
===================================================================
--- arquillian/trunk/doc/reference/src/main/docbook/en-US/container_jetty-embedded-6.1.xml 2010-07-27 19:02:14 UTC (rev 4802)
+++ arquillian/trunk/doc/reference/src/main/docbook/en-US/container_jetty-embedded-6.1.xml 2010-07-27 19:05:16 UTC (rev 4803)
@@ -69,7 +69,7 @@
<title>Configuration</title>
<para>
- Namespace: urn:arq:org.jboss.arquillian.jetty.embedded_6_1
+ Namespace: urn:arq:org.jboss.arquillian.container.jetty.embedded_6_1
</para>
<table frame="all">
<title>Container Configuration Options</title>
Modified: arquillian/trunk/doc/reference/src/main/docbook/en-US/container_jetty-embedded-7.xml
===================================================================
--- arquillian/trunk/doc/reference/src/main/docbook/en-US/container_jetty-embedded-7.xml 2010-07-27 19:02:14 UTC (rev 4802)
+++ arquillian/trunk/doc/reference/src/main/docbook/en-US/container_jetty-embedded-7.xml 2010-07-27 19:05:16 UTC (rev 4803)
@@ -69,7 +69,7 @@
<title>Configuration</title>
<para>
- Namespace: urn:arq:org.jboss.arquillian.jetty.embedded_7
+ Namespace: urn:arq:org.jboss.arquillian.container.jetty.embedded_7
</para>
<table frame="all">
<title>Container Configuration Options</title>
Modified: arquillian/trunk/doc/reference/src/main/docbook/en-US/container_reference.xml
===================================================================
--- arquillian/trunk/doc/reference/src/main/docbook/en-US/container_reference.xml 2010-07-27 19:02:14 UTC (rev 4802)
+++ arquillian/trunk/doc/reference/src/main/docbook/en-US/container_reference.xml 2010-07-27 19:05:16 UTC (rev 4803)
@@ -21,5 +21,6 @@
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="container_weld-ee-embedded-1.1.xml" />
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="container_openwebbeans-embedded-1.xml" />
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="container_openejb-embedded-3.1.xml" />
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="container_osgi-embedded-4.2.xml" />
</chapter>
Modified: arquillian/trunk/doc/reference/src/main/docbook/en-US/container_tomcat-embedded-6.xml
===================================================================
--- arquillian/trunk/doc/reference/src/main/docbook/en-US/container_tomcat-embedded-6.xml 2010-07-27 19:02:14 UTC (rev 4802)
+++ arquillian/trunk/doc/reference/src/main/docbook/en-US/container_tomcat-embedded-6.xml 2010-07-27 19:05:16 UTC (rev 4803)
@@ -103,7 +103,7 @@
<title>Configuration</title>
<para>
- Namespace: urn:arq:org.jboss.arquillian.tomcat.embedded_6
+ Namespace: urn:arq:org.jboss.arquillian.container.tomcat.embedded_6
</para>
<table frame="all">
<title>Container Configuration Options</title>
Modified: arquillian/trunk/doc/reference/src/main/docbook/en-US/intro.xml
===================================================================
--- arquillian/trunk/doc/reference/src/main/docbook/en-US/intro.xml 2010-07-27 19:02:14 UTC (rev 4802)
+++ arquillian/trunk/doc/reference/src/main/docbook/en-US/intro.xml 2010-07-27 19:05:16 UTC (rev 4803)
@@ -19,56 +19,71 @@
<section id="mission">
<title>Mission statement</title>
- <para>
- The mission of the Arquillian project is to provide a simple test harness that developers can use to produce a
- broad range of integration tests for their Java applications (most likely enterprise applications). A test case
- may be executed within the container, deployed alongside the code under test, or by coordinating with the
- container, acting as a client to the deployed code.
- </para>
+ <para>
+ Arquillian is the missing link in Java EE development. Developers have long had to fend for themselves in the testing stage, burdened with
+ bootstrapping the infrastructure on which the test depends. That's time lost, and it places a high barrier to entry on integration testing.
+ Arquillian tears down that barrier.
+ </para>
+
+ <para>
+ Arquillian is a container-oriented test framework. It picks up where unit tests leave off, targeting the integration of application code
+ inside a real runtime environment. Just as Java EE 5 simplified the server programming model by providing declarative services for POJOs,
+ Arquillian equips tests with container lifecycle management and enrichment.
+ </para>
+
+ <para>
+ With Arquillian, you write a basic test case and annotate it with declarative behavior that says, "run with Arquillian." Launching the
+ test is as simple as right-clicking the test class in the IDE and selecting Run As > JUnit or TestNG test.
+ Based on the classpath configuration, Arquillian starts or binds to the target container (JBoss AS, GlassFish, OpenEJB, etc) and
+ deploys the test case bundled with the test archive defined in the @Deployment method. Your test executes inside the container and
+ enjoys all the same services as an application component. That means you get dependency and resource injection into the test,
+ you can access EJBs, you can load a persistence unit, you can get a handle to a database connection, etc. Yet, on the surface,
+ it looks like any other unit test. (Arquillian also has a client execution mode, which only deploys the test archive, not the test case).
+ </para>
- <para>
- Arquillian defines two styles of container, remote and embedded. A remote container resides in a separate JVM
- from the test runner. Its lifecycle may be managed by Arquillian, or Arquillian may bind to a container that is
- already started. An embedded container resides in the same JVM and is mostly likely managed by Arquillian.
- Containers can be further classified by their capabilities. Examples include a fully compliant Java EE
- application server (e.g., GlassFish, JBoss AS, Embedded GlassFish), a Servlet container (e.g., Tomcat, Jetty)
- and a bean container (e.g., Weld SE). Arquillian ensures that the container used for testing is pluggable, so
- the developer is not locked into a proprietary testing environment.
- </para>
-
- <para>
- Arquillian seeks to minimize the burden on the developer to carry out integration testing by handling all
- aspects of test execution, including:
- </para>
-
+ <para>
+ Instead of bringing your runtime to the test, Arquillian brings your test to the runtime.
+ </para>
+
+ <para>
+ Features of Arquillian include:
+
<itemizedlist>
<listitem>
- <para>managing the lifecycle of the container (start/stop),</para>
+ <para>Runnable from both JUnit and TestNG</para>
</listitem>
<listitem>
- <para>bundling the test class with dependent classes and resources into a deployable archive,</para>
+ <para>Abstracts out server lifecycle and deployment</para>
</listitem>
<listitem>
- <para>enhancing the test class (e.g., resolving @Inject, @EJB and @Resource injections),</para>
+ <para>Injects resources like managed beans, EJBs or objects from JNDI into the test instance</para>
</listitem>
<listitem>
- <para>deploying the archive to test (deploy/undeploy) and</para>
+ <para>Zero reliance upon a formal build; can be run or debugged from IDEs like Eclipse, IDEA, NetBeans</para>
</listitem>
<listitem>
- <para>capturing results and failures.</para>
+ <para>Supports remote and embedded containers: JBoss AS, GlassFish, Jetty, Tomcat, OpenEJB, OSGi and more on the way</para>
</listitem>
+ <listitem>
+ <para>Enables pass-by-reference between the test and the server, even if the server is in another JVM from the test launcher</para>
+ </listitem>
+ <listitem>
+ <para>Provides an extensible SPI - plug in your own containers and take advantage of the Arquillian bus to provide services to the test</para>
+ </listitem>
</itemizedlist>
-
- <para>
- To avoid introducing unnecessary complexity into the developer's build environment, Arquillian integrates
- transparently with familiar testing frameworks (e.g., JUnit 4, TestNG 5), allowing tests to be launched using
- existing IDE, Ant and Maven test plugins without any add-ons.
- </para>
-
- <para>
- Arquillian makes integration testing a breeze.
- </para>
+ </para>
+
+ <para>
+ No longer does writing a test involve system administration tasks. No more custom scripts or copy-paste Maven configuration.
+ No more full builds. No more test classpath mayhem. No more looking up resources manually in JNDI. No more reliance on coarse-grained,
+ black-box testing.
+ </para>
+
+ <para>
+ Arquillian keeps you focused on the test, while enjoying the services provided by the container. And it's turning heads.
+ </para>
+
</section>
<section id="overview">
More information about the jboss-svn-commits
mailing list