Commit 5f7897ba authored by Phillip Webb's avatar Phillip Webb

Refine inner-class test @Configuration detection

Update detection logic to also consider `@Rules` classes. Also make the
documentation a little clearer.

Fixes gh-6768
parent 46815fc4
...@@ -4918,8 +4918,8 @@ annotations that can be used on classes in `src/test/java` to indicate that they ...@@ -4918,8 +4918,8 @@ annotations that can be used on classes in `src/test/java` to indicate that they
not be picked up by scanning. not be picked up by scanning.
NOTE: `@TestComponent` and `@TestConfiguration` are only needed on top level classes. If NOTE: `@TestComponent` and `@TestConfiguration` are only needed on top level classes. If
you define `@Configuration` or `@Component` as inner-classes within a test, they will be you define `@Configuration` or `@Component` as inner-classes within a test (any class
automatically filtered. that has `@Test` methods or `@RunWith`), they will be automatically filtered.
NOTE: If you directly use `@ComponentScan` (i.e. not via `@SpringBootApplication`) you NOTE: If you directly use `@ComponentScan` (i.e. not via `@SpringBootApplication`) you
will need to register the `TypeExcludeFilter` with it. See will need to register the `TypeExcludeFilter` with it. See
......
...@@ -31,7 +31,9 @@ import org.springframework.core.type.classreading.MetadataReaderFactory; ...@@ -31,7 +31,9 @@ import org.springframework.core.type.classreading.MetadataReaderFactory;
*/ */
class TestTypeExcludeFilter extends TypeExcludeFilter { class TestTypeExcludeFilter extends TypeExcludeFilter {
private static final String TEST_ANNOTATION = "org.junit.Test"; private static final String[] CLASS_ANNOTATIONS = { "org.junit.runner.RunWith" };
private static final String[] METHOD_ANNOTATIONS = { "org.junit.Test" };
@Override @Override
public boolean match(MetadataReader metadataReader, public boolean match(MetadataReader metadataReader,
...@@ -63,8 +65,18 @@ class TestTypeExcludeFilter extends TypeExcludeFilter { ...@@ -63,8 +65,18 @@ class TestTypeExcludeFilter extends TypeExcludeFilter {
} }
private boolean isTestClass(MetadataReader metadataReader) { private boolean isTestClass(MetadataReader metadataReader) {
return !metadataReader.getAnnotationMetadata() for (String annotation : CLASS_ANNOTATIONS) {
.getAnnotatedMethods(TEST_ANNOTATION).isEmpty(); if (metadataReader.getAnnotationMetadata().hasAnnotation(annotation)) {
return true;
}
}
for (String annotation : METHOD_ANNOTATIONS) {
if (metadataReader.getAnnotationMetadata().hasAnnotatedMethods(annotation)) {
return true;
}
}
return false;
} }
} }
/*
* 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.filter;
import org.junit.runner.RunWith;
import org.springframework.context.annotation.Configuration;
import org.springframework.test.context.junit4.SpringRunner;
/**
* Abstract test with nest {@code @Configuration} and {@code @RunWith} used by
* {@link TestTypeExcludeFilter}.
*
* @author Phillip Webb
*/
@RunWith(SpringRunner.class)
public abstract class AbstractTestWithConfigAndRunWith {
@Configuration
static class Config {
}
}
...@@ -50,6 +50,14 @@ public class TestTypeExcludeFilterTests { ...@@ -50,6 +50,14 @@ public class TestTypeExcludeFilterTests {
this.metadataReaderFactory)).isTrue(); this.metadataReaderFactory)).isTrue();
} }
@Test
public void matchesNestedConfigurationClassWithoutTestMethodsIfItHasRunWith()
throws Exception {
assertThat(this.filter.match(
getMetadataReader(AbstractTestWithConfigAndRunWith.Config.class),
this.metadataReaderFactory)).isTrue();
}
@Test @Test
public void matchesTestConfiguration() throws Exception { public void matchesTestConfiguration() throws Exception {
assertThat(this.filter.match(getMetadataReader(SampleTestConfig.class), assertThat(this.filter.match(getMetadataReader(SampleTestConfig.class),
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment