Scrutineer Documentation

Getting Started

• Getting Started — Quick introduction and first test

Guides

• Installation — Install from source, pre-built binaries, browser setup
• Writing Tests — Test structure, assertions, captures, fixtures, best practices
• Browser Testing — Headless browser automation with Chromium, Firefox, WebKit
• Load Testing — Concurrent execution, ramp-up, distributed SSH nodes, metrics
• Fuzz Testing — Declarative fuzz targets, corpus management, input generation
• CI Integration — GitHub Actions, JSON output, exit codes, Docker

Connector Reference

• CLI — Process execution, stdin/stdout, filesystem assertions
• HTTP — REST APIs, TLS, authentication
• GraphQL — Queries, mutations, subscriptions, introspection
• SSH — Remote command execution, tunneling
• gRPC — Unary and streaming RPCs, protobuf, reflection
• Browser — CDP automation, selectors, interactions, screenshots

Reference

• Assertions — All assertion types and operators
• Configuration — scrutineer.yaml fields and CLI flags
• CLI Commands — All commands, subcommands, and flags
• Exit Codes — Process exit codes and CI handling
• Telemetry — TLV binary log format specification
• Variables — Interpolation, fixtures, captures, environment

Architecture

• Overview — Module structure, data flow, engine design
• Extending — Writing custom connectors and assertions

Contributing

• Development — Repo setup, testing, code style, hooks
• Versioning — Semver policy, release process

Examples

• REST API — CRUD operations with auth and captures
• CLI Tool — Process execution and filesystem checks
• gRPC Service — Unary and streaming RPCs
• Browser Login — Login flow with form interaction
• Load Test — Concurrent load with metrics