[RHELC-1511] Tell users to use config ini instead of env vars #1433
+155
−135
Conversation
This file contains 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
bocekm
added
skip/changelog
bocekm
force-pushed
the
messages-to-tell-to-use-config-not-env-vars
branch
from
2b03ee6
to
20c620c
Compare
|
/packit test |
bocekm
changed the title
bocekm
force-pushed
the
messages-to-tell-to-use-config-not-env-vars
branch
from
9a90f0d
to
e235cbd
Compare
|
/packit test |
bocekm
force-pushed
the
messages-to-tell-to-use-config-not-env-vars
branch
from
58b50cd
to
b737455
Compare
bocekm
commented
Nov 22, 2024
| @@ -167,7 +167,7 @@ def test_logfile_buffer_handler(read_std): | |||
|
|
|||
| stdouterr_out, _ = read_std() | |||
| assert "message 1" not in stdouterr_out | |||
| assert "message 2" in stdouterr_out | |||
| assert "message 2" not in stdouterr_out | |||
There was a problem hiding this comment.
@Venefilyn, I was getting the following unit test failure. Is this fix all right?
=================================== FAILURES ===================================
_________________________ test_logfile_buffer_handler __________________________
[gw0] linux2 -- Python 2.7.5 /usr/bin/python2
read_std = <function factory at 0x7f27c05fd7d0>
@pytest.mark.noautofixtures
def test_logfile_buffer_handler(read_std):
logbuffer_handler = logger_module.LogfileBufferHandler(2, "custom_name")
logger = logging.getLogger("convert2rhel")
logger.addHandler(logbuffer_handler)
logger.warning("message 1")
logger.warning("message 2")
# flushing without other handlers should work, it will just go to NullHandlers
logbuffer_handler.flush()
stdout_handler = logging.StreamHandler(sys.stdout)
stdout_handler.name = "custom_name"
logger.addHandler(stdout_handler)
# flush to the streamhandler we just created
logbuffer_handler.flush()
stdouterr_out, _ = read_std()
assert "message 1" not in stdouterr_out
> assert "message 2" in stdouterr_out
E AssertionError: assert 'message 2' in ''
convert2rhel/unit_tests/logger_test.py:170: AssertionError
There was a problem hiding this comment.
Interestingly, the unit tests executed here on GitHub are giving me an opposite result:
=================================== FAILURES ===================================
_________________________ test_logfile_buffer_handler __________________________
[gw2] linux2 -- Python 2.7.5 /usr/bin/python2
read_std = <function factory at 0x7ff1b0f57c80>
@pytest.mark.noautofixtures
def test_logfile_buffer_handler(read_std):
logbuffer_handler = logger_module.LogfileBufferHandler(2, "custom_name")
logger = logging.getLogger("convert2rhel")
logger.addHandler(logbuffer_handler)
logger.warning("message 1")
logger.warning("message 2")
# flushing without other handlers should work, it will just go to NullHandlers
logbuffer_handler.flush()
stdout_handler = logging.StreamHandler(sys.stdout)
stdout_handler.name = "custom_name"
logger.addHandler(stdout_handler)
# flush to the streamhandler we just created
logbuffer_handler.flush()
stdouterr_out, _ = read_std()
assert "message 1" not in stdouterr_out
> assert "message 2" not in stdouterr_out
E AssertionError: assert 'message 2' not in 'message 2\n'
E 'message 2' is contained here:
E Strings contain only whitespace, escaping them using repr()
E 'message 2\n'
convert2rhel/unit_tests/logger_test.py:170: AssertionError
There was a problem hiding this comment.
I just pulled down the PR locally and ran without any issues 🤔
============= 1323 passed, 97 skipped, 1 warnings in 8.32 seconds ==============
68e08e4
to
913b709
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1433 +/- ##
=======================================
Coverage ? 96.11%
=======================================
Files ? 72
Lines ? 5176
Branches ? 896
=======================================
Hits ? 4975
Misses ? 119
Partials ? 82
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
|
I can split this up into necessary-only changes and nice to have formatting changes so that there's not that many changes to review at once. |
bocekm
force-pushed
the
messages-to-tell-to-use-config-not-env-vars
branch
from
3619535
to
b0e1b95
Compare
|
Ok, I have slashed the number of changed lines to a third, keeping just the bare minimum. I'll create another PR for the nice-to-have changes to the messages. |
bocekm
force-pushed
the
messages-to-tell-to-use-config-not-env-vars
branch
2 times, most recently
from
0db29cc
to
34af479
Compare
Env vars have been deprecated in favor of the ini config file (e.g. /etc/convert2rhel.ini). for that reason We should be telling users to use the config file instead of the deprecated env vars.
bocekm
force-pushed
the
messages-to-tell-to-use-config-not-env-vars
branch
from
34af479
to
539280d
Compare
|
/packit test |
bocekm
added
tests/tier0
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.
Env vars have been deprecated in favor of the ini config file (e.g. /etc/convert2rhel.ini). We should be telling users to use the config file instead of the deprecated env vars.
Jira Issues:
Checklist
[RHELC-]or[HMS-]is part of the PR titleRelease Pendingif relevant