Coverage: Test helpers #580
Merged
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
Reviewer's Guide by SourceryThis pull request refactors and improves the test helpers in libtmux. It removes the ability to import directly from the Updated class diagram for EnvironmentVarGuardclassDiagram
class EnvironmentVarGuard {
- env: dict
- active: bool
+ __init__(env: dict = None)
+ __enter__(): EnvironmentVarGuard
+ __exit__(exc_type, exc_value, traceback)
+ set(varname: str, value: str)
+ unset(varname: str)
}
note for EnvironmentVarGuard "Handles environment variables, setting and unsetting them, and restoring previous values upon exit."
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #580 +/- ##
==========================================
+ Coverage 78.89% 79.83% +0.93%
==========================================
Files 23 22 -1
Lines 1938 1914 -24
Branches 291 294 +3
==========================================
- Hits 1529 1528 -1
+ Misses 284 266 -18
+ Partials 125 120 -5 ☔ View full report in Codecov by Sentry. |
926d744 to
d254201
Compare
why: Ensure test utilities for random string generation and naming work correctly what: - Add tests for RandomStrSequence with default and custom characters - Test iterator protocol and uniqueness guarantees - Test session/window name generation with real tmux server - Use string.ascii_uppercase for predictable character set - Verify prefix requirements and name collisions refs: Uses global server/session fixtures for real tmux testing
why: Ensure temporary tmux objects are properly created and cleaned up what: - Test session creation and automatic cleanup - Verify custom session names are respected - Test window creation and automatic cleanup - Ensure cleanup happens even during exceptions - Verify window counts and IDs before/after operations refs: Uses global server/session fixtures for real tmux testing
why: Ensure test utilities handle name collisions correctly what: - Fix mocking of RandomStrSequence.__next__ - Add doctest examples coverage - Test name collision handling in both session and window names refs: Coverage improved from 52% to 58%
why: Ensure test constants are correctly defined and configurable what: - Test default values for retry timeouts - Test environment variable configuration - Test session prefix constant refs: Coverage for constants.py now at 100%
- Add new test file for environment variable management - Test setting and unsetting environment variables - Test context manager functionality - Test cleanup on normal exit and exceptions - Improve EnvironmentVarGuard to properly handle unset variables - Ensure variables are restored to original state
- Add test for default character set - Add test for custom character sets - Add test for string uniqueness - Add test for iterator protocol - Add test for doctest examples - Improve test coverage and maintainability
- Add realistic sleep durations to simulate work - Add timing assertions with reasonable tolerances - Test both success and timeout scenarios - Test behavior with raises=False option - Improve test readability with clear timing expectations
- Remove duplicate logger definition - Add proper Self type hint for Python 3.11+ - Clean up redundant type checking imports - Improve code organization
- Add test for logger configuration - Add tests for multiple collisions in name generation - Add test for Self type annotation (Python 3.11+) - Add test for global namer instance - Add doctest example coverage
- Use a single with statement with multiple contexts - Fix SIM117 ruff linting issue
- Add pragma: no cover to type checking imports - Add pragma: no cover to future annotations - Add pragma: no cover to Self type imports
- Add pragma: no cover to doctest examples - Fix Self type imports for Python 3.11+ - Improve coverage reporting accuracy
- Add test for unsetting previously set variables - Add test for __exit__ with exception parameters - Fix line length issues in random.py - Fix Self type imports in random.py
- Remove unused pytest import from test_environment.py
why: The doctest examples were using line continuation with backslash followed by ellipsis which caused syntax errors during doctest execution. what: Replace multiline examples with simpler single-line assertions and use intermediate variables to make the examples more readable
- Add test_random_str_sequence_small_character_set to verify behavior with exactly 8 characters - Add test_random_str_sequence_insufficient_characters to verify proper error handling - Add test_logger_configured to verify logger configuration using caplog fixture - Improve assertion messages for better test diagnostics - Use pytest.LogCaptureFixture for proper logger testing
- Add test_temp_session_outside_context to test handling of manually killed sessions - Add test_temp_window_outside_context to verify cleanup behavior for windows - Improve comments and assertions for better test clarity - Fix formatting and line length issues test: remove mocked session test in favor of real implementation
why: Ensure test utilities are properly tested and typed what: - Add proper type annotations for monkeypatch in test functions - Improve test coverage for RandomStrSequence iterator protocol - Add tests for collision handling with actual tmux objects - Add tests for import coverage and return statements - Fix formatting to comply with linting rules
d254201 to
a02e05a
Compare
There was a problem hiding this comment.
Hey @tony - I've reviewed your changes - here's some feedback:
Overall Comments:
- Consider adding a helper function to encapsulate the logic for creating and cleaning up temporary tmux objects, reducing code duplication in tests.
- The changes to
EnvironmentVarGuardlook good, but consider adding a test case that specifically verifies the scenario where a variable is unset and then reset within the same context.
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
|
@sourcery-ai resolve |
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.
Changes
Breaking Changes
libtmux.testroot modulelibtmux.test.named,libtmux.test.constants, etc.test.py: Split intotest/#578Improvements
Enhanced
EnvironmentVarGuardinlibtmux.test.environmentto better handle variable cleanup:Added comprehensive test suites:
tests/test/test_constants.py)tests/test/test_environment.py)Improved code quality:
pragma: no coverfor type checking blocksDocumentation and maintainability:
Test plan
Coverage
Summary by Sourcery
This pull request introduces test helpers for creating temporary sessions and windows, and for generating random names for sessions and windows. These helpers are intended to simplify and improve the reliability of tests that require creating and destroying tmux objects.
Summary by Sourcery
Introduce test helpers for creating temporary sessions and windows, and for generating random names for sessions and windows. Enhance
EnvironmentVarGuardto better handle variable cleanup. Remove ability to import directly fromlibtmux.testroot module. Add comprehensive test suites for constants module and environment utilities. Improve code quality by adding proper coverage markers and updating .coveragerc patterns.New Features:
Bug Fixes:
EnvironmentVarGuardwhen unsetting environment variables that were previously set in the same context, and add protection against accidentally deleting variables that were reset.Documentation:
Tests: