-
Notifications
You must be signed in to change notification settings - Fork 0
test(viewer): session-ledger worklog projector proptest surface (WBS-6.2 #460) #476
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
268 changes: 268 additions & 0 deletions
268
crates/sl-viewer/tests/properties_session_ledger_okf.rs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,268 @@ | ||
| //! Property evidence for `session_ledger::validate_okf_document` and | ||
| //! `session_ledger::OkfDocument::new` (OKF v1 graph validation). | ||
| //! | ||
| //! The OKF validator is the single source of truth for whether an exported | ||
| //! document is well-formed before it is published to downstream consumers | ||
| //! (search index, wiki, replay). Any drift between the validator and the | ||
| //! exporter surfaces as a `Vec<OkfValidationError>` whose shape is pinned | ||
| //! here. | ||
| //! | ||
| //! `OkfDocument::new` invariants: | ||
| //! * `okf` is always `"1.0"`. | ||
| //! * `source_id` matches the input `bundle.source_id`. | ||
| //! * `provenance.corpus` matches the corpus arg. | ||
| //! * `provenance.source_id` matches the bundle `source_id`. | ||
| //! * `entities`, `relations`, `tags` start empty. | ||
| //! | ||
| //! `validate_okf_document` invariants: | ||
| //! * A freshly-constructed `OkfDocument::new(b, c)` is valid (zero errors). | ||
| //! * Bumping `okf` to anything other than `"1.0"` produces exactly one | ||
| //! `unsupported_version` error with field `"okf"`. | ||
| //! * `provenance.source_id != source_id` produces exactly one | ||
| //! `source_id_mismatch` error with field `"provenance.source_id"`. | ||
| //! * Duplicated entity ids each surface a `duplicate_entity_id` error. | ||
| //! * Dangling relation source/target each surface their respective error. | ||
| //! * Each error has non-empty `field` / `code` / `message`. | ||
|
|
||
| use proptest::prelude::*; | ||
| use session_ledger::{ | ||
| validate_okf_document, OkfDocument, OkfEntity, OkfProvenance, OkfRelation, | ||
| OkfValidationError, ContinuationBundle, | ||
| }; | ||
|
|
||
| // ── Strategies ───────────────────────────────────────────────────────────── | ||
|
|
||
| const CORPORA: &[&str] = &["forge", "codex", "claude-code", "cursor"]; | ||
|
|
||
| // ── OkfDocument::new ─────────────────────────────────────────────────────── | ||
|
|
||
| proptest! { | ||
| /// `OkfDocument::new(b, c)` always carries `okf = "1.0"`. | ||
| #[test] | ||
| fn new_document_okf_version_is_one_zero( | ||
| source_id in "[a-zA-Z0-9_-]{1,16}", | ||
| corpus_idx in 0..CORPORA.len(), | ||
| ) { | ||
| let corpus = CORPORA[corpus_idx]; | ||
| let bundle = ContinuationBundle::new(&source_id); | ||
| let document = OkfDocument::new(&bundle, corpus); | ||
| prop_assert_eq!(document.okf, "1.0"); | ||
| } | ||
|
|
||
| /// `OkfDocument::new(b, c)` propagates `bundle.source_id`. | ||
| #[test] | ||
| fn new_document_source_id_matches_bundle( | ||
| source_id in "[a-zA-Z0-9_-]{1,16}", | ||
| corpus_idx in 0..CORPORA.len(), | ||
| ) { | ||
| let corpus = CORPORA[corpus_idx]; | ||
| let bundle = ContinuationBundle::new(&source_id); | ||
| let document = OkfDocument::new(&bundle, corpus); | ||
| prop_assert_eq!(document.source_id, bundle.source_id); | ||
| } | ||
|
|
||
| /// `OkfDocument::new(b, c)` propagates `c` into `provenance.corpus`. | ||
| #[test] | ||
| fn new_document_provenance_corpus_matches_arg( | ||
| source_id in "[a-zA-Z0-9_-]{1,16}", | ||
| corpus_idx in 0..CORPORA.len(), | ||
| ) { | ||
| let corpus = CORPORA[corpus_idx]; | ||
| let bundle = ContinuationBundle::new(&source_id); | ||
| let document = OkfDocument::new(&bundle, corpus); | ||
| prop_assert_eq!(document.provenance.corpus, corpus); | ||
| } | ||
|
|
||
| /// `OkfDocument::new(b, c)` propagates `bundle.source_id` into | ||
| /// `provenance.source_id`. | ||
| #[test] | ||
| fn new_document_provenance_source_id_matches_bundle( | ||
| source_id in "[a-zA-Z0-9_-]{1,16}", | ||
| corpus_idx in 0..CORPORA.len(), | ||
| ) { | ||
| let corpus = CORPORA[corpus_idx]; | ||
| let bundle = ContinuationBundle::new(&source_id); | ||
| let document = OkfDocument::new(&bundle, corpus); | ||
| prop_assert_eq!(document.provenance.source_id, bundle.source_id); | ||
| } | ||
|
|
||
| /// `OkfDocument::new(b, c)` starts with empty entities, relations, tags. | ||
| #[test] | ||
| fn new_document_collections_start_empty( | ||
| source_id in "[a-zA-Z0-9_-]{1,16}", | ||
| corpus_idx in 0..CORPORA.len(), | ||
| ) { | ||
| let corpus = CORPORA[corpus_idx]; | ||
| let bundle = ContinuationBundle::new(&source_id); | ||
| let document = OkfDocument::new(&bundle, corpus); | ||
| prop_assert!(document.entities.is_empty()); | ||
| prop_assert!(document.relations.is_empty()); | ||
| prop_assert!(document.tags.is_empty()); | ||
| } | ||
| } | ||
|
|
||
| // ── validate_okf_document ────────────────────────────────────────────────── | ||
|
|
||
| proptest! { | ||
| /// A freshly-constructed OKF document validates with zero errors. | ||
| #[test] | ||
| fn fresh_document_validates_clean( | ||
| source_id in "[a-zA-Z0-9_-]{1,16}", | ||
| corpus_idx in 0..CORPORA.len(), | ||
| ) { | ||
| let corpus = CORPORA[corpus_idx]; | ||
| let bundle = ContinuationBundle::new(&source_id); | ||
| let document = OkfDocument::new(&bundle, corpus); | ||
| let errors = validate_okf_document(&document); | ||
| prop_assert!(errors.is_empty(), "expected no errors, got {errors:?}"); | ||
| } | ||
|
|
||
| /// Bumping `okf` to anything other than `"1.0"` produces exactly one | ||
| /// `unsupported_version` error with field `"okf"`. | ||
| #[test] | ||
| fn wrong_okf_version_produces_one_unsupported_version_error( | ||
| source_id in "[a-zA-Z0-9_-]{1,16}", | ||
| bad_version in "[0-9A-Za-z.]{1,8}", | ||
| ) { | ||
| let bundle = ContinuationBundle::new(&source_id); | ||
| let mut document = OkfDocument::new(&bundle, "forge"); | ||
| // Filter out the trivial case where the random string happens to | ||
| // equal "1.0" — we want a strictly-non-"1.0" version. | ||
| prop_assume!(bad_version != "1.0"); | ||
| document.okf = bad_version.clone(); | ||
| let errors = validate_okf_document(&document); | ||
| let matching: Vec<&OkfValidationError> = errors | ||
| .iter() | ||
| .filter(|e| e.code == "unsupported_version" && e.field == "okf") | ||
| .collect(); | ||
| prop_assert_eq!(matching.len(), 1); | ||
| // The message must mention the offending version. | ||
| prop_assert!(matching[0].message.contains(&bad_version)); | ||
| } | ||
|
|
||
| /// `provenance.source_id != source_id` produces exactly one | ||
| /// `source_id_mismatch` error. | ||
| #[test] | ||
| fn provenance_source_mismatch_produces_one_error( | ||
| source_id in "[a-zA-Z0-9_-]{1,16}", | ||
| other_id in "[a-zA-Z0-9_-]{1,16}", | ||
| ) { | ||
| prop_assume!(source_id != other_id); | ||
| let bundle = ContinuationBundle::new(&source_id); | ||
| let mut document = OkfDocument::new(&bundle, "forge"); | ||
| document.provenance = OkfProvenance { | ||
| corpus: "forge".into(), | ||
| source_id: other_id.clone(), | ||
| }; | ||
| let errors = validate_okf_document(&document); | ||
| let matching: Vec<&OkfValidationError> = errors | ||
| .iter() | ||
| .filter(|e| e.code == "source_id_mismatch" && e.field == "provenance.source_id") | ||
| .collect(); | ||
| prop_assert_eq!(matching.len(), 1); | ||
| } | ||
|
|
||
| /// Duplicate entity ids surface a `duplicate_entity_id` error per | ||
| /// offending id (one per duplicate occurrence). | ||
| #[test] | ||
| fn duplicate_entity_ids_surface_errors( | ||
| n in 2_usize..6, | ||
| ) { | ||
| let bundle = ContinuationBundle::new("dup-session"); | ||
| let mut document = OkfDocument::new(&bundle, "forge"); | ||
| let entity = OkfEntity { | ||
| id: "dup-entity".into(), | ||
| r#type: "intent".into(), | ||
| label: "shared".into(), | ||
| properties: serde_json::Value::Null, | ||
| }; | ||
| document.entities = (0..n).map(|_| entity.clone()).collect(); | ||
| let errors = validate_okf_document(&document); | ||
| let dups: Vec<&OkfValidationError> = errors | ||
| .iter() | ||
| .filter(|e| e.code == "duplicate_entity_id") | ||
| .collect(); | ||
| // The validator reports the *second* (and subsequent) occurrences. | ||
| prop_assert_eq!(dups.len(), n - 1); | ||
| } | ||
|
|
||
| /// Dangling relation source surfaces a `dangling_relation_source` error. | ||
| #[test] | ||
| fn dangling_relation_source_surfaces_error( | ||
| source_id in "[a-zA-Z0-9_-]{1,16}", | ||
| ) { | ||
| let bundle = ContinuationBundle::new(&source_id); | ||
| let mut document = OkfDocument::new(&bundle, "forge"); | ||
| document.entities = vec![OkfEntity { | ||
| id: "present".into(), | ||
| r#type: "intent".into(), | ||
| label: "p".into(), | ||
| properties: serde_json::Value::Null, | ||
| }]; | ||
| document.relations = vec![OkfRelation { | ||
| source: "missing-source".into(), | ||
| target: "present".into(), | ||
| r#type: "grounds".into(), | ||
| provenance: document.provenance.clone(), | ||
| }]; | ||
| let errors = validate_okf_document(&document); | ||
| prop_assert!(errors.iter().any(|e| e.code == "dangling_relation_source" | ||
| && e.field == "relations[0].source")); | ||
| } | ||
|
|
||
| /// Dangling relation target surfaces a `dangling_relation_target` error. | ||
| #[test] | ||
| fn dangling_relation_target_surfaces_error( | ||
| source_id in "[a-zA-Z0-9_-]{1,16}", | ||
| ) { | ||
| let bundle = ContinuationBundle::new(&source_id); | ||
| let mut document = OkfDocument::new(&bundle, "forge"); | ||
| document.entities = vec![OkfEntity { | ||
| id: "present".into(), | ||
| r#type: "intent".into(), | ||
| label: "p".into(), | ||
| properties: serde_json::Value::Null, | ||
| }]; | ||
| document.relations = vec![OkfRelation { | ||
| source: "present".into(), | ||
| target: "missing-target".into(), | ||
| r#type: "grounds".into(), | ||
| provenance: document.provenance.clone(), | ||
| }]; | ||
| let errors = validate_okf_document(&document); | ||
| prop_assert!(errors.iter().any(|e| e.code == "dangling_relation_target" | ||
| && e.field == "relations[0].target")); | ||
| } | ||
|
|
||
| /// Every `OkfValidationError` carries non-empty `field`, `code`, | ||
| /// `message` so callers can render an actionable diagnostic. | ||
| #[test] | ||
| fn every_error_has_nonempty_components(_seed in any::<u32>()) { | ||
| let bundle = ContinuationBundle::new("err-shape"); | ||
| let mut document = OkfDocument::new(&bundle, "forge"); | ||
| // Force every error class at once. | ||
| document.okf = "2.0".into(); | ||
| document.provenance.source_id = "other".into(); | ||
| document.entities = vec![ | ||
| OkfEntity { | ||
| id: "x".into(), | ||
| r#type: "intent".into(), | ||
| label: "x".into(), | ||
| properties: serde_json::Value::Null, | ||
| }, | ||
| OkfEntity { | ||
| id: "x".into(), | ||
| r#type: "intent".into(), | ||
| label: "x".into(), | ||
| properties: serde_json::Value::Null, | ||
| }, | ||
| ]; | ||
| let errors = validate_okf_document(&document); | ||
| prop_assert!(!errors.is_empty()); | ||
| for err in &errors { | ||
| prop_assert!(!err.field.is_empty(), "error has empty field"); | ||
| prop_assert!(!err.code.is_empty(), "error has empty code"); | ||
| prop_assert!(!err.message.is_empty(), "error has empty message"); | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Add dangling relations to the all-error-shape fixture.
The fixture only produces
unsupported_version,source_id_mismatch, andduplicate_entity_id. It does not producedangling_relation_sourceordangling_relation_target, despite Line 243 claiming that it forces every error class.Add a relation whose source and target are absent from
document.entities. This makes the non-empty component check cover all validator error classes.Proposed fix
document.entities = vec![ OkfEntity { id: "x".into(), @@ properties: serde_json::Value::Null, }, ]; + document.relations = vec![OkfRelation { + source: "missing-source".into(), + target: "missing-target".into(), + r#type: "grounds".into(), + provenance: document.provenance.clone(), + }]; let errors = validate_okf_document(&document);📝 Committable suggestion
🤖 Prompt for AI Agents