Documentation

1. 01 VRaptor3 - One minute guide
2. 02 VRaptor3 - 10 minute guide
3. 03 Resources-Rest
4. 04 Components
5. 05 Converters
6. 06 Interceptors
7. 07 Validation
8. 08 View and Ajax
9. 09 Dependency injection
10. 10 Download and Upload
11. 11 Utility components
12. 12 Overriding Vraptor's behavior and conventions
13. 13 Spring, Joda Time and Hibernate
14. 14 Google App Engine
15. 15 Testing components and controllers
16. 16 Scala
17. 17 Optimizations
18. 18 VRaptor Scaffold
19. 19 Exception handling
20. 20 How to contribute to VRaptor
21. 21 Changelog
22. 22 Migrating from VRaptor2 to VRaptor3

15Testing components and controllers

VRaptor3 manages your class dependencies, so there is no need to worry about instantiating your components and controllers, you can just receive your dependencies on the constructor and VRaptor3 will locate them and instantiate your class. You can take advantage of dependency injection when testing your classes: you can instantiate your class with fake implementations and unit test the class. Nevertheless, there are two VRaptor3 components that are dependencies of most of your controllers: Result and Validator. Their fluent interfaces makes it difficult to create fake implementations or mocks. Therefore there are fake implementations for these components on VRaptor3: MockResult e MockValidator.

MockResult

MockResult ignores all redirects, and stores the included objects, so you can inspect them and make assertions. This snippet shows you how you can use MockResult:

MockResult result = new MockResult();
ClientController controller = new ClientController(..., result);
controller.list(); // will call result.include("clients", something);
List<Client> clients = result.included("clients"); // the cast is implicit
Assert.assertNotNull(clients);
// more assertions

Any calls to result.use(...) will be ignored.

MockValidator

MockValidator will store generated errors, so if there is any error when validator.onErrorUse is called, a ValidationError will be thrown. Therefore you can inspect the added errors, or simply check if there is any error.

@Test(expected=ValidationException.class)
public void testThatAValidationErrorOccurs() {
    ClientController controller = new ClientController(..., new MockValidator());
    controller.add(new Client());
}

or

@Test
public void testThatAValidationErrorOccurs() {
    ClientController controller = new ClientController(..., new MockValidator());
    try {
        controller.add(new Client());
        Assert.fail();
    } catch (ValidationException e) {
        List<Message> errors = e.getErrors();
        //assertions on errors
    }
}

If one uses Hibernate Validator, and calls validator.validate(object) on the controller, one can use the HibernateMockValidator class instead, which will validate the object with the defined rules from HV.