janb
janb

Reputation: 1077

How to exclude classes that are added using Spring's AutoConfiguration when using @WebMvcTest?

I want to test my Controller using @WebMvcTest and mock the dependencies, but Spring Boot's AutoConfiguration loads my Couchbase (Spring Data) configuration automatically. Couchbase is not available on some platforms which run the test, so the Test class will throw an Exception. How can I exclude some classes from the AutoConfiguration mechanism?

I tried the excludeFilters option of @WebMvcTest and @ActiveProfile to load another Application Context, but that didn't work.

Test configuration:

@RunWith(SpringRunner.class)
@WebMvcTest(value = ExchangeJobImportController.class, excludeFilters = @ComponentScan.Filter(classes = CouchbaseConfiguration.class))
@ActiveProfiles("test")
public class ExchangeJobImportControllerTest {
  ...
}

Couchbase Configuration:

@Configuration
@EnableCouchbaseAuditing
@EnableConfigurationProperties({CouchbaseProperties.class})
@EnableCouchbaseRepositories(basePackages = "com....")
public class CouchbaseConfiguration extends AbstractCouchbaseConfiguration {
  ...
}

Upvotes: 5

Views: 5456

Answers (2)

Yavuz Tas
Yavuz Tas

Reputation: 354

I know it's been some time but I suppose the reason why the @ComponentScan.Filter solution doesn't work is that it looks for an annotation type for the classes field by default.

So, setting the FilterType as ASSIGNABLE_TYPE should work in your case:

@ComponentScan.Filter(
    type = FilterType.ASSIGNABLE_TYPE,
    classes = CouchbaseConfiguration.class
)

Upvotes: 0

janb
janb

Reputation: 1077

After some more struggling I found the solution: exclude the @SpringBootApplication annotated class in the @WebMvcTest annotation:

@RunWith(SpringRunner.class)
@WebMvcTest(value = ExchangeJobImportController.class, excludeAutoConfiguration = Application.class, secure = false)
@ActiveProfiles("localhost")
public class ExchangeJobImportControllerTest {
  ...
}

For the record, I am using Spring Boot 1.5.1.RELEASE

Upvotes: 1

Related Questions