-
-
Notifications
You must be signed in to change notification settings - Fork 32.3k
gh-108927: Fix removing testing modules from sys.modules #108952
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
339f260
e52be9b
68c014e
c1ad70c
3f25ab4
7673248
5df4c8b
eb7766b
0eae535
66437b5
8470b33
544c068
1e7ea34
56621ab
ba5597a
d025e22
1aae341
017f01d
5086405
b3ea8fa
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -311,7 +311,7 @@ def run_tests_sequentially(self, runtests) -> None: | |
else: | ||
tracer = None | ||
|
||
save_modules = sys.modules.keys() | ||
save_modules = set(sys.modules) | ||
|
||
jobs = runtests.get_jobs() | ||
if jobs is not None: | ||
|
@@ -335,10 +335,18 @@ def run_tests_sequentially(self, runtests) -> None: | |
|
||
result = self.run_test(test_name, runtests, tracer) | ||
|
||
# Unload the newly imported modules (best effort finalization) | ||
for module in sys.modules.keys(): | ||
if module not in save_modules and module.startswith("test."): | ||
support.unload(module) | ||
# Unload the newly imported test modules (best effort finalization) | ||
new_modules = [module for module in sys.modules | ||
if module not in save_modules and | ||
module.startswith(("test.", "test_"))] | ||
for module in new_modules: | ||
sys.modules.pop(module, None) | ||
# Remove the attribute of the parent module. | ||
parent, _, name = module.rpartition('.') | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Maybe raise an error if the parent itself has a parent other than There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. What do you mean? The parent should be "test" or start with "test.", because the module starts with "test.". If the parent starts with "test." it will be removed as well. If it was already removed before children, the code ignores KeyError. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. If a test imports There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes, if they were not imported before running tests. |
||
try: | ||
delattr(sys.modules[parent], name) | ||
except (KeyError, AttributeError): | ||
pass | ||
|
||
if result.must_stop(self.fail_fast, self.fail_env_changed): | ||
break | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
import sys | ||
import unittest | ||
import test_regrtest_b.util | ||
|
||
class Test(unittest.TestCase): | ||
def test(self): | ||
test_regrtest_b.util # does not fail | ||
self.assertIn('test_regrtest_a', sys.modules) | ||
self.assertIs(sys.modules['test_regrtest_b'], test_regrtest_b) | ||
self.assertIs(sys.modules['test_regrtest_b.util'], test_regrtest_b.util) | ||
self.assertNotIn('test_regrtest_c', sys.modules) |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
import sys | ||
import unittest | ||
|
||
class Test(unittest.TestCase): | ||
def test(self): | ||
self.assertNotIn('test_regrtest_a', sys.modules) | ||
self.assertIn('test_regrtest_b', sys.modules) | ||
self.assertNotIn('test_regrtest_b.util', sys.modules) | ||
self.assertNotIn('test_regrtest_c', sys.modules) |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
import sys | ||
import unittest | ||
import test_regrtest_b.util | ||
|
||
class Test(unittest.TestCase): | ||
def test(self): | ||
test_regrtest_b.util # does not fail | ||
self.assertNotIn('test_regrtest_a', sys.modules) | ||
self.assertIs(sys.modules['test_regrtest_b'], test_regrtest_b) | ||
self.assertIs(sys.modules['test_regrtest_b.util'], test_regrtest_b.util) | ||
self.assertIn('test_regrtest_c', sys.modules) |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2031,6 +2031,25 @@ def test_dev_mode(self): | |
self.check_executed_tests(output, tests, | ||
stats=len(tests), parallel=True) | ||
|
||
def test_unload_tests(self): | ||
# Test that unloading test modules does not break tests | ||
# that import from other tests. | ||
# The test execution order matters for this test. | ||
# Both test_regrtest_a and test_regrtest_c which are executed before | ||
# and after test_regrtest_b import a submodule from the test_regrtest_b | ||
# package and use it in testing. test_regrtest_b itself does not import | ||
# that submodule. | ||
# Previously test_regrtest_c failed because test_regrtest_b.util in | ||
# sys.modules was left after test_regrtest_a (making the import | ||
# statement no-op), but new test_regrtest_b without the util attribute | ||
# was imported for test_regrtest_b. | ||
testdir = os.path.join(os.path.dirname(__file__), | ||
'regrtestdata', 'import_from_tests') | ||
tests = [f'test_regrtest_{name}' for name in ('a', 'b', 'c')] | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Would you mind to add a comment to explain the purpose of these test? By reading the code, it's unclear to me. Explain that the test execution order matters for this test. Does the test fails if a regression is introduced? Maybe add a test_regrtest_d test checking if test_regrtest_a, test_regrtest_b and test_regrtest_c are not loaded? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Done. |
||
args = ['-Wd', '-E', '-bb', '-m', 'test', '--testdir=%s' % testdir, *tests] | ||
output = self.run_python(args) | ||
self.check_executed_tests(output, tests, stats=3) | ||
|
||
def check_add_python_opts(self, option): | ||
# --fast-ci and --slow-ci add "-u -W default -bb -E" options to Python | ||
code = textwrap.dedent(r""" | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
Fixed order dependence in running tests in the same process | ||
when a test that has submodules (e.g. test_importlib) follows a test that | ||
imports its submodule (e.g. test_importlib.util) and precedes a test | ||
(e.g. test_unittest or test_compileall) that uses that submodule. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would prefer to move this logic inside
libregrtest/single.py
, in therun_single_test()
function.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I did it, but it is only needed in single-process run. In multi-process run it only adds an overhead. So I moved it back.