test: extract copy_sample_file_to_tmpdir as test utils

Author: Lee-W

tests/providers/test_uv_provider.py

@@ -2,9 +2,12 @@
 
 from typing import TYPE_CHECKING
 
+import pytest
+
 from commitizen.config.base_config import BaseConfig
 from commitizen.providers import get_provider
 from commitizen.providers.uv_provider import UvProvider
+from tests.utils import copy_sample_file_to_tmpdir
 
 if TYPE_CHECKING:
     from pytest_regressions.file_regression import FileRegressionFixture
@@ -21,18 +24,21 @@
 """
 
 
+@pytest.fixture(scope="function")
+def commitizen_config_file(tmpdir):
+    return copy_sample_file_to_tmpdir(tmpdir, "sample_uv.lock", "uv.lock")
+
+
 def test_uv_provider(
     config: BaseConfig, tmpdir, file_regression: FileRegressionFixture
 ):
-    with open("tests/data/sample_uv.lock") as input_file:
-        uv_lock_content = input_file.read()
+    copy_sample_file_to_tmpdir(tmpdir, "sample_uv.lock", "uv.lock")
 
     with tmpdir.as_cwd():
         pyproject_toml_file = tmpdir / UvProvider.filename
         pyproject_toml_file.write_text(PYPROJECT_TOML, encoding="utf-8")
 
         uv_lock_file = tmpdir / UvProvider.lock_filename
-        uv_lock_file.write_text(uv_lock_content, encoding="utf-8")
 
         config.settings["version_provider"] = "uv"
 

tests/test_bump_update_version_in_files.py

@@ -1,59 +1,49 @@
-from pathlib import Path
 from shutil import copyfile
 
 import pytest
 
 from commitizen import bump
 from commitizen.exceptions import CurrentVersionNotFoundError
+from tests.utils import copy_sample_file_to_tmpdir
 
 MULTIPLE_VERSIONS_INCREASE_STRING = 'version = "1.2.9"\n' * 30
 MULTIPLE_VERSIONS_REDUCE_STRING = 'version = "1.2.10"\n' * 30
 
 TESTING_FILE_PREFIX = "tests/data"
 
 
-def _copy_sample_file_to_tmpdir(
-    tmp_path: Path, source_filename: str, dest_filename: str
-) -> Path:
-    tmp_file = tmp_path / dest_filename
-    copyfile(f"{TESTING_FILE_PREFIX}/{source_filename}", tmp_file)
-    return tmp_file
-
-
 @pytest.fixture(scope="function")
 def commitizen_config_file(tmpdir):
-    return _copy_sample_file_to_tmpdir(
-        tmpdir, "sample_pyproject.toml", "pyproject.toml"
-    )
+    return copy_sample_file_to_tmpdir(tmpdir, "sample_pyproject.toml", "pyproject.toml")
 
 
 @pytest.fixture(scope="function")
 def python_version_file(tmpdir, request):
-    return _copy_sample_file_to_tmpdir(tmpdir, "sample_version.py", "__version__.py")
+    return copy_sample_file_to_tmpdir(tmpdir, "sample_version.py", "__version__.py")
 
 
 @pytest.fixture(scope="function")
 def inconsistent_python_version_file(tmpdir):
-    return _copy_sample_file_to_tmpdir(
+    return copy_sample_file_to_tmpdir(
         tmpdir, "inconsistent_version.py", "__version__.py"
     )
 
 
 @pytest.fixture(scope="function")
 def random_location_version_file(tmpdir):
-    return _copy_sample_file_to_tmpdir(tmpdir, "sample_cargo.lock", "Cargo.lock")
+    return copy_sample_file_to_tmpdir(tmpdir, "sample_cargo.lock", "Cargo.lock")
 
 
 @pytest.fixture(scope="function")
 def version_repeated_file(tmpdir):
-    return _copy_sample_file_to_tmpdir(
+    return copy_sample_file_to_tmpdir(
         tmpdir, "repeated_version_number.json", "package.json"
     )
 
 
 @pytest.fixture(scope="function")
 def docker_compose_file(tmpdir):
-    return _copy_sample_file_to_tmpdir(
+    return copy_sample_file_to_tmpdir(
         tmpdir, "sample_docker_compose.yaml", "docker-compose.yaml"
     )
 
@@ -67,7 +57,7 @@ def docker_compose_file(tmpdir):
     ids=("with_eol", "without_eol"),
 )
 def multiple_versions_to_update_poetry_lock(tmpdir, request):
-    return _copy_sample_file_to_tmpdir(tmpdir, request.param, "pyproject.toml")
+    return copy_sample_file_to_tmpdir(tmpdir, request.param, "pyproject.toml")
 
 
 @pytest.fixture(scope="function")

tests/utils.py

@@ -4,6 +4,7 @@
 import time
 import uuid
 from pathlib import Path
+from shutil import copyfile
 
 import pytest
 from deprecated import deprecated
@@ -20,6 +21,8 @@
     reason="The output message of argparse is different between Python 3.13 and lower than Python 3.13",
 )
 
+TESTING_FILE_PREFIX = "tests/data"
+
 
 class FakeCommand:
     def __init__(self, out=None, err=None, return_code=0):
@@ -74,6 +77,14 @@ def create_tag(tag: str, message: str | None = None) -> None:
         raise exceptions.CommitError(c.err)
 
 
+def copy_sample_file_to_tmpdir(
+    tmp_path: Path, source_filename: str, dest_filename: str
+) -> Path:
+    tmp_file = tmp_path / dest_filename
+    copyfile(f"{TESTING_FILE_PREFIX}/{source_filename}", tmp_file)
+    return tmp_file
+
+
 @deprecated(
     reason="\n\
 Prefer using `create_file_and_commit(filename, committer_date={your_date})` to influence the order of tags.\n\