diff options
| author | DanConwayDev <DanConwayDev@protonmail.com> | 2025-11-28 02:19:47 +0000 |
|---|---|---|
| committer | DanConwayDev <DanConwayDev@protonmail.com> | 2025-11-28 02:19:47 +0000 |
| commit | 43e53b4ccd9fcebf20cc9c1bdbfe568ddd8051b9 (patch) | |
| tree | 4aea212e5b1d307affb8e0ce5db1cc898e217889 /grasp-audit/README.md | |
| parent | f053827e0a157f348d9cf834f026a8de322abfe2 (diff) | |
grasp-audit improve cli output eg. add colors and condense
Diffstat (limited to 'grasp-audit/README.md')
| -rw-r--r-- | grasp-audit/README.md | 29 |
1 files changed, 15 insertions, 14 deletions
diff --git a/grasp-audit/README.md b/grasp-audit/README.md index 44deec2..ab3bddc 100644 --- a/grasp-audit/README.md +++ b/grasp-audit/README.md | |||
| @@ -21,13 +21,13 @@ nix develop -c bash test-ngit-relay.sh --mode test | |||
| 21 | ``` | 21 | ``` |
| 22 | 22 | ||
| 23 | This automatically: | 23 | This automatically: |
| 24 | |||
| 24 | - ✅ Starts ngit-relay in an isolated Docker container | 25 | - ✅ Starts ngit-relay in an isolated Docker container |
| 25 | - ✅ Runs all GRASP-01 compliance tests | 26 | - ✅ Runs all GRASP-01 compliance tests |
| 26 | - ✅ Cleans up resources when finished | 27 | - ✅ Cleans up resources when finished |
| 27 | 28 | ||
| 28 | **Currently Passing:** 4/18 tests (14 tests stubbed with "Not implemented yet") | ||
| 29 | |||
| 30 | For more options: | 29 | For more options: |
| 30 | |||
| 31 | ```bash | 31 | ```bash |
| 32 | ./test-ngit-relay.sh --help | 32 | ./test-ngit-relay.sh --help |
| 33 | ``` | 33 | ``` |
| @@ -218,16 +218,16 @@ pub async fn test_something(client: &AuditClient) -> TestResult { | |||
| 218 | .run(|| async { | 218 | .run(|| async { |
| 219 | // 1. Context | 219 | // 1. Context |
| 220 | let ctx = TestContext::new(client); | 220 | let ctx = TestContext::new(client); |
| 221 | 221 | ||
| 222 | // 2. Prerequisites (cached per-TestContext) | 222 | // 2. Prerequisites (cached per-TestContext) |
| 223 | let repo = ctx.get_fixture(FixtureKind::ValidRepo).await?; | 223 | let repo = ctx.get_fixture(FixtureKind::ValidRepo).await?; |
| 224 | 224 | ||
| 225 | // 3. Test-specific event | 225 | // 3. Test-specific event |
| 226 | let my_event = client.create_issue(&repo, "Title", "Content", vec![])?; | 226 | let my_event = client.create_issue(&repo, "Title", "Content", vec![])?; |
| 227 | 227 | ||
| 228 | // 4. Verify | 228 | // 4. Verify |
| 229 | send_and_verify_accepted(client, my_event, "description").await?; | 229 | send_and_verify_accepted(client, my_event, "description").await?; |
| 230 | 230 | ||
| 231 | Ok(()) | 231 | Ok(()) |
| 232 | }) | 232 | }) |
| 233 | .await | 233 | .await |
| @@ -252,14 +252,14 @@ pub async fn test_something(client: &AuditClient) -> TestResult { | |||
| 252 | 252 | ||
| 253 | ### Available Fixtures | 253 | ### Available Fixtures |
| 254 | 254 | ||
| 255 | | FixtureKind | Provides | Use When | | 255 | | FixtureKind | Provides | Use When | |
| 256 | |-------------|----------|----------| | 256 | | ------------------------ | --------------------------------------- | ------------------------------------- | |
| 257 | | `ValidRepo` | Accepted repo announcement (kind 30617) | Need a repo as prerequisite | | 257 | | `ValidRepo` | Accepted repo announcement (kind 30617) | Need a repo as prerequisite | |
| 258 | | `RepoState` | Repo + state event (kind 30618) | Testing owner push authorization | | 258 | | `RepoState` | Repo + state event (kind 30618) | Testing owner push authorization | |
| 259 | | `MaintainerAnnouncement` | Maintainer's repo announcement | Testing maintainer chain setup | | 259 | | `MaintainerAnnouncement` | Maintainer's repo announcement | Testing maintainer chain setup | |
| 260 | | `MaintainerState` | Maintainer's state event | Testing maintainer push authorization | | 260 | | `MaintainerState` | Maintainer's state event | Testing maintainer push authorization | |
| 261 | | `RepoWithIssue` | Repo + accepted issue (kind 1621) | Testing issue-dependent events | | 261 | | `RepoWithIssue` | Repo + accepted issue (kind 1621) | Testing issue-dependent events | |
| 262 | | `RepoWithComment` | Repo + issue + comment | Testing comment-dependent events | | 262 | | `RepoWithComment` | Repo + issue + comment | Testing comment-dependent events | |
| 263 | 263 | ||
| 264 | ### Fixture Lifecycle: Generate → Send → Verify | 264 | ### Fixture Lifecycle: Generate → Send → Verify |
| 265 | 265 | ||
| @@ -283,6 +283,7 @@ Each TestContext shares a `run_id` with all events: | |||
| 283 | ``` | 283 | ``` |
| 284 | 284 | ||
| 285 | This enables: | 285 | This enables: |
| 286 | |||
| 286 | - Event correlation within a test run | 287 | - Event correlation within a test run |
| 287 | - Production relay cleanup scripts | 288 | - Production relay cleanup scripts |
| 288 | - Test isolation between runs | 289 | - Test isolation between runs |