bpo-30028: make test.support.temp_cwd() fork-safe (GH-1066)

Make test.support.temp_cwd() fork-safe. The context manager test.support.temp_cwd() no longer removes the temporary directory when executing in a process other than the parent it entered from.
If a forked child exits the context manager it won't do the cleanup.
(cherry picked from commit 33dddac00b)

Co-authored-by: Anselm Kruis <a.kruis@science-computing.de>
This commit is contained in:
Miss Islington (bot) 2018-02-22 21:39:02 -08:00 committed by GitHub
parent 24d6e3c56b
commit 694c5e0e1f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 35 additions and 1 deletions

View File

@ -948,10 +948,14 @@ def temp_dir(path=None, quiet=False):
warnings.warn(f'tests may fail, unable to create ' warnings.warn(f'tests may fail, unable to create '
f'temporary directory {path!r}: {exc}', f'temporary directory {path!r}: {exc}',
RuntimeWarning, stacklevel=3) RuntimeWarning, stacklevel=3)
if dir_created:
pid = os.getpid()
try: try:
yield path yield path
finally: finally:
if dir_created: # In case the process forks, let only the parent remove the
# directory. The child has a diffent process id. (bpo-30028)
if dir_created and pid == os.getpid():
rmtree(path) rmtree(path)
@contextlib.contextmanager @contextlib.contextmanager

View File

@ -9,9 +9,11 @@ import stat
import subprocess import subprocess
import sys import sys
import tempfile import tempfile
import textwrap
import time import time
import unittest import unittest
from test import support from test import support
from test.support import script_helper
TESTFN = support.TESTFN TESTFN = support.TESTFN
@ -165,6 +167,33 @@ class TestSupport(unittest.TestCase):
f'temporary directory {path!r}: '), f'temporary directory {path!r}: '),
warn) warn)
@unittest.skipUnless(hasattr(os, "fork"), "test requires os.fork")
def test_temp_dir__forked_child(self):
"""Test that a forked child process does not remove the directory."""
# See bpo-30028 for details.
# Run the test as an external script, because it uses fork.
script_helper.assert_python_ok("-c", textwrap.dedent("""
import os
from test import support
with support.temp_cwd() as temp_path:
pid = os.fork()
if pid != 0:
# parent process (child has pid == 0)
# wait for the child to terminate
(pid, status) = os.waitpid(pid, 0)
if status != 0:
raise AssertionError(f"Child process failed with exit "
f"status indication 0x{status:x}.")
# Make sure that temp_path is still present. When the child
# process leaves the 'temp_cwd'-context, the __exit__()-
# method of the context must not remove the temporary
# directory.
if not os.path.isdir(temp_path):
raise AssertionError("Child removed temp_path.")
"""))
# Tests for change_cwd() # Tests for change_cwd()
def test_change_cwd(self): def test_change_cwd(self):

View File

@ -856,6 +856,7 @@ Pedro Kroger
Hannu Krosing Hannu Krosing
Andrej Krpic Andrej Krpic
Ivan Krstić Ivan Krstić
Anselm Kruis
Steven Kryskalla Steven Kryskalla
Andrew Kuchling Andrew Kuchling
Dave Kuhlman Dave Kuhlman