Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify supported targets for annotations in the TestContext framework #32772

Closed
sbrannen opened this issue May 7, 2024 · 0 comments
Closed
Assignees
Labels
in: test Issues in the test module type: documentation A documentation task
Milestone

Comments

@sbrannen
Copy link
Member

sbrannen commented May 7, 2024

The discussion in #32771 made it apparent that developers can be confused by the generic wording in the Javadoc for annotations in the Spring TestContext Framework (TCF), regarding where developers are allowed to declare such annotations.

For example, the Javadoc for many of the class-level annotations in the TCF states something similar to the following.

@XYZ is a class-level annotation that is used to configure XYZ for an ApplicationContext for integration tests.

Although the statement is true, it does not make it clear that such an annotation is only honored when declared on a test class.

We should therefore make that clear for all effected annotations.

@sbrannen sbrannen added in: test Issues in the test module type: documentation A documentation task labels May 7, 2024
@sbrannen sbrannen added this to the 6.2.0-M2 milestone May 7, 2024
@sbrannen sbrannen self-assigned this May 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
in: test Issues in the test module type: documentation A documentation task
Projects
None yet
Development

No branches or pull requests

1 participant