This document discusses various techniques for testing Spring applications, including: - Using the Spring testing framework and annotations like @RunWith, @ContextConfiguration, and @Transactional for basic unit tests - Embedding an in-memory database for tests using XML or Java configuration - Setting up profiles for different testing environments - Testing Spring MVC controllers with the MockMvc framework - Performing server integration tests by embedding an application server - Testing RESTful APIs using libraries like RestTemplate and REST Assured

1. © 2013 SpringOne 2GX. All rights reserved. Do not distribute without permission.
Spring Testing
Mattias Severson

2. Agenda
• Basic Spring Testing
• Embedded Database
• Transactions
• Profiles
• Controller Tests
• Server Integration Tests
2

3. 3
Mattias

4. Bank App
4

5. AccountService
BankController
ImmutableAccount
AccountEntityAccountRepository
5
Architecture

6. Basics
6

7. jUnit Test
public class AccountServiceTest {
AccountService aService;
@Before
public void setUp() {
aService = new AccountServiceImpl();
}
@Test
public void testDoSomething() {
aService.doSomething();
// verify ...
}
}
7

8. public class AccountServiceTest {
@Autowired
AccountService aService;
@Test
public void testDoSomething() {
aService.doSomething();
// verify ...
}
}
@Autowired
8

9. @ContextConfiguration("/application-context.xml")
public class AccountServiceTest {
@Autowired
AccountService aService;
@Test
public void testDoSomething() {
aService.doSomething();
// verify ...
}
}
public class AccountServiceTest {
@Autowired
AccountService aService;
@Test
public void testDoSomething() {
aService.doSomething();
// verify ...
}
}
9
@ContextConfiguration

10. @RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration("/application-context.xml")
public class AccountServiceTest {
@Autowired
AccountService aService;
@Test
public void testDoSomething() {
aService.doSomething();
// verify ...
}
}
@ContextConfiguration("/application-context.xml")
public class AccountServiceTest {
@Autowired
AccountService aService;
@Test
public void testDoSomething() {
aService.doSomething();
// verify ...
}
}
10
SpringJUnit4ClassRunner

11. • Caches ApplicationContext
–static memory
–unique context configuration
–within the same test suite
• All tests execute in the same JVM
11
@ContextConfiguration

12. • @Before / @After
–Mockito.reset(mockObject)
–EasyMock.reset(mockObject)
• @DirtiesContext
12
Mocked Beans

13. Embedded DB
13
AccountRepository AccountEntity

14. XML Config
<jdbc:embedded-database id="dataSource" type="HSQL">
<jdbc:script location="classpath:db-schema.sql"/>
<jdbc:script location="classpath:db-test-data.sql"/>
</jdbc:embedded-database>
14

15. Java Config
@Configuration
public class EmbeddedDbConfig {
@Bean
public DataSource dataSource() {
return new EmbeddedDatabaseBuilder()
.setType(EmbeddedDatabaseType.HSQL)
.addScript(“classpath:db-schema.sql”)
.addScript(“classpath:db-test-data.sql”)
.build();
}
}
15

16. Demo
16

17. Transactions
17

18. Tx Test
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration("/application-context.xml")
public class AccountServiceTest {
@Test
public void testDoSomething() {
// call DB
}
}
@Transactional
@Test
public void testDoSomething() {
// call DB
}
18

19. Tx Annotations
• @TransactionConfiguration
• @BeforeTransaction
• @AfterTransaction
• @Rollback
19

20. Avoid False Positives
• Always flush() before validation!
–JPA
• entityManager.flush();
–Hibernate
• sessionFactory.getCurrentSession().flush();
20

21. Demo
21

22. No Transactions?
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration("...")
public class AccountRepositoryTest {
@Autowired
AccountRepository accountRepo;
@Before
public void setUp() {
accountRepo.deleteAll();
accountRepo.save(testData);
}
}
22

23. Spring Profiles
23

24. XML Profiles
<beans ...>
<bean id="dataSource">
<!-- Test data source -->
</bean>
<bean id="dataSource">
<!-- Production data source -->
</bean>
</beans>
<beans profile="testProfile">
</beans>
<beans profile="prodProfile">
</beans>
24

25. Java Config Profile
@Configuration
public class EmbeddedDbConfig {
@Bean
public DataSource dataSource() {
return new EmbeddedDatabaseBuilder().
// ...
}
}
@Profile(“testProfile”)
25

26. Component Profile
@Component
public class SomeClass implements SomeInterface {
}
@Profile(“testProfile”)
26

27. Tests and Profiles
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(“/application-context.xml”)
public class SomeTest {
@Autowired
SomeClass someClass;
@Test
public void testSomething() { ... }
}
@ActiveProfiles("testProfile")
27

28. Demo
28
AccountRepository AccountEntity
AccountService ImmutableAccount

29. web.xml
<web-app ...>
<listener>
<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>
</web-app>
<context-param>
<param-name>spring.profiles.active</param-name>
<param-value>someProfile</param-value>
</context-param>
29

30. ApplicationContext
AnnotationConfigApplicationContext ctx =
new AnnotationConfigApplicationContext();
ctx.getEnvironment().setActiveProfiles("someProfile");
ctx.register(SomeConfig.class);
ctx.scan("com.jayway.demo");
ctx.refresh();
30

31. Env Property
System.getProperty(“spring.profiles.active”);
mvn -Dspring.profiles.active=testProfile
31

32. Default Profiles
ctx.getEnvironment().setDefaultProfiles("...");
System.getProperty("spring.profiles.default");
32
<context-param>
<param-name>spring.profiles.default</param-name>
<param-value>defaultProfile</param-value>
</context-param>
<beans profile="default">
<!-- default beans -->
</beans>
@Profile("default")

33. Profile Alternatives
33
• .properties
• Maven Profile

34. Test Controller AccountRepository
AccountService
AccountEntity
ImmutableAccount
BankController
34

35. Spring MVC Test Framework
• Call Controllers through DispatcherServlet
• MockHttpServletRequest
• MockHttpServletResponse
35

36. MockMvc
MockMvc mockMvc = MockMvcBuilders
.standaloneSetup(new BankController())
.build();
36
MockMvc mockMvc = MockMvcBuilders
.standaloneSetup(new BankController())
.setMessageConverters(...)
.setValidator(...)
.setConversionService(...)
.addInterceptors(...)
.setViewResolvers(...)
.setLocaleResolver(...)
.addFilter(...)
.build();

37. Assertions
mockMvc.perform(get("/url")
.accept(MediaType.APPLICATION_XML))
.andExpect(response().status().isOk())
.andExpect(content().contentType(“MediaType.APPLICATION_XML”))
.andExpect(xpath(“key”).string(“value”))
.andExpect(redirectedUrl(“url”))
.andExpect(model().attribute(“name”, value));
37

38. @WebAppConfiguration
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration("/application-context.xml")
@WebAppConfiguration
public class WebApplicationTest {
@Autowired
WebApplicationContext wac;
MockMvc mockMvc;
@Before
public void setup() {
mockMvc = MockMvcBuilders
.webAppContextSetup(wac)
.build();
}
38

39. Demo
39

40. Testing Views
• Supported templates
–JSON
–XML
–Velocity
–Thymeleaf
• Except JSP
40

41. Server Integration Tests
41

42. appCtx
Spring Integration Test
42
Embedded
DB
txMngr
test
dataSrc

43. App Server
appCtx
Server Integration Test
43
Embedded
DB
txMngr
test
dataSrc
HTTP

44. App Server
App Server
44
appCtx
DB
txMngrdataSrc
testAppCtx
dataSrc
test
HTTP

45. jetty-maven-plugin
<executions>
<execution>
<id>start-jetty</id>
<phase>pre-integration-test</phase>
<goals>
<goal>run</goal>
</goals>
</execution>
<execution>
<id>stop-jetty</id>
<phase>post-integration-test</phase>
<goals>
<goal>stop</goal>
</goals>
</execution>
</executions>
45

46. maven-failsafe-plugin
**/IT*.java
**/*IT.java
**/*ITCase.java
46

47. Test RESTful API
47
• RestTemplate
• Selenium
• HttpClient
• ...

48. REST Assured
@Test
public void shouldGetSingleAccount() {
expect().
statusCode(HttpStatus.SC_OK).
contentType(ContentType.JSON).
body("accountNumber", is(1)).
body("balance", is(100)).
when().
get("/account/1");
}
48

49. Demo
49

50. Questions?
50

51. Learn More. Stay Connected.
Talk to us on Twitter: @springcentral
Find session replays on YouTube: spring.io/video
@mattiasseverson
http://blog.jayway.com/author/mattiasseverson/