DDevelopment & Design

Virgo Snaps with Apache Tiles integration

After smoke tests become time to try using Virgo Snaps in more practical way. In modular application it will be useful to run it with templating framework. According to animal-menu-bar sample it will be better if developer of snap will not know anything about layout of host application and snippets like:

<jsp:include page="/../top.jsp"/>
(...)
<jsp:include page="/../bottom.jsp"/>

will be not necessary to put in snap pages. So lets modify a bit hosts jsps. Template page could look similar to old index.jsp:

<%@ taglib prefix="tiles" uri="http://tiles.apache.org/tags-tiles" %>
<jsp:include page="top.jsp"/>

<tiles:insertAttribute name="body" />

<jsp:include page="bottom.jsp"/>

Now index.jsp should not have includes:

 <p>
 The Snap Menu Bar sample is intended to showcase the ability to dynamically change the content of a menu bar using snaps. Each
 of the snaps that might be displayed in the menu bar includes a top and bottom JSP page and inherits it's styling from the host
 bundle.  Therefore, the snap bundle is only responsible for showing a small subset of content.
 </p>

Template definition should have one template without any attributes (it will be added dynamicly):

<tiles-definitions>
    <definition name="defaultTemplate" template="/template.jsp">
    </definition>
</tiles-definitions>

To dynamic adding this definitions we must implement our TilesView. I’ve used one which is a part of parancoe – Open Source Java Web Framework available on Google Code: http://code.google.com/p/parancoe/source/browse/plugins/parancoe-plugin-tiles/src/main/java/org/parancoe/plugin/tiles/CheapTilesView.java?r=f42be9c3c8e2df436d4970cfdaea1aff73d9cfdb and modify it a bit for our purposes. Most interesting part is:

    protected void renderMergedOutputModel(Map model, HttpServletRequest request,
            HttpServletResponse response)
            throws Exception {

        try {
            super.renderMergedOutputModel(model, request, response);
        } catch (TilesException te) {
            lazyRegisterThanRender(request, response);
        } catch (Exception ex) {
            ex.printStackTrace();
        }
    }

    private void lazyRegisterThanRender(HttpServletRequest request, HttpServletResponse response) throws IllegalStateException {
        ServletContext servletContext = getServletContext();
        MutableTilesContainer container = (MutableTilesContainer)
                ServletUtil.getContainer(servletContext);;
        Definition definition = new Definition();

        String[] arr = parsePath(getUrl());
        String subContextPart = arr[0];
        String mainUrlPart    = arr[1];

        definition.setName(getUrl());
        definition.setExtends((String) getAttribute(KEY_DEFAULT_TEMPLATE,
                DEFAULT_DEFAULT_TEMPLATE));
        String attributeList = (String) getAttribute(KEY_DEFAULT_ATTRIBUTES,
                DEFAULT_DEFAULT_ATTRIBUTES);

        String[] attributes = attributeList.split(",");
        if (attributes.length == 1) {
            addAttributeWithPathValueToDefinition(attributes[0], subContextPart, mainUrlPart, definition);
        } else {
            for (String attribute : attributes) {
                addAttributeWithPathValueToDefinition(attributes[0], subContextPart, mainUrlPart + "_" + attribute, definition);
            }
        }

        container.register(definition, request, response);
        container.render(getUrl(), new Object[]{request, response});
    }

How can we see here, lazyRegisterThanRender will be invoked if Tiles will have problems in our case in resolving view name. This method registering new template which extends default one. It also adds attributes taking its values from view name. parsePath parsing path in form: view@snap or only: view:

private String[] parsePath(String path) {
        String[] arr = new String[] {"", ""};
        int indexOfAt = path.indexOf('@');
        if (indexOfAt > 0) {
            arr[0] = '/' + path.substring(indexOfAt+1, path.length());
            arr[1] = path.substring(0, indexOfAt);
        } else {
            arr[1] = path;
        }
        return arr;
    }

In our case will be only body attribute.

To use Tiles we should define tilesConfigurer in spring context. But before this we must declare DispatcherServlet in web.xml which will past requests to our controllers in web.xml:

<servlet>
    <servlet-name>snap</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <load-on-startup>2</load-on-startup>
</servlet>

<servlet-mapping>
    <servlet-name>snap</servlet-name>
    <url-pattern>/*</url-pattern>
</servlet-mapping>

After this simply adding WEB-INF/snap-servlet.xml context of application will be read:

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:p="http://www.springframework.org/schema/p"
    xmlns:context="http://www.springframework.org/schema/context"
    xsi:schemaLocation="
      http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
      http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd
          http://www.springframework.org/schema/osgi http://www.springframework.org/schema/osgi/spring-osgi.xsd"
        default-autowire="byName">

    <bean id="tilesConfigurer" class="org.springframework.web.servlet.view.tiles2.TilesConfigurer">
        <property name="definitions">
            <list>
                <value>/WEB-INF/tiles.xml</value>
            </list>
        </property>
        <property name="useMutableTilesContainer" value="true"/>
    </bean>

    <bean id="tilesViewResolver" class="org.springframework.web.servlet.view.tiles2.TilesViewResolver">
        <property name="attributesMap">
            <map>
                <entry key="CheapTilesView.DEFAULT_TEMPLATE" value="defaultTemplate"/>
                <entry key="CheapTilesView.DEFAULT_ATTRIBUTES" value="body"/>
            </map>
        </property>
        <property name="viewClass" value="CheapTilesView"/>
    </bean>

    <bean class="MainController"/>

</beans>

After this, we must to add templates definitions: lib/tiles-jsp.tld and few entries in template.mf:

Manifest-Version: 1
Bundle-SymbolicName: animal.menu.bar
Bundle-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: Multiple Styles Host
Web-ContextPath: /animal-menu-bar
Import-Library:
 org.springframework.spring;version="[3.0,3.1)"
Import-Bundle:
 com.springsource.org.apache.taglibs.standard;version="[1.1.2,1.3)",
 com.springsource.javax.servlet.jsp.jstl;version="[1.1.2, 1.1.3)",
 org.eclipse.virgo.snaps.api;version="[1.0,2.0)",
 com.springsource.org.apache.tiles;version="2.1.3",
 org.apache.tiles.core;version="2.1.3",
 org.apache.tiles.servlet;version="2.1.3",
 org.apache.tiles.jsp;version="2.1.3"
Import-Package:
 org.eclipse.virgo.snaps.core;version="[1.0,2.0)",
 javax.servlet;version="2.5",
 javax.servlet.http;version="2.5",
 javax.servlet.jsp;version="2.1",
 org.tuckey.web.filters.urlrewrite;version="[3.1.0,3.1.0]",
 org.springframework.js.resource;version="[2.0,2.1)",
 org.springframework.stereotype;version="[3.0,3.1)",
 org.springframework.web.bind.annotation;version="[3.0,3.1)",
 org.springframework.web.servlet;version="[3.0,3.1)",
 org.springframework.web.servlet.view.tiles2;version="[3.0,3.1)",
 org.apache.tiles;version="2.1.3",
 org.apache.tiles.context;version="2.1.3",
 org.apache.tiles.impl;version="2.1.3",
 org.apache.tiles.jsp.context;version="2.1.3",
 org.apache.tiles.mgmt;version="2.1.3",
 org.apache.tiles.renderer.impl;version="2.1.3",
 org.apache.tiles.servlet.context;version="2.1.3"

Our MainController will look like:

@Controller
public class MainController {
    @RequestMapping("/")
    public String rootHandler() {
        return "index";
    }
    @RequestMapping("/index.htm")
    public String snapHandler(@RequestParam("snap") String snap) {
        return "index@" + snap;
    }
}

So we must change top.jsp in host application:

                <snaps:snaps var="snaps">
                    <c:forEach var="snap" items="${snaps}">
                        <li><a href="<c:url value="index.htm?snap=${snap.properties['link.path']}"/>">
                            ${snap.properties['link.text']}</a>
                        </li>
                    </c:forEach>
                </snaps:snaps>

And also in snap.properties of both snaps link.path so it should be equals to snap subcontext (e.g. cat, dog).

After all of this we will have some troubles with resources handling so will be necessary to add urlrewrite filters like it was writed on Rob’s blog about Spring Slices – precursor of Snaps:

Our repository/usr should have:

commons-beanutils-1.8.0.jar
commons-digester-1.8.1.jar
com.springsource.org.apache.commons.collections-3.2.1.jar
com.springsource.org.apache.tiles-2.1.3.jar
com.springsource.org.tuckey.web.filters.urlrewrite-3.1.0.jar
org.eclipse.virgo.snaps.api.jar
org.eclipse.virgo.snaps.core.jar
tiles-core-2.1.3.jar
tiles-jsp-2.1.3.jar
tiles-servlet-2.1.3.jar

which we can copy from maven repository.

Patch with these changes is available on github

— Previous article

<!--:en-->Few thoughts on Crockford's "JavaScript: The Good Parts"<!--:-->

Next article —

<!--:en-->TouK on GitHub Part 1<!--:-->

You May Also Like
DDevelopment & Design

Spock basics

Spock (homepage) is like its authors say 'testing and specification framework'. Spock combines very elegant and natural syntax with the powerful capabilities. And what is most important it is easy to use.

One note at the very beginning: I assume that you are already familiar with principles of Test Driven Development and you know how to use testing framework like for example JUnit.

So how can I start?


Writing spock specifications is very easy. We need basic configuration of Spock and Groovy dependencies (if you are using mavenized project with Eclipse look to my previous post: Spock, Java and Maven). Once we have everything set up and running smooth we can write our first specs (spec or specification is equivalent for test class in other frameworks like JUnit of TestNG).

What is great with Spock is fact that we can use it to test both Groovy projects and pure Java projects or even mixed projects.


Let's go!


Every spec class must inherit from spock.lang.Specification class. Only then test runner will recognize it as test class and start tests. We will write few specs for this simple class: User class and few tests not connected with this particular class.

We start with defining our class:
import spock.lang.*

class UserSpec extends Specification {

}
Now we can proceed to defining test fixtures and test methods.

All activites we want to perform before each test method, are to be put in def setup() {...} method and everything we want to be run after each test should be put in def cleanup() {...} method (they are equivalents for JUnit methods with @Before and @After annotations).

It can look like this:
class UserSpec extends Specification {
    User user
    Document document

    def setup() {
        user = new User()
        document = DocumentTestFactory.createDocumentWithTitle("doc1")
    }

    def cleanup() {

    }
}
Of course we can use field initialization for instantiating test objects:
class UserSpec extends Specification {
    User user = new User()
    Document document = DocumentTestFactory.createDocumentWithTitle("doc1")

    def setup() {

    }

    def cleanup() {

    }
}

What is more readable or preferred? It is just a matter of taste because according to Spock docs behaviour is the same in these two cases.

It is worth mentioning that JUnit @BeforeClass/@AfterClass are also present in Spock as def setupSpec() {...} and def cleanupSpec() {...}. They will be runned before first test and after last test method.


First tests


In Spock every method in specification class, expect setup/cleanup, is treated by runner as a test method (unless you annotate it with @Ignore).

Very interesting feature of Spock and Groovy is ability to name methods with full sentences just like regular strings:
class UserSpec extends Specification {
    // ...

    def "should assign coment to user"() {
        // ...
    }
}
With such naming convention we can write real specification and include details about specified behaviour in method name, what is very convenient when reading test reports and analyzing errors.

Test method (also called feature method) is logically divided into few blocks, each with its own purpose. Blocks are defined like labels in Java (but they are transformed with Groovy AST transform features) and some of them must be put in code in specific order.

Most basic and common schema for Spock test is:
class UserSpec extends Specification {
    // ...

    def "should assign coment to user"() {
        given:
            // do initialization of test objects
        when:
            // perform actions to be tested
        then:
            // collect and analyze results
    }
}

But there are more blocks like:
  • setup
  • expect
  • where
  • cleanup
In next section I am going to describe each block shortly with little examples.

given block

This block is used to setup test objects and their state. It has to be first block in test and cannot be repeated. Below is little example how can it be used:
class UserSpec extends Specification {
    // ...

    def "should add project to user and mark user as project's owner"() {
        given:
            User user = new User()
            Project project = ProjectTestFactory.createProjectWithName("simple project")
        // ...
    }
}

In this code given block contains initialization of test objects and nothing more. We create simple user without any specified attributes and project with given name. In case when some of these objects could be reused in more feature methods, it could be worth putting initialization in setup method.

when and then blocks

When block contains action we want to test (Spock documentation calls it 'stimulus'). This block always occurs in pair with then block, where we are verifying response for satisfying certain conditions. Assume we have this simple test case:
class UserSpec extends Specification {
    // ...

    def "should assign user to comment when adding comment to user"() {
        given:
            User user = new User()
            Comment comment = new Comment()
        when:
            user.addComment(comment)
        then:
            comment.getUserWhoCreatedComment().equals(user)
    }

    // ...
}

In when block there is a call of tested method and nothing more. After we are sure our action was performed, we can check for desired conditions in then block.

Then block is very well structured and its every line is treated by Spock as boolean statement. That means, Spock expects that we write instructions containing comparisons and expressions returning true or false, so we can create then block with such statements:
user.getName() == "John"
user.getAge() == 40
!user.isEnabled()
Each of lines will be treated as single assertion and will be evaluated by Spock.

Sometimes we expect that our method throws an exception under given circumstances. We can write test for it with use of thrown method:
class CommentSpec extends Specification {
    def "should throw exception when adding null document to comment"() {
        given:
            Comment comment = new Comment()
        when:
            comment.setCommentedDocument(null)
        then:
            thrown(RuntimeException)
    }
}

In this test we want to make sure that passing incorrect parameters is correctly handled by tested method and that method throws an exception in response. In case you want to be certain that method does not throw particular exception, simply use notThrown method.


expect block

Expect block is primarily used when we do not want to separate when and then blocks because it is unnatural. It is especially useful for simple test (and according to TDD rules all test should be simple and short) with only one condition to check, like in this example (it is simple but should show the idea):
def "should create user with given name"() {
    given:
        User user = UserTestFactory.createUser("john doe")
    expect:
        user.getName() == "john doe"
}



More blocks!


That were very simple tests with standard Spock test layout and canonical divide into given/when/then parts. But Spock offers more possibilities in writing tests and provides more blocks.


setup/cleanup blocks

These two blocks have the very same functionality as the def setup and def cleanup methods in specification. They allow to perform some actions before test and after test. But unlike these methods (which are shared between all tests) blocks work only in methods they are defined in. 


where - easy way to create readable parameterized tests

Very often when we create unit tests there is a need to "feed" them with sample data to test various cases and border values. With Spock this task is very easy and straighforward. To provide test data to feature method, we need to use where block. Let's take a look at little the piece of code:

def "should successfully validate emails with valid syntax"() {
    expect:
        emailValidator.validate(email) == true
    where:
        email }

In this example, Spock creates variable called email which is used when calling method being tested. Internally feature method is called once, but framework iterates over given values and calls expect/when block as many times as there are values (however, if we use @Unroll annotation Spock can create separate run for each of given values, more about it in one of next examples).

Now, lets assume that we want our feature method to test both successful and failure validations. To achieve that goal we can create few parameterized variables for both input parameter and expected result. Here is a little example:

def "should perform validation of email addresses"() {
    expect:
        emailValidator.validate(email) == result
    where:
        email         result }
Well, it looks nice, but Spock can do much better. It offers tabular format of defining parameters for test what is much more readable and natural. Lets take a look:
def "should perform validation of email addresses"() {
    expect:
        emailValidator.validate(email) == result
    where:
        email           | result
        "WTF"           | false
        "@domain"       | false
        "foo@bar.com"   | true
        "a@test"        | false
}
In this code, each column of our "table" is treated as a separate variable and rows are values for subsequent test iterations.

Another useful feature of Spock during parameterizing test is its ability to "unroll" each parameterized test. Feature method from previous example could be defined as (the body stays the same, so I do not repeat it):
@Unroll("should validate email #email")
def "should perform validation of email addresses"() {
    // ...
}
With that annotation, Spock generate few methods each with its own name and run them separately. We can use symbols from where blocks in @Unroll argument by preceding it with '#' sign what is a signal to Spock to use it in generated method name.


What next?


Well, that was just quick and short journey  through Spock and its capabilities. However, with that basic tutorial you are ready to write many unit tests. In one of my future posts I am going to describe more features of Spock focusing especially on its mocking abilities.