diff --git a/Lib/test/libregrtest/setup.py b/Lib/test/libregrtest/setup.py index 345b5841999504..f9460ae7ed18f2 100644 --- a/Lib/test/libregrtest/setup.py +++ b/Lib/test/libregrtest/setup.py @@ -14,6 +14,9 @@ setup_threading_excepthook) +UNICODE_GUARD_ENV = "PYTHONREGRTEST_UNICODE_GUARD" + + def setup_tests(ns): try: stderr_fd = sys.__stderr__.fileno() @@ -98,6 +101,13 @@ def _test_audit_hook(name, args): from test.support.testresult import RegressionTestResult RegressionTestResult.USE_XML = True + # Ensure there's a non-ASCII character in env vars at all times to force + # tests consider this case. See BPO-44647 for details. + os.environ.setdefault( + UNICODE_GUARD_ENV, + "\N{SMILING FACE WITH SUNGLASSES}", + ) + def replace_stdout(): """Set stdout encoder error handler to backslashreplace (as stderr error diff --git a/Lib/test/test_regrtest.py b/Lib/test/test_regrtest.py index 054776ccf4808a..75fa6f2d3f4d56 100644 --- a/Lib/test/test_regrtest.py +++ b/Lib/test/test_regrtest.py @@ -19,7 +19,7 @@ from test import libregrtest from test import support from test.support import os_helper -from test.libregrtest import utils +from test.libregrtest import utils, setup Py_DEBUG = hasattr(sys, 'gettotalrefcount') @@ -1298,6 +1298,14 @@ def test_threading_excepthook(self): self.assertIn("Warning -- Uncaught thread exception", output) self.assertIn("Exception: bug in thread", output) + def test_unicode_guard_env(self): + guard = os.environ.get(setup.UNICODE_GUARD_ENV) + self.assertIsNotNone(guard, f"{setup.UNICODE_GUARD_ENV} not set") + if guard != "\N{SMILING FACE WITH SUNGLASSES}": + # Skip to signify that the env var value was changed by the user; + # possibly to something ASCII to work around Unicode issues. + self.skipTest("Modified guard") + def test_cleanup(self): dirname = os.path.join(self.tmptestdir, "test_python_123") os.mkdir(dirname) diff --git a/Misc/NEWS.d/next/Tests/2021-07-16-14-02-33.bpo-44647.5LzqIy.rst b/Misc/NEWS.d/next/Tests/2021-07-16-14-02-33.bpo-44647.5LzqIy.rst new file mode 100644 index 00000000000000..e4b2be2b409997 --- /dev/null +++ b/Misc/NEWS.d/next/Tests/2021-07-16-14-02-33.bpo-44647.5LzqIy.rst @@ -0,0 +1,4 @@ +Added a permanent Unicode-valued environment variable to regression tests to +ensure they handle this use case in the future. If your test environment +breaks because of that, report a bug to us, and temporarily set +PYTHONREGRTEST_UNICODE_GUARD=0 in your test environment.