SpringApplicationContextLoader ignores properties files configured via @TestPropertySource

[sbrannen]

SpringApplicationContextLoader supports inlined properties configured via @TestPropertySource, but properties files are currently ignored.

Please add support for properties files configured via @TestPropertySource.

See org.springframework.test.context.support.AbstractContextLoader.prepareContext(ConfigurableApplicationContext, MergedContextConfiguration) for details.

[philwebb]

Presumably we just need to call prepareContext from SpringApplicationContextLoader.loadContext?

[sbrannen]

That's what AbstractGenericContextLoader and AbstractGenericWebContextLoader do; however, it's likely not that simple in the case of Spring Boot, since Spring Boot has special handling of property sources, profiles, initializers, etc.

prepareContext() internally calls addResourcePropertySourcesToEnvironment() which is currently private. So if you guys would like to invoke that directly instead of prepareContext(), you could either use reflection (not so nice), or I could make the method protected (or move it to a public utility).

Thoughts / preferences?

[sbrannen]

See: https://jira.spring.io/browse/SPR-12710 and https://jira.spring.io/browse/SPR-12721

[sbrannen]

This issue is closely related to #2505.

[sbrannen]

Very elegant solution. :)

Thanks, Phil!

[sbrannen]

Oops... I spoke too soon. That solution is actually broken. :(

SpringApplication.run() refreshes the ApplicationContext that it creates. Thus, your current solution adds the properties to the environment after the context has already been loaded. Consequently, any (singleton) components in the application context that should be using the test properties never see them. Your test is therefore a false positive.

For an appropriate fix, please see my comments in #2505.

@philwebb, please reopen this issue.

[wilkinsona]

Thanks, Sam. I believe this modified test captures the problem:

@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = { Config.class, MoreConfig.class })
@WebAppConfiguration
@IntegrationTest({ "server.port=0", "value1=123" })
@TestPropertySource(properties = "value2=456", locations = "classpath:/test-property-source-annotation.properties")
public class SpringApplicationIntegrationTestPropertyLocationTests {

    @Autowired
    private Environment environment;

    @Test
    public void loadedProperties() throws Exception {
        assertThat(this.environment.getProperty("value1"), equalTo("123"));
        assertThat(this.environment.getProperty("value2"), equalTo("456"));
        assertThat(this.environment.getProperty("annotation-referenced"),
                equalTo("fromfile"));
    }

    @Configuration
    static class MoreConfig {

        @Value("${value1}")
        private String value1;

        @Value("${value2}")
        private String value2;

        @Value("${annotation-referenced}")
        private String annotationReferenced;

        @PostConstruct
        void checkValues() {
            assertThat(this.value1, equalTo("123"));
            assertThat(this.value2, equalTo("456"));
            assertThat(this.annotationReferenced, equalTo("fromFile"));
        }

    }

}

It fails on the third assertion in checkValues(). @sbrannen is that what you expected?

[sbrannen]

Yes, that is exactly what I expected!

Thanks for updating the test.

looking forward to the fix. ;)

[philwebb]

Thanks for finding that one!

[sbrannen]

prego, signore!