Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Tidy up readmes

  • Loading branch information...
commit 8e4b8eebfdfe4abda22fe4f600b3344e16207b64 1 parent 594e541
Pete Muir pmuir authored
Showing with 145 additions and 106 deletions.
  1. +117 −0 jboss-javaee-6.0-with-tools/README.md
  2. +28 −106 readme.md
117 jboss-javaee-6.0-with-tools/README.md
View
@@ -0,0 +1,117 @@
+Java EE lacks any testing APIs, and for this reason JBoss developed the Arquillian project, along with it's various component projects, such as Arquillian Drone, and the sister project Shrinkwrap. This BOM builds on the Java EE full profile BOM, adding Arquillian to the mix. It also provides a version of JUnit and TestNG recommended for use with Arquillian.
+
+Furthermore, this BOM adds the JBoss AS Maven deployment plugin. EAP 6's recommended mode of deployment is via the management APIs, and the Maven plugin is the recommended way to do this, if the customer is using Maven for building.
+
+Usage
+=====
+
+To use the BOM, import into your dependency management:
+
+ <dependencyManagement>
+ <dependencies>
+ <dependency>
+ <groupId>org.jboss.spec</groupId>
+ <artifactId>jboss-javaee-web-6.0-with-tools-</artifactId>
+ <version>7.0.2.CR1</version>
+ <scope>import</scope>
+ </dependency>
+ </dependencies>
+ </dependencyManagement>
+
+Unfortunately, Maven doesn't allow you to specify plugin versions this way. To use the plugins associated with "Java EE with Tools recommended by JBoss" BOM, add:
+
+ <pluginManagement>
+ <plugins>
+ <!-- The Maven Surefire plugin tests your application. Here we ensure we are using a version compatible with Arquillian -->
+ <plugin>
+ <artifactId>maven-surefire-plugin</artifactId>
+ <version>2.10</version>
+ </plugin>
+ <!-- The JBoss AS plugin deploys your war to a local JBoss AS container -->
+ <!-- To use, set the JBOSS_HOME environment variable and run:
+ mvn package jboss-as:deploy -->
+ <plugin>
+ <groupId>org.jboss.as.plugins</groupId>
+ <artifactId>jboss-as-maven-plugin</artifactId>
+ <version>7.1.0.CR1b</version>
+ </plugin>
+ </plugins>
+ </pluginManagement>
+
+You'll need to take a look at the POM source in order to find the latest versions of plugins recommended.
+
+
+Deploying/undeploying your application to server
+------------------------------------------------
+
+To be able to easily deploy (or undeploy) your application from the application server, include following in the ``<build>`` section of your pom.xml file:
+
+ <plugins>
+ <plugin>
+ <groupId>org.jboss.as.plugins</groupId>
+ <artifactId>jboss-as-maven-plugin</artifactId>
+ </plugin>
+ </plugins>
+
+You'll be able to deploy your application via `mvn package jboss-as:deploy`. See <https://github.com/jbossas/jboss-as-maven-plugin> for further information how to use the plugin.
+
+Testing your application with Arquillian
+----------------------------------------
+
+To able to test your application with Arquillian, you have decide which type container you prefer. Arquillian allows you to choose
+between a managed invocation, where it controls startup and shutdown of the container and a remote invocation, which connects to a running instance of JBoss AS.
+See <https://docs.jboss.org/author/display/ARQ/Container+varieties> for further details. You may wish to set up two distint profiles, each using one type of
+the container.
+
+To select JBoss AS 7 managed container, following dependency has to be added into the `<dependencies>` section of your pom.xml file:
+
+ <dependency>
+ <groupId>org.jboss.as</groupId>
+ <artifactId>jboss-as-arquillian-container-managed</artifactId>
+ <scope>test</scope>
+ </dependency>
+
+Or for JBoss AS 7 remote container:
+
+ <dependency>
+ <groupId>org.jboss.as</groupId>
+ <artifactId>jboss-as-arquillian-container-remote</artifactId>
+ <scope>test</scope>
+ </dependency>
+
+Apart from setting a container, you need to choose a testing framework (e.g. JUnit) and add the Arquillan bindings for it:
+
+ <dependency>
+ <groupId>junit</groupId>
+ <artifactId>junit</artifactId>
+ <scope>test</scope>
+ </dependency>
+
+ <dependency>
+ <groupId>org.jboss.arquillian.junit</groupId>
+ <artifactId>arquillian-junit-container</artifactId>
+ <scope>test</scope>
+ </dependency>
+
+*Note: Don't forget to set JBOSS_HOME environment variable so Arquillian will be able to find your container location.
+If you want to experiment with Arquillian settings, you can find plenty of information at <http://arqpreview-alrubinger.rhcloud.com/>*
+
+Testing your application with Arquillian Drone
+----------------------------------------------
+
+Arquillian Drone uses the very same setup as plain Arquillian. Arquillian Drone lets you choice between different Selenium bindings.
+Here we cover Arquillian Ajocado, for further binding please follow <https://docs.jboss.org/author/display/ARQ/Drone>.
+
+In order to use Arquillian with Arquillian Drone, include following dependency into your ``<dependencies>`` section:
+
+ <dependency>
+ <groupId>org.jboss.arquillian.ajocado</groupId>
+ <artifactId>arquillian-ajocado-junit</artifactId>
+ <scope>test</scope>
+ <type>pom</type>
+ </dependency>
+
+*Note: Ajocado already contains a certified version of Selenium. Should you need to use a different version (for example to test your
+application in a newer very new browser, compatible with the latest Selenium version only), you can get more information how to do that
+at <https://community.jboss.org/wiki/SpecifyingSeleniumVersionInArquillianDrone>*
+
134 readme.md
View
@@ -1,41 +1,27 @@
-Description
-===========
-
-Maven BOM files enhancing Jave EE 6 with deployment and test tooling. These files manage version of dependencies you
-want to use in your project, so you can pretty sure you always get a compatible stack.
+Maven BOM files enhancing Jave EE 6 with deployment and test tooling. These files manage the version of the dependencies
+you use in your project, ensuring you always get a compatible stack.
Usage
=====
-Depending whether you want to use Java EE 6 Web Profile or Java EE 6 Full Profile, add following into your pom.xml:
-
- <dependencyManagement>
- <dependencies>
- <dependency>
- <groupId>org.jboss.spec</groupId>
- <artifactId>jboss-javaee-web-6.0-with-tools-</artifactId>
- <version>1.0.0-SNAPSHOT</version>
- </dependency>
- </dependencies>
- </dependencyManagement>
+To use the BOM, import into your dependency management. For example, if you wanted "Java EE with Tools recommended by JBoss", use:
+
+ <dependencyManagement>
+ <dependencies>
+ <dependency>
+ <groupId>org.jboss.spec</groupId>
+ <artifactId>jboss-javaee-web-6.0-with-tools-</artifactId>
+ <version>7.0.2.CR1</version>
+ <scope>import</scope>
+ </dependency>
+ </dependencies>
+ </dependencyManagement>
-Respectively, for the Java EE Full Profile:
-
- <dependencyManagement>
- <dependencies>
- <dependency>
- <groupId>org.jboss.spec</groupId>
- <artifactId>jboss-javaee-6.0-with-tools-</artifactId>
- <version>1.0.0-SNAPSHOT</version>
- </dependency>
- </dependencies>
- </dependencyManagement>
+Unfortunately, Maven doesn't allow you to specify plugin versions this way. The readme for each BOM calls out any plugin versions you should use. For example, to use the plugins associated with "Java EE with Tools recommended by JBoss":
-Later, you have to ensure you're running with correct versions of plugin. Add following snippet to ``<build>`` section of your pom.xml:
-
- <pluginManagement>
- <plugins>
- <!-- The Maven Surefire plugin tests your application. Here we ensure we are using a version compatible with Arquillian -->
+ <pluginManagement>
+ <plugins>
+ <!-- The Maven Surefire plugin tests your application. Here we ensure we are using a version compatible with Arquillian -->
<plugin>
<artifactId>maven-surefire-plugin</artifactId>
<version>2.10</version>
@@ -49,83 +35,19 @@ Later, you have to ensure you're running with correct versions of plugin. Add fo
<version>7.1.0.CR1b</version>
</plugin>
</plugins>
- </pluginManagement>
+ </pluginManagement>
+
+You'll need to take a look at the POM source in order to find the latest versions of plugins recommended.
Use cases
=========
-There are various use case, let's cover the most popular ones.
-
-Deploying/undeploying your application to server
-------------------------------------------------
-
-To be able to easily deploy (or undeploy) your application from the application server, include following in the ``<build>`` section of your pom.xml file:
-
- <plugins>
- <plugin>
- <groupId>org.jboss.as.plugins</groupId>
- <artifactId>jboss-as-maven-plugin</artifactId>
- </plugin>
- </plugins>
-
-You'll be able to deploy your application via ``mvn package jboss-as:deploy``. See <https://github.com/jbossas/jboss-as-maven-plugin> for further information how to use the plugin.
-
-Testing your application with Arquillian
-----------------------------------------
-
-To able to test your application with Arquillian, you have decide which type container invocation you prefer. Arquillian allows you to choice
-between a managed invocation, where it controls startup and shutdown of the container and a remote invocation, which connects to an already running
-container. See <https://docs.jboss.org/author/display/ARQ/Container+varieties> for further details. If you are experienced Maven user, you can
-obviously set up two distint profiles, each using one type of the container.
-
-To select JBoss AS 7 managed container, following dependency has to be added into the ``<dependencies>`` section of your pom.xml file:
-
- <dependency>
- <groupId>org.jboss.as</groupId>
- <artifactId>jboss-as-arquillian-container-managed</artifactId>
- <scope>test</scope>
- </dependency>
-
-On the other hand, for JBoss AS 7 remote container, the dependency coordinates looks are:
-
- <dependency>
- <groupId>org.jboss.as</groupId>
- <artifactId>jboss-as-arquillian-container-remote</artifactId>
- <scope>test</scope>
- </dependency>
-
-Apart from setting a container, you need to add a testing framework (e.g. JUnit) and Arquillan bindings for it:
-
- <dependency>
- <groupId>junit</groupId>
- <artifactId>junit</artifactId>
- <scope>test</scope>
- </dependency>
-
- <dependency>
- <groupId>org.jboss.arquillian.junit</groupId>
- <artifactId>arquillian-junit-container</artifactId>
- <scope>test</scope>
- </dependency>
-
-*Note: Don't forget to set JBOSS_HOME environment variable so Arquillian will be able to find your container location.
-If you want to experiment with Arquillian settings, you can find plenty of information at <http://arqpreview-alrubinger.rhcloud.com/>*
+A number of BOMs are provided, each of which address a specific use case. If your usage falls into a number of use cases, simply use all of the relevant BOMs.
-Testing your application with Arquillian Drone
-----------------------------------------------
+jboss-javaee-6.0-with-tools: Java EE with Tools recommended by JBoss
+--------------------------------------------------------------------
-Arquillian Drone uses the very same setup as plain Arquillian. Arquillian Drone lets you choice between different Selenium bindings.
-Here we cover Arquillian Ajocado, for further binding please follow <https://docs.jboss.org/author/display/ARQ/Drone>.
-
-In order to use Arquillian with Arquillian Drone, include following dependency into your ``<dependencies>`` section:
-
- <dependency>
- <groupId>org.jboss.arquillian.ajocado</groupId>
- <artifactId>arquillian-ajocado-junit</artifactId>
- <scope>test</scope>
- <type>pom</type>
- </dependency>
-
-*Note: Ajocado already contains a certified version of Selenium. Should you need to use a different version, for example to test you
-application in a very new browser compatible with the latest Selenium only, you can get more information how to do that at <https://community.jboss.org/wiki/SpecifyingSeleniumVersionInArquillianDrone>*
-
+Java EE lacks any testing APIs, and for this reason JBoss developed the Arquillian project, along with it's various component projects, such as Arquillian Drone, and the sister project Shrinkwrap. This BOM builds on the Java EE full profile BOM, adding Arquillian to the mix. It also provides a version of JUnit and TestNG recommended for use with Arquillian.
+
+Furthermore, this BOM adds the JBoss AS Maven deployment plugin. EAP 6's recommended mode of deployment is via the management APIs, and the Maven plugin is the recommended way to do this, if the customer is using Maven for building.
+
Please sign in to comment.
Something went wrong with that request. Please try again.