Support property placeholders in @⁠Sql script paths

Prior to this commit, paths configured via the scripts attribute in
@⁠Sql were required to be final paths without dynamic placeholders;
however, being able to make script paths dependent on the current
environment can be useful in certain testing scenarios.

This commit introduces support for property placeholders (${...}) in
@⁠Sql script paths which will be replaced by properties available in
the Environment of the test's ApplicationContext.

Closes gh-33114
This commit is contained in:
Sam Brannen
2024-07-03 15:33:20 +02:00
parent 384d0e4fd5
commit abcad5dbcf
8 changed files with 100 additions and 2 deletions

View File

@@ -0,0 +1,61 @@
/*
* Copyright 2002-2024 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.test.context.jdbc;
import org.junit.jupiter.api.Nested;
import org.junit.jupiter.api.Test;
import org.springframework.test.annotation.DirtiesContext;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.TestPropertySource;
/**
* Integration tests that verify support for property placeholders in SQL script locations.
*
* @author Sam Brannen
* @since 6.2
*/
@ContextConfiguration(classes = PopulatedSchemaDatabaseConfig.class)
class PropertyPlaceholderSqlScriptsTests {
private static final String SCRIPT_LOCATION = "classpath:org/springframework/test/context/jdbc/${vendor}/data.sql";
@Nested
@TestPropertySource(properties = "vendor = db1")
@DirtiesContext
class DatabaseOneTests extends AbstractTransactionalTests {
@Test
@Sql(SCRIPT_LOCATION)
void placeholderIsResolvedInScriptLocation() {
assertUsers("Dilbert 1");
}
}
@Nested
@TestPropertySource(properties = "vendor = db2")
@DirtiesContext
class DatabaseTwoTests extends AbstractTransactionalTests {
@Test
@Sql(SCRIPT_LOCATION)
void placeholderIsResolvedInScriptLocation() {
assertUsers("Dilbert 2");
}
}
}

View File

@@ -21,6 +21,7 @@ import org.mockito.BDDMockito;
import org.springframework.context.ApplicationContext;
import org.springframework.core.annotation.AnnotationConfigurationException;
import org.springframework.mock.env.MockEnvironment;
import org.springframework.test.context.TestContext;
import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
@@ -84,6 +85,7 @@ class SqlScriptsTestExecutionListenerTests {
ApplicationContext ctx = mock();
given(ctx.getResource(anyString())).willReturn(mock());
given(ctx.getAutowireCapableBeanFactory()).willReturn(mock());
given(ctx.getEnvironment()).willReturn(new MockEnvironment());
Class<?> clazz = IsolatedWithoutTxMgr.class;
BDDMockito.<Class<?>> given(testContext.getTestClass()).willReturn(clazz);
@@ -98,6 +100,7 @@ class SqlScriptsTestExecutionListenerTests {
ApplicationContext ctx = mock();
given(ctx.getResource(anyString())).willReturn(mock());
given(ctx.getAutowireCapableBeanFactory()).willReturn(mock());
given(ctx.getEnvironment()).willReturn(new MockEnvironment());
Class<?> clazz = MissingDataSourceAndTxMgr.class;
BDDMockito.<Class<?>> given(testContext.getTestClass()).willReturn(clazz);