test(version): set version file as ignored file

Tweaks tests to use one committed change file and the version file as an ignored change file. This allows us to verify that our commit mechanism does not crash if a file that is changed is ignored by user
python-semantic-release · Dec 7, 2023 · 814a20e · 814a20e
1 parent 35a7bd4
commit 814a20e
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 9 deletions.
diff --git a/tests/command_line/test_version.py b/tests/command_line/test_version.py
@@ -389,7 +389,7 @@ def test_version_no_push_force_level(
     expected_new_version,
     example_project,
     example_pyproject_toml,
-    tmp_path_factory,
+    tmp_path_factory: "pytest.TempPathFactory",
     cli_runner,
 ):
     tempdir = tmp_path_factory.mktemp("test_version")
@@ -415,7 +415,7 @@ def test_version_no_push_force_level(
     # Changelog already reflects changes this should introduce
     assert differing_files == [
         "pyproject.toml",
-        f"src/{EXAMPLE_PROJECT_NAME}/__init__.py",
+        f"src/{EXAMPLE_PROJECT_NAME}/_version.py",
     ]
 
     # Compare pyproject.toml
@@ -434,14 +434,14 @@ def test_version_no_push_force_level(
     assert old_pyproject_toml == new_pyproject_toml
     assert new_version == expected_new_version
 
-    # Compare __init__.py
+    # Compare _version.py
     new_init_py = (
-        (example_project / "src" / EXAMPLE_PROJECT_NAME / "__init__.py")
+        (example_project / "src" / EXAMPLE_PROJECT_NAME / "_version.py")
         .read_text(encoding="utf-8")
         .splitlines(keepends=True)
     )
     old_init_py = (
-        (tempdir / "src" / EXAMPLE_PROJECT_NAME / "__init__.py")
+        (tempdir / "src" / EXAMPLE_PROJECT_NAME / "_version.py")
         .read_text(encoding="utf-8")
         .splitlines(keepends=True)
     )

diff --git a/tests/const.py b/tests/const.py
@@ -180,7 +180,7 @@
 
 [tool.semantic_release]
 version_variables = [
-    "src/{EXAMPLE_PROJECT_NAME}/__init__.py:__version__",
+    "src/{EXAMPLE_PROJECT_NAME}/_version.py:__version__",
 ]
 version_toml = ["pyproject.toml:tool.poetry.version"]
 build_command = "bash -c \"echo 'Hello World'\""

diff --git a/tests/fixtures/example_project.py b/tests/fixtures/example_project.py
@@ -26,7 +26,7 @@ def cd(path: Path) -> Generator[Path, None, None]:
 
 
 @pytest.fixture
-def example_project(tmp_path):
+def example_project(tmp_path: "Path") -> "Generator[Path, None, None]":
     with cd(tmp_path):
         src_dir = tmp_path / "src"
         src_dir.mkdir()
@@ -35,18 +35,35 @@ def example_project(tmp_path):
         init_py = example_dir / "__init__.py"
         init_py.write_text(
             dedent(
-                f'''
+                '''
                 """
                 An example package with a very informative docstring
                 """
-                __version__ = "{EXAMPLE_PROJECT_VERSION}"
+                from ._version import __version__
 
 
                 def hello_world() -> None:
                     print("Hello World")
                 '''
             )
         )
+        version_py = example_dir / "_version.py"
+        version_py.write_text(
+            dedent(
+                f'''
+                __version__ = "{EXAMPLE_PROJECT_VERSION}"
+                '''
+            )
+        )
+        gitignore = tmp_path / ".gitignore"
+        gitignore.write_text(
+            dedent(
+                f"""
+                *.pyc
+                /src/**/{version_py.name}
+                """
+            )
+        )
         pyproject_toml = tmp_path / "pyproject.toml"
         pyproject_toml.write_text(EXAMPLE_PYPROJECT_TOML_CONTENT)
         setup_cfg = tmp_path / "setup.cfg"