Friday, October 7, 2011

How to test primefaces component with JSFUnit2

As you may know JSFUnit 2.0.0.Beta 2 is Out!

After successfully execute the JSFUnit2 getting started example on jboss as7, i've triyed the the integration between JSFUnit and primefaces (since it's my favorite JSF components library ;-)
First i've included the primefaces library into my test war archive in the deployement method using MavenDependencyResolver (for further details see this blog entry)

If you do not use Maven you can just put the primefaces librairy in a lib folder under WEB-INF folder and add this line to the deployement method :

.addAsWebInfResource(new File("src/main/webapp/WEB-INF/lib/primefaces-2.2.jar"),"lib/primefaces-2.2.jar")

Second, i've modifed the index.xhtml as bellow:

After that i executed my mvn install but i got the error "PrimeFaces" is not defined... humm... may be primefaces resources wasn't injected ...

I've just added the "h:head" tag to the index.xhtml file and my test succed !!!!! witch means that the primefaces resources was included automatically and JSFUnit recognize it now ...

Note that the component test is based on components client ID, so be prudent on your component testing !!

For example if you want to test the calendar component by trying the the setValue method on your test class with the id you have gave to your p:calendar (), you get the error :

java.lang.IllegalArgumentException: This method can not be used on components of type com.gargoylesoftware.htmlunit.html.HtmlSpan

it's normal because the setValue is used for input field not for span ;-) so you should use setValue ("date_input", VALUE) instead of setValue("date",VALUE)
[Tips: you can use Firebug to inspect elements and see their client id]

I'm adding the full example for p:calendar here based on the getting starded example

Test page:

Test method:
public void testInitialPage(JSFServerSession server, JSFClientSession client)
throws IOException {

// Set the param and submit
String sDate = new Date().toString();
client.setValue("date_input", sDate);"submit_button");

// Assert that the greeting component is in the component tree and rendered
UIComponent greeting = server.findComponent("greeting");

// Test a managed bean using EL. We cheat and use the request object.

you can download the full example here

The test was done using primefaces2.2,JSF 2.0, JSFUnit2Beta2, Maven3, Jboss as7


  1. I kind of like this jsfunittest my only fear is that it depends tightly on the view client code ( as for the date component example ) this not good because after a while you will find your tests unusable and will invest more time (money ;) ) to keep them runing...
    An alternative will be creating an application web driver interface that do the thing and that is almost loosely coupled to the html code.

  2. I think giving client ID for each component is from the best practices in web developpement, also unit testing main goal is when you change your implementation ( client id in this case) you test will fails and you will be noticed for that ;-) More over i think creating an application web driver interface will not be usefull for white box testing (with Selenium for example)

  3. hey badr!

    I am using JSFUnit 1.3 and with cactus 1.7, on a project where primefaces are used. Here I have two problems.
    1)It seems that the javascript code generated(I have no idea what it does), while rendering the primefaces page seems to be faulty. It throws an exception about the same
    2)I use a method in WebClientSpec class so that it skips the javascript validations. But I couldn't figure out how to write a test case on component, i tried using the HtmlUnit api but it turns out that the javascript part of the component is not rendered, hence leaving the component 'non-ajax'. The rendering in the browser is just fine, but when it comes to HtmlUnit there seems to be a bit of problems. Please help!!!!!

    Thanks in advance