Don't run tree or git when running golden tests

Both tree and git have unstable output between different versions, so it
makes the golden tests too flaky when they run in different
environments.

Since which files are being generated is already being tested by the
golden tree, we don't really need to check for this.

Signed-off-by: Leandro Lucarella <[email protected]>

Author: llucax

cookiecutter/hooks/post_gen_project.py

@@ -10,6 +10,7 @@
 import configparser as _configparser
 import dataclasses as _dataclasses
 import json as _json
+import os
 import pathlib as _pathlib
 import shutil as _shutil
 import subprocess as _subprocess
@@ -189,6 +190,11 @@ def initialize_git_submodules() -> bool:
     Returns:
         Whether any git submodules were initialized.
     """
+    if is_golden_testing():
+        # We don't use external tools when running tests because they are too flaky, as
+        # different versions emit different outputs
+        return False
+
     gitmodules_path = _pathlib.Path(".gitmodules")
 
     if not gitmodules_path.exists():
@@ -287,8 +293,14 @@ def initialize_git_repo() -> bool:
     Returns:
         Whether the project was initialized as a git repository.
     """
+    if is_golden_testing():
+        # We don't use external tools when running tests because they are too flaky, as
+        # different versions emit different outputs
+        return False
+
     if _pathlib.Path(".git").exists():
         return False
+
     print()
     note("Initializing git repository...")
     try_run(
@@ -309,6 +321,11 @@ def commit_git_changes(*, first_commit: bool) -> None:
     Args:
         first_commit: Whether this is the first commit in the git repository.
     """
+    if is_golden_testing():
+        # We don't use external tools when running tests because they are too flaky, as
+        # different versions emit different outputs
+        return
+
     if not try_run(["git", "status", "--porcelain"]):
         return
 
@@ -367,6 +384,11 @@ def is_file_empty(path: _pathlib.Path) -> bool:
 
 def print_generated_tree() -> None:
     """Print the generated files tree."""
+    if is_golden_testing():
+        # We don't use external tools when running tests because they are too flaky, as
+        # different versions emit different outputs
+        return
+
     result = try_run(["tree"])
     if result is not None and result.returncode == 0:
         print()
@@ -487,6 +509,8 @@ def try_run(
         note_on_failure: If not `None`, print this note if the command fails (either
             because of an error or a non-zero status code).
         verbose: Whether to print the command before running it.
+        shell: Whether to run the command in a shell. If `True`, `cmd` must be a
+            string, otherwise it must be a list of strings.
 
     Returns:
         The result of the command or `None` if the command could not be run because
@@ -513,6 +537,15 @@ def try_run(
     return result
 
 
+def is_golden_testing() -> bool:
+    """Return `True` if we are running as part of a golden testing.
+
+    Returns:
+        Whether we are running as part of a golden testing.
+    """
+    return os.environ.get("GOLDEN_TEST", None) is not None
+
+
 def recursive_overwrite_move(src: _pathlib.Path, dst: _pathlib.Path) -> None:
     """Recursively move a directory overwriting the target files if they exist.
 

tests/integration/test_cookiecutter_generation.py

@@ -30,6 +30,13 @@ def test_golden(
     request: pytest.FixtureRequest,
 ) -> None:
     """Test generation of a new repo comparing it to a golden tree."""
+    env = os.environ.copy()
+    env.update(
+        # Signal to the cookiecutter template that it is running in a golden test, so
+        # some flaky outputs can be disabled.
+        GOLDEN_TEST="1",
+    )
+
     cwd = pathlib.Path().cwd()
     golden_path = (
         cwd
@@ -39,7 +46,7 @@ def test_golden(
     )
 
     generated_repo_path, run_result = _generate_repo(
-        repo_type, tmp_path, capture_output=True
+        repo_type, tmp_path, capture_output=True, env=env
     )
     stdout, stderr = _filter_generation_output(run_result)
     _assert_golden_file(golden_path, "cookiecutter-stdout", stdout)