Browse Source
Prior to this commit, inlined properties could only be supplied as an
array of Strings as follows.
@TestPropertySource(properties = {
"key1 = value1",
"key2 = value2"
})
Although a user could supply a text block, it was previously rejected
due to a "single key-value pair per string" check in
TestPropertySourceUtils.convertInlinedPropertiesToMap(String...).
This commit removes that restriction and allows the above example to be
refactored to use a text block as follows.
@TestPropertySource(properties = """
key1 = value1
key2 = value2
"""
)
Closes gh-31053
pull/31063/head
Sam Brannen
2 years ago
5 changed files with 223 additions and 41 deletions
@ -0,0 +1,142 @@
@@ -0,0 +1,142 @@
|
||||
/* |
||||
* Copyright 2002-2023 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.env; |
||||
|
||||
import org.junit.jupiter.api.Nested; |
||||
import org.junit.jupiter.api.Test; |
||||
import org.junit.jupiter.api.extension.ExtendWith; |
||||
|
||||
import org.springframework.beans.factory.annotation.Autowired; |
||||
import org.springframework.context.annotation.Configuration; |
||||
import org.springframework.core.env.ConfigurableEnvironment; |
||||
import org.springframework.core.env.EnumerablePropertySource; |
||||
import org.springframework.core.env.Environment; |
||||
import org.springframework.test.annotation.DirtiesContext; |
||||
import org.springframework.test.context.ContextConfiguration; |
||||
import org.springframework.test.context.TestPropertySource; |
||||
import org.springframework.test.context.junit.jupiter.SpringExtension; |
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat; |
||||
import static org.springframework.test.context.support.TestPropertySourceUtils.INLINED_PROPERTIES_PROPERTY_SOURCE_NAME; |
||||
|
||||
/** |
||||
* Integration tests for {@link TestPropertySource @TestPropertySource} support |
||||
* with inlined properties supplied via text blocks. |
||||
* |
||||
* @author Sam Brannen |
||||
* @since 6.1 |
||||
* @see InlinedPropertiesTestPropertySourceTests |
||||
*/ |
||||
@ExtendWith(SpringExtension.class) |
||||
@ContextConfiguration |
||||
@DirtiesContext |
||||
class InlinedPropertiesWithTextBlockTestPropertySourceTests { |
||||
|
||||
@Nested |
||||
@DirtiesContext |
||||
@TestPropertySource(properties = """ |
||||
foo = bar |
||||
baz quux |
||||
enigma: 42 |
||||
x.y.z = a=b=c |
||||
server.url = https://example.com
|
||||
key.value.1: key=value |
||||
key.value.2 key=value |
||||
key.value.3 key:value |
||||
""") |
||||
class AllInOneTextBlockTests { |
||||
|
||||
@Autowired |
||||
ConfigurableEnvironment env; |
||||
|
||||
@Test |
||||
void propertiesAreAvailableInEnvironment() { |
||||
// Simple key/value pairs
|
||||
assertEnvironmentProperty(this.env, "foo", "bar"); |
||||
assertEnvironmentProperty(this.env, "baz", "quux"); |
||||
assertEnvironmentProperty(this.env, "enigma", "42"); |
||||
|
||||
// Values containing key/value delimiters (":", "=", " ")
|
||||
assertEnvironmentProperty(this.env, "x.y.z", "a=b=c"); |
||||
assertEnvironmentProperty(this.env, "server.url", "https://example.com"); |
||||
assertEnvironmentProperty(this.env, "key.value.1", "key=value"); |
||||
assertEnvironmentProperty(this.env, "key.value.2", "key=value"); |
||||
assertEnvironmentProperty(this.env, "key.value.3", "key:value"); |
||||
} |
||||
|
||||
/** |
||||
* Not necessarily preserved because the properties are all added at the |
||||
* same time. |
||||
*/ |
||||
@Test |
||||
@SuppressWarnings("rawtypes") |
||||
void propertyNameOrderingIsNotNecessarilyPreservedInEnvironment() { |
||||
EnumerablePropertySource eps = (EnumerablePropertySource) env.getPropertySources().get( |
||||
INLINED_PROPERTIES_PROPERTY_SOURCE_NAME); |
||||
assertThat(eps.getPropertyNames()).containsExactlyInAnyOrder("foo", "baz", "enigma", "x.y.z", |
||||
"server.url", "key.value.1", "key.value.2", "key.value.3"); |
||||
} |
||||
|
||||
} |
||||
|
||||
@Nested |
||||
@DirtiesContext |
||||
@TestPropertySource(properties = { |
||||
""" |
||||
foo = bar |
||||
""", |
||||
""" |
||||
bar = baz |
||||
""", |
||||
""" |
||||
baz = quux |
||||
""" |
||||
}) |
||||
class MultipleTextBlockTests { |
||||
|
||||
@Autowired |
||||
ConfigurableEnvironment env; |
||||
|
||||
@Test |
||||
void propertiesAreAvailableInEnvironment() { |
||||
assertEnvironmentProperty(this.env, "foo", "bar"); |
||||
assertEnvironmentProperty(this.env, "bar", "baz"); |
||||
assertEnvironmentProperty(this.env, "baz", "quux"); |
||||
} |
||||
|
||||
@Test |
||||
@SuppressWarnings("rawtypes") |
||||
void propertyNameOrderingIsPreservedInEnvironment() { |
||||
EnumerablePropertySource eps = (EnumerablePropertySource) env.getPropertySources().get( |
||||
INLINED_PROPERTIES_PROPERTY_SOURCE_NAME); |
||||
assertThat(eps.getPropertyNames()).containsExactly("foo", "bar", "baz"); |
||||
} |
||||
|
||||
} |
||||
|
||||
|
||||
static void assertEnvironmentProperty(Environment env, String name, Object value) { |
||||
assertThat(env.getProperty(name)).as("environment property '%s'", name).isEqualTo(value); |
||||
} |
||||
|
||||
|
||||
@Configuration |
||||
static class Config { |
||||
/* no user beans required for these tests */ |
||||
} |
||||
|
||||
} |
||||
Loading…
Reference in new issue