root
/
spring-boot
mirror of https://github.com/spring-projects/spring-boot.git
1
0
Fork 0
Code Issues Actions 12 Packages Projects Releases Wiki Activity

Fail fast if @WebAppConfiguration and @SpringBootTest are used together 

Closes gh-6795
This commit is contained in:
Andy Wilkinson 2016-09-14 10:43:53 +01:00
parent 878a052567
commit c54cdd6735
4 changed files with 128 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
spring-boot-test/src/main/java/org/springframework/boot/test/context/SpringBootTestContextBootstrapper.java
View File

@ -16,6 +16,7 @@
package org.springframework.boot.test.context;
import java.lang.annotation.Annotation;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
@ -72,6 +73,7 @@ public class SpringBootTestContextBootstrapper extends DefaultTestContextBootstr
@Override
public TestContext buildTestContext() {
TestContext context = super.buildTestContext();
verifyConfiguration(context.getTestClass());
WebEnvironment webEnvironment = getWebEnvironment(context.getTestClass());
if (webEnvironment == WebEnvironment.MOCK && hasWebEnvironmentClasses()) {
context.setAttribute(ACTIVATE_SERVLET_LISTENER, true);
@ -246,6 +248,19 @@ public class SpringBootTestContextBootstrapper extends DefaultTestContextBootstr
return AnnotatedElementUtils.getMergedAnnotation(testClass, SpringBootTest.class);
}
protected void verifyConfiguration(Class<?> testClass) {
if (getAnnotation(testClass) != null
&& getAnnotation(WebAppConfiguration.class, testClass) != null) {
throw new IllegalStateException("@WebAppConfiguration is unnecessary when "
+ "using @SpringBootTest and should be removed");
}
}
private <T extends Annotation> T getAnnotation(Class<T> annotationType,
Class<?> testClass) {
return AnnotatedElementUtils.getMergedAnnotation(testClass, annotationType);
}
/**
* Create a new {@link MergedContextConfiguration} with different classes.
* @param mergedConfig the source config

2
spring-boot-test/src/test/java/org/springframework/boot/test/context/bootstrap/SpringBootTestContextBootstrapperExampleConfig.java
View File

@ -19,7 +19,7 @@ package org.springframework.boot.test.context.bootstrap;
import org.springframework.boot.SpringBootConfiguration;
/**
* Example configuration used in {@link SpringBootTestContextBootstrapperTests}.
* Example configuration used in {@link SpringBootTestContextBootstrapperIntegrationTests}.
*
* @author Phillip Webb
*/

82
spring-boot-test/src/test/java/org/springframework/boot/test/context/bootstrap/SpringBootTestContextBootstrapperIntegrationTests.java Normal file
View File

@ -0,0 +1,82 @@
/*
* Copyright 2012-2016 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
*
* http://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.boot.test.context.bootstrap;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTestContextBootstrapper;
import org.springframework.boot.test.context.TestConfiguration;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.Bean;
import org.springframework.stereotype.Component;
import org.springframework.test.context.BootstrapWith;
import org.springframework.test.context.junit4.SpringRunner;
import static org.assertj.core.api.Assertions.assertThat;
/**
* Integration tests for {@link SpringBootTestContextBootstrapper} (in its own package so
* we can test detection).
*
* @author Phillip Webb
*/
@RunWith(SpringRunner.class)
@BootstrapWith(SpringBootTestContextBootstrapper.class)
public class SpringBootTestContextBootstrapperIntegrationTests {
@Autowired
private ApplicationContext context;
@Autowired
private SpringBootTestContextBootstrapperExampleConfig config;
@Test
public void findConfigAutomatically() throws Exception {
assertThat(this.config).isNotNull();
}
@Test
public void contextWasCreatedViaSpringApplication() throws Exception {
assertThat(this.context.getId()).startsWith("application:");
}
@Test
public void testConfigurationWasApplied() throws Exception {
assertThat(this.context.getBean(ExampleBean.class)).isNotNull();
}
@TestConfiguration
static class TestConfig {
@Bean
public ExampleBean exampleBean() {
return new ExampleBean();
}
}
static class ExampleBean {
}
@Component
static class ExampleTestComponent {
}
}

76
spring-boot-test/src/test/java/org/springframework/boot/test/context/bootstrap/SpringBootTestContextBootstrapperTests.java
View File

@ -16,67 +16,51 @@
package org.springframework.boot.test.context.bootstrap;
import org.junit.Rule;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.rules.ExpectedException;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.context.SpringBootTestContextBootstrapper;
import org.springframework.boot.test.context.TestConfiguration;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.Bean;
import org.springframework.stereotype.Component;
import org.springframework.test.context.BootstrapWith;
import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.test.context.BootstrapContext;
import org.springframework.test.context.CacheAwareContextLoaderDelegate;
import org.springframework.test.context.web.WebAppConfiguration;
import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.BDDMockito.given;
import static org.mockito.Mockito.mock;
/**
* Tests for {@link SpringBootTestContextBootstrapper} (in its own package so we can test
* detection).
* Tests for {@link SpringBootTestContextBootstrapper}.
*
* @author Phillip Webb
* @author Andy Wilkinson
*/
@RunWith(SpringRunner.class)
@BootstrapWith(SpringBootTestContextBootstrapper.class)
public class SpringBootTestContextBootstrapperTests {
@Autowired
private ApplicationContext context;
@Autowired
private SpringBootTestContextBootstrapperExampleConfig config;
@Rule
public ExpectedException thrown = ExpectedException.none();
@SuppressWarnings("rawtypes")
@Test
public void findConfigAutomatically() throws Exception {
assertThat(this.config).isNotNull();
public void failFastWhenSpringBootTestAndWebAppConfigurationAreUsedTogether() {
SpringBootTestContextBootstrapper bootstrapper = new SpringBootTestContextBootstrapper();
BootstrapContext bootstrapContext = mock(BootstrapContext.class);
bootstrapper.setBootstrapContext(bootstrapContext);
given((Class) bootstrapContext.getTestClass())
.willReturn(SpringBootTestAndWebAppConfiguration.class);
CacheAwareContextLoaderDelegate contextLoaderDeleagte = mock(
CacheAwareContextLoaderDelegate.class);
given(bootstrapContext.getCacheAwareContextLoaderDelegate())
.willReturn(contextLoaderDeleagte);
this.thrown.expect(IllegalStateException.class);
this.thrown.expectMessage("@WebAppConfiguration is unnecessary when using "
+ "@SpringBootTest and should be removed");
bootstrapper.buildTestContext();
}
@Test
public void contextWasCreatedViaSpringApplication() throws Exception {
assertThat(this.context.getId()).startsWith("application:");
}
@Test
public void testConfigurationWasApplied() throws Exception {
assertThat(this.context.getBean(ExampleBean.class)).isNotNull();
}
@TestConfiguration
static class TestConfig {
@Bean
public ExampleBean exampleBean() {
return new ExampleBean();
}
@SpringBootTest
@WebAppConfiguration
private static class SpringBootTestAndWebAppConfiguration {
}
static class ExampleBean {
}
@Component
static class ExampleTestComponent {
}
}