Handle notebooks not in test rootdir (#45)

Author: MusicalNinjaDad

CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [unreleased]
 
+### Fixed
+
+- Handle notebooks not in test rootdir [#45][pr-45]
+
+[pr-45]: https://github.com/MusicalNinjaDad/pytest-ipynb2/pull/45
+
 ### Changed
 
 - Only issue warnings from cached ExampleDir on verbosity 3 [#40][pr-40]

__pyversion__

@@ -1 +1 @@
-0.3.1
+0.3.2

pytest_ipynb2/_pytester_helpers.py

@@ -5,6 +5,7 @@
 import sys
 from dataclasses import dataclass, field
 from functools import cached_property
+from pathlib import Path
 from textwrap import indent
 from typing import TYPE_CHECKING, Protocol
 from warnings import warn
@@ -14,7 +15,6 @@
 
 if TYPE_CHECKING:
     from contextlib import suppress
-    from pathlib import Path
     from types import FunctionType
     from typing import Any
 
@@ -218,6 +218,7 @@ def runresult(self) -> pytest.RunResult:
 class ExampleDirSpec:
     """The various elements to set up a pytester instance."""
 
+    path: Path = Path()  # Currently only relevant for notebooks - everything else goes in rootdir
     conftest: str = ""
     ini: str = ""
     files: list[Path] = field(default_factory=list)
@@ -253,6 +254,7 @@ def example_dir(
     """Parameterised fixture. Requires a list of `Path`s to copy into a pytester instance."""
     example = request.param
     if (cached_dir := example_dir_cache.get(example)) is None:
+        (pytester.path / example.path).mkdir(parents=True, exist_ok=True)
         if example.conftest:
             pytester.makeconftest(request.param.conftest)
 
@@ -267,7 +269,7 @@ def example_dir(
             for cellsource in contents:
                 cellnode = nbformat.v4.new_code_cell(cellsource)
                 nbnode.cells.append(cellnode)
-            nbformat.write(nb=nbnode, fp=pytester.path / f"{notebook}.ipynb")
+            nbformat.write(nb=nbnode, fp=pytester.path / example.path / f"{notebook}.ipynb")
         cached_dir = example_dir_cache[example] = ExampleDir(pytester=pytester)
     elif request.config.get_verbosity() >= 3:  # noqa: PLR2004 # pragma: no cover
         # 1st keyword is the test name (incl. any parametrized id)

pytest_ipynb2/plugin.py

@@ -11,6 +11,7 @@
 import ast
 import importlib.util
 import linecache
+import os
 import sys
 import types
 from contextlib import suppress
@@ -28,7 +29,6 @@
 from ._parser import Notebook as _ParsedNotebook
 
 if TYPE_CHECKING:
-    import os
     from collections.abc import Generator
     from os import PathLike
 
@@ -287,6 +287,6 @@ def pytest_sessionfinish(session: pytest.Session, exitstatus: int | pytest.ExitC
 def pytest_collect_file(file_path: Path, parent: pytest.Collector) -> Notebook | None:
     """Hook implementation to collect jupyter notebooks."""
     if file_path.suffix == ".ipynb":
-        nodeid = file_path.name
+        nodeid = os.fspath(file_path.relative_to(parent.config.rootpath))
         return Notebook.from_parent(parent=parent, path=file_path, nodeid=nodeid)
     return None

tests/test_execution.py

@@ -112,9 +112,6 @@ class ExpectedResults:
                     ),
                 ],
             ),
-            # marks=pytest.mark.xfail_for(
-            #     failures="Exception Repr not yet implemented",
-            # ),
             id="Failing Test",
         ),
         pytest.param(
@@ -294,6 +291,36 @@ class ExpectedResults:
             ),
             id="failing python module",
         ),
+        pytest.param(
+            ExampleDirSpec(
+                path=Path("notebooks"),
+                conftest="pytest_plugins = ['pytest_ipynb2.plugin']",
+                ini="addopts = -vv",
+                notebooks={
+                    "two_cells": [
+                        add_ipytest_magic(
+                            "\n".join(
+                                [
+                                    Path("tests/assets/test_passing.py").read_text(),
+                                    Path("tests/assets/test_failing.py").read_text(),
+                                ],
+                            ),
+                        ),
+                        add_ipytest_magic(Path("tests/assets/test_passing.py").read_text()),
+                    ],
+                },
+            ),
+            ExpectedResults(
+                outcomes={"passed": 2, "failed": 1},
+                logreport=[
+                    ("notebooks/two_cells.ipynb::Cell0::test_pass", "PASSED", 33),
+                    ("notebooks/two_cells.ipynb::Cell0::test_fails", "FAILED", 66),
+                    ("notebooks/two_cells.ipynb::Cell1::test_pass", "PASSED", 100),
+                ],
+                summary=[("FAILED", "notebooks/two_cells.ipynb::Cell0::test_fails", None, "assert 1 == 2")],
+            ),
+            id="Subdirectory verbose",
+        ),
     ],
     indirect=["example_dir"],
 )