Making --debug more configurable for the pytest user
#8955
Merged
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
symonk
changed the title
--debug more configurable for the pytest user
nicoddemus
reviewed
Jul 30, 2021
src/_pytest/helpconfig.py
Outdated
| metavar="DEBUG_FILE_NAME", | ||
| help="store internal tracing debug information in this log file.\n" | ||
| "This file is opened with 'w' and truncated as a result, care advised.\n" | ||
| "Defaults to 'pytestdebug.log', '.log' is suffixed if omitted.", |
There was a problem hiding this comment.
Suggested change
| "Defaults to 'pytestdebug.log', '.log' is suffixed if omitted.", | |
| "Defaults to 'pytestdebug.log', '.log' is suffixed if omitted.", |
I think we don't need to automatically append .log if omitted... I the user passes a file, let's just use that instead of trying to be helpful here.
src/_pytest/helpconfig.py
Outdated
| config.trace.root.setwriter(None) | ||
| undo_tracing() | ||
|
|
||
| config.add_cleanup(unset_tracing) | ||
|
|
||
|
|
||
| def _resolve_debug_log_name(file_name: str) -> str: |
There was a problem hiding this comment.
As I mentioned, I don't think we need this.
nicoddemus
reviewed
Jul 30, 2021
testing/test_config.py
Outdated
| @@ -2042,3 +2043,58 @@ def test_parse_warning_filter_failure(arg: str) -> None: | |||
|
|
|||
| with pytest.raises(warnings._OptionError): | |||
| parse_warning_filter(arg, escape=True) | |||
|
|
|||
|
|
|||
| def test_debug_file_name_is_suffixed_with_dot_log() -> None: | |||
There was a problem hiding this comment.
Personally I would group those new tests into a class:
class TestDebugOption:
def test_suffixed_with_dot_log() -> None:
...But that's just a matter of choice I guess.
nicoddemus
requested changes
Jul 30, 2021
Thanks again @nicoddemus for the review, should be sorted now, appreciate it. |
RonnyPfannschmidt
pushed a commit
to RonnyPfannschmidt/pytest
that referenced
this pull request
Oct 1, 2021
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.
Hi all, hope you are well,
This patch adds capabilities to provide a customised file name to
--debugwhich routes the debug logs into a file of the users choice. I have proposed this because we use multiple pytest executions as part of one jenkins job and find we have a wealth of internal plugins, running each run with--debugand artifacting the log is useful for us on a per run basis, we run parallel tests with xdist (want the debug log) then isolated sequential tests in a single process (want the debug log) and by default, this overwrites the pytestdebug.log. see #8954 for some of my reasoning.This remains the same functionality to most users in the sense that:
There are now 3 options to
--debug:--debugin isolation will result in apytestdebug.logfile in the root directory as prior--debugomitted from the command line (ini args etc) will result in no log file written--debug mylogwill result inmylog.logholding the debug logsNotes:
.logis suffixed to the user file if it does not end in.logjust to keep things relatively similar to the original file herew, so there is a chance someone passes a file that exists and we truncate and write logs to it 🤔 (not really sure how to solve that one, we don't want to append and can't check if it exists do nothing as overwriting it is the norm)Let me know what you think, thanks!
Close #8954