move sanity-checks from the pytest into the post-generation hook (workaround)

Author: a.pirogov

src/fair_python_cookiecutter/template/hooks/post_gen_project.sh

@@ -27,7 +27,15 @@ rm tests/test_api.py
 # finalize repo setup
 git init
 
-poetry install --with docs
+# make sure we are not in some venv (or poetry would just use that!)
+if pip -V | grep poetry; then
+    env=$(pip -V | awk '{print $4}' | sed 's/\/lib\/.*//')
+    echo WARNING: deactivating currently active virtual environment "$env"
+    source "$env/bin/activate"
+    deactivate
+fi
+
+poetry install --with docs  # install everything into a new venv
 poetry run poe init-dev  # init git repo + register pre-commit
 poetry run pip install pipx  # install pipx into venv without adding it as dep
 poetry run pipx run reuse download --all  # get license files for REUSE compliance
@@ -49,3 +57,9 @@ poetry run git commit \
 
 # make sure that the default branch is called 'main'
 git branch -M main
+
+# sanity-check that main tasks all work
+poetry install --with docs 
+poetry run poe lint --all-files
+poetry run poe test
+poetry run poe docs

tests/test_main.py

@@ -1,46 +1,9 @@
 import subprocess
 import sys
 
-from fair_python_cookiecutter.main import create_repository, CookiecutterConfig
-from fair_python_cookiecutter.utils import TempDir
-
-
-def sanity_check_project(proj_path):
-    """Sanity-check a generated project (linters, tests, doc generation)."""
-    try:
-        subprocess.check_output(
-            "poetry install --with docs".split(), cwd=proj_path, stderr=subprocess.PIPE
-        )
-        subprocess.check_output(
-            "poetry run poe lint --all-files".split(),
-            cwd=proj_path,
-            stderr=subprocess.PIPE,
-        )
-        subprocess.check_output(
-            "poetry run poe test".split(), cwd=proj_path, stderr=subprocess.PIPE
-        )
-        subprocess.check_output(
-            "poetry run poe docs".split(), cwd=proj_path, stderr=subprocess.PIPE
-        )
-    except subprocess.CalledProcessError as e:
-        print("exit code: {}".format(e.returncode))
-        print("stderr: {}".format(e.stderr.decode(sys.getfilesystemencoding())))
+import pytest
 
-
-# def test_defaults(tmp_path):
-#     # generate with default values
-#     conf = CookiecutterConfig()
-#     dir = create_repository(conf, tmp_path)
-#     sanity_check_project(dir)
-
-#     # should NOT have the code files
-#     assert not (dir / f"src/{DEMO_PROJ_SLUG}api.py").is_file()
-#     assert not (dir / f"src/{DEMO_PROJ_SLUG}/cli.py").is_file()
-#     assert not (dir / "tests/test_api.py").is_file()
-#     assert not (dir / "tests/test_cli.py").is_file()
-#     # and the expected license (MIT)
-#     first_license_line = open(dir / "LICENSE", "r").readline()
-#     assert first_license_line.find("MIT") >= 0
+from fair_python_cookiecutter.main import create_repository, CookiecutterConfig
 
 
 def test_configured(tmp_path):
@@ -51,7 +14,6 @@ def test_configured(tmp_path):
     )
     DEMO_PROJ_PKG = "my_project"
     dir = create_repository(conf, tmp_path)
-    sanity_check_project(dir)
 
     # should have the code files
     assert (dir / f"src/{DEMO_PROJ_PKG}/api.py").is_file()