test(viewer): tokens SSOT proptest surface (WBS-6.2 #450) #456
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
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,186 @@ | ||
| //! Property evidence for sl-viewer's `tokens` module — the design-token | ||
| //! single source of truth for the Lab-Coat / viewer color palette. | ||
| //! | ||
| //! The unit tests in `tokens.rs` pin specific values and exercise | ||
| //! `ThemeColors::light() / dark()` against the `lab_coat::*` mirror. | ||
| //! These properties pin the broader SSOT invariants: | ||
| //! | ||
| //! * Every `lab_coat::*` hex constant is a well-formed `#RRGGBB` string | ||
| //! (7 chars, leading `#`, then 6 hex digits). | ||
| //! * All Lab-Coat hex constants are pairwise distinct — no two share | ||
| //! the same value (catches drift where a constant is silently | ||
| //! re-aliased to another). | ||
| //! * Every Lab-Coat hex appears somewhere in `TOKENS_CSS` so the | ||
| //! Rust mirror and the CSS SSOT stay in sync. | ||
| //! * Every `REQUIRED_CSS_VARS` entry starts with `--`, has no | ||
| //! duplicates, and appears as a substring of `TOKENS_CSS`. | ||
| //! * `VIEWER_COLOR_SCHEME` mentions both `:root[data-theme="dark"]` | ||
| //! and `:root` so the dark-mode flip is wired. | ||
| //! | ||
| //! proptest is added to `sl-viewer/[dev-dependencies]` (mirroring the | ||
| //! workspace root); see PR #425 for the initial wiring. | ||
|
|
||
| use std::collections::HashSet; | ||
|
|
||
| use proptest::prelude::*; | ||
| use sl_viewer::tokens::{ | ||
| lab_coat, REQUIRED_CSS_VARS, TOKENS_CSS, VIEWER_COLOR_SCHEME, | ||
| }; | ||
|
|
||
| // ── strategies ────────────────────────────────────────────────────────────── | ||
|
|
||
| /// Generate indices into `REQUIRED_CSS_VARS` for prop_any tests. | ||
| fn required_var_index_strategy() -> impl Strategy<Value = usize> { | ||
| 0..REQUIRED_CSS_VARS.len() | ||
| } | ||
|
|
||
| /// Generate indices into the `lab_coat::*` constants via the documented | ||
| /// hex list. We use the indices, then look up the value, so we exercise | ||
| /// the actual const definitions (not duplicates). | ||
| fn lab_coat_hex_indices_strategy() -> impl Strategy<Value = usize> { | ||
| 0..lab_coat_hex_list().len() | ||
| } | ||
|
|
||
| /// The full list of `lab_coat::*` hex constants in stable declaration | ||
| /// order. We compute this once via a small reflection-on-source approach: | ||
| /// every `pub const` in `lab_coat::*` whose value is a `&'static str` | ||
| /// starting with `#`. Since we can't introspect Rust modules at runtime, | ||
| /// we hard-code the list (mirroring `tokens.rs`). The constants are | ||
| /// public — any new addition requires also extending this list, which | ||
| /// the `proptest` exhaustiveness check below will catch. | ||
| fn lab_coat_hex_list() -> &'static [&'static str] { | ||
| &[ | ||
| lab_coat::LAB_WHITE, | ||
| lab_coat::SLATE, | ||
| lab_coat::COBALT, | ||
| lab_coat::COBALT_ON_DARK, | ||
| lab_coat::ORANGE, | ||
| lab_coat::TEAL, | ||
| lab_coat::TEAL_ON_DARK, | ||
| lab_coat::BG_DARK, | ||
| lab_coat::SURFACE_LIGHT, | ||
| lab_coat::BORDER_LIGHT, | ||
| lab_coat::BORDER_DARK, | ||
| lab_coat::TEXT_DARK, | ||
| lab_coat::TEXT_MUTED_LIGHT, | ||
| lab_coat::TEXT_MUTED_DARK, | ||
| lab_coat::DANGER_LIGHT, | ||
| lab_coat::DANGER_DARK, | ||
| ] | ||
| } | ||
|
|
||
| // ── lab_coat hex well-formedness ──────────────────────────────────────────── | ||
|
|
||
| proptest! { | ||
| /// Property: every `lab_coat::*` hex constant is a 7-char string | ||
| /// starting with `#`, followed by 6 lowercase hex digits. Catches | ||
| /// drift where someone hand-types an `rgb(…)` literal or a 3-digit | ||
| /// hex. | ||
| #[test] | ||
| fn lab_coat_hex_well_formed(i in lab_coat_hex_indices_strategy()) { | ||
| let hex = lab_coat_hex_list()[i]; | ||
| prop_assert_eq!(hex.len(), 7, "hex {:?} must be 7 chars", hex); | ||
| prop_assert!(hex.starts_with('#'), "hex {:?} must start with '#'", hex); | ||
| let body = &hex[1..]; | ||
| prop_assert!( | ||
| body.chars().all(|c| c.is_ascii_hexdigit() && !c.is_ascii_uppercase()), | ||
| "hex {:?} must be lowercase ASCII hex digits only", | ||
| hex, | ||
| ); | ||
| } | ||
|
|
||
| /// Property: every `lab_coat::*` hex constant is non-empty (sanity | ||
| /// check — the well-formedness check above is the stricter version). | ||
| #[test] | ||
| fn lab_coat_hex_nonempty(i in lab_coat_hex_indices_strategy()) { | ||
| let hex = lab_coat_hex_list()[i]; | ||
| prop_assert!(!hex.is_empty(), "lab_coat hex at index {} is empty", i); | ||
| } | ||
|
|
||
| /// Property: all `lab_coat::*` hex constants are pairwise distinct. | ||
| /// No silent re-aliasing. | ||
| #[test] | ||
| fn lab_coat_hexes_distinct(_i in 0u8..4) { | ||
| let list = lab_coat_hex_list(); | ||
| let set: HashSet<_> = list.iter().collect(); | ||
| prop_assert_eq!(set.len(), list.len()); | ||
| } | ||
|
|
||
| /// Property: every `lab_coat::*` hex appears as a substring of | ||
| /// `TOKENS_CSS` so the Rust mirror and the CSS SSOT stay in sync. | ||
| /// If a constant is added without updating the CSS, this fails. | ||
| #[test] | ||
| fn lab_coat_hex_in_tokens_css(i in lab_coat_hex_indices_strategy()) { | ||
| let hex = lab_coat_hex_list()[i]; | ||
| prop_assert!( | ||
| TOKENS_CSS.contains(hex), | ||
| "TOKENS_CSS missing lab_coat hex {:?}", | ||
| hex, | ||
|
Comment on lines
+114
to
+118
There was a problem hiding this comment. Suggestion: This only checks that each hex string occurs somewhere in the entire stylesheet, not that it is assigned to the corresponding token. A token declaration can be changed or removed while the same color remains in another declaration, a comment, or an unrelated selector, and this property will still pass. Validate the expected variable-to-hex assignment on the same declaration line, as the existing unit test does. [api mismatch] Severity Level: Major
|
||
| ); | ||
| } | ||
| } | ||
|
|
||
| // ── REQUIRED_CSS_VARS invariants ──────────────────────────────────────────── | ||
|
|
||
| proptest! { | ||
| /// Property: every `REQUIRED_CSS_VARS` entry starts with `--` (CSS | ||
| /// custom property convention). | ||
| #[test] | ||
| fn required_css_var_starts_with_double_dash(i in required_var_index_strategy()) { | ||
| let var = REQUIRED_CSS_VARS[i]; | ||
| prop_assert!(var.starts_with("--"), "var {:?} must start with '--'", var); | ||
| } | ||
|
|
||
| /// Property: `REQUIRED_CSS_VARS` has no duplicates. | ||
| #[test] | ||
| fn required_css_vars_unique(_i in 0u8..4) { | ||
| let list = REQUIRED_CSS_VARS; | ||
| let set: HashSet<_> = list.iter().collect(); | ||
| prop_assert_eq!(set.len(), list.len()); | ||
| } | ||
|
|
||
| /// Property: every `REQUIRED_CSS_VARS` entry is non-empty (no | ||
| /// empty `--` strings accidentally added). | ||
| #[test] | ||
| fn required_css_var_nonempty(i in required_var_index_strategy()) { | ||
| let var = REQUIRED_CSS_VARS[i]; | ||
| prop_assert!(!var.is_empty(), "REQUIRED_CSS_VARS[{}] is empty", i); | ||
| } | ||
|
|
||
| /// Property: every `REQUIRED_CSS_VARS` entry appears as a | ||
| /// substring of `TOKENS_CSS`. Catches drift where a var name is | ||
| /// added to the list without updating the CSS file. | ||
| #[test] | ||
| fn required_css_var_in_tokens_css(i in required_var_index_strategy()) { | ||
| let var = REQUIRED_CSS_VARS[i]; | ||
| prop_assert!( | ||
| TOKENS_CSS.contains(var), | ||
| "TOKENS_CSS missing required CSS var {:?}", | ||
| var, | ||
|
Comment on lines
+155
to
+159
There was a problem hiding this comment. Suggestion: This accepts a required variable when its name appears only in a comment, a Severity Level: Major
|
||
| ); | ||
| } | ||
| } | ||
|
|
||
| // ── VIEWER_COLOR_SCHEME invariants ────────────────────────────────────────── | ||
|
|
||
| proptest! { | ||
| /// Property: `VIEWER_COLOR_SCHEME` declares both the default | ||
| /// (`:root`) and dark (`:root[data-theme="dark"]`) selectors so the | ||
| /// viewer's color-scheme flip is wired. | ||
| #[test] | ||
| fn viewer_color_scheme_declares_both_selectors(_i in 0u8..4) { | ||
| prop_assert!(VIEWER_COLOR_SCHEME.contains(":root")); | ||
| prop_assert!(VIEWER_COLOR_SCHEME.contains("[data-theme=\"dark\"]")); | ||
|
Comment on lines
+172
to
+173
There was a problem hiding this comment. Suggestion: The two independent substring checks do not require the dark selector to be the exact Severity Level: Major
|
||
| } | ||
|
|
||
| /// Property: `VIEWER_COLOR_SCHEME` declares `color-scheme` for | ||
| /// both modes (the W3C CSS prop that triggers browser scrollbar | ||
| /// and form-control color flips). | ||
| #[test] | ||
| fn viewer_color_scheme_declares_color_scheme_property(_i in 0u8..4) { | ||
| prop_assert!(VIEWER_COLOR_SCHEME.contains("color-scheme")); | ||
| // Both modes must set the property. | ||
| let occurrences = VIEWER_COLOR_SCHEME.matches("color-scheme").count(); | ||
| prop_assert_eq!(occurrences, 2); | ||
|
Comment on lines
+181
to
+184
There was a problem hiding this comment. Suggestion: Counting textual occurrences does not prove that light and dark selectors each contain one Severity Level: Major
|
||
| } | ||
| } | ||
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
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
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.
WARNING: The
lab_coat_hex_list()doc promises an 'exhaustiveness check' that does not exist.The doc comment (lines 45–50) claims the list is derived via a 'reflection-on-source approach' over every
pub constinlab_coat, and that any new constant addition 'will [be] catch[ed] by the proptest exhaustiveness check below.' Neither is true: the list is hand-maintained (no reflection), and none of the 10 properties cross-checkslab_coat_hex_list()against the full set oflab_coatconstants. A newlab_coat::*constant added without extending this list would silently escape coverage — precisely the drift this SSOT test surface is meant to prevent.Suggested fix: either (a) add a property asserting
lab_coat_hex_list().len()equals the documented count (16) and that everylab_coat::*value is present, or (b) reword the doc to state the list must be updated manually and the suite does not assert completeness.Reply with
@kilocode-bot fix itto have Kilo Code address this issue.