home / skills / sickn33 / antigravity-awesome-skills / temporal-python-testing

temporal-python-testing skill

/skills/temporal-python-testing

This skill helps you test Temporal Python workflows efficiently using time-skipping, mocks, and replay testing for fast, reliable development.

This is most likely a fork of the temporal-python-testing skill from xfstudio
npx playbooks add skill sickn33/antigravity-awesome-skills --skill temporal-python-testing

Review the files below or copy the command above to add this skill to your agents.

Files (5)
SKILL.md
5.2 KB
---
name: temporal-python-testing
description: Test Temporal workflows with pytest, time-skipping, and mocking strategies. Covers unit testing, integration testing, replay testing, and local development setup. Use when implementing Temporal workflow tests or debugging test failures.
---

# Temporal Python Testing Strategies

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

## Do not use this skill when

- The task is unrelated to temporal python testing strategies
- You need a different domain or tool outside this scope

## Instructions

- Clarify goals, constraints, and required inputs.
- Apply relevant best practices and validate outcomes.
- Provide actionable steps and verification.
- If detailed examples are required, open `resources/implementation-playbook.md`.

## Use this skill when

- **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

```python
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

```python
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

Overview

This skill helps you test Temporal Python workflows using pytest, time-skipping, and activity mocking. It covers unit tests, integration tests, replay testing, and local development setup so you can get fast, reliable feedback. Use it to design tests that are deterministic, fast, and easy to run locally or in CI.

How this skill works

The skill describes test environments and patterns: WorkflowEnvironment with time-skipping for fast workflow execution, ActivityEnvironment for isolated activity tests, and worker-based integration setups for mocked activities. It explains replay testing to validate determinism against production histories and provides Docker/pytest guidance for local and CI runs. Examples and fixtures show how to start environments, run workflows, and assert outcomes.

When to use it

  • Writing unit tests for workflow logic that must run quickly (time-skipping).
  • Creating integration tests that exercise workflow-to-activity interactions with mocked activities.
  • Validating determinism or debugging failures by replaying production histories.
  • Setting up a local Temporal server and pytest for developer feedback loops.
  • Adding Temporal tests into CI/CD pipelines for automated verification.

Best practices

  • Prefer integration-style tests for most workflow logic while keeping activities well-covered by unit tests.
  • Use time-skipping to compress long timers/schedules into milliseconds for fast feedback.
  • Mock external dependencies and activities to isolate workflow decision logic.
  • Run replay tests against production histories before deploying workflow changes to catch nondeterminism.
  • Aim for ≥80% coverage for workflows and activities on critical paths.

Example use cases

  • Unit test a retry/backoff branch with WorkflowEnvironment and manual time advancement.
  • Integration test a multi-activity workflow using Worker with mocked activity implementations and injected errors.
  • Replay-test a workflow version using a recorded production history to validate determinism.
  • Local development: run Temporal via Docker Compose and execute pytest fixtures for rapid iteration.
  • CI pipeline: spin up a lightweight Temporal test server and run integration+replay suites before merge.

FAQ

How do I test month-long timers quickly?

Use WorkflowEnvironment time-skipping or manual time advancement so timers elapse instantly in tests.

When should I mock activities vs run real ones?

Mock activities to isolate workflow logic and speed tests; run real activities sparingly for end-to-end verification or when validating integration behavior.