Get the FREE Ultimate OpenClaw Setup Guide →

temporal-python-testing

Scanned
npx machina-cli add skill wshobson/agents/temporal-python-testing --openclaw
Files (1)
SKILL.md
4.8 KB

Temporal Python Testing Strategies

Comprehensive testing approaches for Temporal workflows using pytest, progressive disclosure resources for specific testing scenarios.

When to Use This Skill

  • Unit testing workflows - Fast tests with time-skipping
  • Integration testing - Workflows with mocked activities
  • Replay testing - Validate determinism against production histories
  • Local development - Set up Temporal server and pytest
  • CI/CD integration - Automated testing pipelines
  • Coverage strategies - Achieve ≥80% test coverage

Testing Philosophy

Recommended Approach (Source: docs.temporal.io/develop/python/testing-suite):

  • Write majority as integration tests
  • Use pytest with async fixtures
  • Time-skipping enables fast feedback (month-long workflows → seconds)
  • Mock activities to isolate workflow logic
  • Validate determinism with replay testing

Three Test Types:

  1. Unit: Workflows with time-skipping, activities with ActivityEnvironment
  2. Integration: Workers with mocked activities
  3. End-to-end: Full Temporal server with real activities (use sparingly)

Available Resources

This skill provides detailed guidance through progressive disclosure. Load specific resources based on your testing needs:

Unit Testing Resources

File: resources/unit-testing.md When to load: Testing individual workflows or activities in isolation Contains:

  • WorkflowEnvironment with time-skipping
  • ActivityEnvironment for activity testing
  • Fast execution of long-running workflows
  • Manual time advancement patterns
  • pytest fixtures and patterns

Integration Testing Resources

File: resources/integration-testing.md When to load: Testing workflows with mocked external dependencies Contains:

  • Activity mocking strategies
  • Error injection patterns
  • Multi-activity workflow testing
  • Signal and query testing
  • Coverage strategies

Replay Testing Resources

File: resources/replay-testing.md When to load: Validating determinism or deploying workflow changes Contains:

  • Determinism validation
  • Production history replay
  • CI/CD integration patterns
  • Version compatibility testing

Local Development Resources

File: resources/local-setup.md When to load: Setting up development environment Contains:

  • Docker Compose configuration
  • pytest setup and configuration
  • Coverage tool integration
  • Development workflow

Quick Start Guide

Basic Workflow Test

import pytest
from temporalio.testing import WorkflowEnvironment
from temporalio.worker import Worker

@pytest.fixture
async def workflow_env():
    env = await WorkflowEnvironment.start_time_skipping()
    yield env
    await env.shutdown()

@pytest.mark.asyncio
async def test_workflow(workflow_env):
    async with Worker(
        workflow_env.client,
        task_queue="test-queue",
        workflows=[YourWorkflow],
        activities=[your_activity],
    ):
        result = await workflow_env.client.execute_workflow(
            YourWorkflow.run,
            args,
            id="test-wf-id",
            task_queue="test-queue",
        )
        assert result == expected

Basic Activity Test

from temporalio.testing import ActivityEnvironment

async def test_activity():
    env = ActivityEnvironment()
    result = await env.run(your_activity, "test-input")
    assert result == expected_output

Coverage Targets

Recommended Coverage (Source: docs.temporal.io best practices):

  • Workflows: ≥80% logic coverage
  • Activities: ≥80% logic coverage
  • Integration: Critical paths with mocked activities
  • Replay: All workflow versions before deployment

Key Testing Principles

  1. Time-Skipping - Month-long workflows test in seconds
  2. Mock Activities - Isolate workflow logic from external dependencies
  3. Replay Testing - Validate determinism before deployment
  4. High Coverage - ≥80% target for production workflows
  5. Fast Feedback - Unit tests run in milliseconds

How to Use Resources

Load specific resource when needed:

  • "Show me unit testing patterns" → Load resources/unit-testing.md
  • "How do I mock activities?" → Load resources/integration-testing.md
  • "Setup local Temporal server" → Load resources/local-setup.md
  • "Validate determinism" → Load resources/replay-testing.md

Additional References

  • Python SDK Testing: docs.temporal.io/develop/python/testing-suite
  • Testing Patterns: github.com/temporalio/temporal/blob/main/docs/development/testing.md
  • Python Samples: github.com/temporalio/samples-python

Source

git clone https://github.com/wshobson/agents/blob/main/plugins/backend-development/skills/temporal-python-testing/SKILL.mdView on GitHub

Overview

Temporal Python Testing Strategies offers structured guidance for testing Temporal workflows from unit to end-to-end. It covers time-skipping, activity mocking, replay testing for determinism, and local development setups to accelerate feedback and improve reliability.

How This Skill Works

The guide shows how to write tests with pytest and async fixtures, using WorkflowEnvironment.start_time_skipping for fast execution and ActivityEnvironment to isolate activities. It categorizes tests into unit, integration, and end-to-end types and provides progressive resources to load as needed.

When to Use It

  • Unit testing workflows with time-skipping to run fast
  • Integration testing with mocked activities to exercise workflow logic
  • Replay testing to validate determinism against production histories
  • Local development setup with a Temporal server and pytest for rapid iteration
  • CI/CD pipelines that enforce coverage and regression checks

Quick Start

  1. Step 1: Create a pytest fixture that starts a WorkflowEnvironment with start_time_skipping
  2. Step 2: Run a Worker for your workflows and activities and execute the workflow in tests
  3. Step 3: Run pytest and verify results with assertions

Best Practices

  • Prefer integration tests over isolated unit tests when possible
  • Use time-skipping to accelerate long-running workflows
  • Mock external activities to isolate workflow logic and failure modes
  • Validate determinism with replay testing against known histories
  • Structure tests with async pytest fixtures for reliable isolation

Example Use Cases

  • Unit-test a long-running workflow by advancing simulated time
  • Test a multi-activity workflow using ActivityEnvironment mocks
  • Replay-test a workflow to ensure determinism with production histories
  • Spin up a local Temporal server (Docker Compose) for development testing
  • Incorporate pytest-based tests into CI/CD for coverage gating

Frequently Asked Questions

Add this skill to your agents
Sponsor this space

Reach thousands of developers