Unify temporary directory allocation strategy in tests

This package was previously using three different temporary directory
allocation strategies:
- Manual `TemporaryDirectory` management
- pytest `tmpdir` fixture
- pytest `tmp_path` fixture

This commit changes all temporary directory allocation in tests to use
the `tmp_path` fixture, and includes a compatibility definition of that
fixture so that the tests will continue to work properly on RHEL 8.

Author: cottsay

test/conftest.py

@@ -0,0 +1,18 @@
+# Copyright 2026 Open Source Robotics Foundation, Inc.
+# Licensed under the Apache License, Version 2.0
+
+from pathlib import Path
+
+import pytest
+
+
+if getattr(pytest, 'version_tuple', ()) < (3, 9):
+    @pytest.fixture
+    def tmp_path(tmpdir):
+        """
+        Compatibility fixture for temporary directory allocation.
+
+        This can be removed when we drop support for platforms with Pytest
+        versions older than 3.9 (namely Enterprise Linux 8).
+        """
+        return Path(tmpdir)

test/spell_check.words

@@ -6,7 +6,6 @@ asyncio
 autouse
 backend
 backported
-basepath
 bazqux
 blocklist
 callables

test/test_build_python.py

@@ -4,7 +4,6 @@
 import asyncio
 from contextlib import suppress
 from pathlib import Path
-from tempfile import TemporaryDirectory
 from types import SimpleNamespace
 
 from colcon_core.package_descriptor import PackageDescriptor
@@ -179,15 +178,16 @@ def _test_build_package(
 @pytest.mark.parametrize(
     'symlink_first',
     [False, True])
-def test_build_package(symlink_first, setup_cfg, libexec_pattern, data_files):
-    with TemporaryDirectory(prefix='test_colcon_') as tmp_path_str:
-        _test_build_package(
-            tmp_path_str, symlink_install=symlink_first,
-            setup_cfg=setup_cfg, libexec_pattern=libexec_pattern,
-            data_files=data_files)
-
-        # Test again with the symlink flag inverted to validate cleanup
-        _test_build_package(
-            tmp_path_str, symlink_install=not symlink_first,
-            setup_cfg=setup_cfg, libexec_pattern=libexec_pattern,
-            data_files=data_files)
+def test_build_package(
+    symlink_first, setup_cfg, libexec_pattern, data_files, tmp_path,
+):
+    tmp_path_str = str(tmp_path)
+
+    _test_build_package(
+        tmp_path_str, symlink_install=symlink_first, setup_cfg=setup_cfg,
+        libexec_pattern=libexec_pattern, data_files=data_files)
+
+    # Test again with the symlink flag inverted to validate cleanup
+    _test_build_package(
+        tmp_path_str, symlink_install=not symlink_first, setup_cfg=setup_cfg,
+        libexec_pattern=libexec_pattern, data_files=data_files)

test/test_command.py

@@ -6,7 +6,6 @@
 import signal
 import sys
 from tempfile import mkdtemp
-from tempfile import TemporaryDirectory
 from unittest.mock import Mock
 from unittest.mock import patch
 
@@ -234,20 +233,19 @@ def test_prog_name_not_a_file():
 
 
 @pytest.mark.skipif(sys.platform == 'win32', reason='Symlinks not supported.')
-def test_prog_name_symlink():
+def test_prog_name_symlink(tmp_path):
     # use __file__ since we know it exists
-    with TemporaryDirectory(prefix='test_colcon_') as temp_dir:
-        linked_file = os.path.join(temp_dir, 'test_command.py')
-        os.symlink(__file__, linked_file)
-
-        argv = [linked_file]
-        with patch('colcon_core.command.sys.argv', argv):
-            with patch(
-                'colcon_core.command.shutil.which',
-                return_value=__file__
-            ):
-                # prog should be shortened to the basename
-                assert get_prog_name() == 'test_command.py'
+    linked_file = tmp_path / 'test_command.py'
+    linked_file.symlink_to(__file__)
+
+    argv = [str(linked_file)]
+    with patch('colcon_core.command.sys.argv', argv):
+        with patch(
+            'colcon_core.command.shutil.which',
+            return_value=__file__
+        ):
+            # prog should be shortened to the basename
+            assert get_prog_name() == 'test_command.py'
 
 
 @pytest.mark.skipif(sys.platform != 'win32', reason='Only valid on Windows.')

test/test_environment.py

@@ -1,9 +1,7 @@
 # Copyright 2016-2018 Dirk Thomas
 # Licensed under the Apache License, Version 2.0
 
-import os
 from pathlib import Path
-from tempfile import TemporaryDirectory
 from unittest.mock import Mock
 from unittest.mock import patch
 
@@ -51,66 +49,60 @@ class Extension4(ShellExtensionPoint):
     pass
 
 
-def test_create_environment_scripts():
-    with TemporaryDirectory(prefix='test_colcon_') as basepath:
-        pkg = Mock()
-        pkg.name = 'name'
-        pkg.dependencies = {}
-        pkg.hooks = []
-        args = Mock()
-        args.install_base = basepath
+def test_create_environment_scripts(tmp_path):
+    pkg = Mock()
+    pkg.name = 'name'
+    pkg.dependencies = {}
+    pkg.hooks = []
+    args = Mock()
+    args.install_base = str(tmp_path)
 
-        # no hooks at all
+    # no hooks at all
+    with patch(
+        'colcon_core.environment.create_environment_hooks', return_value=[],
+    ):
         with patch(
-            'colcon_core.environment.create_environment_hooks', return_value=[]
+            'colcon_core.environment.get_shell_extensions', return_value={},
         ):
-            with patch(
-                'colcon_core.environment.get_shell_extensions', return_value={}
-            ):
-                create_environment_scripts(pkg, args)
-
-        pkg.hooks = [os.path.join(basepath, 'subA')]
-        with ExtensionPointContext(
-            extension3=Extension3, extension4=Extension4
-        ):
-            extensions = get_shell_extensions()
-            # one invalid return value, one check correct hooks argument
-            extensions[100]['extension3'].create_package_script = Mock()
-            extensions[100]['extension4'].create_package_script = Mock(
-                return_value=None)
-            with patch('colcon_core.environment.logger.error') as error:
-                create_environment_scripts(
-                    pkg, args, default_hooks=[('subB', )],
-                    additional_hooks=[['subC', 'arg1', 'arg2']])
-            # the raised exception is catched and results in an error message
-            assert error.call_count == 1
-            assert len(error.call_args[0]) == 1
-            assert error.call_args[0][0].startswith(
-                "Exception in shell extension 'extension3': "
-                'create_package_script() should return a list\n')
-            # check for correct hooks argument
-            mock = extensions[100]['extension4'].create_package_script
-            assert mock.call_count == 1
-            assert len(mock.call_args[0]) == 3
-            assert mock.call_args[0][0] == Path(args.install_base)
-            assert mock.call_args[0][1] == pkg.name
-            hook_tuples = mock.call_args[0][2]
-            assert len(hook_tuples) == 3
-            assert hook_tuples[0] == ('subB', ())
-            assert hook_tuples[1] == ('subC', ['arg1', 'arg2'])
-            assert hook_tuples[2] == ('subA', [])
-
-
-def test_create_environment_hooks():
-    with TemporaryDirectory(prefix='test_colcon_') as basepath:
-        with ExtensionPointContext(
-            extension1=Extension1, extension2=Extension2
-        ):
-            with patch('colcon_core.environment.logger.error') as error:
-                hooks = create_environment_hooks(basepath, 'pkg_name')
+            create_environment_scripts(pkg, args)
+
+    pkg.hooks = [str(tmp_path / 'subA')]
+    with ExtensionPointContext(extension3=Extension3, extension4=Extension4):
+        extensions = get_shell_extensions()
+        # one invalid return value, one check correct hooks argument
+        extensions[100]['extension3'].create_package_script = Mock()
+        extensions[100]['extension4'].create_package_script = Mock(
+            return_value=None)
+        with patch('colcon_core.environment.logger.error') as error:
+            create_environment_scripts(
+                pkg, args, default_hooks=[('subB', )],
+                additional_hooks=[['subC', 'arg1', 'arg2']])
+        # the raised exception is catched and results in an error message
+        assert error.call_count == 1
+        assert len(error.call_args[0]) == 1
+        assert error.call_args[0][0].startswith(
+            "Exception in shell extension 'extension3': "
+            'create_package_script() should return a list\n')
+        # check for correct hooks argument
+        mock = extensions[100]['extension4'].create_package_script
+        assert mock.call_count == 1
+        assert len(mock.call_args[0]) == 3
+        assert mock.call_args[0][0] == Path(args.install_base)
+        assert mock.call_args[0][1] == pkg.name
+        hook_tuples = mock.call_args[0][2]
+        assert len(hook_tuples) == 3
+        assert hook_tuples[0] == ('subB', ())
+        assert hook_tuples[1] == ('subC', ['arg1', 'arg2'])
+        assert hook_tuples[2] == ('subA', [])
+
+
+def test_create_environment_hooks(tmp_path):
+    with ExtensionPointContext(extension1=Extension1, extension2=Extension2):
+        with patch('colcon_core.environment.logger.error') as error:
+            hooks = create_environment_hooks(str(tmp_path), 'pkg_name')
     assert len(hooks) == 2
-    assert hooks[0] == f'{basepath}/share/pkg_name/hook/one.ext'
-    assert hooks[1] == f'{basepath}/share/pkg_name/hook/two.ext'
+    assert hooks[0] == f'{tmp_path}/share/pkg_name/hook/one.ext'
+    assert hooks[1] == f'{tmp_path}/share/pkg_name/hook/two.ext'
     # the raised exception is catched and results in an error message
     assert error.call_count == 1
     assert len(error.call_args[0]) == 1

test/test_environment_path.py

@@ -1,42 +1,38 @@
 # Copyright 2016-2018 Dirk Thomas
 # Licensed under the Apache License, Version 2.0
 
-from pathlib import Path
-from tempfile import TemporaryDirectory
 from unittest.mock import patch
 
 from colcon_core.environment.path import PathEnvironment
 
 
-def test_path():
+def test_path(tmp_path):
     extension = PathEnvironment()
 
-    with TemporaryDirectory(prefix='test_colcon_') as prefix_path:
-        prefix_path = Path(prefix_path)
-        with patch(
-            'colcon_core.shell.create_environment_hook',
-            return_value=['/some/hook', '/other/hook']
-        ):
-            # bin directory does not exist
-            hooks = extension.create_environment_hooks(prefix_path, 'pkg_name')
-            assert len(hooks) == 0
-
-            # bin directory exists, but empty
-            (prefix_path / 'bin').mkdir()
-            hooks = extension.create_environment_hooks(prefix_path, 'pkg_name')
-            assert len(hooks) == 0
-
-            # bin directory exists, but only subdirectories
-            (prefix_path / 'bin' / 'subdir').mkdir()
-            hooks = extension.create_environment_hooks(prefix_path, 'pkg_name')
-            assert len(hooks) == 0
-
-            # bin directory exists, with file
-            (prefix_path / 'bin' / 'hook').write_text('')
-            hooks = extension.create_environment_hooks(prefix_path, 'pkg_name')
-            assert len(hooks) == 2
-
-            # bin directory exists, with files
-            (prefix_path / 'bin' / 'hook2').write_text('')
-            hooks = extension.create_environment_hooks(prefix_path, 'pkg_name')
-            assert len(hooks) == 2
+    with patch(
+        'colcon_core.shell.create_environment_hook',
+        return_value=['/some/hook', '/other/hook']
+    ):
+        # bin directory does not exist
+        hooks = extension.create_environment_hooks(tmp_path, 'pkg_name')
+        assert len(hooks) == 0
+
+        # bin directory exists, but empty
+        (tmp_path / 'bin').mkdir()
+        hooks = extension.create_environment_hooks(tmp_path, 'pkg_name')
+        assert len(hooks) == 0
+
+        # bin directory exists, but only subdirectories
+        (tmp_path / 'bin' / 'subdir').mkdir()
+        hooks = extension.create_environment_hooks(tmp_path, 'pkg_name')
+        assert len(hooks) == 0
+
+        # bin directory exists, with file
+        (tmp_path / 'bin' / 'hook').write_text('')
+        hooks = extension.create_environment_hooks(tmp_path, 'pkg_name')
+        assert len(hooks) == 2
+
+        # bin directory exists, with files
+        (tmp_path / 'bin' / 'hook2').write_text('')
+        hooks = extension.create_environment_hooks(tmp_path, 'pkg_name')
+        assert len(hooks) == 2

test/test_environment_pythonpath.py

@@ -1,30 +1,25 @@
 # Copyright 2016-2018 Dirk Thomas
 # Licensed under the Apache License, Version 2.0
 
-from pathlib import Path
-from tempfile import TemporaryDirectory
 from unittest.mock import patch
 
 from colcon_core.environment.pythonpath import PythonPathEnvironment
 from colcon_core.python_install_path import get_python_install_path
 
 
-def test_pythonpath():
+def test_pythonpath(tmp_path):
     extension = PythonPathEnvironment()
 
-    with TemporaryDirectory(prefix='test_colcon_') as prefix_path:
-        prefix_path = Path(prefix_path)
-        with patch(
-            'colcon_core.shell.create_environment_hook',
-            return_value=['/some/hook', '/other/hook']
-        ):
-            # Python path does not exist
-            hooks = extension.create_environment_hooks(prefix_path, 'pkg_name')
-            assert len(hooks) == 0
+    with patch(
+        'colcon_core.shell.create_environment_hook',
+        return_value=['/some/hook', '/other/hook'],
+    ):
+        # Python path does not exist
+        hooks = extension.create_environment_hooks(tmp_path, 'pkg_name')
+        assert len(hooks) == 0
 
-            # Python path exists
-            python_path = get_python_install_path(
-                'purelib', {'base': prefix_path})
-            python_path.mkdir(parents=True)
-            hooks = extension.create_environment_hooks(prefix_path, 'pkg_name')
-            assert len(hooks) == 2
+        # Python path exists
+        python_path = get_python_install_path('purelib', {'base': tmp_path})
+        python_path.mkdir(parents=True)
+        hooks = extension.create_environment_hooks(tmp_path, 'pkg_name')
+        assert len(hooks) == 2