Files
gaokao-volunteer-system/data/rules/cli.py
Hermes a57522b11e
Some checks failed
CI / pytest (Python 3.10) (push) Has been cancelled
CI / pytest (Python 3.11) (push) Has been cancelled
CI / pytest (Python 3.12) (push) Has been cancelled
feat(cli): delegate channel/delivery/retention/backup to gaokao-cli (phase 3 batch 3)
Round 3 of the unified gaokao-cli rollout. Adds four more passthrough
markers so the unified entry point can drive the remaining ops scripts
without bringing new data models into data/.

- data/cli_compat_delivery_dispatch.py: runpy shim for
  scripts/gaokao-delivery-dispatch.py (DispatchDeliveryEvents).
- data/cli_compat_delivery_watchdog.py: runpy shim for
  scripts/gaokao-delivery-watchdog.py (WatchdogDeliveryEvents).
- data/cli_compat_retention_cleanup.py: runpy shim for
  scripts/gaokao-retention-cleanup.py (OrderRetentionCleanup).
- data/cli_compat_channel_fallback.py: forwarder for
  data.channel_sync.monitor.main (CheckChannelHealth /
  ManualTemplate).
- data/cli_compat_backup.py: subprocess wrapper that dispatches
  scripts/backup_snapshot.sh and scripts/backup_verify.sh.
- data/rules/cli.py main(): routes gaokao-cli {channel, delivery
  {dispatch,watchdog}, retention, backup {snapshot,verify}} to the
  shims; rejects unknown subcommands with a structured error.
- docs/CLI_API_MAPPING.md §2.1: now lists 12 top-level commands with
  their real subcommands and fallback paths.
- tests/test_cli_doctor_phase3.py: +6 tests covering channel
  delegation, delivery dispatch / unknown-subcommand, retention
  routing, backup shell routing, and backup unknown-subcommand
  rejection.

Verification:
- focused: 12 passed
- dev-verify full gate: all checks passed (ruff / mypy / coverage /
  pytest / benchmark)
2026-06-17 22:18:57 +08:00

292 lines
12 KiB
Python

from __future__ import annotations
import argparse
import json
import sys
from pathlib import Path
from data.majors_catalog.cli import (
DEFAULT_CATALOG_ROOT,
build_changes_payload,
build_lookup_payload,
build_school_status_payload,
build_school_verify_payload,
build_status_payload as build_majors_status_payload,
build_verify_payload as build_majors_verify_payload,
)
from data.majors_catalog.loader import MajorsCatalogLoader
from data.rules.audit_engine import AuditEngine
from data.rules.loader import RuleLoader
DEFAULT_RULES_TRUTH_ROOT = Path(__file__).resolve().parents[2] / "rules" / "_truth"
def _build_parser() -> argparse.ArgumentParser:
parser = argparse.ArgumentParser(prog="gaokao-cli")
subparsers = parser.add_subparsers(dest="command", required=True)
rules_parser = subparsers.add_parser("rules", help="rules truth source commands")
rules_sub = rules_parser.add_subparsers(dest="rules_command", required=True)
status_parser = rules_sub.add_parser("status", help="show rules truth status")
status_parser.add_argument("--truth-root", default=str(DEFAULT_RULES_TRUTH_ROOT))
status_parser.add_argument("--json", action="store_true")
verify_parser = rules_sub.add_parser("verify", help="verify rules truth tree")
verify_parser.add_argument("--truth-root", default=str(DEFAULT_RULES_TRUTH_ROOT))
verify_parser.add_argument("--json", action="store_true")
majors_parser = subparsers.add_parser(
"majors", help="national majors catalog commands"
)
majors_sub = majors_parser.add_subparsers(dest="majors_command", required=True)
majors_status = majors_sub.add_parser("status", help="show majors catalog status")
majors_status.add_argument("--catalog-root", default=str(DEFAULT_CATALOG_ROOT))
majors_status.add_argument("--json", action="store_true")
majors_lookup = majors_sub.add_parser(
"lookup", help="lookup a major by code or name"
)
majors_lookup.add_argument("name_or_code")
majors_lookup.add_argument("--catalog-root", default=str(DEFAULT_CATALOG_ROOT))
majors_lookup.add_argument("--json", action="store_true")
majors_verify = majors_sub.add_parser(
"verify", help="verify majors catalog structure"
)
majors_verify.add_argument("--catalog-root", default=str(DEFAULT_CATALOG_ROOT))
majors_verify.add_argument("--json", action="store_true")
majors_changes = majors_sub.add_parser(
"changes", help="list non-active major records"
)
majors_changes.add_argument("--catalog-root", default=str(DEFAULT_CATALOG_ROOT))
majors_changes.add_argument("--json", action="store_true")
school_status = majors_sub.add_parser(
"school-status", help="show school catalog summary for a year"
)
school_status.add_argument("--catalog-root", default=str(DEFAULT_CATALOG_ROOT))
school_status.add_argument("--year", required=True, type=int)
school_status.add_argument("--json", action="store_true")
school_verify = majors_sub.add_parser(
"school-verify", help="verify school catalog structure for a year"
)
school_verify.add_argument("--catalog-root", default=str(DEFAULT_CATALOG_ROOT))
school_verify.add_argument("--year", required=True, type=int)
school_verify.add_argument("--json", action="store_true")
audit_parser = subparsers.add_parser("audit", help="structured audit commands")
audit_sub = audit_parser.add_subparsers(dest="audit_command", required=True)
audit_run = audit_sub.add_parser("run", help="run structured audit on JSON plan")
audit_run.add_argument("--province", required=True)
audit_run.add_argument("--plan", required=True)
audit_run.add_argument("--truth-root", default=str(DEFAULT_RULES_TRUTH_ROOT))
audit_run.add_argument("--catalog-root", default=str(DEFAULT_CATALOG_ROOT))
audit_run.add_argument("--json", action="store_true")
subparsers.add_parser("order", help="delegate to data.orders.cli (orders commands)")
doctor_parser = subparsers.add_parser(
"doctor", help="self-check rules/majors/audit/catalog wiring"
)
doctor_parser.add_argument("--truth-root", default=str(DEFAULT_RULES_TRUTH_ROOT))
doctor_parser.add_argument("--catalog-root", default=str(DEFAULT_CATALOG_ROOT))
doctor_parser.add_argument("--json", action="store_true")
return parser
def _emit(payload: dict[str, object], json_output: bool) -> int:
if json_output:
print(json.dumps(payload, ensure_ascii=False))
else:
print(payload)
return 0 if bool(payload.get("ok", payload.get("overall_pass", True))) else 1
def main(argv: list[str] | None = None) -> int:
# `order` / `share` / `payment` / `channel` / `delivery` / `retention`
# / `backup` are pure delegation markers. Handle them before argparse
# so the legacy parsers can see their native subcommands and flags
# directly (including `--help`).
tokens = list(sys.argv[1:]) if argv is None else list(argv)
if tokens and tokens[0] in (
"order",
"share",
"payment",
"channel",
"delivery",
"retention",
"backup",
):
marker = tokens[0]
if marker == "order":
from data.orders.cli import main as orders_main
# data.orders.cli.main expects subcommands without the `order`
# prefix (its parser exposes `create` / `list` / `show` / ...).
return orders_main(tokens[1:])
if marker == "share":
from data.cli_compat_gaokao_shortlink import main as shortlink_main
return shortlink_main(tokens[1:])
if marker == "payment":
from data.cli_compat_payment_doctor import (
main as payment_doctor_main,
)
return payment_doctor_main(tokens[1:])
if marker == "channel":
from data.cli_compat_channel_fallback import (
main as channel_main,
)
return channel_main(tokens[1:])
if marker == "delivery":
from data.cli_compat_delivery_dispatch import (
main as delivery_dispatch_main,
)
from data.cli_compat_delivery_watchdog import (
main as delivery_watchdog_main,
)
sub = tokens[1] if len(tokens) > 1 else ""
if sub == "dispatch":
return delivery_dispatch_main(tokens[2:])
if sub == "watchdog":
return delivery_watchdog_main(tokens[2:])
raise SystemExit(
f"gaokao-cli delivery expects one of [dispatch, watchdog]; got: {sub!r}"
)
if marker == "retention":
from data.cli_compat_retention_cleanup import (
main as retention_main,
)
return retention_main(tokens[1:])
if marker == "backup":
from data.cli_compat_backup import main as backup_main
return backup_main(tokens[1:])
parser = _build_parser()
args = parser.parse_args(tokens)
if args.command == "rules" and args.rules_command == "status":
loader = RuleLoader.from_truth_root(Path(args.truth_root))
status = loader.build_status()
return _emit(
{
"ok": True,
"province_count": status.province_count,
"national_rule_count": status.national_rule_count,
"active_provinces": status.active_provinces,
},
args.json,
)
if args.command == "rules" and args.rules_command == "verify":
loader = RuleLoader.from_truth_root(Path(args.truth_root))
status = loader.build_status()
missing_required_files: list[str] = []
truth_root = Path(args.truth_root)
if not (truth_root / "national.yaml").is_file():
missing_required_files.append("national.yaml")
if not (truth_root / "province").is_dir():
missing_required_files.append("province/")
return _emit(
{
"ok": not missing_required_files,
"province_count": status.province_count,
"national_rule_count": status.national_rule_count,
"missing_required_files": missing_required_files,
},
args.json,
)
if args.command == "majors" and args.majors_command == "status":
payload = build_majors_status_payload(Path(args.catalog_root))
return _emit(payload, args.json)
if args.command == "majors" and args.majors_command == "lookup":
payload = build_lookup_payload(Path(args.catalog_root), args.name_or_code)
return _emit(payload, args.json)
if args.command == "majors" and args.majors_command == "verify":
payload = build_majors_verify_payload(Path(args.catalog_root))
return _emit(payload, args.json)
if args.command == "majors" and args.majors_command == "changes":
payload = build_changes_payload(Path(args.catalog_root))
return _emit(payload, args.json)
if args.command == "majors" and args.majors_command == "school-status":
payload = build_school_status_payload(Path(args.catalog_root), args.year)
return _emit(payload, args.json)
if args.command == "majors" and args.majors_command == "school-verify":
payload = build_school_verify_payload(Path(args.catalog_root), args.year)
return _emit(payload, args.json)
if args.command == "audit" and args.audit_command == "run":
truth_loader = RuleLoader.from_truth_root(Path(args.truth_root))
majors_loader = MajorsCatalogLoader.from_catalog_root(Path(args.catalog_root))
plan = json.loads(Path(args.plan).read_text(encoding="utf-8"))
payload = AuditEngine(truth_loader, majors_loader=majors_loader).audit_plan(
args.province, plan
)
return _emit(payload, args.json)
if args.command == "doctor":
truth_root = Path(args.truth_root)
catalog_root = Path(args.catalog_root)
rules_section: dict[str, object]
rules_ok: bool
try:
rule_status = RuleLoader.from_truth_root(truth_root).build_status()
rules_section = {
"province_count": rule_status.province_count,
"national_rule_count": rule_status.national_rule_count,
}
rules_ok = rule_status.province_count > 0
except (FileNotFoundError, KeyError, ValueError) as exc:
rules_section = {"error": f"{type(exc).__name__}: {exc}"}
rules_ok = False
def _safe_build(builder: object, root: Path) -> tuple[dict[str, object], bool]:
try:
payload = builder(root) # type: ignore[operator]
return dict(payload), bool(payload.get("ok", True)) # type: ignore[union-attr]
except (FileNotFoundError, KeyError, ValueError) as exc:
return (
{"ok": False, "error": f"{type(exc).__name__}: {exc}"},
False,
)
majors_status, majors_status_ok = _safe_build(
build_majors_status_payload, catalog_root
)
majors_verify, majors_verify_ok = _safe_build(
build_majors_verify_payload, catalog_root
)
majors_ok = majors_status_ok and majors_verify_ok
overall_ok = rules_ok and majors_ok
payload = {
"ok": overall_ok,
"rules": rules_section,
"majors": majors_status,
"majors_verify": majors_verify,
}
return _emit(payload, args.json)
parser.error("unsupported command")
return 2
if __name__ == "__main__":
raise SystemExit(main())