mirror of
https://github.com/spring-projects/spring-framework.git
synced 2026-09-21 21:39:05 +00:00
Evict context from ContextCache before loading a new context
Since Spring Framework 4.2, DefaultContextCache supported an LRU (least recently used) eviction policy via a custom LruCache which extended LinkedHashMap. The LruCache reacted to LinkedHashMap's removeEldestEntry() callback to remove the LRU context if the maxSize of the cache was exceeded. Due to the nature of the implementation in LinkedHashMap, the removeEldestEntry() callback is invoked after a new entry has been stored to the map. Consequently, a Spring ApplicationContext (C1) was evicted from the cache after a new context (C2) was loaded and added to the cache, leading to failure scenarios such as the following. - C1 and C2 share an external resource -- for example, a database. - C2 initializes the external resource with test data when C2 is loaded. - C1 cleans up the external resource when C1 is closed. - C1 is loaded and added to the cache. - C2 is loaded and added to the cache before C1 is evicted. - C1 is evicted and closed. - C2 tests fail, because C1 removed test data required for C2. To address such scenarios, this commit replaces the custom LruCache with custom LRU eviction logic in DefaultContextCache and revises the put(MergedContextConfiguration, ApplicationContext) method to delegate to a new evictLruContextIfNecessary() method. This commit also introduces a new put(MergedContextConfiguration, LoadFunction) method in the ContextCache API which is overridden by DefaultContextCache to ensure that an evicted context is removed and closed before a new context is loaded to take its place in the cache. In addition, DefaultCacheAwareContextLoaderDelegate has been revised to make use of the new put(MergedContextConfiguration, LoadFunction) API. Closes gh-21007
This commit is contained in:
Sam Brannen
+390
-60
@@ -16,14 +16,29 @@
|
||||
|
||||
package org.springframework.test.context.cache;
|
||||
|
||||
import java.util.ArrayList;
|
||||
import java.util.Arrays;
|
||||
import java.util.HashSet;
|
||||
import java.util.List;
|
||||
import java.util.Set;
|
||||
import java.util.concurrent.atomic.AtomicInteger;
|
||||
|
||||
import org.junit.jupiter.api.AfterEach;
|
||||
import org.junit.jupiter.api.BeforeEach;
|
||||
import org.junit.jupiter.api.Nested;
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import org.springframework.beans.factory.DisposableBean;
|
||||
import org.springframework.beans.factory.InitializingBean;
|
||||
import org.springframework.context.ApplicationContext;
|
||||
import org.springframework.context.ConfigurableApplicationContext;
|
||||
import org.springframework.context.annotation.Configuration;
|
||||
import org.springframework.context.annotation.Import;
|
||||
import org.springframework.test.annotation.DirtiesContext.HierarchyMode;
|
||||
import org.springframework.test.context.MergedContextConfiguration;
|
||||
import org.springframework.test.context.TestContext;
|
||||
import org.springframework.test.context.TestContextTestUtils;
|
||||
import org.springframework.test.context.junit.jupiter.SpringJUnitConfig;
|
||||
|
||||
import static org.assertj.core.api.Assertions.as;
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
@@ -33,6 +48,7 @@ import static org.mockito.Mockito.mock;
|
||||
import static org.mockito.Mockito.never;
|
||||
import static org.mockito.Mockito.times;
|
||||
import static org.mockito.Mockito.verify;
|
||||
import static org.springframework.test.context.cache.ContextCacheTestUtils.assertContextCacheStatistics;
|
||||
|
||||
/**
|
||||
* Tests for the LRU eviction policy in {@link DefaultContextCache}.
|
||||
@@ -65,89 +81,403 @@ class LruContextCacheTests {
|
||||
assertThatIllegalArgumentException().isThrownBy(() -> new DefaultContextCache(0));
|
||||
}
|
||||
|
||||
@Test
|
||||
void maxCacheSizeOne() {
|
||||
DefaultContextCache cache = new DefaultContextCache(1);
|
||||
assertThat(cache.size()).isEqualTo(0);
|
||||
assertThat(cache.getMaxSize()).isEqualTo(1);
|
||||
|
||||
cache.put(fooConfig, fooContext);
|
||||
assertCacheContents(cache, "Foo");
|
||||
@Nested
|
||||
class PutUnitTests {
|
||||
|
||||
cache.put(fooConfig, fooContext);
|
||||
assertCacheContents(cache, "Foo");
|
||||
@Test
|
||||
void maxCacheSizeOne() {
|
||||
DefaultContextCache cache = new DefaultContextCache(1);
|
||||
assertThat(cache.size()).isEqualTo(0);
|
||||
assertThat(cache.getMaxSize()).isEqualTo(1);
|
||||
|
||||
cache.put(barConfig, barContext);
|
||||
assertCacheContents(cache, "Bar");
|
||||
cache.put(fooConfig, fooContext);
|
||||
assertCacheContents(cache, "Foo");
|
||||
|
||||
cache.put(fooConfig, fooContext);
|
||||
assertCacheContents(cache, "Foo");
|
||||
cache.put(fooConfig, fooContext);
|
||||
assertCacheContents(cache, "Foo");
|
||||
|
||||
cache.put(barConfig, barContext);
|
||||
assertCacheContents(cache, "Bar");
|
||||
|
||||
cache.put(fooConfig, fooContext);
|
||||
assertCacheContents(cache, "Foo");
|
||||
}
|
||||
|
||||
@Test
|
||||
void maxCacheSizeThree() {
|
||||
DefaultContextCache cache = new DefaultContextCache(3);
|
||||
assertThat(cache.size()).isEqualTo(0);
|
||||
assertThat(cache.getMaxSize()).isEqualTo(3);
|
||||
|
||||
cache.put(fooConfig, fooContext);
|
||||
assertCacheContents(cache, "Foo");
|
||||
|
||||
cache.put(fooConfig, fooContext);
|
||||
assertCacheContents(cache, "Foo");
|
||||
|
||||
cache.put(barConfig, barContext);
|
||||
assertCacheContents(cache, "Foo", "Bar");
|
||||
|
||||
cache.put(bazConfig, bazContext);
|
||||
assertCacheContents(cache, "Foo", "Bar", "Baz");
|
||||
|
||||
cache.put(abcConfig, abcContext);
|
||||
assertCacheContents(cache, "Bar", "Baz", "Abc");
|
||||
}
|
||||
|
||||
@Test
|
||||
void ensureLruOrderingIsUpdated() {
|
||||
DefaultContextCache cache = new DefaultContextCache(3);
|
||||
|
||||
// Note: when a new entry is added it is considered the MRU entry and inserted at the tail.
|
||||
cache.put(fooConfig, fooContext);
|
||||
cache.put(barConfig, barContext);
|
||||
cache.put(bazConfig, bazContext);
|
||||
assertCacheContents(cache, "Foo", "Bar", "Baz");
|
||||
|
||||
// Note: the MRU entry is moved to the tail when accessed.
|
||||
cache.get(fooConfig);
|
||||
assertCacheContents(cache, "Bar", "Baz", "Foo");
|
||||
|
||||
cache.get(barConfig);
|
||||
assertCacheContents(cache, "Baz", "Foo", "Bar");
|
||||
|
||||
cache.get(bazConfig);
|
||||
assertCacheContents(cache, "Foo", "Bar", "Baz");
|
||||
|
||||
cache.get(barConfig);
|
||||
assertCacheContents(cache, "Foo", "Baz", "Bar");
|
||||
}
|
||||
|
||||
@Test
|
||||
void ensureEvictedContextsAreClosed() {
|
||||
DefaultContextCache cache = new DefaultContextCache(2);
|
||||
|
||||
cache.put(fooConfig, fooContext);
|
||||
cache.put(barConfig, barContext);
|
||||
assertCacheContents(cache, "Foo", "Bar");
|
||||
|
||||
cache.put(bazConfig, bazContext);
|
||||
assertCacheContents(cache, "Bar", "Baz");
|
||||
verify(fooContext, times(1)).close();
|
||||
|
||||
cache.put(abcConfig, abcContext);
|
||||
assertCacheContents(cache, "Baz", "Abc");
|
||||
verify(barContext, times(1)).close();
|
||||
|
||||
verify(abcContext, never()).close();
|
||||
verify(bazContext, never()).close();
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
void maxCacheSizeThree() {
|
||||
DefaultContextCache cache = new DefaultContextCache(3);
|
||||
assertThat(cache.size()).isEqualTo(0);
|
||||
assertThat(cache.getMaxSize()).isEqualTo(3);
|
||||
/**
|
||||
* @since 7.0
|
||||
*/
|
||||
@Nested
|
||||
class PutWithLoadFunctionUnitTests {
|
||||
|
||||
cache.put(fooConfig, fooContext);
|
||||
assertCacheContents(cache, "Foo");
|
||||
@Test
|
||||
void maxCacheSizeOne() {
|
||||
DefaultContextCache cache = new DefaultContextCache(1);
|
||||
assertThat(cache.size()).isEqualTo(0);
|
||||
assertThat(cache.getMaxSize()).isEqualTo(1);
|
||||
|
||||
cache.put(fooConfig, fooContext);
|
||||
assertCacheContents(cache, "Foo");
|
||||
cache.put(fooConfig, key -> fooContext);
|
||||
assertCacheContents(cache, "Foo");
|
||||
|
||||
cache.put(barConfig, barContext);
|
||||
assertCacheContents(cache, "Foo", "Bar");
|
||||
cache.put(fooConfig, key -> fooContext);
|
||||
assertCacheContents(cache, "Foo");
|
||||
|
||||
cache.put(bazConfig, bazContext);
|
||||
assertCacheContents(cache, "Foo", "Bar", "Baz");
|
||||
cache.put(barConfig, key -> barContext);
|
||||
assertCacheContents(cache, "Bar");
|
||||
|
||||
cache.put(abcConfig, abcContext);
|
||||
assertCacheContents(cache, "Bar", "Baz", "Abc");
|
||||
cache.put(fooConfig, key -> fooContext);
|
||||
assertCacheContents(cache, "Foo");
|
||||
}
|
||||
|
||||
@Test
|
||||
void maxCacheSizeThree() {
|
||||
DefaultContextCache cache = new DefaultContextCache(3);
|
||||
assertThat(cache.size()).isEqualTo(0);
|
||||
assertThat(cache.getMaxSize()).isEqualTo(3);
|
||||
|
||||
cache.put(fooConfig, key -> fooContext);
|
||||
assertCacheContents(cache, "Foo");
|
||||
|
||||
cache.put(fooConfig, key -> fooContext);
|
||||
assertCacheContents(cache, "Foo");
|
||||
|
||||
cache.put(barConfig, key -> barContext);
|
||||
assertCacheContents(cache, "Foo", "Bar");
|
||||
|
||||
cache.put(bazConfig, key -> bazContext);
|
||||
assertCacheContents(cache, "Foo", "Bar", "Baz");
|
||||
|
||||
cache.put(abcConfig, key -> abcContext);
|
||||
assertCacheContents(cache, "Bar", "Baz", "Abc");
|
||||
}
|
||||
|
||||
@Test
|
||||
void ensureLruOrderingIsUpdated() {
|
||||
DefaultContextCache cache = new DefaultContextCache(3);
|
||||
|
||||
// Note: when a new entry is added it is considered the MRU entry and inserted at the tail.
|
||||
cache.put(fooConfig, key -> fooContext);
|
||||
cache.put(barConfig, key -> barContext);
|
||||
cache.put(bazConfig, key -> bazContext);
|
||||
assertCacheContents(cache, "Foo", "Bar", "Baz");
|
||||
|
||||
// Note: the MRU entry is moved to the tail when accessed.
|
||||
cache.get(fooConfig);
|
||||
assertCacheContents(cache, "Bar", "Baz", "Foo");
|
||||
|
||||
cache.get(barConfig);
|
||||
assertCacheContents(cache, "Baz", "Foo", "Bar");
|
||||
|
||||
cache.get(bazConfig);
|
||||
assertCacheContents(cache, "Foo", "Bar", "Baz");
|
||||
|
||||
cache.get(barConfig);
|
||||
assertCacheContents(cache, "Foo", "Baz", "Bar");
|
||||
}
|
||||
|
||||
@Test
|
||||
void ensureEvictedContextsAreClosed() {
|
||||
DefaultContextCache cache = new DefaultContextCache(2);
|
||||
|
||||
cache.put(fooConfig, key -> fooContext);
|
||||
cache.put(barConfig, key -> barContext);
|
||||
assertCacheContents(cache, "Foo", "Bar");
|
||||
|
||||
cache.put(bazConfig, key -> bazContext);
|
||||
assertCacheContents(cache, "Bar", "Baz");
|
||||
verify(fooContext, times(1)).close();
|
||||
|
||||
cache.put(abcConfig, key -> abcContext);
|
||||
assertCacheContents(cache, "Baz", "Abc");
|
||||
verify(barContext, times(1)).close();
|
||||
|
||||
verify(abcContext, never()).close();
|
||||
verify(bazContext, never()).close();
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
void ensureLruOrderingIsUpdated() {
|
||||
DefaultContextCache cache = new DefaultContextCache(3);
|
||||
/**
|
||||
* @since 7.0
|
||||
*/
|
||||
@Nested
|
||||
class PutWithLoadFunctionIntegrationTests {
|
||||
|
||||
// Note: when a new entry is added it is considered the MRU entry and inserted at the tail.
|
||||
cache.put(fooConfig, fooContext);
|
||||
cache.put(barConfig, barContext);
|
||||
cache.put(bazConfig, bazContext);
|
||||
assertCacheContents(cache, "Foo", "Bar", "Baz");
|
||||
/**
|
||||
* Mimics a database shared across application contexts.
|
||||
*/
|
||||
private static final Set<String> database = new HashSet<>();
|
||||
|
||||
// Note: the MRU entry is moved to the tail when accessed.
|
||||
cache.get(fooConfig);
|
||||
assertCacheContents(cache, "Bar", "Baz", "Foo");
|
||||
private static final List<String> events = new ArrayList<>();
|
||||
|
||||
cache.get(barConfig);
|
||||
assertCacheContents(cache, "Baz", "Foo", "Bar");
|
||||
|
||||
cache.get(bazConfig);
|
||||
assertCacheContents(cache, "Foo", "Bar", "Baz");
|
||||
@BeforeEach
|
||||
@AfterEach
|
||||
void resetTracking() {
|
||||
resetEvents();
|
||||
DatabaseInitializer.counter.set(0);
|
||||
database.clear();
|
||||
}
|
||||
|
||||
cache.get(barConfig);
|
||||
assertCacheContents(cache, "Foo", "Baz", "Bar");
|
||||
}
|
||||
@Test
|
||||
void maxCacheSizeOne() {
|
||||
DefaultContextCache contextCache = new DefaultContextCache(1);
|
||||
|
||||
@Test
|
||||
void ensureEvictedContextsAreClosed() {
|
||||
DefaultContextCache cache = new DefaultContextCache(2);
|
||||
// -----------------------------------------------------------------
|
||||
|
||||
cache.put(fooConfig, fooContext);
|
||||
cache.put(barConfig, barContext);
|
||||
assertCacheContents(cache, "Foo", "Bar");
|
||||
// Get ApplicationContext for TestCase1.
|
||||
Class<?> testClass1 = TestCase1.class;
|
||||
TestContext testContext1 = TestContextTestUtils.buildTestContext(testClass1, contextCache);
|
||||
testContext1.getApplicationContext();
|
||||
assertContextCacheStatistics(contextCache, testClass1.getSimpleName(), 1, 1, 0, 1);
|
||||
assertCacheContents(contextCache, "Config1");
|
||||
assertThat(database).containsExactly("enigma1");
|
||||
assertThat(events).containsExactly("START 1");
|
||||
resetEvents();
|
||||
|
||||
cache.put(bazConfig, bazContext);
|
||||
assertCacheContents(cache, "Bar", "Baz");
|
||||
verify(fooContext, times(1)).close();
|
||||
// -----------------------------------------------------------------
|
||||
|
||||
cache.put(abcConfig, abcContext);
|
||||
assertCacheContents(cache, "Baz", "Abc");
|
||||
verify(barContext, times(1)).close();
|
||||
// Get ApplicationContext for TestCase2.
|
||||
Class<?> testClass2 = TestCase2.class;
|
||||
TestContext testContext2 = TestContextTestUtils.buildTestContext(testClass2, contextCache);
|
||||
testContext2.getApplicationContext();
|
||||
assertContextCacheStatistics(contextCache, testClass2.getSimpleName(), 1, 1, 0, 2);
|
||||
assertCacheContents(contextCache, "Config2");
|
||||
assertThat(database).containsExactly("enigma2");
|
||||
assertThat(events).containsExactly("CLOSE 1", "START 2");
|
||||
resetEvents();
|
||||
|
||||
verify(abcContext, never()).close();
|
||||
verify(bazContext, never()).close();
|
||||
// -----------------------------------------------------------------
|
||||
|
||||
// Get ApplicationContext for TestCase3.
|
||||
Class<?> testClass3 = TestCase3.class;
|
||||
TestContext testContext3 = TestContextTestUtils.buildTestContext(testClass3, contextCache);
|
||||
testContext3.getApplicationContext();
|
||||
assertContextCacheStatistics(contextCache, testClass3.getSimpleName(), 1, 1, 0, 3);
|
||||
assertCacheContents(contextCache, "Config3");
|
||||
assertThat(database).containsExactly("enigma3");
|
||||
assertThat(events).containsExactly("CLOSE 2", "START 3");
|
||||
resetEvents();
|
||||
|
||||
// -----------------------------------------------------------------
|
||||
|
||||
// Get ApplicationContext for TestCase1 again.
|
||||
testContext1.getApplicationContext();
|
||||
assertContextCacheStatistics(contextCache, testClass1.getSimpleName(), 1, 1, 0, 4);
|
||||
assertCacheContents(contextCache, "Config1");
|
||||
assertThat(database).containsExactly("enigma4");
|
||||
assertThat(events).containsExactly("CLOSE 3", "START 4");
|
||||
resetEvents();
|
||||
|
||||
// -----------------------------------------------------------------
|
||||
|
||||
testContext1.markApplicationContextDirty(HierarchyMode.EXHAUSTIVE);
|
||||
assertThat(events).containsExactly("CLOSE 4");
|
||||
assertThat(database).isEmpty();
|
||||
assertThat(contextCache.size()).isZero();
|
||||
}
|
||||
|
||||
@Test
|
||||
void maxCacheSizeTwo() {
|
||||
DefaultContextCache contextCache = new DefaultContextCache(2);
|
||||
|
||||
// -----------------------------------------------------------------
|
||||
|
||||
// Get ApplicationContext for TestCase1.
|
||||
Class<?> testClass1 = TestCase1.class;
|
||||
TestContext testContext1 = TestContextTestUtils.buildTestContext(testClass1, contextCache);
|
||||
testContext1.getApplicationContext();
|
||||
assertContextCacheStatistics(contextCache, testClass1.getSimpleName(), 1, 1, 0, 1);
|
||||
testContext1.markApplicationContextUnused();
|
||||
assertContextCacheStatistics(contextCache, testClass1.getSimpleName(), 1, 0, 0, 1);
|
||||
assertCacheContents(contextCache, "Config1");
|
||||
assertThat(events).containsExactly("START 1");
|
||||
assertThat(database).containsExactly("enigma1");
|
||||
resetEvents();
|
||||
|
||||
// -----------------------------------------------------------------
|
||||
|
||||
// Get ApplicationContext for TestCase2.
|
||||
Class<?> testClass2 = TestCase2.class;
|
||||
TestContext testContext2 = TestContextTestUtils.buildTestContext(testClass2, contextCache);
|
||||
testContext2.getApplicationContext();
|
||||
assertContextCacheStatistics(contextCache, testClass2.getSimpleName(), 2, 1, 0, 2);
|
||||
testContext2.markApplicationContextUnused();
|
||||
assertContextCacheStatistics(contextCache, testClass2.getSimpleName(), 2, 0, 0, 2);
|
||||
assertCacheContents(contextCache, "Config1", "Config2");
|
||||
assertThat(events).containsExactly("START 2");
|
||||
assertThat(database).containsExactly("enigma1", "enigma2");
|
||||
resetEvents();
|
||||
|
||||
// -----------------------------------------------------------------
|
||||
|
||||
// Get ApplicationContext for TestCase3.
|
||||
Class<?> testClass3 = TestCase3.class;
|
||||
TestContext testContext3 = TestContextTestUtils.buildTestContext(testClass3, contextCache);
|
||||
testContext3.getApplicationContext();
|
||||
assertContextCacheStatistics(contextCache, testClass3.getSimpleName(), 2, 1, 0, 3);
|
||||
testContext3.markApplicationContextUnused();
|
||||
assertContextCacheStatistics(contextCache, testClass3.getSimpleName(), 2, 0, 0, 3);
|
||||
assertCacheContents(contextCache, "Config2", "Config3");
|
||||
assertThat(events).containsExactly("CLOSE 1", "START 3");
|
||||
// Closing App #1 removed "enigma1" and "enigma2" from the database.
|
||||
assertThat(database).containsExactly("enigma3");
|
||||
resetEvents();
|
||||
|
||||
// -----------------------------------------------------------------
|
||||
|
||||
// Get ApplicationContext for TestCase1 again.
|
||||
testContext1.getApplicationContext();
|
||||
assertContextCacheStatistics(contextCache, testClass1.getSimpleName(), 2, 1, 0, 4);
|
||||
testContext1.markApplicationContextUnused();
|
||||
assertContextCacheStatistics(contextCache, testClass1.getSimpleName(), 2, 0, 0, 4);
|
||||
assertCacheContents(contextCache, "Config3", "Config1");
|
||||
assertThat(events).containsExactly("CLOSE 2", "START 4");
|
||||
// Closing App #2 removed "enigma3" from the database.
|
||||
assertThat(database).containsExactly("enigma4");
|
||||
resetEvents();
|
||||
|
||||
// -----------------------------------------------------------------
|
||||
|
||||
testContext3.markApplicationContextDirty(HierarchyMode.EXHAUSTIVE);
|
||||
assertThat(events).containsExactly("CLOSE 3");
|
||||
resetEvents();
|
||||
|
||||
testContext1.markApplicationContextDirty(HierarchyMode.EXHAUSTIVE);
|
||||
assertThat(events).containsExactly("CLOSE 4");
|
||||
assertThat(database).isEmpty();
|
||||
assertThat(contextCache.size()).isZero();
|
||||
}
|
||||
|
||||
|
||||
private static void resetEvents() {
|
||||
events.clear();
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Mimics a Spring component that inserts data into the database when the
|
||||
* application context is started and drops data from a database when the
|
||||
* application context is closed.
|
||||
*
|
||||
* @see org.springframework.jdbc.datasource.init.DataSourceInitializer
|
||||
*/
|
||||
static class DatabaseInitializer implements InitializingBean, DisposableBean {
|
||||
|
||||
static final AtomicInteger counter = new AtomicInteger();
|
||||
|
||||
private final int count;
|
||||
|
||||
|
||||
DatabaseInitializer() {
|
||||
this.count = counter.incrementAndGet();
|
||||
}
|
||||
|
||||
@Override
|
||||
public void afterPropertiesSet() {
|
||||
events.add("START " + this.count);
|
||||
database.add("enigma" + this.count);
|
||||
}
|
||||
|
||||
@Override
|
||||
public void destroy() {
|
||||
events.add("CLOSE " + this.count);
|
||||
database.clear();
|
||||
}
|
||||
}
|
||||
|
||||
@SpringJUnitConfig
|
||||
static class TestCase1 {
|
||||
|
||||
@Configuration
|
||||
@Import(DatabaseInitializer.class)
|
||||
static class Config1 {
|
||||
}
|
||||
}
|
||||
|
||||
@SpringJUnitConfig
|
||||
static class TestCase2 {
|
||||
|
||||
@Configuration
|
||||
@Import(DatabaseInitializer.class)
|
||||
static class Config2 {
|
||||
}
|
||||
}
|
||||
|
||||
@SpringJUnitConfig
|
||||
static class TestCase3 {
|
||||
|
||||
@Configuration
|
||||
@Import(DatabaseInitializer.class)
|
||||
static class Config3 {
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user