Skip to content

Documentation Map

Every part of the TestLab documentation, grouped by section. Not sure where to begin? Find your role first, then follow the section it points to.

Find your path

Home

Page What it covers
Welcome What TestLab is, and a five-minute quick start with the testlab CLI
Overview How a test goes from YAML to a result
Installation Every way to install the package and the testlab CLI
Documentation Map This page

Specification

The requirements specification for the TestLab module, and a guided walkthrough of its lifecycle. The YAML authoring syntax is not part of it — see TCK Syntax.

Page What it covers
Introduction Executive summary, goals and non-goals of the specification
Concepts & Terminology The core layers — authoring, compilation, packaging, execution, server — and the vocabulary
Functional Requirements What the engine must do, requirement by requirement
Data Models Enumerations and the authoring, compile-time and run-time models
Constraints & Verification Technical constraints and quality attributes
Package Security Why and how .tck packages are signed and encrypted
Walkthrough The full lifecycle, from first test to interpreted results
Writing Tests Creating a TCK project from scratch
Compiling Packages Validating tests and compiling them into a portable .tck
Executing Tests Running packages against live connectors and reading the results

TCK Syntax

Page What it covers
Syntax Reference The complete v1-alpha syntax for TCK manifests and tests
Cheat Sheet A one-page quick reference for authors

Tutorials

Page What it covers
Your First TCK Install the package, write a two-test TCK, validate and run it
Certificate Management The shipped CX-0135 suite: business, developer and architecture guides and the test reference
Create a Step Add a step: its id, the module it lives in, its contract, tests and reference page
Add an Assertion Operator Add an operator to the validate: vocabulary
Add an Infrastructure Capability Let a TCK require, and a run bind, a new kind of service
Add a Validation Rule Catch a TCK mistake at validation time
Development Workflow The checks CI runs, and where new tests go
Debugging Validation errors, runs that won't start, failed steps and checks

API Reference

Page What it covers
Overview The block-based test authoring system
Steps Every step a test can use, with its parameters and outputs — generated from the code

Developer

For engineers working on the TestLab engine itself.

Page What it covers
Overview Technical handover guide to the engine
Product Scope What TestLab delivers, and what it does not
Architecture The compiler, runner and server, and how they fit together
AI-Assisted Development Working with the project's AI agents
Step Contracts The single canonical contract every step has, one name and one shape per field
Contract Conflict Decisions · Contract Migration Plan How contract conflicts were settled, and the plan to migrate to them
Data Models The engine's internal models
Block Lifecycle How a step works, from YAML to SDK call
Creating a Step Conventions for adding a step
Execution Events The events the engine emits while it runs
Infrastructure Bindings How a TCK's declared requirements are bound to a real deployment
Environment Injection Analysis How environment and context reach a step
Step Reference Drift Report Differences between the documented steps and their implementation
Decision Records The architecture decisions behind TestLab

Contributing

Page What it covers
Guidelines How to contribute to the project