How to force a fresh version of the Spring context BEFORE the test executes

Question

I use the SpringJUnit4ClassRunner for writing integration tests. I also use @DirtiesContext for tests that leave the context in an broken state behind and that works just fine.

But now I have a test the sets an important SystemProperty in an static initializer, which in turn is used in the Spring context. This again works fine when the test executes on its own. But when I run the test with other tests the Spring context gets already created with out that property set and gets reused by my new Test.

How can I force the fresh creation of a Spring context in my test, which then will use the changed System Property?

score 26 · Accepted Answer · answered Aug 08 '15 at 08:47

As of Spring 4.2 the DirtiesContext annotation supports the following new phases: BEFORE_CLASS, BEFORE_EACH_TEST_METHOD and BEFORE_METHOD. So you can now do for example:

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(...)
@DirtiesContext(classMode = ClassMode.BEFORE_EACH_TEST_METHOD)
public class MyTest {
   ..
}

score 17 · Answer 2 · edited Feb 07 '17 at 12:10

17

Pre-Spring 4.2:

I can only suggest a hack unfortunately - you are right, there does not seem to be a simple way to initialize a new application context rather than using a cached application context. These are some of the workarounds that I can suggest:

Use a slightly different @ContextConfiguration - a quick and dirty way to do that could be to add an @ActiveProfiles annotation to the test class, this way Spring will be forced to cache the context with a new key OR define a dummy context with your existing configuration as imports
A hack, but JUnit 4.11+ allows some level of control over test method ordering, it is possible to have a test method right before your target test method and have the dummy test method annotated with @DirtiesContext, this way when your target method is called a fresh context will be created.

edited Feb 07 '17 at 12:10

Tzach Zohar

37,442
3
79
85

answered Jan 11 '13 at 12:22

Biju Kunjummen

49,138
14
112
125

1

I can't seem to get the DirtiesContext to work, but the ActiveProfiles does work. – JBCP Sep 10 '14 at 19:42
1

The best solution is to use ActiveProfiles, as the dirtiesCOntext solution may not work, because the order in which tests are executed is not defined. A testrunner may reorder and skip tests. This will lead to fragile test runs! – Patrick Cornelissen Oct 21 '14 at 07:35

score 1 · Answer 3 · answered Jan 11 '13 at 12:47

There are several options:

You can create an individual spring context for this test by loading another configuration into it. That way, your test will be completely independent of every other test.
You can create a stripped down configuration for this test. That would achieve the same but be faster.
Create a test suite which runs this test first.

How to force a fresh version of the Spring context BEFORE the test executes

3 Answers3

Linked