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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pl-e2e-test
-Version: 0.1.1
+Version: 0.1.2
 Summary: Fuzz PrairieLearn question lifecycles against the real Python element runtime
 License-Expression: MIT
 Project-URL: Homepage, https://github.com/PrairieLearn/pl-e2e-test
@@ -28,12 +28,16 @@ generate, prepare, render, parse, grade, test, and file phases. It was extracted
 from the `pl-oer-lv102` course so that courses can install one uv-managed tool
 instead of copying the harness and its support scripts.
 
-The package installs the reusable `prairielearn_e2e` Python API and these commands:
+The package installs the reusable `prairielearn_e2e` Python API and a single
+`pl-e2e-test` command:
 
-- `pl-e2e-test` runs the installed lifecycle pytest suite.
-- `pl-e2e-test-diff` fuzzes questions selected from a Git diff.
-- `pl-e2e-add-regression-seed` records a failing concrete variant seed.
-- `pl-e2e-merge-reports` merges parallel shard results into terminal and JUnit reports.
+- `pl-e2e-test` (no command, or any pytest/harness options) runs the installed
+  lifecycle pytest suite.
+- `pl-e2e-test diff` fuzzes questions selected from a Git diff.
+- `pl-e2e-test add-seed` records a failing concrete variant seed.
+- `pl-e2e-test reports` merges parallel shard results into terminal and JUnit reports.
+- `pl-e2e-test version` prints the installed version.
+- `pl-e2e-test help [COMMAND]` prints top-level help, or one command's help.
 
 ## Requirements and installation
 
@@ -105,7 +109,7 @@ same checkout and arguments. Sharded fuzz runs must also use one explicit shared
 merge them into a combined terminal summary and JUnit report:
 
 ```sh
-uv run pl-e2e-merge-reports e2e-reports \
+uv run pl-e2e-test reports e2e-reports \
   --junitxml pl-e2e-results.xml
 ```
 
@@ -161,7 +165,7 @@ jobs:
           merge-multiple: true
       - name: Merge reports
         run: |
-          uv run pl-e2e-merge-reports e2e-reports \
+          uv run pl-e2e-test reports e2e-reports \
             --junitxml pl-e2e-results.xml
       - name: Upload merged JUnit report
         if: ${{ always() }}
@@ -208,7 +212,7 @@ questions automatically skip only the grade check.
 Record the concrete seed shown in a failing pytest case with:
 
 ```sh
-uv run pl-e2e-add-regression-seed \
+uv run pl-e2e-test add-seed \
   questions/chapter/example 1843927501
 ```
 
@@ -221,7 +225,7 @@ The diff runner tests changed question directories. A non-ignored changed file o
 `questions/` selects every question:
 
 ```sh
-uv run pl-e2e-test-diff \
+uv run pl-e2e-test diff \
   --base origin/main \
   --head HEAD \
   --seed-count 10
@@ -247,7 +251,7 @@ To migrate from `.question-e2e.diffignore`, copy its non-comment rules into the
 
 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-diff` accepts the same `--shard` and `--shard-report` options. If a diff
+`pl-e2e-test diff` accepts the same `--shard` and `--shard-report` options. If a diff
 selects no questions, it writes a successful empty shard report so the merge job can
 still verify that every matrix job completed.
 

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

@@ -5,12 +5,16 @@ generate, prepare, render, parse, grade, test, and file phases. It was extracted
 from the `pl-oer-lv102` course so that courses can install one uv-managed tool
 instead of copying the harness and its support scripts.
 
-The package installs the reusable `prairielearn_e2e` Python API and these commands:
+The package installs the reusable `prairielearn_e2e` Python API and a single
+`pl-e2e-test` command:
 
-- `pl-e2e-test` runs the installed lifecycle pytest suite.
-- `pl-e2e-test-diff` fuzzes questions selected from a Git diff.
-- `pl-e2e-add-regression-seed` records a failing concrete variant seed.
-- `pl-e2e-merge-reports` merges parallel shard results into terminal and JUnit reports.
+- `pl-e2e-test` (no command, or any pytest/harness options) runs the installed
+  lifecycle pytest suite.
+- `pl-e2e-test diff` fuzzes questions selected from a Git diff.
+- `pl-e2e-test add-seed` records a failing concrete variant seed.
+- `pl-e2e-test reports` merges parallel shard results into terminal and JUnit reports.
+- `pl-e2e-test version` prints the installed version.
+- `pl-e2e-test help [COMMAND]` prints top-level help, or one command's help.
 
 ## Requirements and installation
 
@@ -82,7 +86,7 @@ same checkout and arguments. Sharded fuzz runs must also use one explicit shared
 merge them into a combined terminal summary and JUnit report:
 
 ```sh
-uv run pl-e2e-merge-reports e2e-reports \
+uv run pl-e2e-test reports e2e-reports \
   --junitxml pl-e2e-results.xml
 ```
 
@@ -138,7 +142,7 @@ jobs:
           merge-multiple: true
       - name: Merge reports
         run: |
-          uv run pl-e2e-merge-reports e2e-reports \
+          uv run pl-e2e-test reports e2e-reports \
             --junitxml pl-e2e-results.xml
       - name: Upload merged JUnit report
         if: ${{ always() }}
@@ -185,7 +189,7 @@ questions automatically skip only the grade check.
 Record the concrete seed shown in a failing pytest case with:
 
 ```sh
-uv run pl-e2e-add-regression-seed \
+uv run pl-e2e-test add-seed \
   questions/chapter/example 1843927501
 ```
 
@@ -198,7 +202,7 @@ The diff runner tests changed question directories. A non-ignored changed file o
 `questions/` selects every question:
 
 ```sh
-uv run pl-e2e-test-diff \
+uv run pl-e2e-test diff \
   --base origin/main \
   --head HEAD \
   --seed-count 10
@@ -224,7 +228,7 @@ To migrate from `.question-e2e.diffignore`, copy its non-comment rules into the
 
 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-diff` accepts the same `--shard` and `--shard-report` options. If a diff
+`pl-e2e-test diff` accepts the same `--shard` and `--shard-report` options. If a diff
 selects no questions, it writes a successful empty shard report so the merge job can
 still verify that every matrix job completed.
 

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

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pl-e2e-test"
-version = "0.1.1"
+version = "0.1.2"
 description = "Fuzz PrairieLearn question lifecycles against the real Python element runtime"
 readme = "README.md"
 requires-python = ">=3.13"
@@ -31,10 +31,7 @@ Issues = "https://github.com/PrairieLearn/pl-e2e-test/issues"
 Repository = "https://github.com/PrairieLearn/pl-e2e-test"
 
 [project.scripts]
-pl-e2e-test = "prairielearn_e2e.runner:main"
-pl-e2e-test-diff = "prairielearn_e2e.fuzz:main"
-pl-e2e-add-regression-seed = "prairielearn_e2e.regression:main"
-pl-e2e-merge-reports = "prairielearn_e2e.reporting:main"
+pl-e2e-test = "prairielearn_e2e.cli:main"
 
 [tool.setuptools.packages.find]
 where = ["src"]

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pl-e2e-test
-Version: 0.1.1
+Version: 0.1.2
 Summary: Fuzz PrairieLearn question lifecycles against the real Python element runtime
 License-Expression: MIT
 Project-URL: Homepage, https://github.com/PrairieLearn/pl-e2e-test
@@ -28,12 +28,16 @@ generate, prepare, render, parse, grade, test, and file phases. It was extracted
 from the `pl-oer-lv102` course so that courses can install one uv-managed tool
 instead of copying the harness and its support scripts.
 
-The package installs the reusable `prairielearn_e2e` Python API and these commands:
+The package installs the reusable `prairielearn_e2e` Python API and a single
+`pl-e2e-test` command:
 
-- `pl-e2e-test` runs the installed lifecycle pytest suite.
-- `pl-e2e-test-diff` fuzzes questions selected from a Git diff.
-- `pl-e2e-add-regression-seed` records a failing concrete variant seed.
-- `pl-e2e-merge-reports` merges parallel shard results into terminal and JUnit reports.
+- `pl-e2e-test` (no command, or any pytest/harness options) runs the installed
+  lifecycle pytest suite.
+- `pl-e2e-test diff` fuzzes questions selected from a Git diff.
+- `pl-e2e-test add-seed` records a failing concrete variant seed.
+- `pl-e2e-test reports` merges parallel shard results into terminal and JUnit reports.
+- `pl-e2e-test version` prints the installed version.
+- `pl-e2e-test help [COMMAND]` prints top-level help, or one command's help.
 
 ## Requirements and installation
 
@@ -105,7 +109,7 @@ same checkout and arguments. Sharded fuzz runs must also use one explicit shared
 merge them into a combined terminal summary and JUnit report:
 
 ```sh
-uv run pl-e2e-merge-reports e2e-reports \
+uv run pl-e2e-test reports e2e-reports \
   --junitxml pl-e2e-results.xml
 ```
 
@@ -161,7 +165,7 @@ jobs:
           merge-multiple: true
       - name: Merge reports
         run: |
-          uv run pl-e2e-merge-reports e2e-reports \
+          uv run pl-e2e-test reports e2e-reports \
             --junitxml pl-e2e-results.xml
       - name: Upload merged JUnit report
         if: ${{ always() }}
@@ -208,7 +212,7 @@ questions automatically skip only the grade check.
 Record the concrete seed shown in a failing pytest case with:
 
 ```sh
-uv run pl-e2e-add-regression-seed \
+uv run pl-e2e-test add-seed \
   questions/chapter/example 1843927501
 ```
 
@@ -221,7 +225,7 @@ The diff runner tests changed question directories. A non-ignored changed file o
 `questions/` selects every question:
 
 ```sh
-uv run pl-e2e-test-diff \
+uv run pl-e2e-test diff \
   --base origin/main \
   --head HEAD \
   --seed-count 10
@@ -247,7 +251,7 @@ To migrate from `.question-e2e.diffignore`, copy its non-comment rules into the
 
 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-diff` accepts the same `--shard` and `--shard-report` options. If a diff
+`pl-e2e-test diff` accepts the same `--shard` and `--shard-report` options. If a diff
 selects no questions, it writes a successful empty shard report so the merge job can
 still verify that every matrix job completed.
 

{pl_e2e_test-0.1.1 → pl_e2e_test-0.1.2}/src/pl_e2e_test.egg-info/SOURCES.txt

@@ -12,6 +12,7 @@ src/prairielearn_e2e/__init__.py
 src/prairielearn_e2e/__main__.py
 src/prairielearn_e2e/_git.py
 src/prairielearn_e2e/backend.py
+src/prairielearn_e2e/cli.py
 src/prairielearn_e2e/config.json
 src/prairielearn_e2e/config.py
 src/prairielearn_e2e/contract.py
@@ -32,6 +33,7 @@ src/prairielearn_e2e/sharding.py
 tests/__init__.py
 tests/conftest.py
 tests/stub_git.py
+tests/test_cli.py
 tests/test_contract.py
 tests/test_discovery.py
 tests/test_fuzz.py

pl_e2e_test-0.1.2/src/pl_e2e_test.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+pl-e2e-test = prairielearn_e2e.cli:main

{pl_e2e_test-0.1.1 → pl_e2e_test-0.1.2}/src/prairielearn_e2e/__main__.py

@@ -1,3 +1,3 @@
-from .runner import main
+from .cli import main
 
 raise SystemExit(main())

pl_e2e_test-0.1.2/src/prairielearn_e2e/cli.py

@@ -0,0 +1,56 @@
+"""Top-level command dispatch for the ``pl-e2e-test`` console script."""
+
+from __future__ import annotations
+
+import sys
+from collections.abc import Sequence
+from importlib.metadata import version
+
+from . import fuzz, regression, reporting, runner
+
+_SUBCOMMANDS = {
+    "diff": fuzz.main,
+    "add-seed": regression.main,
+    "reports": reporting.main,
+}
+
+_TOP_LEVEL_HELP = """\
+usage: pl-e2e-test [COMMAND] [ARGS...]
+
+With no COMMAND, runs the installed PrairieLearn question lifecycle test
+suite; any arguments (pytest options, --question-path, --seed-count, ...)
+are passed straight through to pytest.
+
+Commands:
+  diff        fuzz questions changed between two Git refs
+  add-seed    record a concrete regression seed for a question
+  reports     merge parallel shard reports into one terminal/JUnit report
+  version     show the installed pl-e2e-test version
+  help        show this message, or `pl-e2e-test help COMMAND` for one command
+"""
+
+
+def _version_command(_argv: Sequence[str]) -> int:
+    print(f"pl-e2e-test {version('pl-e2e-test')}")
+    return 0
+
+
+def _help_command(argv: Sequence[str]) -> int:
+    if argv and argv[0] in _SUBCOMMANDS:
+        return _SUBCOMMANDS[argv[0]](["--help"])
+    print(_TOP_LEVEL_HELP, end="")
+    return 0
+
+
+_COMMANDS = {**_SUBCOMMANDS, "version": _version_command, "help": _help_command}
+
+
+def main(argv: Sequence[str] | None = None) -> int:
+    arguments = list(sys.argv[1:] if argv is None else argv)
+    if arguments and arguments[0] in _COMMANDS:
+        return _COMMANDS[arguments[0]](arguments[1:])
+    return runner.main(arguments)
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

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

@@ -195,7 +195,7 @@ def positive_integer(value: str) -> int:
 
 
 def main(argv: Sequence[str] | None = None) -> int:
-    parser = argparse.ArgumentParser(description=__doc__)
+    parser = argparse.ArgumentParser(prog="pl-e2e-test diff", description=__doc__)
     parser.add_argument("--course-root", type=Path)
     parser.add_argument("--base", default="main", help="base Git ref (default: main)")
     parser.add_argument("--head", default="HEAD", help="head Git ref (default: HEAD)")
@@ -274,7 +274,7 @@ def main(argv: Sequence[str] | None = None) -> int:
     seeds = variant_seeds({}, args.seed_count, fuzz_seed)
     print(f"E2E fuzz seed: {fuzz_seed}")
     print(f"Variant seeds: {', '.join(str(seed) for seed in seeds)}")
-    replay_arguments = ["pl-e2e-test-diff", "--fuzz-seed", str(fuzz_seed)]
+    replay_arguments = ["pl-e2e-test", "diff", "--fuzz-seed", str(fuzz_seed)]
     test_arguments: list[str] = []
     if args.prairielearn_path is not None:
         replay_arguments.extend(

{pl_e2e_test-0.1.1 → pl_e2e_test-0.1.2}/src/prairielearn_e2e/regression.py

@@ -96,7 +96,7 @@ def add_regression_seed(course_root: Path, question_path: Path, seed: int) -> bo
 
 
 def main(argv: Sequence[str] | None = None) -> int:
-    parser = argparse.ArgumentParser(description=__doc__)
+    parser = argparse.ArgumentParser(prog="pl-e2e-test add-seed", description=__doc__)
     parser.add_argument("question_path", type=Path)
     parser.add_argument("variant_seed", type=_variant_seed)
     parser.add_argument("--course-root", type=Path)

{pl_e2e_test-0.1.1 → pl_e2e_test-0.1.2}/src/prairielearn_e2e/reporting.py

@@ -659,7 +659,8 @@ def merge_reports(inputs: Sequence[Path], junitxml: Path) -> int:
 
 def main(argv: Sequence[str] | None = None) -> int:
     parser = argparse.ArgumentParser(
-        description="Merge pl-e2e-test shard reports into one terminal and JUnit report."
+        prog="pl-e2e-test reports",
+        description="Merge pl-e2e-test shard reports into one terminal and JUnit report.",
     )
     parser.add_argument("reports", nargs="+", type=Path)
     parser.add_argument("--junitxml", type=Path, default=Path("pl-e2e-results.xml"))
@@ -667,7 +668,7 @@ def main(argv: Sequence[str] | None = None) -> int:
     try:
         return merge_reports(args.reports, args.junitxml)
     except (OSError, ReportError) as exc:
-        print(f"pl-e2e-merge-reports: error: {exc}", file=sys.stderr)
+        print(f"pl-e2e-test reports: error: {exc}", file=sys.stderr)
         return 2
 
 

pl_e2e_test-0.1.2/tests/test_cli.py

@@ -0,0 +1,81 @@
+from __future__ import annotations
+
+from collections.abc import Sequence
+from importlib.metadata import version
+
+import pytest
+
+from prairielearn_e2e import cli
+
+
+def _stub(calls: list[Sequence[str]], result: int = 0):
+    def _main(argv: Sequence[str]) -> int:
+        calls.append(list(argv))
+        return result
+
+    return _main
+
+
+@pytest.mark.parametrize("command", ["diff", "add-seed", "reports"])
+def test_dispatches_known_commands_to_their_module(
+    monkeypatch: pytest.MonkeyPatch, command: str
+) -> None:
+    calls: list[Sequence[str]] = []
+    monkeypatch.setitem(cli._COMMANDS, command, _stub(calls, result=3))
+
+    assert cli.main([command, "--example", "value"]) == 3
+    assert calls == [["--example", "value"]]
+
+
+def test_no_command_falls_through_to_the_test_runner(
+    monkeypatch: pytest.MonkeyPatch,
+) -> None:
+    calls: list[Sequence[str]] = []
+    monkeypatch.setattr(cli, "runner", type("_Runner", (), {"main": _stub(calls)}))
+
+    assert cli.main(["--question-path", "questions/example", "-k", "sample"]) == 0
+    assert calls == [["--question-path", "questions/example", "-k", "sample"]]
+
+
+def test_bare_invocation_falls_through_to_the_test_runner(
+    monkeypatch: pytest.MonkeyPatch,
+) -> None:
+    calls: list[Sequence[str]] = []
+    monkeypatch.setattr(cli, "runner", type("_Runner", (), {"main": _stub(calls)}))
+
+    assert cli.main([]) == 0
+    assert calls == [[]]
+
+
+def test_version_command_prints_the_installed_version(
+    capsys: pytest.CaptureFixture[str],
+) -> None:
+    assert cli.main(["version"]) == 0
+    assert capsys.readouterr().out == f"pl-e2e-test {version('pl-e2e-test')}\n"
+
+
+def test_help_command_with_no_argument_prints_top_level_help(
+    capsys: pytest.CaptureFixture[str],
+) -> None:
+    assert cli.main(["help"]) == 0
+    out = capsys.readouterr().out
+    assert "Commands:" in out
+    for command in ("diff", "add-seed", "reports", "version", "help"):
+        assert command in out
+
+
+def test_help_command_delegates_to_a_known_subcommand(
+    monkeypatch: pytest.MonkeyPatch,
+) -> None:
+    calls: list[Sequence[str]] = []
+    monkeypatch.setitem(cli._SUBCOMMANDS, "diff", _stub(calls))
+
+    assert cli.main(["help", "diff"]) == 0
+    assert calls == [["--help"]]
+
+
+def test_help_command_with_unknown_argument_prints_top_level_help(
+    capsys: pytest.CaptureFixture[str],
+) -> None:
+    assert cli.main(["help", "not-a-command"]) == 0
+    assert "Commands:" in capsys.readouterr().out

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

@@ -278,7 +278,7 @@ def test_main_uses_managed_cache_when_prairielearn_path_is_omitted(
         for line in capsys.readouterr().out.splitlines()
         if line.startswith("Replay")
     )
-    assert replay == "Replay with: pl-e2e-test-diff --fuzz-seed 9876"
+    assert replay == "Replay with: pl-e2e-test diff --fuzz-seed 9876"
 
 
 def test_empty_diff_does_not_generate_a_seed(

pl_e2e_test-0.1.1/src/pl_e2e_test.egg-info/entry_points.txt

@@ -1,5 +0,0 @@
-[console_scripts]
-pl-e2e-add-regression-seed = prairielearn_e2e.regression:main
-pl-e2e-merge-reports = prairielearn_e2e.reporting:main
-pl-e2e-test = prairielearn_e2e.runner:main
-pl-e2e-test-diff = prairielearn_e2e.fuzz:main