Tests: Improved parametrization

[tony]

• See also: Tests: Improved parametrization tmuxp#964

Summary

This PR refactors the test suite in test_common.py to improve organization, maintainability, and test coverage by consolidating version-related tests into parametrized fixtures.

Changes

Test Organization

• Consolidated individual version test functions into parametrized test fixtures
• Introduced clear test IDs for better test output and debugging
• Grouped related test cases logically within fixture collections

New Test Fixtures

Added several NamedTuple fixtures to improve test organization:

• VersionComparisonFixture - Tests for version comparison operations (gt, gte, lt, lte)
• VersionParsingFixture - Tests for version string parsing and validation
• VersionValidationFixture - Tests for version validation logic
• Added proper test IDs to SessionCheckName fixture

Coverage Improvements

• Added comprehensive test cases for various version formats:
  • Master versions (e.g., "master")
  • Next versions (e.g., "next-3.4")
  • OpenBSD versions (e.g., "3.3-openbsd")
  • Development versions (e.g., "3.3-dev")
  • Release candidate versions (e.g., "3.3-rc2")

Code Quality

• Improved type hints and annotations
• Better organization of test cases with clear separation of concerns
• More maintainable test structure using parametrization
• Consistent naming and formatting across test fixtures

Testing

All tests pass successfully with improved organization and no loss of coverage.

Summary by Sourcery

Tests:

• Refactor version and window tests to use named tuples as fixtures, improving readability and maintainability.

Summary by Sourcery

Refactor the test suite to use parametrized fixtures for version handling, improving test coverage and maintainability.

Tests:

• Consolidate version-related tests into parametrized fixtures.
• Introduce clear test IDs for improved test output.
• Group related test cases within fixture collections.
• Add comprehensive test cases for various version formats (master, next, OpenBSD, dev, and release candidate).
• Improve type hints and annotations.
• Improve organization and maintainability of test structure.

[sourcery-ai]

Reviewer's Guide by Sourcery

This PR refactors the test suite to improve organization, maintainability, and test coverage by consolidating version-related tests into parametrized fixtures and adding new test fixtures for version comparison, parsing, and validation. It also enhances tests for session name validation, window renaming, and splitting windows with environment variables.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change	Details	Files
Refactored version-related tests to use parametrized fixtures, improving test organization and coverage.	Consolidated individual version test functions into parametrized test fixtures. Introduced clear test IDs for better test output and debugging. Grouped related test cases logically within fixture collections. Added comprehensive test cases for various version formats, including master, next, OpenBSD, development, and release candidate versions.	tests/test_common.py
Introduced NamedTuple fixtures to enhance test organization and readability.	Added VersionComparisonFixture for testing version comparison operations. Added VersionParsingFixture for testing version string parsing and validation. Added VersionValidationFixture for testing version validation logic. Added proper test IDs to SessionCheckName fixture.	tests/test_common.py tests/test_version.py tests/test_window.py tests/test_session.py
Improved test coverage and organization for session name validation.	Added test cases for session names containing periods and colons. Ensured that invalid session names raise appropriate exceptions. Added test IDs to the parametrization.	tests/test_session.py tests/test_common.py
Enhanced window rename tests with parametrization.	Added test cases for renaming windows with spaces and escape characters. Ensured that window names are correctly updated after renaming. Added test IDs to the parametrization.	tests/test_window.py
Improved tests for splitting windows with environment variables.	Added test cases for splitting windows with single and multiple environment variables. Verified that environment variables are correctly passed to the new panes. Added test IDs to the parametrization.	tests/test_window.py tests/test_session.py

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[codecov]

Codecov Report

Attention: Patch coverage is 96.70330% with 3 lines in your changes missing coverage. Please review.

Project coverage is 88.82%. Comparing base (e2bbf72) to head (0c047a5).
Report is 10 commits behind head on master.

Files with missing lines	Patch %	Lines
tests/test_common.py	95.45%	0 Missing and 3 partials ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #570      +/-   ##
==========================================
- Coverage   88.84%   88.82%   -0.03%     
==========================================
  Files          36       36              
  Lines        4080     4079       -1     
  Branches      376      385       +9     
==========================================
- Hits         3625     3623       -2     
+ Misses        310      308       -2     
- Partials      145      148       +3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[tony]

@sourcery-ai review

[sourcery-ai]

Hey @tony - I've reviewed your changes - here's some feedback:

Overall Comments:

• The use of NamedTuples for test fixtures is a great way to improve readability and organization.
• Consider adding a helper function to reduce the repetition in the version validation tests.

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

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}