tests: fixes all warnings #1746
Open
+639
−749
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
…for_tag()` function, removing the associated warnings
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1746 +/- ##
==========================================
+ Coverage 97.33% 97.81% +0.47%
==========================================
Files 42 60 +18
Lines 2104 2604 +500
==========================================
+ Hits 2048 2547 +499
- Misses 56 57 +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:
|
Lee-W
reviewed
Dec 30, 2025
Member
Lee-W
left a comment
Lee-W
left a comment
There was a problem hiding this comment.
This PR is awesome! Just browsed through it Left a few nits and need some time to take a deeper look
Comment on lines
+146
to
+161
| def cli(self, *args: str): | ||
| """Execute commitizen CLI with given args.""" | ||
| self.mocker.patch.object(sys, "argv", ["cz", *args]) | ||
| cli.main() | ||
| self.tick() | ||
|
|
||
| def patch_env(self): | ||
| """Patch environment variables to sync with FreezeGun time.""" | ||
| self.monkeypatch.setenv("DATE", datetime.now().isoformat()) | ||
| self.monkeypatch.setenv("GIT_AUTHOR_DATE", datetime.now().isoformat()) | ||
| self.monkeypatch.setenv("GIT_COMMITTER_DATE", datetime.now().isoformat()) | ||
|
|
||
| def tick(self): | ||
| """Advance time by 1 second.""" | ||
| self.freezer.tick() | ||
| self.patch_env() |
Member
There was a problem hiding this comment.
Suggested change
| def cli(self, *args: str): | |
| """Execute commitizen CLI with given args.""" | |
| self.mocker.patch.object(sys, "argv", ["cz", *args]) | |
| cli.main() | |
| self.tick() | |
| def patch_env(self): | |
| """Patch environment variables to sync with FreezeGun time.""" | |
| self.monkeypatch.setenv("DATE", datetime.now().isoformat()) | |
| self.monkeypatch.setenv("GIT_AUTHOR_DATE", datetime.now().isoformat()) | |
| self.monkeypatch.setenv("GIT_COMMITTER_DATE", datetime.now().isoformat()) | |
| def tick(self): | |
| """Advance time by 1 second.""" | |
| self.freezer.tick() | |
| self.patch_env() | |
| def cli(self, *args: str) -> None: | |
| """Execute commitizen CLI with given args.""" | |
| self.mocker.patch.object(sys, "argv", ["cz", *args]) | |
| cli.main() | |
| self.tick() | |
| def patch_env(self) -> None: | |
| """Patch environment variables to sync with FreezeGun time.""" | |
| self.monkeypatch.setenv("DATE", datetime.now().isoformat()) | |
| self.monkeypatch.setenv("GIT_AUTHOR_DATE", datetime.now().isoformat()) | |
| self.monkeypatch.setenv("GIT_COMMITTER_DATE", datetime.now().isoformat()) | |
| def tick(self) -> None: | |
| """Advance time by 1 second.""" | |
| self.freezer.tick() | |
| self.patch_env() |
Since we're returning None above, let's do it consistently. Would love to know whether we can have a better name than patch_env. It's no easy to understand at the first glance
| raise exceptions.GitCommandError(c.err) | ||
| self.tick() | ||
|
|
||
| def current_branch(self) -> str: |
Member
There was a problem hiding this comment.
Suggested change
| def current_branch(self) -> str: | |
| def get_current_branch(self) -> str: |
| raise exceptions.CommitError(c.err) | ||
| self.tick() | ||
|
|
||
| def branch(self, name: str): |
Member
There was a problem hiding this comment.
Suggested change
| def branch(self, name: str): | |
| def create_branch(self, name: str): |
| raise exceptions.GitCommandError(c.err) | ||
| return c.out | ||
|
|
||
| def tag( |
Member
There was a problem hiding this comment.
Suggested change
| def tag( | |
| def create_tag( |
| raise exceptions.CommitError(c.err) | ||
| self.tick() | ||
|
|
||
| def cli(self, *args: str): |
Member
There was a problem hiding this comment.
Suggested change
| def cli(self, *args: str): | |
| def run_cli(self, *args: str): |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
This PR fixes all raised warnings during tests (making it easier to read actual errors).
Moving from 30 warnings and a duration of ~40s:
to no warnings for a duration of less than 10s:
The time gained is because we don't rely on
sleepanymore.Checklist
Code Changes
pyproject.tomlutil: UtilFixturehelper (freeze time withFreezeGunonce required):cli(*args)helper also time-controlled (underlying git operations have the time frozen too). Reduce the amount of boilerplate to execute the cli during testswait_for_tagintest_changelog_command.py(the only one still depending onwait_for_tag)test_changelog_command(all but those based on legacy pytesttmpdir/py.path.localtype which is badly typed)1970-01-01)The fixtures has not yet replaced helpers in other tests to reduce the size of the PR (will be done in separate pull requests)
Documentation Changes
None
Expected Behavior
Faster (no sleep) and fully deterministic (full control over time) tests execution.
Cleaner output (no more pages of warnings)
Easier to maintain tests
Steps to Test This Pull Request
Execute
poetry testonmasterand this branch to observe the differences of execution (speed and output).Additional Context
This was a long task but this was also (IMHO) required to make it easier to maintain tests on long term.
I'll update other test files when this one is merged
Fixes #1623