Getting friendly with Spring, JUnit and EasyMock.
Here are some steps that can get you using Spring, JUnit and EasyMock all together in some Test Driven Development hotness.
Start by adding the following lines to the top of your unit test. Specifying Autowire by name ensures you get the injection you want and will stop those Spring errors that there are more than one of the same type of mock objects in your mock-applicationContext.xml. When you specify the Spring Junit runner you must provide one ore more context configurations with @ContextConfiguration.
MyClassUnitTest.java
...
@Configurable(autowire = Autowire.BY_NAME)
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations = {"classpath:com/some/domain/someproject/resources/mock-applicationContext.xml"})
public class MyClassUnitTest {
...
@Autowired private Collaborator mockCollaborator;
@Before
public void setup() throws Exception {
...
}
@After
public void teardown() throws Exception {
...
}
@Test
public void testMyClass() throws Exception {
//Set your mock behavior here
....
EasyMock.replay(mockCollaborator);
MyClass myClass = new MyClass(mockCollaborator);
myClass.run();
EasyMock.verify(mockCollaborator);
// Other JUnit assertions
...
}
}
Then add your mocks to your mock-applicationContext.xml (an applicationContext in your test resources just for providing your unit tests with spring injection dependencies):
mock-applicationContext.xml
...
<bean id="mockCollaborator" name="mockCollaborator" class="org.easymock.EasyMock" factory-method="createStrictMock">
<constructor-arg value="com.some.domain.someproject.Collaborator"/>
</bean>
<bean id="mockOtherCollaborator" name="mockOtherCollaborator" class="org.easymock.EasyMock" factory-method="createStrictMock">
<constructor-arg value="com.some.domain.someproject.OtherCollaborator"/>
</bean>
...
Ensure your maven pom has the following test-scoped dependency:
pom.xml
...
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-test</artifactId>
<version>2.5.6</version>
<scope>test</scope>
</dependency>
...
Then use your mocks as normal. Make sure you call EasyMock.reset(mock) in your @After teardown() method so that each of your mocks are reset for each test. You can also tell Spring to reset the context after a test if needed with @DirtiesContext.
For official documentation and tutorials check out these links.
Spring
http://www.springsource.org/documentation
JUnit
EasyMock
http://easymock.org/Documentation.html
New and Unknown Java Libraries
I like finding new useful java libraries. I usually find them from posts like this one. Other times I find them because I have a problem needing a solution. Here are some of my favorite unknown java libraries that I have found over the past year. Today I use every one of these in my projects. Interestingly, 4 of 6 are hosted on http://code.google.com.
Google-API-Translate-Java
Provides a simple, unofficial, Java client API for using Google Translate. I use this to translate caption files for videos into several other languages. It has lots of options and has never failed me.
XmlTool
XMLTool is a very simple Java library to be able to do all sorts of common operations with an XML document with a very easy to use class using the Fluent Interface pattern to facilitate XML manipulations.
XStream
XStream is a simple library to serialize objects to XML and back again. Also useful for creating JSON responses.
Architecture Rules
Architecture Rules leverages an xml configuration file and optional programmatic configuration to assert your code’s architecture via unit tests or ant tasks. This test is able to assert that specific packages do not depend on others and is able to check for and report on cyclic dependencies among your project’s packages and classes. Get cyclic dependency detection with the Maven 2 plugin and zero configuration.
CyberNeko HTML Parser
NekoHTML is a simple HTML scanner and tag balancer that enables application programmers to parse HTML documents and access the information using standard XML interfaces. This can be used to extract the textual content from an HTML fragment.
Charts4j
charts4j is a free, lightweight charts & graphs Java API. It enables developers to programmatically create the charts available in the Google Chart API through a straightforward and intuitive Java API.
What do you use?
Do you have any new and unknown java tools that you use that you would recommend we checkout?
Load Multiple Contexts into Spring
I have already argued that many application contexts are better than a single application context. But how do you load more than one context?
There are a couple of ways to do this.
web.xml contextConfigLocation
Your first option is to load them all into your Web application context via the ContextConfigLocation element. You’re already going to have your primary applicationContext here, assuming you’re writing a web application. All you need to do is put some white space between the declaration of the next context.
<context-param>
<param-name>
contextConfigLocation
</param-name>
<param-value>
applicationContext1.xml
applicationContext2.xml
</param-value>
</context-param>
<listener>
<listener-class>
org.springframework.web.context.ContextLoaderListener
</listener-class>
</listener>
The above uses carriage returns. Alternatively, yo could just put in a space.
<context-param>
<param-name>
contextConfigLocation
</param-name>
<param-value>
applicationContext1.xml applicationContext2.xml
</param-value>
</context-param>
<listener>
<listener-class>
org.springframework.web.context.ContextLoaderListener
</listener-class>
</listener>
applicationContext.xm import resourcel
Your other option is to just add your primary applicationContext.xml to the web.xml and then use import statements in that primary context.
In applicationContext.xml you might have…
<!-- hibernate configuration and mappings --> <import resource="applicationContext-hibernate.xml"/> <!-- ldap --> <import resource="applicationContext-ldap.xml"/> <!-- aspects --> <import resource="applicationContext-aspects.xml"/>
Which strategy should you use?
I always prefer to load up via web.xml This allows me to keep all contexts isolated from each other. With tests, we can load just the contexts that we need to run those tests. This makes development more modular too as components stay loosely coupled, so that in the future I can extract a package or vertical layer and move it to its own module.
If you are loading contexts into a non-web application, I would use the import resource.
Any benefits to going with the application context import method over the web.xml contextConfigLocation?