test.py: Split into test/

[tony]

This PR refactors the test helper functionality from a monolithic test/__init__.py into separate, focused modules. The changes improve code organization, maintainability, and make the test utilities more modular.

Changes

1. Module Reorganization

• Split test/__init__.py into specialized modules:
  • test/constants.py: Test-related constants
  • test/random.py: Random string generation utilities
  • test/environment.py: Environment variable mocking
  • test/temporary.py: Temporary session/window management
  • test/__init__.py: Now serves as a lightweight entry point

2. New Modules

• Created test/constants.py containing:

  • TEST_SESSION_PREFIX
  • RETRY_TIMEOUT_SECONDS
  • RETRY_INTERVAL_SECONDS

• Created test/environment.py containing:

  • EnvironmentVarGuard class for mocking environment variables

• Created temp.py containing context managers:

  • temp_session() for temporary tmux sessions
  • temp_window() for temporary tmux windows

3. Dependencies

• Added random to allowed builtin modules in pyproject.toml
• Updated imports in pytest_plugin.py to reflect new module structure

Benefits

• Better Organization: Code is now organized by functionality rather than being in one large file
• Improved Maintainability: Each module has a single responsibility
• Clearer Dependencies: Module dependencies are more explicit
• Better Testing: Easier to test individual components
• Reduced Cognitive Load: Smaller, focused files are easier to understand and modify

Testing

All existing tests continue to pass. The refactoring is purely organizational and doesn't change any functionality.

Migration

No migration steps are needed as all public APIs remain unchanged. Internal imports have been updated to reflect the new structure.

Summary by Sourcery

Chores:

• Refactor test helper functions into separate modules for better organization and maintainability.

[sourcery-ai]

Reviewer's Guide by Sourcery

This PR refactors the test helper functionality by splitting the monolithic test/__init__.py into separate, focused modules. It improves code organization, maintainability, and makes the test utilities more modular. Imports have been updated to reflect the new structure, and random has been added to the allowed builtin modules.

Updated class diagram for test helpers

classDiagram
    class pytest_plugin {
      -from libtmux.test.constants import TEST_SESSION_PREFIX
      -from libtmux.test.random import get_test_session_name, namer
    }

    class test_constants {
      +TEST_SESSION_PREFIX
      +RETRY_TIMEOUT_SECONDS
      +RETRY_INTERVAL_SECONDS
    }

    class test_random {
      +get_test_session_name()
      +namer()
    }

    class test_environment {
      +EnvironmentVarGuard
    }

    class test_temporary {
      +temp_session()
      +temp_window()
    }

    note for test_constants "New module for test constants"
    note for test_random "New module for random string generation"
    note for test_environment "New module for environment variable mocking"
    note for test_temporary "New module for temporary session/window management"

Loading

File-Level Changes

Change	Details	Files
Split the monolithic test/__init__.py module into smaller, focused modules for better organization and maintainability.	Created test/constants.py for test-related constants. Created test/random.py for random string generation utilities. Created test/environment.py for environment variable mocking. Created test/temporary.py for temporary session/window management. Updated test/__init__.py to serve as a lightweight entry point. Moved retry_until to test/retry.py.	src/libtmux/test/__init__.py src/libtmux/test/constants.py src/libtmux/test/random.py src/libtmux/test/environment.py src/libtmux/test/temporary.py src/libtmux/test/retry.py
Updated imports throughout the project to reflect the new module structure in the test/ directory.	Updated imports in pytest_plugin.py. Updated imports in tests/legacy_api/test_session.py. Updated imports in tests/legacy_api/test_tmuxobject.py. Updated imports in tests/test_session.py. Updated imports in tests/test_tmuxobject.py. Updated imports in tests/test_pane.py. Updated imports in tests/test_test.py.	src/libtmux/pytest_plugin.py tests/legacy_api/test_session.py tests/legacy_api/test_tmuxobject.py tests/test_session.py tests/test_tmuxobject.py tests/test_pane.py tests/test_test.py
Added random to the list of allowed builtin modules in pyproject.toml.	Added random to builtins-allowed-modules in pyproject.toml.	pyproject.toml

---

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 79.13043% with 24 lines in your changes missing coverage. Please review.

Project coverage is 78.89%. Comparing base (11748a9) to head (6cbfe31).
Report is 13 commits behind head on master.

Files with missing lines	Patch %	Lines
src/libtmux/test/environment.py	40.00%	15 Missing ⚠️
src/libtmux/test/temporary.py	80.00%	2 Missing and 4 partials ⚠️
src/libtmux/test/random.py	88.88%	1 Missing and 2 partials ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #578      +/-   ##
==========================================
+ Coverage   78.65%   78.89%   +0.24%     
==========================================
  Files          18       23       +5     
  Lines        1916     1938      +22     
  Branches      291      291              
==========================================
+ Hits         1507     1529      +22     
  Misses        284      284              
  Partials      125      125              

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

[sourcery-ai]

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

Overall Comments:

• Consider adding a brief explanation or example usage for each function/class in the newly created modules to improve discoverability.
• Since you've split the test helpers into modules, consider renaming test_test.py to something more descriptive, like test_retry.py.

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.}