pl-e2e-test 0.1.0__tar.gz → 0.1.1__tar.gz

{pl_e2e_test-0.1.0/src/pl_e2e_test.egg-info → pl_e2e_test-0.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pl-e2e-test
-Version: 0.1.0
+Version: 0.1.1
 Summary: Fuzz PrairieLearn question lifecycles against the real Python element runtime
 License-Expression: MIT
 Project-URL: Homepage, https://github.com/PrairieLearn/pl-e2e-test
@@ -227,10 +227,23 @@ uv run pl-e2e-test-diff \
   --seed-count 10
 ```
 
-Optional repository-relative ignore rules live in `.question-e2e.diffignore` and use
-Git's native ignore syntax. Missing default configuration means that no paths are
-ignored. Pass `--e2ediffignore PATH` to require and use another file. Additional
-arguments are forwarded to pytest.
+Configure optional repository-relative ignore rules in the course's `pyproject.toml`:
+
+```toml
+[tool.pl-e2e-test]
+diffignore = [
+  ".github",
+  "README.md",
+  "*lock.yaml",
+]
+```
+
+Rules use Git's native ignore syntax and are evaluated in order, so later rules may
+negate earlier ones with `!`. A missing `pyproject.toml`, tool table, or `diffignore`
+entry means that no paths are ignored. Additional arguments are forwarded to pytest.
+
+To migrate from `.question-e2e.diffignore`, copy its non-comment rules into the
+`diffignore` array. The former file and `--e2ediffignore` option are no longer used.
 
 In pull-request CI, fetch the base commit before running the command and pass the
 appropriate base and head SHAs. Set `--fuzz-seed` to replay a reported run.

{pl_e2e_test-0.1.0 → pl_e2e_test-0.1.1}/README.md

@@ -204,10 +204,23 @@ uv run pl-e2e-test-diff \
   --seed-count 10
 ```
 
-Optional repository-relative ignore rules live in `.question-e2e.diffignore` and use
-Git's native ignore syntax. Missing default configuration means that no paths are
-ignored. Pass `--e2ediffignore PATH` to require and use another file. Additional
-arguments are forwarded to pytest.
+Configure optional repository-relative ignore rules in the course's `pyproject.toml`:
+
+```toml
+[tool.pl-e2e-test]
+diffignore = [
+  ".github",
+  "README.md",
+  "*lock.yaml",
+]
+```
+
+Rules use Git's native ignore syntax and are evaluated in order, so later rules may
+negate earlier ones with `!`. A missing `pyproject.toml`, tool table, or `diffignore`
+entry means that no paths are ignored. Additional arguments are forwarded to pytest.
+
+To migrate from `.question-e2e.diffignore`, copy its non-comment rules into the
+`diffignore` array. The former file and `--e2ediffignore` option are no longer used.
 
 In pull-request CI, fetch the base commit before running the command and pass the
 appropriate base and head SHAs. Set `--fuzz-seed` to replay a reported run.

{pl_e2e_test-0.1.0 → pl_e2e_test-0.1.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pl-e2e-test"
-version = "0.1.0"
+version = "0.1.1"
 description = "Fuzz PrairieLearn question lifecycles against the real Python element runtime"
 readme = "README.md"
 requires-python = ">=3.13"

{pl_e2e_test-0.1.0 → pl_e2e_test-0.1.1/src/pl_e2e_test.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pl-e2e-test
-Version: 0.1.0
+Version: 0.1.1
 Summary: Fuzz PrairieLearn question lifecycles against the real Python element runtime
 License-Expression: MIT
 Project-URL: Homepage, https://github.com/PrairieLearn/pl-e2e-test
@@ -227,10 +227,23 @@ uv run pl-e2e-test-diff \
   --seed-count 10
 ```
 
-Optional repository-relative ignore rules live in `.question-e2e.diffignore` and use
-Git's native ignore syntax. Missing default configuration means that no paths are
-ignored. Pass `--e2ediffignore PATH` to require and use another file. Additional
-arguments are forwarded to pytest.
+Configure optional repository-relative ignore rules in the course's `pyproject.toml`:
+
+```toml
+[tool.pl-e2e-test]
+diffignore = [
+  ".github",
+  "README.md",
+  "*lock.yaml",
+]
+```
+
+Rules use Git's native ignore syntax and are evaluated in order, so later rules may
+negate earlier ones with `!`. A missing `pyproject.toml`, tool table, or `diffignore`
+entry means that no paths are ignored. Additional arguments are forwarded to pytest.
+
+To migrate from `.question-e2e.diffignore`, copy its non-comment rules into the
+`diffignore` array. The former file and `--e2ediffignore` option are no longer used.
 
 In pull-request CI, fetch the base commit before running the command and pass the
 appropriate base and head SHAs. Set `--fuzz-seed` to replay a reported run.

{pl_e2e_test-0.1.0 → pl_e2e_test-0.1.1}/src/prairielearn_e2e/fuzz.py

@@ -7,6 +7,7 @@ import os
 import secrets
 import shlex
 import subprocess
+import tomllib
 from collections.abc import Sequence
 from pathlib import Path
 from tempfile import TemporaryDirectory
@@ -17,7 +18,7 @@ from .runner import run_tests
 from .sharding import Shard, parse_shard
 
 QUESTIONS_ROOT = Path("questions")
-DEFAULT_E2E_DIFF_IGNORE = Path(".question-e2e.diffignore")
+PYPROJECT_CONFIG = Path("pyproject.toml")
 
 
 def git_repository_root(start: Path) -> Path:
@@ -32,18 +33,37 @@ def git_repository_root(start: Path) -> Path:
     return Path(result.stdout.strip()).resolve()
 
 
-def load_e2e_diff_ignore(config_path: Path, *, missing_ok: bool = False) -> list[str]:
-    """Load Git-style ignore rules used by E2E change detection."""
+def load_e2e_diff_ignore(config_path: Path) -> list[str]:
+    """Load Git-style ignore rules from a course's pyproject.toml."""
 
     try:
-        return config_path.read_text(encoding="utf-8").splitlines()
+        with config_path.open("rb") as config_file:
+            config = tomllib.load(config_file)
     except FileNotFoundError:
-        if missing_ok:
-            return []
-        raise ValueError(f"Unable to read {config_path}: file does not exist") from None
+        return []
+    except tomllib.TOMLDecodeError as exc:
+        raise ValueError(f"Unable to read {config_path}: invalid TOML: {exc}") from exc
     except OSError as exc:
         raise ValueError(f"Unable to read {config_path}: {exc}") from exc
 
+    tool_config = config.get("tool", {})
+    if not isinstance(tool_config, dict):
+        raise TypeError(f"Invalid configuration in {config_path}: tool must be a table")
+    e2e_config = tool_config.get("pl-e2e-test", {})
+    if not isinstance(e2e_config, dict):
+        raise TypeError(
+            f"Invalid configuration in {config_path}: tool.pl-e2e-test must be a table"
+        )
+    ignore_rules = e2e_config.get("diffignore", [])
+    if not isinstance(ignore_rules, list) or not all(
+        isinstance(rule, str) for rule in ignore_rules
+    ):
+        raise TypeError(
+            f"Invalid configuration in {config_path}: "
+            "tool.pl-e2e-test.diffignore must be an array of strings"
+        )
+    return ignore_rules
+
 
 def e2e_diff_ignored_files(
     changed_files: Sequence[Path], ignore_rules: Sequence[str]
@@ -195,8 +215,7 @@ def main(argv: Sequence[str] | None = None) -> int:
     )
     parser.add_argument(
         "--e2ediffignore",
-        type=Path,
-        help="E2E change-detection ignore file (default: COURSE_ROOT/.question-e2e.diffignore)",
+        help=argparse.SUPPRESS,
     )
     parser.add_argument(
         "--shard",
@@ -211,6 +230,11 @@ def main(argv: Sequence[str] | None = None) -> int:
         help="write a mergeable JSON result blob for this shard",
     )
     args, pytest_args = parser.parse_known_args(argv)
+    if args.e2ediffignore is not None:
+        parser.error(
+            "--e2ediffignore has been removed; configure "
+            "tool.pl-e2e-test.diffignore in COURSE_ROOT/pyproject.toml"
+        )
     shard: Shard | None = args.shard
     if args.shard_report is not None and shard is None:
         parser.error("--shard-report requires --shard")
@@ -226,17 +250,9 @@ def main(argv: Sequence[str] | None = None) -> int:
     except (OSError, subprocess.CalledProcessError) as exc:
         parser.error(f"could not find the course Git repository: {exc}")
 
-    ignore_path = args.e2ediffignore
-    if ignore_path is None:
-        ignore_path = repository_root / DEFAULT_E2E_DIFF_IGNORE
-        missing_ok = True
-    else:
-        if not ignore_path.is_absolute():
-            ignore_path = repository_root / ignore_path
-        missing_ok = False
     try:
-        ignored_patterns = load_e2e_diff_ignore(ignore_path, missing_ok=missing_ok)
-    except ValueError as exc:
+        ignored_patterns = load_e2e_diff_ignore(repository_root / PYPROJECT_CONFIG)
+    except (TypeError, ValueError) as exc:
         parser.error(str(exc))
 
     changed_files = changed_files_between(args.base, args.head, repository_root)

{pl_e2e_test-0.1.0 → pl_e2e_test-0.1.1}/tests/test_fuzz.py

@@ -65,14 +65,83 @@ def test_root_anchored_gitignore_pattern() -> None:
     ) == {Path("README.md")}
 
 
-def test_missing_default_ignore_file_is_empty(tmp_path: Path) -> None:
-    assert (
-        fuzz.load_e2e_diff_ignore(
-            tmp_path / ".question-e2e.diffignore", missing_ok=True
-        )
-        == []
+def test_later_gitignore_pattern_can_negate_earlier_pattern() -> None:
+    assert fuzz.e2e_diff_ignored_files(
+        [Path("uv.lock"), Path("required.lock")], ["*.lock", "!required.lock"]
+    ) == {Path("uv.lock")}
+
+
+def test_loads_diff_ignore_from_pyproject(tmp_path: Path) -> None:
+    config_path = tmp_path / "pyproject.toml"
+    config_path.write_text(
+        """
+[tool.pl-e2e-test]
+diffignore = ["/README.md", "*.lock", "!required.lock"]
+""",
+        encoding="utf-8",
     )
 
+    assert fuzz.load_e2e_diff_ignore(config_path) == [
+        "/README.md",
+        "*.lock",
+        "!required.lock",
+    ]
+
+
+@pytest.mark.parametrize(
+    "contents",
+    [
+        "",
+        "[tool.pytest.ini_options]\n",
+        "[tool.pl-e2e-test]\n",
+        "[tool.pl-e2e-test]\ndiffignore = []\n",
+    ],
+)
+def test_missing_or_empty_diff_ignore_configuration_is_empty(
+    tmp_path: Path, contents: str
+) -> None:
+    config_path = tmp_path / "pyproject.toml"
+    config_path.write_text(contents, encoding="utf-8")
+
+    assert fuzz.load_e2e_diff_ignore(config_path) == []
+
+
+def test_missing_pyproject_is_empty(tmp_path: Path) -> None:
+    assert fuzz.load_e2e_diff_ignore(tmp_path / "pyproject.toml") == []
+
+
+def test_invalid_pyproject_is_rejected(tmp_path: Path) -> None:
+    config_path = tmp_path / "pyproject.toml"
+    config_path.write_text("[tool.pl-e2e-test\n", encoding="utf-8")
+
+    with pytest.raises(ValueError, match="invalid TOML"):
+        fuzz.load_e2e_diff_ignore(config_path)
+
+
+def test_unreadable_pyproject_is_rejected(tmp_path: Path) -> None:
+    config_path = tmp_path / "pyproject.toml"
+    config_path.mkdir()
+
+    with pytest.raises(ValueError, match="Unable to read"):
+        fuzz.load_e2e_diff_ignore(config_path)
+
+
+@pytest.mark.parametrize(
+    "configured_value",
+    ['"README.md"', '["README.md", 1]'],
+)
+def test_diff_ignore_must_be_an_array_of_strings(
+    tmp_path: Path, configured_value: str
+) -> None:
+    config_path = tmp_path / "pyproject.toml"
+    config_path.write_text(
+        f"[tool.pl-e2e-test]\ndiffignore = {configured_value}\n",
+        encoding="utf-8",
+    )
+
+    with pytest.raises(TypeError, match="must be an array of strings"):
+        fuzz.load_e2e_diff_ignore(config_path)
+
 
 def test_main_forwards_selected_questions_and_seed(
     monkeypatch: pytest.MonkeyPatch,
@@ -82,11 +151,16 @@ def test_main_forwards_selected_questions_and_seed(
     question = tmp_path / "questions" / "chapter" / "example"
     question.mkdir(parents=True)
     (question / "info.json").write_text("{}", encoding="utf-8")
+    (tmp_path / "pyproject.toml").write_text(
+        '[tool.pl-e2e-test]\ndiffignore = ["README.md"]\n',
+        encoding="utf-8",
+    )
     monkeypatch.setattr(
         fuzz,
         "changed_files_between",
         lambda base, head, repository_root: [
-            Path("questions/chapter/example/server.py")
+            Path("README.md"),
+            Path("questions/chapter/example/server.py"),
         ],
     )
     calls: list[tuple[list[str], Path]] = []
@@ -131,6 +205,28 @@ def test_main_forwards_selected_questions_and_seed(
     assert "E2E fuzz seed: 12345" in capsys.readouterr().out
 
 
+def test_main_reports_invalid_pyproject(
+    tmp_path: Path, capsys: pytest.CaptureFixture[str]
+) -> None:
+    (tmp_path / "pyproject.toml").write_text("[tool.pl-e2e-test\n", encoding="utf-8")
+
+    with pytest.raises(SystemExit, match="2"):
+        fuzz.main(["--course-root", str(tmp_path)])
+
+    assert "invalid TOML" in capsys.readouterr().err
+
+
+def test_removed_diff_ignore_option_reports_migration(
+    capsys: pytest.CaptureFixture[str],
+) -> None:
+    with pytest.raises(SystemExit, match="2"):
+        fuzz.main(["--e2ediffignore", ".question-e2e.diffignore"])
+
+    error = capsys.readouterr().err
+    assert "--e2ediffignore has been removed" in error
+    assert "tool.pl-e2e-test.diffignore" in error
+
+
 def test_main_uses_managed_cache_when_prairielearn_path_is_omitted(
     monkeypatch: pytest.MonkeyPatch,
     tmp_path: Path,