Simplify test framework; add test_editable_conflict

Author: stefanv

.github/workflows/test.yml

@@ -29,9 +29,6 @@ jobs:
         run: |
           sudo apt-get update
           sudo apt-get install -y gdb
-      # - name: Tests Old
-      #   run: |
-      #     pipx run nox --forcecolor -s tests_old_sh
       - name: Tests PyTest
         run: |
-          pipx run nox --forcecolor -s tests_pytest
+          pipx run nox --forcecolor -s test

noxfile.py

@@ -2,18 +2,6 @@
 
 
 @nox.session
-def tests_old_sh(session: nox.Session) -> None:
-    """
-    [TBD DEPCRECATED]Run the unit and regular tests.
-    """
-    session.install(".", "pytest", "build")
-    session.run("bash", ".github/workflows/test.sh", external=True)
-
-
-@nox.session
-def tests_pytest(session: nox.Session) -> None:
-    """
-    [TBD DEPCRECATED]Run the unit and regular tests.
-    """
+def test(session: nox.Session) -> None:
     session.install(".", "pytest", "build", "meson-python", "ninja")
     session.run("pytest", "spin", *session.posargs)

spin/tests/conftest.py

@@ -1,7 +1,6 @@
 import os
 
 import pytest
-from util import PKG_NAME
 
 from spin import util
 
@@ -10,11 +9,12 @@
 def pre_post_test():
     # Pre-test code
     cwd = os.getcwd()
+    os.chdir("example_pkg")
 
     try:
         yield
-
-        # Post test code
-        util.run(["git", "clean", "-xdf"], cwd=PKG_NAME)
     finally:
+        # Post test code
+        os.chdir(cwd)
+        util.run(["git", "clean", "-xdf"], cwd="example_pkg")
         os.chdir(cwd)

spin/tests/test_build_cmds.py

@@ -1,54 +1,63 @@
+import subprocess
 from pathlib import Path
 
-from util import PKG_NAME, assert_cmd
+import spin as libspin
+from spin.cmds.util import run
 
-import spin
+
+def spin(*args):
+    return run(["spin"] + list(args), stdout=subprocess.PIPE, stderr=subprocess.PIPE)
 
 
 def stdout(p):
     return p.stdout.decode("utf-8").strip()
 
 
 def test_get_version():
-    p = assert_cmd(["spin", "--version"])
-    assert stdout(p) == f"spin {spin.__version__}"
+    p = spin("--version")
+    assert stdout(p) == f"spin {libspin.__version__}"
 
 
 def test_basic_build():
-    assert_cmd(["spin", "build"])
+    spin("build")
 
+    assert Path("build").exists(), "`build` folder not created after `spin build`"
     assert Path(
-        PKG_NAME, "build"
-    ).exists(), "`build` folder not created after `spin build`"
-    assert Path(
-        PKG_NAME, "build-install"
+        "build-install"
     ).exists(), "`build-install` folder not created after `spin build`"
 
 
 def test_debug_builds():
-    assert_cmd(["spin", "build", "--gcov"])
+    spin("build", "--gcov")
 
-    debug_files = Path(PKG_NAME).rglob("*.gcno")
+    debug_files = Path(".").rglob("*.gcno")
     assert len(list(debug_files)) != 0, "debug files not generated for gcov build"
 
 
 def test_expand_pythonpath():
-    output = assert_cmd(["spin", "run", "echo $PYTHONPATH"])
+    output = spin("run", "echo $PYTHONPATH")
     assert any(
         p in stdout(output) for p in ("site-packages", "dist-packages")
     ), f"Expected value of $PYTHONPATH, got {stdout(output)} instead"
 
 
 def test_run_stdout():
-    p = assert_cmd(
-        [
-            "spin",
-            "run",
-            "python",
-            "-c",
-            "import sys; del sys.path[0]; import example_pkg; print(example_pkg.__version__)",
-        ]
+    p = spin(
+        "run",
+        "python",
+        "-c",
+        "import sys; del sys.path[0]; import example_pkg; print(example_pkg.__version__)",
     )
     assert (
         stdout(p) == "0.0.0dev0"
     ), f"`spin run` stdout did not yield version, but {stdout(p)}"
+
+
+def test_editable_conflict():
+    try:
+        run(["pip", "install", "--quiet", "-e", "."])
+        assert "Warning! An editable installation" in stdout(
+            spin("run", "ls")
+        ), "Failed to detect and warn about editable install"
+    finally:
+        run(["pip", "uninstall", "--quiet", "-y", "example_pkg"])