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

Documentation for quarkus.test.profile not mentioning multi-profile support? #38345

Closed
marcelstoer opened this issue Jan 23, 2024 · 5 comments · Fixed by #38382
Closed

Documentation for quarkus.test.profile not mentioning multi-profile support? #38345

marcelstoer opened this issue Jan 23, 2024 · 5 comments · Fixed by #38382

Comments

@marcelstoer
Copy link
Contributor

marcelstoer commented Jan 23, 2024

Describe the bug

https://quarkus.io/guides/continuous-testing#configuring-continuous-testing currently documents quarkus.test.profile as not having multi-profile support.

The profile (dev, test or prod) to use ...

Type: string

Since Quarkus now accepts quarkus.profile to be a comma-separated list of profiles, I expected the same support for quarkus.test.profile. And indeed, running Quarkus using -Dquarkus.test.profile=foo,bar does seem supported.

Profiles bar,foo activated.

Yet, the documentation still lists quarkus.test.profile as being a single string.

Expected behavior

No response

Actual behavior

No response

How to Reproduce?

No response

Output of uname -a or ver

No response

Output of java -version

No response

Quarkus version or git rev

No response

Build tool (ie. output of mvnw --version or gradlew --version)

No response

Additional information

No response

@marcelstoer marcelstoer added the kind/bug Something isn't working label Jan 23, 2024
@marcelstoer
Copy link
Contributor Author

Oh, same situation here for quarkus.profile: https://quarkus.io/guides/config-reference#configuration-reference.

@geoand geoand added area/documentation and removed kind/bug Something isn't working triage/needs-triage labels Jan 24, 2024
Copy link

quarkus-bot bot commented Jan 24, 2024

/cc @MichalMaler (documentation), @ebullient (documentation), @inoxx03 (documentation), @michelle-purcell (documentation), @rolfedh (documentation), @sheilamjones (documentation), @sunayna15 (documentation)

@geoand
Copy link
Contributor

geoand commented Jan 24, 2024

Would you like to propose an improvement?

@marcelstoer
Copy link
Contributor Author

Sure, I was just waiting for a confirmation that this indeed is a docs bug rather than a misunderstanding on my behalf 😄

@marcelstoer
Copy link
Contributor Author

At first I was really confused how the implementation can be so inconsistent with your documentation, knowing that your reference docs is generated from code.

After some digging and grepping in your code to find the correct classes I found this

* TODO refactor code to actually use these values
and this
* We don't really use this, because these are configurations for the config itself, so it causes a chicken / egg
* problem, but we need it for documentation purposes.
* <br>
* Relocation of the Config configurations to the Quarkus namespace is done in
* {@link io.quarkus.runtime.configuration.ConfigUtils#configBuilder}.

It all makes sense now 🤓 It explains why I found no references to those profile() methods. This in turn confirms that I can change the types from String to List<String> without breaking anything.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

Successfully merging a pull request may close this issue.

2 participants