Throw exception when @ContextConfiguration#classes are not annotated with @Configuration [SPR-10971]

[spring-projects-issues]

Wojciech Krak opened SPR-10971 and commented

I think that would be nicer if the TestContext framework would throw an exception if a class declared via @ContextConfiguration#classes is not annotated with @Configuration.

If a configuration class has many annotations it is easy to forget to annotate it with @Configuration. With the status quo, it is possible that an empty application context is created, which can be a bit surprising.

---

Affects: 3.2.4

Issue Links:

• spring-test allows you to reference configuration classes that aren't annotated with @Configuration [SPR-9051] #13690 spring-test allows you to reference configuration classes that aren't annotated with @Configuration

Referenced from: commits 7ffd05a

[spring-projects-issues]

Sam Brannen commented

It is not an error if an annotated class declared via @ContextConfiguration#classes is not annotated with @Configuration. Thus it would not be acceptable for the TestContext framework to throw an exception in such cases.

FYI: As mentioned in the Javadoc for @ContextConfiguration, the term annotated class can refer to any of the following.

• A class annotated with @Configuration
• A component (i.e., a class annotated with @Component, @Service, @Repository, etc.)
• A JSR-330 compliant class that is annotated with javax.inject annotations
• Any other class that contains @Bean-methods

Consult the Javadoc for @Configuration and @Bean for further information regarding the configuration and semantics of annotated classes.

See also the discussion in #13690.

I am therefore resolving this issue as Works as Designed.

Regards,

Sam

[spring-projects-issues]

Wojciech Krak commented

I didn't know it, thanks for info. It's little tricky, I have to remember.
I read reference and it is rather [terse|docs.spring.io/spring/docs/3.2.x/spring-framework-reference/html/testing.html#integration-testing-annotations-spring]:
"annotated classes are typically @Configuration classes (...) annotated classes can be component classes, etc."

Regards, Wojtek

[spring-projects-issues]

Sam Brannen commented

I agree that the documentation you referenced is rather terse. Consequently, I have just made the following commit on GitHub which will show up in the Context configuration with annotated classes section of the Testing chapter.

Document 'annotated classes' in Testing chapter

In order to help developers avoid surprises from unintended use of
"@Bean Lite Mode" when referencing classes via @ContextConfiguration in
the TestContext framework, this commit duplicates the previous
discussion of "annotated classes" from the Javadoc for
@ContextConfiguration as a tip in the "Context configuration with
annotated classes" section of the Testing chapter in the reference
manual.

Thanks for your feedback!

Sam

[spring-projects-issues]

Wojciech Krak commented

I'm happy to hear that this notice was useful. This trap is defused, I think!
Regards, Wojtek