Isolate tests in multi_process_shared with unique temp path.#38498
Isolate tests in multi_process_shared with unique temp path.#38498shunping wants to merge 1 commit into
Conversation
4a61e84 to
af38047
Compare
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request addresses flaky tests in the multi_process_shared module by improving test isolation. By replacing shared temporary directory usage with unique paths per test and removing problematic global cleanup routines, the changes ensure that concurrent test runs do not conflict with one another. Highlights
New Features🧠 You can now enable Memory (public preview) to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize the Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counterproductive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request introduces a pytest fixture to isolate MultiProcessShared tests by injecting a unique temporary directory path during initialization, enabling safer parallel execution. It also removes manual cleanup logic from MultiProcessSharedSpawnProcessTest. Feedback was provided regarding the fragility of the mock_init implementation, specifically concerning positional arguments and explicit None values for the path parameter, with a suggestion for a more robust function signature.
| def mock_init(self, constructor, tag, *args, **kwargs): | ||
| if 'path' not in kwargs: | ||
| kwargs['path'] = str(tmp_path) | ||
| return orig_init(self, constructor, tag, *args, **kwargs) |
There was a problem hiding this comment.
The current implementation of mock_init is fragile and will fail in several scenarios:
- Positional Arguments: If
pathis passed as a positional argument (e.g.,MultiProcessShared(cons, tag, "/path")), it will be captured in*args. Since'path'is not inkwargs, the code will add it tokwargs, causingorig_initto receive multiple values for thepathargument and raising aTypeError. - Explicit
None: Ifpath=Noneis passed explicitly as a keyword argument, the isolation will fail because'path' in kwargswill be true, and the mock won't replace it with the uniquetmp_path. The original__init__will then fall back to the global temp directory.
A more robust approach is to explicitly capture path in the signature and check if it is None.
| def mock_init(self, constructor, tag, *args, **kwargs): | |
| if 'path' not in kwargs: | |
| kwargs['path'] = str(tmp_path) | |
| return orig_init(self, constructor, tag, *args, **kwargs) | |
| def mock_init(self, constructor, tag, path=None, *args, **kwargs): | |
| if path is None: | |
| path = str(tmp_path) | |
| return orig_init(self, constructor, tag, path, *args, **kwargs) |
Flaky tests:
These tests were failing intermittently in parallel runs because
setUpwas cleaning up shared files in the default temp directory, including the ones created by any on-going tests, which interferes with concurrent tests.This fix adds an
autousepytest fixture to force allMultiProcessSharedinstances to use a uniquetmp_pathper test, and removes the unsafe global cleanup insetUp.