Skip to content

Commit fbfec56

Browse files
vstinnervstinner
authored
gh-109566: regrtest reexecutes the process (#109909)
When --fast-ci or --slow-ci option is used, regrtest now replaces the current process with a new process to add "-u -W default -bb -E" options to Python. Changes: * PCbuild/rt.bat and Tools/scripts/run_tests.py no longer need to add "-u -W default -bb -E" options to Python: it's now done by regrtest. * Fix Tools/scripts/run_tests.py: flush stdout before replacing the process. Previously, buffered messages were lost.
1 parent ecd813f commit fbfec56

7 files changed

Lines changed: 107 additions & 14 deletions

File tree

‎Lib/test/__main__.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
from test.libregrtest.main import main
2-
main()
2+
main(reexec=True)

‎Lib/test/libregrtest/cmdline.py‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -184,6 +184,7 @@ def __init__(self, **kwargs) -> None:
184184
self.threshold = None
185185
self.fail_rerun = False
186186
self.tempdir = None
187+
self.no_reexec = False
187188

188189
super().__init__(**kwargs)
189190

@@ -343,6 +344,8 @@ def _create_parser():
343344
help='override the working directory for the test run')
344345
group.add_argument('--cleanup', action='store_true',
345346
help='remove old test_python_* directories')
347+
group.add_argument('--no-reexec', action='store_true',
348+
help="internal option, don't use it")
346349
return parser
347350

348351

@@ -421,6 +424,8 @@ def _parse_args(args, **kwargs):
421424
ns.verbose3 = True
422425
if MS_WINDOWS:
423426
ns.nowindows = True # Silence alerts under Windows
427+
else:
428+
ns.no_reexec = True
424429

425430
# When both --slow-ci and --fast-ci options are present,
426431
# --slow-ci has the priority

‎Lib/test/libregrtest/main.py‎

Lines changed: 37 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
import os
22
import random
33
import re
4+
import shlex
45
import sys
56
import time
67

@@ -20,7 +21,7 @@
2021
StrPath, StrJSON, TestName, TestList, TestTuple, FilterTuple,
2122
strip_py_suffix, count, format_duration,
2223
printlist, get_temp_dir, get_work_dir, exit_timeout,
23-
display_header, cleanup_temp_dir,
24+
display_header, cleanup_temp_dir, print_warning,
2425
MS_WINDOWS)
2526

2627

@@ -47,7 +48,7 @@ class Regrtest:
4748
directly to set the values that would normally be set by flags
4849
on the command line.
4950
"""
50-
def __init__(self, ns: Namespace):
51+
def __init__(self, ns: Namespace, reexec: bool = False):
5152
# Log verbosity
5253
self.verbose: int = int(ns.verbose)
5354
self.quiet: bool = ns.quiet
@@ -69,6 +70,7 @@ def __init__(self, ns: Namespace):
6970
self.want_cleanup: bool = ns.cleanup
7071
self.want_rerun: bool = ns.rerun
7172
self.want_run_leaks: bool = ns.runleaks
73+
self.want_reexec: bool = (reexec and not ns.no_reexec)
7274

7375
# Select tests
7476
if ns.match_tests:
@@ -95,6 +97,7 @@ def __init__(self, ns: Namespace):
9597
self.worker_json: StrJSON | None = ns.worker_json
9698

9799
# Options to run tests
100+
self.ci_mode: bool = (ns.fast_ci or ns.slow_ci)
98101
self.fail_fast: bool = ns.failfast
99102
self.fail_env_changed: bool = ns.fail_env_changed
100103
self.fail_rerun: bool = ns.fail_rerun
@@ -483,7 +486,37 @@ def run_tests(self, selected: TestTuple, tests: TestList | None) -> int:
483486
# processes.
484487
return self._run_tests(selected, tests)
485488

489+
def _reexecute_python(self):
490+
if self.python_cmd:
491+
# Do nothing if --python=cmd option is used
492+
return
493+
494+
python_opts = [
495+
'-u', # Unbuffered stdout and stderr
496+
'-W', 'default', # Add warnings filter 'default'
497+
'-bb', # Error on bytes/str comparison
498+
'-E', # Ignore PYTHON* environment variables
499+
]
500+
501+
cmd = [*sys.orig_argv, "--no-reexec"]
502+
cmd[1:1] = python_opts
503+
504+
# Make sure that messages before execv() are logged
505+
sys.stdout.flush()
506+
sys.stderr.flush()
507+
508+
try:
509+
os.execv(cmd[0], cmd)
510+
# execv() do no return and so we don't get to this line on success
511+
except OSError as exc:
512+
cmd_text = shlex.join(cmd)
513+
print_warning(f"Failed to reexecute Python: {exc!r}\n"
514+
f"Command: {cmd_text}")
515+
486516
def main(self, tests: TestList | None = None):
517+
if self.want_reexec and self.ci_mode:
518+
self._reexecute_python()
519+
487520
if self.junit_filename and not os.path.isabs(self.junit_filename):
488521
self.junit_filename = os.path.abspath(self.junit_filename)
489522

@@ -515,7 +548,7 @@ def main(self, tests: TestList | None = None):
515548
sys.exit(exitcode)
516549

517550

518-
def main(tests=None, **kwargs):
551+
def main(tests=None, reexec=False, **kwargs):
519552
"""Run the Python suite."""
520553
ns = _parse_args(sys.argv[1:], **kwargs)
521-
Regrtest(ns).main(tests=tests)
554+
Regrtest(ns, reexec=reexec).main(tests=tests)

‎Lib/test/test_regrtest.py‎

Lines changed: 57 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -382,7 +382,8 @@ def check_ci_mode(self, args, use_resources):
382382
# Check Regrtest attributes which are more reliable than Namespace
383383
# which has an unclear API
384384
regrtest = main.Regrtest(ns)
385-
self.assertNotEqual(regrtest.num_workers, 0)
385+
self.assertTrue(regrtest.ci_mode)
386+
self.assertEqual(regrtest.num_workers, -1)
386387
self.assertTrue(regrtest.want_rerun)
387388
self.assertTrue(regrtest.randomize)
388389
self.assertIsNone(regrtest.random_seed)
@@ -1960,6 +1961,61 @@ def test_dev_mode(self):
19601961
self.check_executed_tests(output, tests,
19611962
stats=len(tests), parallel=True)
19621963

1964+
def check_reexec(self, option):
1965+
# --fast-ci and --slow-ci add "-u -W default -bb -E" options to Python
1966+
code = textwrap.dedent(r"""
1967+
import sys
1968+
import unittest
1969+
try:
1970+
from _testinternalcapi import get_config
1971+
except ImportError:
1972+
get_config = None
1973+
1974+
class WorkerTests(unittest.TestCase):
1975+
@unittest.skipUnless(get_config is None, 'need get_config()')
1976+
def test_config(self):
1977+
config = get_config()['config']
1978+
# -u option
1979+
self.assertEqual(config['buffered_stdio'], 0)
1980+
# -W default option
1981+
self.assertTrue(config['warnoptions'], ['default'])
1982+
# -bb option
1983+
self.assertTrue(config['bytes_warning'], 2)
1984+
# -E option
1985+
self.assertTrue(config['use_environment'], 0)
1986+
1987+
# test if get_config() is not available
1988+
def test_unbuffered(self):
1989+
# -u option
1990+
self.assertFalse(sys.stdout.line_buffering)
1991+
self.assertFalse(sys.stderr.line_buffering)
1992+
1993+
def test_python_opts(self):
1994+
# -W default option
1995+
self.assertTrue(sys.warnoptions, ['default'])
1996+
# -bb option
1997+
self.assertEqual(sys.flags.bytes_warning, 2)
1998+
# -E option
1999+
self.assertTrue(sys.flags.ignore_environment)
2000+
""")
2001+
testname = self.create_test(code=code)
2002+
2003+
cmd = [sys.executable,
2004+
"-m", "test", option,
2005+
f'--testdir={self.tmptestdir}',
2006+
testname]
2007+
proc = subprocess.run(cmd,
2008+
stdout=subprocess.PIPE,
2009+
stderr=subprocess.STDOUT,
2010+
text=True)
2011+
self.assertEqual(proc.returncode, 0, proc)
2012+
2013+
def test_reexec_fast_ci(self):
2014+
self.check_reexec("--fast-ci")
2015+
2016+
def test_reexec_slow_ci(self):
2017+
self.check_reexec("--slow-ci")
2018+
19632019

19642020
class TestUtils(unittest.TestCase):
19652021
def test_format_duration(self):

‎Misc/NEWS.d/next/Tests/2023-09-26-18-12-01.gh-issue-109566.CP0Vhf.rst‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
regrtest: When ``--fast-ci`` or ``--slow-ci`` option is used, regrtest now
2+
replaces the current process with a new process to add ``-u -W default -bb -E``
3+
options to Python. Patch by Victor Stinner.

‎PCbuild/rt.bat‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ if NOT "%1"=="" (set regrtestargs=%regrtestargs% %1) & shift & goto CheckOpts
4848

4949
if not defined prefix set prefix=%pcbuild%amd64
5050
set exe=%prefix%\python%suffix%.exe
51-
set cmd="%exe%" %dashO% -u -Wd -E -bb -m test %regrtestargs%
51+
set cmd="%exe%" %dashO% -m test %regrtestargs%
5252
if defined qmode goto Qmode
5353

5454
echo Deleting .pyc files ...

‎Tools/scripts/run_tests.py‎

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,7 @@ def is_python_flag(arg):
2323

2424

2525
def main(regrtest_args):
26-
args = [sys.executable,
27-
'-u', # Unbuffered stdout and stderr
28-
'-W', 'default', # Warnings set to 'default'
29-
'-bb', # Warnings about bytes/bytearray
30-
]
26+
args = [sys.executable]
3127

3228
cross_compile = '_PYTHON_HOST_PLATFORM' in os.environ
3329
if (hostrunner := os.environ.get("_PYTHON_HOSTRUNNER")) is None:
@@ -47,7 +43,6 @@ def main(regrtest_args):
4743
}
4844
else:
4945
environ = os.environ.copy()
50-
args.append("-E")
5146

5247
# Allow user-specified interpreter options to override our defaults.
5348
args.extend(test.support.args_from_interpreter_flags())
@@ -70,7 +65,8 @@ def main(regrtest_args):
7065

7166
args.extend(regrtest_args)
7267

73-
print(shlex.join(args))
68+
print(shlex.join(args), flush=True)
69+
7470
if sys.platform == 'win32':
7571
from subprocess import call
7672
sys.exit(call(args))

0 commit comments

Comments
 (0)