Skip to content

Walkthrough

This walkthrough guides you through the complete Testlab lifecycle — from writing your first YAML tests, through compiling them into a portable .tck package, to executing tests and interpreting results.

What You'll Build

By the end of this walkthrough, you will have:

  1. Written two YAML tests that validate connector data exchange end-to-end
  2. Organized them into a TCK with shared variables and supporting assets
  3. Compiled the TCK into a distributable .tck package
  4. Executed the tests against live connectors and reviewed the results

Workflow Overview

flowchart LR
    subgraph "1. Write"
        A["YAML tests<br/>+ assets<br/>+ TCK definition"]
    end

    subgraph "2. Compile"
        B["Validate & package<br/><code>testlab compile</code>"]
    end

    subgraph "3. Execute"
        C["Run tests<br/><code>testlab run</code>"]
    end

    subgraph "4. Results"
        D["Console summary<br/>+ CloudEvents trace"]
    end

    A --> B --> C --> D

    style A fill:#0288d133,stroke:#0288d1
    style B fill:#f57c0033,stroke:#f57c00
    style C fill:#7b1fa233,stroke:#7b1fa2
    style D fill:#388e3c33,stroke:#388e3c

Prerequisites

  • Python 3.12+
  • tractusx-testlab installed (pip install --pre tractusx-testlab) — see Installation
  • For the connector tests, a connector for the engine and one for the system under test (management URLs, API keys, DSP endpoint and participant IDs)

Sections

Section Description
Writing Tests Create YAML tests, declare variables, define steps and assertions, organize into a TCK with assets
Compiling Packages Validate and package tests into .tck, inspect the compiled output, sign and encrypt for a player
Executing Tests Bind infrastructure, run tests via CLI, provide runtime variables, read results, use the Player API and the server

NOTICE

This work is licensed under the CC-BY-4.0.