Sample: JSFUnit

Content:

Introduction

Concept behind this application

Preparing for JSFUnit

-startup
plugins/org.eclipse.equinox.launcher_1.2.0.v20110502.jar
--launcher.library
plugins/org.eclipse.equinox.launcher.win32.win32.x86_1.1.100.v20110502
-showsplash
org.eclipse.platform
--launcher.XXMaxPermSize
256m
--launcher.defaultAction
openFile
-vm
C:/Program Files (x86)/Java/jdk1.6.0_26/bin/javaw.exe
-vmargs
-Xms40m
-Xmx384m

Building JSFUnit

%MAVEN_HOME%\bin\mvn.bat install

%MAVEN_HOME%\bin\mvn.bat test -Pjbossas-remote-6

 <repositories>
    <repository>
      <id>jboss-public-repository-group</id>
      <name>JBoss Public Maven Repository Group</name>
      <url>https://repository.jboss.org/nexus/content/groups/public</url>
      <layout>default</layout>
      <releases>
        <enabled>true</enabled>
        <updatePolicy>never</updatePolicy>
      </releases>
      <snapshots>
        <enabled>true</enabled>
        <updatePolicy>never</updatePolicy>
      </snapshots>
    </repository>
    <repository>
      <id>repository.jboss.org</id>
      <url>http://repository.jboss.org/maven2</url>
      <releases>
      </releases>
      <snapshots>
        <enabled>false</enabled>
      </snapshots>
    </repository>

    <repository>
      <id>jboss-deprecated-repository-group</id>
      <name>JBoss Deprecated Maven Repository Group</name>
      <url>https://repository.jboss.org/nexus/content/repositories/deprecated/</url>
      <releases>
        <enabled>true</enabled>
        <updatePolicy>never</updatePolicy>
      </releases>
      <snapshots>
        <enabled>true</enabled>
        <updatePolicy>never</updatePolicy>
      </snapshots>
    </repository>

  </repositories>

• Remove the repository URL "http://repository.jboss.org/maven2".
  
• The "deprecated" repository is required, because some JBoss module references a wrong version of "Trove", and this wrong version can be found only in this repository: http://community.jboss.org/wiki/JBossDeprecatedRepository.
  

Version 1 - Sources

Version 1 - Preparation

Version 1 - Creating the projects

This is the first difference to the projects used by the Web Tools Platform: we create a "Maven Project":

Step 1 of the wizard uses default settings:

Step 2 is more interesting: we need an archetype for a JavaEE6 web project. Here I use the archetype "jboss-javaee6-webapp":

Note that this archetype is found in a JBoss specific catalog. When first using the archetype, you have to add it first. Use this URL:

Version 1 - cleanup

Now we see a new project:



But the archetype introduced a whole bunch of files we don't need, and unfortunately it's dependencies point to JBoss 7. So, we start some cleanup;-).

• Delete all the files which are marked in the screenshot:
  • All sources in "src\main\java"
  • All sources in "src\test\java"
  • All files in "src\main\resources" ("import.sql" and the META-INF subdir)
  • "src\main\web-app\index.html" and "index.xhtml", also the whole "resources" subdir
• Open "test\resources\arquillian.xml" and remove the "container" element - it points to AS 7. Actually, you might also delete it, as it is empty after cleanup. More details about this file to be done ;-)...
• The necessary changes to "pom.xml" are described in the next chapter.

Version 1 - pom.xml

Now we are updating "pom.xml" to match our goals: we change the server dependencies from JBoss 7 to JBoss 6, and we add the configuration required for JSFUnit.

Step 0: general settings
There is this line:

   <properties>
      <!-- Explicitly declaring the source encoding eliminates the following 
         message: -->
      <!-- [WARNING] Using platform encoding (UTF-8 actually) to copy filtered 
         resources, i.e. build is platform dependent! -->
      <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

As the comment explains, this might remove a Maven warning. But I found that this default "UTF-8" did not match my own project settings on a windows machine, where the project default encoding is "Cp1252":

Here, a Maven build resulted in those errors:

[ERROR] Failed to execute goal org.apache.maven.plugins:maven-compiler-plugin:2.3.2:compile (default-compile) on project JSF: Compilation failure: Compilation failure:
[ERROR] \temp\workspace370\JSF\src\main\java\de\fhw\komponentenarchitekturen\knauf\jsf\GeometricModelHandler.java:[3,22] unmappable character for encoding UTF-8

So, either remove the "project.build.sourceEncoding" property in pom.xml, or (better) set the Eclipse project properties to UTF-8. In own sample, I removed the property - might have been a bad idea ;-).

Step 1: Java version
The archetype has already done a good job by declaring Java version 1.6. See "build" - "plugins" for the declaration of "maven-compiler-plugin". So nothing has to be changed in "pom.xml".
But if Eclipse found a JRE and used it by default (see the warning message above), you should now create a JDK configuration: in "Preferences" => "Java" => "Installed JREs" add a new one which points to a JDK:

And in "Preferences" => "Java" => "Installed JREs" => "Excecution Environments", select "JavaSE-1.6" and check the JDK instead of the JRE:

The project will reference the new JDK now.

Step 2: Repositories
Now we add some JBoss repositories. The following list is taken from the "gettingstarted" example (see above).
For more information about JBoss repositories, see here:

	<repositories>
		<repository>
			<id>jboss-public-repository-group</id>
			<name>JBoss Public Maven Repository Group</name>
			<url>https://repository.jboss.org/nexus/content/groups/public</url>
			<layout>default</layout>
			<releases>
				<enabled>true</enabled>
				<updatePolicy>never</updatePolicy>
			</releases>
			<snapshots>
				<enabled>true</enabled>
				<updatePolicy>never</updatePolicy>
			</snapshots>
		</repository>
		<!-- Deprecated Repository -->
		<repository>
			<id>jboss-deprecated-repository-group</id>
			<name>JBoss Deprecated Maven Repository Group</name>
			<url>https://repository.jboss.org/nexus/content/repositories/deprecated/</url>
			<releases>
				<enabled>true</enabled>
				<updatePolicy>never</updatePolicy>
			</releases>
			<snapshots>
				<enabled>true</enabled>
				<updatePolicy>never</updatePolicy>
			</snapshots>
		</repository>
	</repositories>
	<pluginRepositories>
		<pluginRepository>
			<id>jboss-public-repository-group</id>
			<name>JBoss Public Maven Repository Group</name>
			<url>https://repository.jboss.org/nexus/content/repositories/releases/</url>
			<layout>default</layout>
			<releases>
				<enabled>true</enabled>
				<updatePolicy>never</updatePolicy>
			</releases>
			<snapshots>
				<enabled>false</enabled>
				<updatePolicy>never</updatePolicy>
			</snapshots>
		</pluginRepository>
	</pluginRepositories>

	<properties>
		<version.jsfunit>2.0.0-SNAPSHOT</version.jsfunit>
		<version.arquillian>1.0.0.Alpha5</version.arquillian>
	</properties>

	...
	
	<dependencies>
		<dependency>
			<groupId>javax.enterprise</groupId>
			<artifactId>cdi-api</artifactId>
			<version>1.0-SP1</version>
			<scope>provided</scope>
		</dependency>

		<dependency>
			<groupId>junit</groupId>
			<artifactId>junit</artifactId>
			<version>4.8.1</version>
			<scope>test</scope>
		</dependency>

		<dependency>
			<groupId>org.jboss.arquillian</groupId>
			<artifactId>arquillian-junit</artifactId>
			<version>${version.arquillian}</version>
			<scope>test</scope>
		</dependency>

		<dependency>
			<groupId>com.sun.faces</groupId>
			<artifactId>jsf-api</artifactId>
			<version>2.0.4-b03</version>
			<scope>provided</scope>
		</dependency>

		<dependency>
			<groupId>jboss.web</groupId>
			<artifactId>servlet-api</artifactId>
			<version>3.0.0-beta-2</version>
			<scope>provided</scope>
		</dependency>


		<dependency>
			<groupId>org.jboss.jsfunit</groupId>
			<artifactId>jsfunit-arquillian</artifactId>
			<version>${version.jsfunit}</version>
			<scope>test</scope>
		</dependency>

		
		<!-- JSTL.jar: -->
		<dependency>
			<groupId>javax.servlet</groupId>
			<artifactId>jstl</artifactId>
			<version>1.2</version>
		</dependency>
	
	</dependencies>

	<profiles>

		<profile>
			<id>arq-jbossas-remote</id>
			<dependencies>
				<dependency>
					<groupId>org.jboss.arquillian.container</groupId>
					<artifactId>arquillian-jbossas-remote-6</artifactId>
					<version>${version.arquillian}</version>
					<scope>test</scope>
				</dependency>

				<dependency>
					<groupId>org.jboss.jbossas</groupId>
					<artifactId>jboss-as-profileservice-client</artifactId>
					<version>6.0.0.Final</version>
					<type>pom</type>
					<scope>test</scope>
				</dependency>
				<!-- jboss-deployers-client-spi provides deployment exception class -->
				<dependency>
					<groupId>org.jboss.deployers</groupId>
					<artifactId>jboss-deployers-client-spi</artifactId>
					<version>2.2.0.GA</version>
					<scope>test</scope>
				</dependency>
			</dependencies>
		</profile>
	</profiles>

Version 1 - First Test: creating deployable file

Now, we add the test class "de.fhw.komponentenarchitekturen.knauf.jsf.tests.GeometricModelTest" in the source directory "src\test\java" (NOT in "src\main\java").

The class header will look like this:

@RunWith(Arquillian.class)
public class GeometricModelTest
{
  ...

First step in this test is to create a deployable archive which basically has the same content as a WAR file which would be deployed by Eclipse. The Arquillian framework will deploy this archive to a remote (local running) JBoss. So we add a static method "createDeployment" and annotate it with @org.jboss.arquillian.api.Deployment:

  @Deployment
  public static WebArchive createDeployment()
  {
    WebArchive war = ShrinkWrap.create(WebArchive.class, "JSF.war");

    war.setWebXML(new File("src/main/webapp/WEB-INF/web.xml"));

    war.addClasses(GeometricModelHandler.class, Historie.class, Seitenlaengen.class, GeometricModelTest.class);

    war.addAsWebResource(new File("src/main/webapp/index.jsp"));
    war.addAsWebResource(new File("src/main/webapp/geometricmodel.jsp"));

    war.addAsWebInfResource(new File("src/main/webapp/WEB-INF//faces-config.xml"), "faces-config.xml");

    // Required for CDI Injection...
    war.addAsWebInfResource(EmptyAsset.INSTANCE, "beans.xml");

    //Find "jstl.jar" in your local maven repostory!
    File[] jars = DependencyResolvers.use(MavenDependencyResolver.class).artifact("javax.servlet:jstl:1.2").resolveAsFiles();
    war.addAsLibraries (jars);
    
    System.out.println("JSF.GeometricModelTest.createDeployment");

    System.out.println(war.toString(true));

    return war;
  }

We create a "WebArchive", using the "ShrinkWrap" API. Note that the war file name defines the default context root (if no different context root is declared), so it must be identical to the name which is used to access the app later.

• "web.xml" is put in the archive by using the method "setWebXML".
• All class files are added by using "addPackage" or "addClass". In my sample I add the package "de.fhw.komponentenarchitekturen.knauf.jsf": this contains the classes from my "JSF" project, and also the classes in the subpackage ".tests".
  But error detection for missing classes will be easier if you don't add a full package, but single classes:
  

      war.addClasses(GeometricModelHandler.class, Historie.class, Seitenlaengen.class, GeometricModelTest.class);

  This way, you will see an error message when you take some classes from a different project and this project reference is lost.
• All JSP files are added by using "addAsWebResource"
• "faces-config.xml" must be added using "addAsWebInfResource": this method adds files to "WEB-INF".
• An empty "beans.xml" is added - as far as I know this is required for CDI ("Context and Dependency Injection"). The snippet is taken from the "Getting Started" sample, I don't know in how far it is required. For more details see here: http://community.jboss.org/wiki/InjectionCDIForJSFSessionJSFClientSessionAndJSFServerSession
• "jstl.jar" can be found in our local repository. To add it to WEB-INF/lib, we have to do a repository lookup. We achieve this with the help of org.jboss.shrinkwrap.resolver.api.DependencyResolvers, using the resolver org.jboss.shrinkwrap.resolver.api.maven.MavenDependencyResolver. A lookup for "groupId:artifactId:version" is performed, and the return value is resolved to a java.io.File array. This array is added to the archive by using "addAsLibraries".
• For debugging purposes, a "war.toString(true)" is very helpful - it outputs a full list of all files in the archive.

Version 1 - First Test: test code

Now it is time for the test: the JSF sample app contains a form with three input fields. After clicking a submit button, the input page is re-shown, and two more labels show the results.

The test method looks like this:

  @Test
  @InitialPage("/geometricmodel.faces")
  public void testGeometricModel(JSFServerSession server, JSFClientSession client) 
    throws IOException 
  {
      // Test navigation to initial viewID
      Assert.assertEquals("/geometricmodel.jsp", server.getCurrentViewID());
  
      //Set data to form:
      client.setValue("formGeometricModelInput:a", "1");
      client.setValue("formGeometricModelInput:b", "2");
      client.setValue("formGeometricModelInput:c", "3");
      
      //Submit form:
      client.click("formGeometricModelInput:calculate");
      
      //The new page should also be "geometricmodel.jsp":
      Assert.assertEquals("/geometricmodel.jsp", server.getCurrentViewID());
      
      //Get results and assert they have the expected values:
      Double volume = (Double) server.getComponentValue("formGeometricModelInput:volume");
      Double surface = (Double) server.getComponentValue("formGeometricModelInput:surface");
      System.out.println ("Volume: " + volume + ", Surface: " + surface);
      
      Assert.assertEquals(6.0, volume.doubleValue(), 0.0);
      Assert.assertEquals(22.0, surface.doubleValue(), 0.0);
  }

The code in detail:

• The annotation "@org.junit.Test" marks the method as "testable"
• The annotation "@org.jboss.jsfunit.api.InitialPage" declares a page to which the JSFUnit framework should browse before starting the test. Here this is "/geometricmodel.faces".
• The two parameter "org.jboss.jsfunit.jsfsession.JSFClientSession" and "org.jboss.jsfunit.jsfsession.JSFServerSession" are provided by JSFUnit. The "client" parameter represents the client side of the current workflow: it can e.g. fill form fields and submit forms and browse to other pages. The "server" parameter provides access to the server side of the current response: here you can access the server side of the JSF component tree. The client/server state is initialized according to the "@InitialPage" annotation.
  
  Alternatively, you could create them yourself (see test method testGeometricModelAndCreateSession in my sample code):

    @Test
    public void testGeometricModelAndCreateSession() throws IOException
    {
      JSFSession jsfSession = new JSFSession("/geometricmodel.faces");
  
      JSFClientSession client = jsfSession.getJSFClientSession();
      JSFServerSession server = jsfSession.getJSFServerSession();

  The rest of the code is the same as above.
  
• The first check is that our current view ("server.getCurrentViewID()") is really "geometricmodel.jsp".
• Next, three field values are set to the form fields and then the submit button is clicked. Note that the full component tree must be used to access a field, e.g. points "formGeometricModelInput:a" to a field with ID "a" in a form "formGeometricModelInput".
• After submitting the form, we check that we are returned to "geometricmodel.jsp" once again.
• Now the results are evaluated: this does not happen by finding some values in the client HTML code, but by finding the fields in the server side JSF component tree. So we can test that the value made it to the correct JSF component, but we could not test whether e.g. a bug in the JSF library would render a wrong value to the resulting HTML.

Now we are nearly ready to execute the text. Before doing so, there is one step of configuration left:
In the project properties, enter the "Maven" group and enter the profile name you declared in "pom.xml":

Version 1 - First Test: run, Forrest, run!

So let's start our test: in the "Run as" contextmenu of the project, select "Maven test":

Now you will see the output of the test in a "Maven console" window. If everything works fine, you will also see server output: the war file "JSF.war" will be deployed, and all "System.out.println" in the test will be output on the server console.

Test results (or exceptions) can be found here:

The "txt" file is the human readable part, the "xml" file can be used to show results in the "JUnit results" view.

Version 1 - Run the Test by using Maven

set JAVA_HOME=C:\Program Files (x86)\Java\jdk1.6.0_26
set JBOSS_HOME=C:\temp\jboss-6.0.0.Final

C:\temp\apache-maven-3.0.3\bin\mvn.bat test -Parq-jbossas-remote

Version 1 - Run the Test by using the Eclipse JUnit framework

Using the Eclipse JUnit framework is simple: select the project, contextmenu "Run as" => "JUnit test":

Now the tests will run, and we will see the results in the "JUnit" view:

You can also debug your tests this way.

---

Version 2 - Sources

• JSF.war - import it in Eclipse as "Dynamic Web Project"
• JSFTest.zip - this is the full project containing the unit test. Unzip it to your workspace, then import as "General" => "Existing Projects into Workspace"

Version 2 - Creating the projects

Version 2 - pom.xml

We now prepare "pom.xml" for our project. When double clicking it, there is a rich GUI editor for it. But for this sample, simply switch to the "pom.xml" tab of the editor and copy/paste the content from my page. You might see the results in the editor and thus see where to input the data in the GUI editor.

Step 1: Java 1.6
We want to use Java 1.6, so we change the version. Add this to your pom.xml:

	<build>
		<plugins>

			<plugin>
				<groupId>org.apache.maven.plugins</groupId>
				<artifactId>maven-compiler-plugin</artifactId>
				<version>2.3.2</version>
				<configuration>
					<source>1.6</source>
					<target>1.6</target>
				</configuration>
			</plugin>
		</plugins>
	</build>

In my previous attempts with Eclipse 3.6. and M2Eclipse 0.12.1, saving the pom.xml updated the project configuration automatically. But with Eclipse 3.7 and M2Eclipse 1.0.0., I just saw an error marker "Project configuration is not up-to-date with pom.xml. Run project configuration update":

So right click the project, and in the context menu, select "Maven" => "Update Project Configuration...":

This will bring up this dialog. Leave all settings to their defaults:

Now the Java version of our project will be changed:


If Eclipse found a JRE and used it by default (see the warning message above), you should now create a JDK configuration: in "Preferences" => "Java" => "Installed JREs" add a new one which points to a JDK:

And in "Preferences" => "Java" => "Installed JREs" => "Excecution Environments", select "JavaSE-1.6" and check the JDK instead of the JRE:

The project will reference the new JDK now.

Step 2: Repositories
Now we add some JBoss repositories. The following list is taken from the "gettingstarted" example (see above).
For more information about JBoss repositories, see here:

	<repositories>
		<repository>
			<id>jboss-public-repository-group</id>
			<name>JBoss Public Maven Repository Group</name>
			<url>https://repository.jboss.org/nexus/content/groups/public</url>
			<layout>default</layout>
			<releases>
				<enabled>true</enabled>
				<updatePolicy>never</updatePolicy>
			</releases>
			<snapshots>
				<enabled>true</enabled>
				<updatePolicy>never</updatePolicy>
			</snapshots>
		</repository>
		<!-- Deprecated Repository -->
		<repository>
			<id>jboss-deprecated-repository-group</id>
			<name>JBoss Deprecated Maven Repository Group</name>
			<url>https://repository.jboss.org/nexus/content/repositories/deprecated/</url>
			<releases>
				<enabled>true</enabled>
				<updatePolicy>never</updatePolicy>
			</releases>
			<snapshots>
				<enabled>true</enabled>
				<updatePolicy>never</updatePolicy>
			</snapshots>
		</repository>
	</repositories>
	<pluginRepositories>
		<pluginRepository>
			<id>jboss-public-repository-group</id>
			<name>JBoss Public Maven Repository Group</name>
			<url>https://repository.jboss.org/nexus/content/repositories/releases/</url>
			<layout>default</layout>
			<releases>
				<enabled>true</enabled>
				<updatePolicy>never</updatePolicy>
			</releases>
			<snapshots>
				<enabled>false</enabled>
				<updatePolicy>never</updatePolicy>
			</snapshots>
		</pluginRepository>
	</pluginRepositories>

	<properties>
		<version.jsfunit>2.0.0-SNAPSHOT</version.jsfunit>
		<version.arquillian>1.0.0.Alpha5</version.arquillian>
	</properties>

	...
	
	<dependencies>
		<dependency>
			<groupId>javax.enterprise</groupId>
			<artifactId>cdi-api</artifactId>
			<version>1.0-SP1</version>
			<scope>provided</scope>
		</dependency>

		<dependency>
			<groupId>junit</groupId>
			<artifactId>junit</artifactId>
			<version>4.8.1</version>
			<scope>test</scope>
		</dependency>

		<dependency>
			<groupId>org.jboss.arquillian</groupId>
			<artifactId>arquillian-junit</artifactId>
			<version>${version.arquillian}</version>
			<scope>test</scope>
		</dependency>

		<dependency>
			<groupId>com.sun.faces</groupId>
			<artifactId>jsf-api</artifactId>
			<version>2.0.4-b03</version>
			<scope>provided</scope>
		</dependency>

		<dependency>
			<groupId>jboss.web</groupId>
			<artifactId>servlet-api</artifactId>
			<version>3.0.0-beta-2</version>
			<scope>provided</scope>
		</dependency>


		<dependency>
			<groupId>org.jboss.jsfunit</groupId>
			<artifactId>jsfunit-arquillian</artifactId>
			<version>${version.jsfunit}</version>
			<scope>test</scope>
		</dependency>

	</dependencies>

	<profiles>

		<profile>
			<id>arq-jbossas-remote</id>
			<dependencies>
				<dependency>
					<groupId>org.jboss.arquillian.container</groupId>
					<artifactId>arquillian-jbossas-remote-6</artifactId>
					<version>${version.arquillian}</version>
					<scope>test</scope>
				</dependency>

				<dependency>
					<groupId>org.jboss.jbossas</groupId>
					<artifactId>jboss-as-profileservice-client</artifactId>
					<version>6.0.0.Final</version>
					<type>pom</type>
					<scope>test</scope>
				</dependency>
				<!-- jboss-deployers-client-spi provides deployment exception class -->
				<dependency>
					<groupId>org.jboss.deployers</groupId>
					<artifactId>jboss-deployers-client-spi</artifactId>
					<version>2.2.0.GA</version>
					<scope>test</scope>
				</dependency>
			</dependencies>
		</profile>
	</profiles>

Version 2 - First Test: creating deployable file

Before starting with the coding, we first have to make the "JSFTest" project reference the "JSF" dynamic web project, because we need some utility classes from this project:
In the properties of the project "JSFTest", go to the "Build Path" and add a "Projects" reference:

Important:
Whenever you save "pom.xml" and thus update the project configuration, you have to re-add this reference!

Note:
This project reference will probably not work when trying to start the tests by using the Eclipse integrated JUnit test runner, but it will be good enough for the beginning.

Now, we add the test class "de.fhw.komponentenarchitekturen.knauf.jsf.tests.GeometricModelTest" in the source directory "src\test\java" (NOT in "src\main\java"). The class header will look like this:

@RunWith(Arquillian.class)
public class GeometricModelTest
{
  ...

First step in this test is to create a deployable archive which basically has the same content as a WAR file which would be deployed by Eclipse. The Arquillian framework will deploy this archive to a remote (local running) JBoss. So we add a static method "createDeployment" and annotate it with @org.jboss.arquillian.api.Deployment:

  @Deployment
  public static WebArchive createDeployment()
  {
    WebArchive war = ShrinkWrap.create(WebArchive.class, "JSF.war");
    
    war.setWebXML(new File("../JSF/WebContent/WEB-INF/web.xml"));
    war.addPackage("de.fhw.komponentenarchitekturen.knauf.jsf"); //will add the "GeometricModelTest" class itself, though it is in a sub package.
    
    war.addAsWebResource(new File("../JSF/WebContent/", "index.jsp"));
    war.addAsWebResource(new File("../JSF/WebContent/", "geometricmodel.jsp"));
    
    war.addAsWebInfResource(new File("../JSF/WebContent/WEB-INF/faces-config.xml"), "faces-config.xml");
    
    war.addAsWebInfResource(EmptyAsset.INSTANCE, "beans.xml");

    war.addAsLibrary(new File("../JSF/WebContent/WEB-INF/lib/jstl.jar"));
    
    System.out.println(war.toString(true));
    
    return war;
  }

Here is some tricky code: we pick all the files from the the "JSF" project (web.xml, JSPs, faces-config.xml, classes, libraries). Thus we need relative paths here. We create a "WebArchive", using the "ShrinkWrap" API. Note that the war file name defines the default context root (if no different context root is declared), so it must be identical to the name which is used to access the app later.

• "web.xml" is put in the archive by using the method "setWebXML".
• All class files are added by using "addPackage" or "addClass". In my sample I add the package "de.fhw.komponentenarchitekturen.knauf.jsf": this contains the classes from my "JSF" project, and also the classes in the subpackage ".tests".
  But error detection for missing classes will be easier if you don't add a full package, but single classes:
  

      war.addClasses(GeometricModelHandler.class, Historie.class, Seitenlaengen.class, GeometricModelTest.class);

  This way, you will see an error message when you take some classes from a different project and this project reference is lost.
• All JSP files are added by using "addAsWebResource"
• "faces-config.xml" must be added using "addAsWebInfResource": this method adds files to "WEB-INF".
• An empty "beans.xml" is added - as far as I know this is required for CDI ("Context and Dependency Injection"). The snippet is taken from the "Getting Started" sample, I don't know in how far it is required. For more details see here: http://community.jboss.org/wiki/InjectionCDIForJSFSessionJSFClientSessionAndJSFServerSession
• JAR files are added to WEB-INF/lib by using "addAsLibrary". Note that in my sample (with the split projects), I had to use the overload with a "java.io.File" parameter - the overload with a "string" parameter did not find the JAR file.
• For debugging purposes, a "war.toString(true)" is very helpful - it outputs a full list of all files in the archive.

	<build>
		<plugins>
			...
			<plugin>
				<groupId>org.codehaus.mojo</groupId>
				<artifactId>build-helper-maven-plugin</artifactId>
				<version>1.7</version>
				<executions>
					<execution>
						<id>add-source</id>
						<phase>generate-sources</phase>
						<goals>
							<goal>add-source</goal>
						</goals>
						<configuration>
							<sources>
								<source>${basedir}/../JSF/src</source>
							</sources>
						</configuration>
					</execution>
				</executions>
			</plugin>
		</plugins>
	</build>

	<build>
		...
		<pluginManagement>
			<plugins>
				<plugin>
					<groupId>org.eclipse.m2e</groupId>
					<artifactId>lifecycle-mapping</artifactId>
					<version>1.0.0</version>
					<configuration>
						<lifecycleMappingMetadata>
							<pluginExecutions>
								<pluginExecution>
									<pluginExecutionFilter>
										<groupId>org.codehaus.mojo</groupId>
										<artifactId>build-helper-maven-plugin</artifactId>
										<versionRange>[1.6,)</versionRange>
										<goals>
											<goal>add-source</goal>
										</goals>
									</pluginExecutionFilter>
									<action>
										<execute></execute>
									</action>
								</pluginExecution>
							</pluginExecutions>
						</lifecycleMappingMetadata>
					</configuration>
				</plugin>
			</plugins>
		</pluginManagement>
	</build>

Version 2 - First Test: test code

Version 2 - First Test: run, Forrest, run!

So let's start our test: in the "Run as" contextmenu of the project, select "9 Maven test":

Now you will see the output of the test in a "Maven console" window. If everything works fine, you will also see server output: the war file "JSF.war" will be deployed, and all "System.out.println" in the test will be output on the server console.

Test results (or exceptions) can be found here:

The "txt" file is the human readable part, the "xml" file can be used to show results in the "JUnit results" view.


The tests can be started by using Maven and the command line. See

Version 2 - Run the Test by using the Eclipse JUnit framework

This method to run the test will cause some problems, but it will have one big benefit: debugging ;-)!

Using the Eclipse JUnit framework is simple: select the project, contextmenu "Run as" => "JUnit test":

But for me, this resulted in a nasty error Cannot run program "...\javaw.exe" (in directory "...\JSFTest"): CreateProcess error=87, Wrong Parameter:

The reason seems to be that the command line (to be more specific: the classpath) is too long. I assume that not the Maven dependencies from the current project cause this error, but Eclipse is including also all references from the referenced Dynamic Web Project "JSF", too - and this is a full JBoss server.
To work around this, we have to change the "Build path": instead of including the full project, we just include the "classes" directory. In the tab "Libraries", we click "Add Class Folder" and select "JSF/build/classes". The result should look like this:

We will see this directory also in our "Project explorer", but hopefully it won't hurt:

Now the tests will run, and we will see the results in the "JUnit" view:



When we start the JBoss server in "Debug" mode, we can also debug our unit tests!
Only a small problem is left: when I hit a breakpoint in the Dynamic Web Project "JSF", I saw an error message "Source not found". To resolve it: click on "Edit Source Lookup Path". In the next dialog, click "Add...", then choose "Java Project" and click "OK", and finally select the project "JSF".

This additional source lookup path will be stored in the Run Configuration of the unit test.

Some hints

I would advice to perform a "Maven: clean" call regularly, because it might happen that Maven caches e.g. compiled classes, and because of modifications to the project configuration they are no longer valid. To refresh the Maven data (and to delete old test reports), call "Run as" => "6 Maven clean":

Troubleshooting

[ERROR] Failed to execute goal org.apache.maven.plugins:maven-compiler-plugin:2.3.2:testCompile (default-testCompile) on project JSFTest: Compilation failure
[ERROR] Unable to locate the Javac Compiler in:
[ERROR] C:\Program Files (x86)\Java\jre6\..\lib\tools.jar
[ERROR] Please ensure you are using JDK 1.4 or above and
[ERROR] not a JRE (the com.sun.tools.javac.Main class is required).
[ERROR] In most cases you can change the location of your Java
[ERROR] installation by setting the JAVA_HOME environment variable.

-------------------------------------------------------------------------------
Test set: de.fhw.komponentenarchitekturen.knauf.jsf.GeometricModelTest
-------------------------------------------------------------------------------
Tests run: 2, Failures: 0, Errors: 2, Skipped: 0, Time elapsed: 0.281 sec <<< FAILURE!
de.fhw.komponentenarchitekturen.knauf.jsf.GeometricModelTest  Time elapsed: 0 sec  <<< ERROR!
org.jboss.arquillian.impl.client.deployment.ValidationException: DeploymentScenario contains targets not maching any defined Container in the registry. _DEFAULT_
	at org.jboss.arquillian.impl.client.deployment.DeploymentGenerator.validate(DeploymentGenerator.java:95)
	at org.jboss.arquillian.impl.client.deployment.DeploymentGenerator.generateDeployment(DeploymentGenerator.java:77)
	at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
	at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
	at java.lang.reflect.Method.invoke(Method.java:597)
	at org.jboss.arquillian.impl.core.ObserverImpl.invoke(ObserverImpl.java:90)
	....
	at org.apache.maven.surefire.booter.SurefireStarter.invokeProvider(SurefireStarter.java:145)
	at org.apache.maven.surefire.booter.SurefireStarter.runSuitesInProcess(SurefireStarter.java:87)
	at org.apache.maven.surefire.booter.ForkedBooter.main(ForkedBooter.java:69)

de.fhw.komponentenarchitekturen.knauf.jsf.GeometricModelTest  Time elapsed: 0 sec  <<< ERROR!
java.lang.NullPointerException
	at org.jboss.arquillian.impl.client.container.ContainerDeployController.forEachManagedDeployment(ContainerDeployController.java:204)
	at org.jboss.arquillian.impl.client.container.ContainerDeployController.undeployManaged(ContainerDeployController.java:99)
	at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
	at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
	at java.lang.reflect.Method.invoke(Method.java:597)
	at org.jboss.arquillian.impl.core.ObserverImpl.invoke(ObserverImpl.java:90)
	at org.jboss.arquillian.impl.core.EventContextImpl.invokeObservers(EventContextImpl.java:98)
	at org.jboss.arquillian.impl.core.EventContextImpl.proceed(EventContextImpl.java:80)
	at org.jboss.arquillian.impl.core.ManagerImpl.fire(ManagerImpl.java:126)
	at org.jboss.arquillian.impl.core.ManagerImpl.fire(ManagerImpl.java:106)
	at org.jboss.arquillian.impl.core.EventImpl.fire(EventImpl.java:67)
	at org.jboss.arquillian.impl.client.ContainerEventController.execute(ContainerEventController.java:74)
	...
	at org.apache.maven.surefire.booter.SurefireStarter.invokeProvider(SurefireStarter.java:145)
	at org.apache.maven.surefire.booter.SurefireStarter.runSuitesInProcess(SurefireStarter.java:87)
	at org.apache.maven.surefire.booter.ForkedBooter.main(ForkedBooter.java:69)