feat: added Client.test_mode() to prevent subprocess locking

[petruki]

This pull request introduces a new "test mode" to the Client class, designed to prevent subprocesses like the snapshot watcher from running during tests. This makes it easier to avoid file locking issues in test environments. The implementation adds a new error type, updates documentation, and includes a test to verify the new behavior.

Key changes:

Test Mode Feature Implementation

• Added a _test_mode flag to the Client class, initialized with DEFAULT_TEST_MODE, and a static test_mode() method to enable test mode and prevent subprocesses during tests (switcher_client/client.py). [1] [2] [3]
• Updated the watch_snapshot method to reject snapshot watching in test mode, raising a new TestModeError (switcher_client/client.py).

Error Handling

• Introduced a new TestModeError exception to signal operations that are not allowed in test mode, and exported it in the module's __all__ list (switcher_client/errors/__init__.py).
• Updated imports to include TestModeError where needed (switcher_client/client.py).

Documentation

• Updated the README to document the new test mode functionality and its usage (README.md).

Testing

• Added a unit test to verify that the snapshot watcher is blocked when test mode is enabled (tests/test_client_watch_snapshot.py).

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud