robotframework-okw-env-docker

Docker Compose provider for okw-env.

Deutsche Version: README_de.md

What

Implements the OKW Environment Provider Contract using Docker Compose. Generates docker-compose.yml from YAML component definitions and manages the full container lifecycle (create, start, health check, logs, snapshot, stop, destroy).

Why — Signal vs. NOISE

Docker Compose syntax is NOISE. The tester only writes:

ENV_Start        PostgresDB
ENV_BuildAndRun
ENV_WaitForReady PostgresDB

The framework generates the Compose file, starts the container, and polls the health check. No Docker knowledge required in test code.

Install

pip install robotframework-okw-env-docker

This automatically installs robotframework-okw-env (core) and robotframework-docker (Docker Compose engine).

Component YAML

PostgresDB:
  provider: docker
  image: postgres
  version: "17"
  port: 5432
  env:
    POSTGRES_DB: testdb
    POSTGRES_PASSWORD: testpass
  healthcheck: "pg_isready -U postgres"
  timeout: 30s

Minimal Example

*** Settings ***
Library    okw_env.library.OkwEnvLibrary    components_dir=components    WITH NAME    ENV

*** Test Cases ***
Database Is Reachable
    ENV_Start        PostgresDB
    ENV_BuildAndRun
    ENV_WaitForReady    PostgresDB
    Log    PostgresDB is ready for testing.
    [Teardown]    ENV_Stop

Architecture

okw-env (keywords, YAML loader, registry)
    │
    ▼
okw-env-docker (this library)
    │
    ▼
DockerComposeLibrary (robotframework-docker)
    │
    ▼
Docker Compose CLI → Docker Engine

Documentation

• CONTRACT.md — How this provider implements the contract
• SPECIFICATION.md — Lifecycle, isolation, snapshot model
• KEYWORDS.md — Keyword reference with examples