Skip to content

docker.md

Latest commit

 

History

History
104 lines (73 loc) · 3.32 KB

docker.md

File metadata and controls

104 lines (73 loc) · 3.32 KB

Docker Support

Open-AutoTools can be tested across multiple platforms using Docker containers.

Usage

# Go to docker directory
cd docker

# Run full matrix (3.10 -> 3.14) x (ubuntu/macos/windows) concurrently (DEFAULT)
docker-compose build
docker-compose up

# Run single-version services (ubuntu/macos/windows) with default Python (3.12)
COMPOSE_PROFILES=single docker-compose build
COMPOSE_PROFILES=single docker-compose up

# Run single-version services with a specific Python version (example: 3.13, 3.14)
PYTHON_VERSION=3.13 COMPOSE_PROFILES=single docker-compose build
PYTHON_VERSION=3.13 COMPOSE_PROFILES=single docker-compose up

# Run a single matrix service (example: Ubuntu / Python 3.14)
docker-compose up ubuntu-py314

# Run the full matrix sequentially (LOWER DISK USAGE)
./run_matrix.sh

# Run only one platform in single-version mode (enable profile)
COMPOSE_PROFILES=single docker-compose up ubuntu    # For Ubuntu
COMPOSE_PROFILES=single docker-compose up macos     # For macOS
COMPOSE_PROFILES=single docker-compose up windows   # For Windows

# Clean up
docker-compose down --remove-orphans

Notes

  • macos/windows services: they run Linux containers (python:X.Y-slim) but set PLATFORM to exercise platform-specific code paths.
  • Ubuntu Python patch versions: Ubuntu images install pythonX.Y via deadsnakes on Ubuntu 24.04, so patch versions can differ (example: 3.12.3). Slim images use official python:X.Y-slim (example: 3.12.x).
  • Disk usage: if Docker Desktop runs out of space (example: no space left on device while exporting layers), prune build cache and dangling images:
docker system df
docker builder prune -af
docker image prune -af
docker volume prune -f

Test suite + smoke tests

By default, each container runs:

  • autotools test (full pytest suite + coverage)
  • then autotools smoke (CLI smoke runner, auto-discovery)

You can disable either step:

# Skip full pytest suite, run smoke only
RUN_AUTOTOOLS_TEST=0 docker-compose up

# Skip smoke, run full pytest suite only
RUN_AUTOTOOLS_SMOKE=0 docker-compose up

The smoke runner (autotools smoke) auto-detects tools, so you do not need to edit docker/run_tests.sh when you add a new tool.

Adding a new tool to smoke

  • Required: add a package autotools/<tool>/ with a commands.py that exposes a @click.command() (the command name should match the folder name).
  • Recommended: define SMOKE_TESTS in autotools/<tool>/commands.py so the smoke test is deterministic (otherwise it will try a best-effort default invocation).

Example:

# SMOKE TEST CASES (USED BY 'autotools smoke')
SMOKE_TESTS = [
    {"name": "basic", "args": ["hello", "world"]},
    {"name": "flags", "args": ["--some-flag"]},
]

To quickly verify:

# Lists detected tools
autotools list-tools

# Runs smoke only for one tool
autotools smoke --include <tool> --verbose

Platform Support

Each platform-specific container includes:

  • Python environment (default: 3.12, configurable with PYTHON_VERSION, matrix: 3.10 -> 3.14)
  • All required dependencies (FFmpeg, Java, etc.)
  • Automated test suite
  • Volume mapping for persistent data

Note: The Docker setup is primarily for testing and development. For regular use, install via pip as described in installation.md.