Fix testing for editable and non-editable installs alike (#213)

stefanv · web-flow · commit 7e0c6b3cae56 · 2024-06-28T10:13:26.000-07:00
Closes #209 #203 #204 #208
diff --git a/example_pkg/example_pkg/conftest.py b/example_pkg/example_pkg/conftest.py
diff --git a/example_pkg/example_pkg/meson.build b/example_pkg/example_pkg/meson.build
@@ -6,12 +6,14 @@ py.extension_module(
 )
 
 python_sources = [
-  '__init__.py'
+  '__init__.py',
+  'conftest.py'
 ]
 
 py.install_sources(
   python_sources,
   subdir: 'example_pkg'
 )
 
-install_subdir('tests', install_dir: py.get_install_dir() / 'example_pkg/tests')
+install_subdir('submodule', install_dir: py.get_install_dir() / 'example_pkg')
+install_subdir('tests', install_dir: py.get_install_dir() / 'example_pkg')
diff --git a/example_pkg/example_pkg/submodule/__init__.py b/example_pkg/example_pkg/submodule/__init__.py
diff --git a/example_pkg/example_pkg/submodule/meson.build b/example_pkg/example_pkg/submodule/meson.build
@@ -0,0 +1 @@
+install_subdir('tests', install_dir: py.get_install_dir() / 'example_pkg/submodule')
diff --git a/example_pkg/example_pkg/submodule/tests/__init__.py b/example_pkg/example_pkg/submodule/tests/__init__.py
diff --git a/example_pkg/example_pkg/submodule/tests/test_submodule.py b/example_pkg/example_pkg/submodule/tests/test_submodule.py
@@ -0,0 +1,2 @@
+def test_something():
+    pass
diff --git a/example_pkg/example_pkg/tests/__init__.py b/example_pkg/example_pkg/tests/__init__.py
diff --git a/example_pkg/meson.build b/example_pkg/meson.build
@@ -3,7 +3,7 @@ project(
   'c',
   version: '0.0.dev0',
   license: 'BSD-3',
-  meson_version: '>= 0.61.0',
+  meson_version: '>= 0.64',
   default_options: [
     'buildtype=debugoptimized',
     'c_std=c99',
diff --git a/spin/cmds/__init__.py b/spin/cmds/__init__.py
@@ -1,8 +1,3 @@
-from . import meson
+__all__ = ["meson"]
 
-# Backward compatibility with older versions
-build = meson.build
-test = meson.test
-ipython = meson.ipython
-python = meson.python
-shell = meson.shell
+from . import meson
diff --git a/spin/cmds/meson.py b/spin/cmds/meson.py
@@ -428,8 +428,35 @@ def test(
     """  # noqa: E501
     cfg = get_config()
     distname = cfg.get("project.name", None)
+    pytest_args = pytest_args or ()
 
-    if gcov and distname and _is_editable_install_of_same_source(distname):
+    # User specified tests without -t flag
+    # Rewrite arguments as though they specified using -t and proceed
+    if (len(pytest_args) == 1) and (not tests):
+        tests = pytest_args[0]
+        pytest_args = ()
+
+    package = cfg.get("tool.spin.package", None)
+    if package is None:
+        print(
+            "Please specify `package = packagename` under `tool.spin` section of `pyproject.toml`"
+        )
+        raise SystemExit(1)
+
+    # User did not specify what to test, so we test
+    # the full package
+    if not (pytest_args or tests):
+        pytest_args = ("--pyargs", package)
+    elif tests:
+        if (os.path.sep in tests) or ("/" in tests):
+            # Tests specified as file path
+            pytest_args = pytest_args + (tests,)
+        else:
+            # Otherwise tests given as modules
+            pytest_args = pytest_args + ("--pyargs", tests)
+
+    is_editable_install = distname and _is_editable_install_of_same_source(distname)
+    if gcov and is_editable_install:
         click.secho(
             "Error: cannot generate coverage report for editable installs",
             fg="bright_red",
@@ -446,16 +473,6 @@ def test(
         else:
             ctx.invoke(build_cmd)
 
-    package = cfg.get("tool.spin.package", None)
-    if package is None:
-        print(
-            "Please specify `package = packagename` under `tool.spin` section of `pyproject.toml`"
-        )
-        raise SystemExit(1)
-
-    if (not pytest_args) and (not tests):
-        tests = package
-
     site_path = _set_pythonpath()
     if site_path:
         print(f'$ export PYTHONPATH="{site_path}"')
@@ -479,8 +496,8 @@ def test(
     if (n_jobs != "1") and ("-n" not in pytest_args):
         pytest_args = ("-n", str(n_jobs)) + pytest_args
 
-    if tests and "--pyargs" not in pytest_args:
-        pytest_args = ("--pyargs", tests) + pytest_args
+    if not any("--import-mode" in arg for arg in pytest_args):
+        pytest_args = ("--import-mode=importlib",) + pytest_args
 
     if verbose:
         pytest_args = ("-v",) + pytest_args
@@ -503,9 +520,12 @@ def test(
     else:
         cmd = ["pytest"]
 
-    pytest_p = _run(
-        cmd + list(pytest_args),
-    )
+    if not os.path.exists(install_dir):
+        os.mkdir(install_dir)
+
+    cwd = os.getcwd()
+    pytest_p = _run(cmd + list(pytest_args), cwd=site_path)
+    os.chdir(cwd)
 
     if gcov:
         # Verify the tools are present
diff --git a/spin/cmds/util.py b/spin/cmds/util.py
@@ -41,6 +41,10 @@ def run(
 
     Other arguments and keywords are passed directly to `subprocess.run`.
 
+
+    Returns
+    -------
+    p : CompletedProcess
     """
     if cwd:
         if echo:
diff --git a/spin/tests/conftest.py b/spin/tests/conftest.py
@@ -18,3 +18,10 @@ def pre_post_test():
         os.chdir(cwd)
         util.run(["git", "clean", "-xdf"], cwd="example_pkg")
         os.chdir(cwd)
+
+
+@pytest.fixture
+def editable_install():
+    util.run(["pip", "install", "--quiet", "--no-build-isolation", "-e", "."])
+    yield
+    util.run(["pip", "uninstall", "--quiet", "-y", "example_pkg"])
diff --git a/spin/tests/test_build_cmds.py b/spin/tests/test_build_cmds.py
@@ -88,16 +88,6 @@ def test_recommend_run_python():
         ), "Failed to recommend `python run python file.py`"
 
 
-def test_test():
-    """Does the test command run?"""
-    spin("test")
-
-
-def test_test_with_pythonpath():
-    """Does `spin test` work when PYTHONPATH is set?"""
-    spin("test", env={**os.environ, "PYTHONPATH": "/tmp"})
-
-
 def test_sdist():
     spin("sdist")
 
diff --git a/spin/tests/test_editable.py b/spin/tests/test_editable.py
@@ -1,15 +1,5 @@
-import pytest
 from testutil import spin, stdout
 
-from spin.cmds.util import run
-
-
-@pytest.fixture
-def editable_install():
-    run(["pip", "install", "--quiet", "--no-build-isolation", "-e", "."])
-    yield
-    run(["pip", "uninstall", "--quiet", "-y", "example_pkg"])
-
 
 def test_detect_editable(editable_install):
     assert "Editable install of same source detected" in stdout(
diff --git a/spin/tests/test_test.py b/spin/tests/test_test.py
@@ -0,0 +1,29 @@
+import os
+
+from testutil import spin
+
+
+def test_test():
+    """Does the test command run?"""
+    spin("test")
+
+
+def test_test_with_pythonpath():
+    """Does `spin test` work when PYTHONPATH is set?"""
+    spin("test", env={**os.environ, "PYTHONPATH": "/tmp"})
+
+
+def test_test_file_spec():
+    spin("test", "example_pkg/submodule/tests/test_submodule.py")
+
+
+def test_test_module_spec():
+    spin("test", "example_pkg.submodule")
+
+
+def test_test_editable_file_spec(editable_install):
+    spin("test", "example_pkg/submodule/tests/test_submodule.py")
+
+
+def test_test_editable_module_spec(editable_install):
+    spin("test", "example_pkg.submodule")

Original file line number	Diff line number	Diff line change
`@@ -6,12 +6,14 @@ py.extension_module(`
`6`	`6`	`)`
`7`	`7`
`8`	`8`	`python_sources = [`
`9`		`- '__init__.py'`
	`9`	`+ '__init__.py',`
	`10`	`+ 'conftest.py'`
`10`	`11`	`]`
`11`	`12`
`12`	`13`	`py.install_sources(`
`13`	`14`	`python_sources,`
`14`	`15`	`subdir: 'example_pkg'`
`15`	`16`	`)`
`16`	`17`
`17`		`-install_subdir('tests', install_dir: py.get_install_dir() / 'example_pkg/tests')`
	`18`	`+install_subdir('submodule', install_dir: py.get_install_dir() / 'example_pkg')`
	`19`	`+install_subdir('tests', install_dir: py.get_install_dir() / 'example_pkg')`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+install_subdir('tests', install_dir: py.get_install_dir() / 'example_pkg/submodule')`