@ContextConfiguration is not inherited with Springockito

Question

I am currently playing around with springockito-annotations and this requires @RunWith and @ContextConfiguration annotations in order to work. I would like to put these annotations on a superclass of my tests, but can't seem to get it to work.

Superclass:

@RunWith(SpringJUnit4ClassRunner.class)
@TestExecutionListeners({ DependencyInjectionTestExecutionListener.class, DirtiesContextTestExecutionListener.class})
@ContextConfiguration(loader = SpringockitoContextLoader.class, locations = "classpath:spring/test-context.xml")
public class MyTestSuperclass {
    //...

Example testclass:

public class MyTest extends MyTestSuperclass {
    @Inject
    @ReplaceWithMock
    private MyService myService;
    //...

With this code, myService is not replaced with a mock.

But, if I change it to...

@ContextConfiguration
public class MyTest extends MyTestSuperclass {
    //...

...it works.

Is there a way to avoid having to add @ContextConfiguration to all my test classes? Has this perhaps been fixed in a newer version of Spring/Spring-tests? From what I can tell it is able to inherit the locations part from the superclass without annotating the subclass, but the loader part does not work without an annotation in the subclass. I'm using version 3.2.1.RELEASE of Spring-test.

Here is a sample projec that shows the bug:

http://www.filedropper.com/springockitobug

Answer 1

This is due to a bug in Springockito.

@ContextConfiguration is in fact inherited, which has been true since it was introduced in Spring 2.5. Furthermore, the configured loader (i.e., SpringockitoContextLoader in this case) is also inherited, which has been true since Spring 3.0.

The issue here is that SpringockitoContextLoader incorrectly processes the declaring class (i.e., the class that is annotated with @ContextConfiguration) instead of the actual test class (which can be a subclass that inherits the declaration of @ContextConfiguration).

After thorough debugging, it turns out that the solution is quite simple (in fact simpler than the original SpringockitoContextLoader implementation).

The following PatchedSpringockitoContextLoader should work fine as a drop-in replacement for the broken SpringockitoContextLoader.

import org.kubek2k.springockito.annotations.internal.Loader;

import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.context.support.GenericApplicationContext;
import org.springframework.test.context.MergedContextConfiguration;
import org.springframework.test.context.support.GenericXmlContextLoader;

public class PatchedSpringockitoContextLoader extends GenericXmlContextLoader {

    private final Loader loader = new Loader();

    @Override
    protected void prepareContext(ConfigurableApplicationContext context, MergedContextConfiguration mergedConfig) {
        super.prepareContext(context, mergedConfig);
        this.loader.defineMocksAndSpies(mergedConfig.getTestClass());
    }

    @Override
    protected void customizeContext(GenericApplicationContext context) {
        super.customizeContext(context);
        this.loader.registerMocksAndSpies(context);
    }

}

Regards,

Sam (author of the Spring TestContext Framework)

Answer 2

Instead of using a super class, use an annotation.

For instance:

@RunWith(SpringJUnit4ClassRunner.class)
@TestExecutionListeners({ DependencyInjectionTestExecutionListener.class, DirtiesContextTestExecutionListener.class})
@ContextConfiguration(loader = SpringockitoContextLoader.class, locations = "classpath:spring/test-context.xml")
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestConfiguration {
}

Then, annotate your test classes with

@TestConfiguration 
public class MyTest  {
    @Inject
    @ReplaceWithMock
    private MyService myService;
    //...

The IDE's syntax highlighting may complain about not being allowed to inject, depending which you use, but my initial tests have this working