Author: rsmeral Date: 2013-06-13 09:03:20 -0400 (Thu, 13 Jun 2013) New Revision: 15564 Added: branches/enterprise/WFK-2_1/examples/README.md Removed: branches/enterprise/WFK-2_1/examples/readme.txt Log: Rename readme Added: branches/enterprise/WFK-2_1/examples/README.md =================================================================== --- branches/enterprise/WFK-2_1/examples/README.md (rev 0) +++ branches/enterprise/WFK-2_1/examples/README.md 2013-06-13 13:03:20 UTC (rev 15564) @@ -0,0 +1,78 @@ +Seam Example EE6 Applications +============================= +This directory contains the Seam example applications, which have all been +tested on the latest release of JBoss EAP 6.0. Consult the `README.md` file in each of +the examples to see details. + +The name of each example, refered to later as `${example.name}`, is equivalent to the name of the folder. + +---------------------------------------------------------------------- + +## Deploying and Testing an Example Application + +These are general instructions for deploying Seam examples. Take a look at the +`README.md` file in the example to see if there are any specific instructions. + +### How to Build and Deploy an Example on EAP 6 + +1. Download and unzip JBoss EAP 6 + + https://access.redhat.com/downloads + +2. Make sure you have set up WFK and EAP 6 Maven repositories. + More details how to do that, you can read in JBoss Web Framework Kit documentation book called Maven + Repository Guide. + +3. Build the example by running the following command from the Seam + `examples/${example.name}` directory: + + mvn clean install + + _NOTE: There is an option to create an "exploded" archive. For this purpose, use `-Pexploded` maven profile._ + +4. Deploy the example by running the following command from the `examples/${example.name}/{example.name}-ear` + directory in case of an EAR packaged example or from `examples/${example.name}/{example.name}-war` + in case of a WAR packaged example: + + mvn jboss-as:deploy + + To undeploy the example, run: + + mvn jboss-as:undeploy + +5. Point your web browser to: + + http://localhost:8080/seam-${example.name} + + The context path is set to the final name of the EAR archive. + + However, WAR deployments use a different naming convention for the context + path. If you deploy a WAR example, point your web browser to: + + http://localhost:8080/${example.name}-web + + The WAR examples are: + spring, jpa, hibernate, groovybooking. + +_NOTE: The examples use the H2 default database embedded in JBoss EAP 6._ + + +### Running The Integration Tests + +Integration tests can be executed during a build of the application using: + + mvn clean install -Darquillian=jbossas-{managed,remote}-7 + + +## Running functional tests on an example + +The following steps describe executing of functional tests in general. +Some examples are not covered with functional tests and thus don't contain +the `${example.name}-ftest` folder. + +* Start JBoss EAP 6 Server +* Set `JBOSS_HOME` environment property, respectively + +To run functional tests: + + mvn clean test -f ${example.name}/${example.name}-ftest/pom.xml \ No newline at end of file Deleted: branches/enterprise/WFK-2_1/examples/readme.txt =================================================================== --- branches/enterprise/WFK-2_1/examples/readme.txt 2013-06-13 13:02:27 UTC (rev 15563) +++ branches/enterprise/WFK-2_1/examples/readme.txt 2013-06-13 13:03:20 UTC (rev 15564) @@ -1,78 +0,0 @@ -Seam Example EE6 Applications -============================= -This directory contains the Seam example applications, which have all been -tested on the latest release of JBoss EAP 6.0. Consult the `README.md` file in each of -the examples to see details. - -The name of each example, refered to later as `${example.name}`, is equivalent to the name of the folder. - ----------------------------------------------------------------------- - -## Deploying and Testing an Example Application - -These are general instructions for deploying Seam examples. Take a look at the -`README.md` file in the example to see if there are any specific instructions. - -### How to Build and Deploy an Example on EAP 6 - -1. Download and unzip JBoss EAP 6 - - https://access.redhat.com/downloads - -2. Make sure you have set up WFK and EAP 6 Maven repositories. - More details how to do that, you can read in JBoss Web Framework Kit documentation book called Maven - Repository Guide. - -3. Build the example by running the following command from the Seam - `examples/${example.name}` directory: - - mvn clean install - - _NOTE: There is an option to create an "exploded" archive. For this purpose, use `-Pexploded` maven profile._ - -4. Deploy the example by running the following command from the `examples/${example.name}/{example.name}-ear` - directory in case of an EAR packaged example or from `examples/${example.name}/{example.name}-war` - in case of a WAR packaged example: - - mvn jboss-as:deploy - - To undeploy the example, run: - - mvn jboss-as:undeploy - -5. Point your web browser to: - - http://localhost:8080/seam-${example.name} - - The context path is set to the final name of the EAR archive. - - However, WAR deployments use a different naming convention for the context - path. If you deploy a WAR example, point your web browser to: - - http://localhost:8080/${example.name}-web - - The WAR examples are: - spring, jpa, hibernate, groovybooking. - -_NOTE: The examples use the H2 default database embedded in JBoss EAP 6._ - - -### Running The Integration Tests - -Integration tests can be executed during a build of the application using: - - mvn clean install -Darquillian=jbossas-{managed,remote}-7 - - -## Running functional tests on an example - -The following steps describe executing of functional tests in general. -Some examples are not covered with functional tests and thus don't contain -the `${example.name}-ftest` folder. - -* Start JBoss EAP 6 Server -* Set `JBOSS_HOME` environment property, respectively - -To run functional tests: - - mvn clean test -f ${example.name}/${example.name}-ftest/pom.xml \ No newline at end of file