ngit-grasp/grasp-audit/README.md

GRASP Audit

A reusable audit and compliance testing tool for GRASP protocol implementations.

Features

• ✅ Isolated Testing: Tests run in parallel with unique audit IDs
• ✅ Production Audit: Test live services with minimal impact
• ✅ Clean Audit Events: Special tags for easy cleanup (no deletion trails)
• ✅ Spec-Mirrored Tests: Test structure matches GRASP protocol exactly
• ✅ Reusable: Can test any GRASP implementation (Rust, Go, Python, etc.)

Quick Start

The fastest way to run GRASP-01 compliance tests:

# Run the test suite against ngit-relay
cd grasp-audit
nix develop -c bash test-ngit-relay.sh --mode test

This automatically:

• ✅ Starts ngit-relay in an isolated Docker container
• ✅ Runs all GRASP-01 compliance tests
• ✅ Cleans up resources when finished

Currently Passing: 4/18 tests (14 tests stubbed with "Not implemented yet")

For more options:

./test-ngit-relay.sh --help

Usage Examples

As a Library

use grasp_audit::*;

#[tokio::main]
async fn main() -> Result<()> {
    // Create audit client for CI testing
    let config = AuditConfig::ci();
    let client = AuditClient::new("ws://localhost:7000", config).await?;

    // Run NIP-01 smoke tests
    let results = specs::Nip01SmokeTests::run_all(&client).await;
    results.print_report();

    if !results.all_passed() {
        std::process::exit(1);
    }

    Ok(())
}

As a CLI Tool

# Install
cargo install --path .

# Run smoke tests against local relay
grasp-audit audit --relay ws://localhost:7000 --mode ci --spec nip01-smoke

# Audit production server
grasp-audit audit --relay wss://grasp.example.com --mode production --spec all

Test Specifications

NIP-01 Smoke Tests (6 tests)

Basic Nostr relay functionality:

1. websocket_connection - Can connect to /
2. send_receive_event - Can send EVENT, get OK
3. create_subscription - Can subscribe with REQ
4. close_subscription - Can close subscriptions
5. reject_invalid_signature - Rejects bad signatures
6. reject_invalid_event_id - Rejects wrong IDs

Why only smoke tests? rust-nostr already has 1000+ tests for NIP-01 compliance. We focus on GRASP-specific behavior.

GRASP-01 Tests (Coming Soon)

• Repository announcement acceptance
• State event handling
• Policy enforcement
• And more...

Audit Event Strategy

All audit events automatically include special tags for isolation and cleanup:

{
  "tags": [
    ["t", "grasp-audit-test-event"],
    ["t", "audit-ci-a1b2c3d4-e5f6-7890-abcd-ef1234567890"],
    ["t", "audit-cleanup-after-1730822334"]
  ]
}

Tag Format:

• ["t", "grasp-audit-test-event"] - Identifies all audit-related events
• ["t", "audit-{run_id}"] - Unique identifier for each audit run
  • CI mode: audit-ci-{uuid}
  • Production mode: audit-prod-audit-{timestamp}
• ["t", "audit-cleanup-after-{unix_timestamp}"] - Cleanup scheduling
  • CI mode: Current time + 3600 seconds (1 hour)
  • Production mode: Current time + 300 seconds (5 minutes)

Benefits:

• Automatic: Tags added automatically to all events via AuditEventBuilder
• Isolation: Each test run has unique ID for event filtering
• Cleanup: Events marked for cleanup after timestamp (direct database cleanup)
• No deletion trails: No NIP-09 deletion events needed
• Discovery: Easy to query all audit events via hashtag

Modes

CI Mode (Default)

• Tests are isolated by unique run ID
• Tests only see their own events
• Full read/write access
• Cleanup after 1 hour

let config = AuditConfig::ci();

Production Mode

• Tests see all events (including real ones)
• Read-only by default (minimal impact)
• Cleanup after 5 minutes

let config = AuditConfig::production();

Examples

See examples/ directory:

# Simple audit example
cargo run --example simple_audit

Testing

TL;DR: See the Quick Start section for the fastest way to run tests.

Unit Tests

# Enter dev environment (NixOS)
nix develop

# Run unit tests (no relay required)
cargo test

Integration Tests

The recommended approach is test-ngit-relay.sh, which handles all relay lifecycle management automatically.

See the Quick Start section for common usage patterns.

Advanced: Manual Relay Setup

Click to expand manual testing instructions

For advanced use cases where you need direct control over the relay:

# Start relay on a specific port (example uses 18081)
docker run --rm -p 18081:8081 ghcr.io/danconwaydev/ngit-relay:latest

# In another terminal, run tests with RELAY_URL
grasp-audit audit --relay ws://localhost:18081 --mode ci

# or run all ignored tests via cargo
RELAY_URL="ws://localhost:18081" cargo test --lib -- --ignored --nocapture

# or run specific test via cargo
RELAY_URL="ws://localhost:18081" cargo test --lib test_grasp01_nostr_relay_against_relay -- --ignored --nocapture

Architecture

grasp-audit/
├── src/
│   ├── lib.rs              # Public API
│   ├── audit.rs            # Audit config and event tagging
│   ├── client.rs           # Audit client
│   ├── result.rs           # Test result types
│   ├── isolation.rs        # Test isolation utilities
│   └── specs/
│       ├── mod.rs
│       └── nip01_smoke.rs  # NIP-01 smoke tests
├── examples/
│   └── simple_audit.rs     # Example usage
└── bin/
    └── grasp-audit.rs      # CLI tool

Development Status

• ✅ Audit framework
• ✅ NIP-01 smoke tests (6 tests)
• 🚧 GRASP-01 relay tests (planned)
• 🚧 GRASP-01 git tests (planned)
• 🚧 Cleanup utilities (planned)

Contributing

This tool is designed to be reusable by any GRASP implementation. Contributions welcome!

License

MIT