Skip to content

feat(resources): validate v2 maps against exact OEE Git commits (WS-I01) - #7

Merged
christophersesugh merged 1 commit into
mainfrom
feat/ws-i01-pinned-resource-validation
Nov 16, 2026
Merged

christophersesugh merged 1 commit into
mainfrom
feat/ws-i01-pinned-resource-validation

Conversation

@christophersesugh

Copy link
Copy Markdown
Contributor

WS-I01 — exact source-commit validation

Implements the P0 WS-I01 backlog ticket on top of merged WS-I03 and its strict resource-map v2 schema. No curriculum migration is included.

Changes

  • For each active v2 map, run the public OEE Toolkit offline against curriculum.revision (full 40-character Git commit), not OEE HEAD, working-tree Markdown or an arbitrary externally supplied JSON export.
  • Use the existing Workspace pinned-export consumer from merged PR test(workspace): strict OEE pinned-export consumer contract (WS-I11 groundwork) #5 to validate source identity, module/lesson locators, referenced outcomes and assessments after the Toolkit generates the export.
  • Reject historical schema v1; unsupported OEE formats and absent local Git objects are incomplete (exit 3), rather than a false green result or a fallback to the latest source.
  • Add --oee PATH, OEE_REPO support and --json diagnostic output. Remove the full map validator's previously untrusted --export switch.
  • Thread the exact source checkout through resource-guide generation and course workspace initialization. Keep unmapped courses independently usable.
  • Extend the offline resource CI to fetch OEE history and run synthetic and real pinned SEF1 negative tests. Update public CLI/resource docs.

Verification

CI resource check (Ubuntu, Python stdlib): 29 passing tests on the implementation content before squash, including:

  • Actual pinned OEE SEF1 export at cf7903f701582c7a1a3933d1eb65df0289e8a6aa and a v2 module graph sourced from it.
  • Missing SHA yields typed incomplete; wrong module/outcome references fail; v0.1.0 course format rejected.
  • A separate offline OEE clone with a new HEAD and dirty worktree generates identical results for the recorded pin.
  • Existing v1 negative fixture remains rejected; empty active-map catalogue checks do not claim conformance.

Run:

python3 scripts/check-resources.py --oee /path/to/open-engineering-education --json
python3 -m unittest discover -s tests -p 'test_*.py' -v
python3 scripts/render-resource-guides.py --oee /path/to/open-engineering-education --check

Remaining independent tickets

  • WS-I02: Author and independently review an actual SEF1 v2 resource map, including book chapters, editions, free accessible alternatives and coverage truth.
  • WS-I04: Safe/reproducible mapped guide publication and learner file protection.
  • WS-I11: Upstream contract CI and advisory drift notifications.

Review/DCO gate: This draft PR contains one unsigned GitHub integration commit. The repository owner must inspect and legitimately sign off that commit (git commit --amend -s --no-edit), push with --force-with-lease, wait for green checks and mark ready before merging. Do not claim WS-I01 completed or mark the course reviewed until those requirements are satisfied.

…s (WS-I01)

Resolve each v2 mapping through the authoritative offline OEE Toolkit at its exact full source SHA, then consume the derived export for module/lesson/outcome/assessment checks. Missing or unsupported sources are incomplete, never silently validated against HEAD. Remove user-supplied export from the full mapper; wire guide generation/scaffolding, update docs and CI, and add offline negative and moving-HEAD tests.

No v1 compatibility path, curriculum migration or automatic editorial approval.

Signed-off-by: Christopher S. Aondona <christohybrid185@gmail.com>
@christophersesugh
christophersesugh force-pushed the feat/ws-i01-pinned-resource-validation branch from 96a9a0e to a0494af Compare November 16, 2026 13:09
@christophersesugh
christophersesugh marked this pull request as ready for review November 16, 2026 13:09
@christophersesugh
christophersesugh merged commit 0346ca0 into main Nov 16, 2026
4 checks passed
@christophersesugh
christophersesugh deleted the feat/ws-i01-pinned-resource-validation branch November 16, 2026 13:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant