Skip to content

[3.13] gh-119727: Add --single-process option to regrtest (#119728) #123010

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Aug 26, 2024
Merged

[3.13] gh-119727: Add --single-process option to regrtest (#119728) #123010

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions Lib/test/libregrtest/cmdline.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,7 @@ def __init__(self, **kwargs) -> None:
self.tempdir = None
self._add_python_opts = True
self.xmlpath = None
self.single_process = False

super().__init__(**kwargs)

Expand Down Expand Up @@ -307,6 +308,12 @@ def _create_parser():
group.add_argument('-j', '--multiprocess', metavar='PROCESSES',
dest='use_mp', type=int,
help='run PROCESSES processes at once')
group.add_argument('--single-process', action='store_true',
dest='single_process',
help='always run all tests sequentially in '
'a single process, ignore -jN option, '
'and failed tests are also rerun sequentially '
'in the same process')
group.add_argument('-T', '--coverage', action='store_true',
dest='trace',
help='turn on code coverage tracing using the trace '
Expand Down Expand Up @@ -435,6 +442,10 @@ def _parse_args(args, **kwargs):
else:
ns._add_python_opts = False

# --singleprocess overrides -jN option
if ns.single_process:
ns.use_mp = None

# When both --slow-ci and --fast-ci options are present,
# --slow-ci has the priority
if ns.slow_ci:
Expand Down
26 changes: 17 additions & 9 deletions Lib/test/libregrtest/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,12 +89,13 @@ def __init__(self, ns: Namespace, _add_python_opts: bool = False):
self.cmdline_args: TestList = ns.args

# Workers
if ns.use_mp is None:
num_workers = 0 # run sequentially
self.single_process: bool = ns.single_process
if self.single_process or ns.use_mp is None:
num_workers = 0 # run sequentially in a single process
elif ns.use_mp <= 0:
num_workers = -1 # use the number of CPUs
num_workers = -1 # run in parallel, use the number of CPUs
else:
num_workers = ns.use_mp
num_workers = ns.use_mp # run in parallel
self.num_workers: int = num_workers
self.worker_json: StrJSON | None = ns.worker_json

Expand Down Expand Up @@ -236,7 +237,7 @@ def list_tests(tests: TestTuple):

def _rerun_failed_tests(self, runtests: RunTests):
# Configure the runner to re-run tests
if self.num_workers == 0:
if self.num_workers == 0 and not self.single_process:
# Always run tests in fresh processes to have more deterministic
# initial state. Don't re-run tests in parallel but limit to a
# single worker process to have side effects (on the system load
Expand All @@ -246,7 +247,6 @@ def _rerun_failed_tests(self, runtests: RunTests):
tests, match_tests_dict = self.results.prepare_rerun()

# Re-run failed tests
self.log(f"Re-running {len(tests)} failed tests in verbose mode in subprocesses")
runtests = runtests.copy(
tests=tests,
rerun=True,
Expand All @@ -256,7 +256,15 @@ def _rerun_failed_tests(self, runtests: RunTests):
match_tests_dict=match_tests_dict,
output_on_failure=False)
self.logger.set_tests(runtests)
self._run_tests_mp(runtests, self.num_workers)

msg = f"Re-running {len(tests)} failed tests in verbose mode"
if not self.single_process:
msg = f"{msg} in subprocesses"
self.log(msg)
self._run_tests_mp(runtests, self.num_workers)
else:
self.log(msg)
self.run_tests_sequentially(runtests)
return runtests

def rerun_failed_tests(self, runtests: RunTests):
Expand Down Expand Up @@ -371,7 +379,7 @@ def run_tests_sequentially(self, runtests) -> None:
tests = count(jobs, 'test')
else:
tests = 'tests'
msg = f"Run {tests} sequentially"
msg = f"Run {tests} sequentially in a single process"
if runtests.timeout:
msg += " (timeout: %s)" % format_duration(runtests.timeout)
self.log(msg)
Expand Down Expand Up @@ -599,7 +607,7 @@ def _add_cross_compile_opts(self, regrtest_opts):
keep_environ = True

if cross_compile and hostrunner:
if self.num_workers == 0:
if self.num_workers == 0 and not self.single_process:
# For now use only two cores for cross-compiled builds;
# hostrunner can be expensive.
regrtest_opts.extend(['-j', '2'])
Expand Down
13 changes: 13 additions & 0 deletions Lib/test/test_regrtest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -475,6 +475,19 @@ def test_verbose3_huntrleaks(self):
self.assertEqual(regrtest.hunt_refleak.runs, 10)
self.assertFalse(regrtest.output_on_failure)

def test_single_process(self):
args = ['-j2', '--single-process']
with support.captured_stderr():
regrtest = self.create_regrtest(args)
self.assertEqual(regrtest.num_workers, 0)
self.assertTrue(regrtest.single_process)

args = ['--fast-ci', '--single-process']
with support.captured_stderr():
regrtest = self.create_regrtest(args)
self.assertEqual(regrtest.num_workers, 0)
self.assertTrue(regrtest.single_process)


@dataclasses.dataclass(slots=True)
class Rerun:
Expand Down
2 changes: 2 additions & 0 deletions Misc/NEWS.d/next/Tests/2024-05-29-15-28-08.gh-issue-119727.dVkaZM.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Add ``--single-process`` command line option to Python test runner (regrtest).
Patch by Victor Stinner.
Loading