Improve documentation for overriding profiles defined by `@ActiveProfiles` via `-Dspring.profiles.active`

[manueljordan]

For a test class, when it uses @ActiveProfiles it works as expected by applying the profile(s) defined through the profiles attribute. But it is not possible to override this via a JVM system propety: -Dspring.profiles.active=....

For example:

• Override @ActiveProfiles({"dev","cache"}) by -Dspring.profiles.active=prod,-no-cache

Of course, if the test class comments out @ActiveProfiles({"dev","cache"}), then -Dspring.profiles.active=prod,-no-cache works in peace.

Is there an official explicit indication and explanation about the following?

1. Why is it not possible to override @ActiveProfiles via -Dspring.profiles.active=...?
2. How to accomplish the desired goal?

I already did some research in the official documentation at:

• @ActiveProfiles
• Annotation Interface ActiveProfiles

And there is nothing about how to resolve 1 and 2.

According to my understanding, to accomplish (2):

1. Implement the ActiveProfilesResolver interface to take into consideration the spring.profiles.active option over the profiles element. Of course only if the former exists, otherwise the latter works in peace (practically the current behavior of the unique and default implementation: the DefaultActiveProfilesResolver class).
2. Finally choose this implementation through the resolver attribute as @ActiveProfiles(profiles={"dev","cache"}, resolver=ImprovedActiveProfilesResolver.class)

Thanks for your understanding.

[Mohak-Nagaraju]

Hi, I'd like to work on this. Could a maintainer confirm this is accepted and point me to the right documentation file to edit? Thank you.

[sbrannen]

Is there an official explicit indication and explanation about the following?

There are various answers available online; however, you are correct: we have not officially documented this clearly.

Why is it not possible to override @ActiveProfiles via -Dspring.profiles.active=...?

This is discussed in a fair amount of detail in:

• Allow overriding @ActiveProfiles in test classes with system property [SPR-8982] #13622

How to accomplish the desired goal?

As mentioned in #13622 (comment) (and as you also pointed out), the best approach is to implement a custom ActiveProfilesResolver and register it via @ActiveProfiles(resolver=...).

We actually have examples of that in the reference manual in the Context Configuration with Environment Profiles section. See the OperatingSystemActiveProfilesResolver example.

In summary, I think we should:

1. Update the documentation for @ActiveProfiles and DefaultActiveProfilesResolver to explicitly state that the spring.profiles.active property is not taken into account and is not set by the DefaultActiveProfilesResolver. This should be documented in Javadoc and the respective sections of the reference manual.
2. Update the Context Configuration with Environment Profiles section of the reference manual to include an example ActiveProfilesResolver which allows the spring.profiles.active property to override profiles configured via @ActiveProfiles, preferably after the existing OperatingSystemActiveProfilesResolver example.

[sbrannen]

Hi, I'd like to work on this. Could a maintainer confirm this is accepted and point me to the right documentation file to edit? Thank you.

Hi @Mohak-Nagaraju,

Thanks for offering.

You should be able to infer the necessary places to make the changes based on links in this issue's description and my previous comment.

If you still feel confident about taking this on after having read my previous comment, please let us know and feel free to submit a PR. Otherwise, I'll will likely address this myself.

Cheers

[Mohak-Nagaraju]

Thanks for the detailed guidance @sbrannen ! I've gone through the links and feel confident taking this on.

[sbrannen]

Great, @Mohak-Nagaraju. 👍

Please let us know if you run into any issues.