app: Alert user if TESTING is not properly set (PROJQUAY-8123) #3343
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The `TESTING` flag is used to set Quay in testing mode. In certain occasions (when Quay is deployed on VMs but config tool hasn't verified the validity of the configuration or when users build their own confuguration), this flag sometimes gets omitted from the end `config.yaml` file. When this happens, Quay will start with `TESTING: true` which will disable certain functionality (such as e-mail sending). We add the check to `app.py` to notify the user that `TESTING: false` is missing or misconfigured in their `config.yaml` file. The change doesn't break Quay startup, merely prints a warning in the container logs when `app.py` gets initialized.
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #3343 +/- ##
==========================================
- Coverage 70.60% 70.60% -0.01%
==========================================
Files 442 442
Lines 41942 41945 +3
Branches 4745 4746 +1
==========================================
+ Hits 29613 29615 +2
Misses 10644 10644
- Partials 1685 1686 +1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
bcaton85
reviewed
May 28, 2025
| # Check if TESTING is properly set | ||
| if app.config.get("TESTING", False): | ||
| logger.warning( | ||
| "🟡🟡🟡 Detected TESTING: true on startup. TESTING property is either missing from config.yaml or set to 'true'." |
There was a problem hiding this comment.
interesting we default to starting quay in testing mode
bcaton85
approved these changes
May 28, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
TESTINGflag is used to set Quay in testing mode. In certain occasions (when Quay is deployed on VMs but config tool hasn't verified the validity of the configuration or when users build their own confuguration), this flag sometimes gets omitted from the endconfig.yamlfile. When this happens, Quay will start withTESTING: truewhich will disable certain functionality (such as e-mail sending).We add the check to
app.pyto notify the user thatTESTING: falseis missing or misconfigured in theirconfig.yamlfile. The change doesn't break Quay startup, merely prints a warning in the container logs whenapp.pygets initialized.