Files
Eduard van Valkenburg a2856d3b92 Python: restructure: Python samples into progressive 01-05 layout (#3862)
* restructure: Python samples into progressive 01-05 layout

- 01-get-started/: 6 numbered steps (hello agent → hosting)
- 02-agents/: all agent concept samples (tools, middleware, providers, etc.)
- 03-workflows/: ALL existing workflow samples preserved as-is
- 04-hosting/: azure-functions, durabletask, a2a
- 05-end-to-end/: demos, evaluation, hosted agents
- Old files moved to _to_delete/ for review
- Added AGENTS.md with structure documentation
- autogen-migration/ and semantic-kernel-migration/ preserved at root

* fix: switch to AzureOpenAI Foundry, fix CI failures

- Switch all 01-get-started samples to AzureOpenAIResponsesClient with
  Azure AI Foundry project endpoint (AZURE_AI_PROJECT_ENDPOINT +
  AZURE_OPENAI_RESPONSES_DEPLOYMENT_NAME + AzureCliCredential)
- Add _to_delete/ and 05-end-to-end/ to pyrightconfig.samples.json excludes
- Fix test paths in packages/ that referenced old getting_started/ dirs:
  durabletask conftest + streaming test, azurefunctions conftest,
  devui conftest + capture_messages + openai_sdk_integration
- Fix workflow_as_agent_human_in_the_loop.py import (sibling import)
- Update hosting READMEs and tool comment paths
- Replace root README.md with new structure overview
- Update AGENTS.md to document Azure OpenAI Foundry as default provider

* cleanup: remove _to_delete folder, copy resource files to active dirs

All files in _to_delete/ were either:
- Exact duplicates of files in the new structure (240 files)
- Same file with only comment path updates (100 files)
- One import-fix diff (workflow_as_agent_human_in_the_loop.py)
- One superseded minimal_sample.py

Resource files (sample.pdf, countries.json, employees.pdf, weather.json)
copied to 02-agents/sample_assets/ and 02-agents/resources/ since active
samples reference them.

* fix: address PR review comments, centralize resources, remove root duplicates

- Fix type annotation in 04_memory.py (string union -> proper types)
- Fix old sample paths in observability files
- Fix grammar/spelling in observability samples
- Move sample_assets/ and resources/ to shared/ folder
- Remove 8 duplicate observability files from 02-agents root
- Update resource path references in multimodal_input and provider samples

* fix: update broken links from old getting_started paths to new structure

- Update relative paths in READMEs: getting_started/ → 01-get-started/,
  02-agents/, 03-workflows/, 04-hosting/, 05-end-to-end/
- Fix absolute GitHub URLs in package READMEs
- Fix broken link in ollama package README

* fix: convert absolute GitHub URLs to relative paths for link checker

Absolute URLs to python/samples/ on main branch 404 until PR merges.
Converted to relative paths that linkspector can verify locally.

* fix: update link for handoff sample moved to orchestrations/

* fix: update chatkit-integration README path from demos/ to 05-end-to-end/

* fix: update broken links in orchestrations README to match flat directory structure
a2856d3b92 · 2026-02-12 17:36:36 +00:00
History
..

Sample Integration Tests

Integration tests that validate the Durable Agent Framework samples by running them against a Durable Task Scheduler (DTS) instance.

Setup

1. Create .env file

Copy .env.example to .env and fill in your Azure credentials:

cp .env.example .env

Required variables:

  • AZURE_OPENAI_ENDPOINT
  • AZURE_OPENAI_CHAT_DEPLOYMENT_NAME
  • AZURE_OPENAI_API_KEY (optional if using Azure CLI authentication)
  • RUN_INTEGRATION_TESTS (set to true)
  • ENDPOINT (default: http://localhost:8080)
  • TASKHUB (default: default)

Optional variables (for streaming tests):

  • REDIS_CONNECTION_STRING (default: redis://localhost:6379)
  • REDIS_STREAM_TTL_MINUTES (default: 10)

2. Start required services

Durable Task Scheduler:

docker run -d --name dts-emulator -p 8080:8080 -p 8082:8082 mcr.microsoft.com/dts/dts-emulator:latest
  • Port 8080: gRPC endpoint (used by tests)
  • Port 8082: Web dashboard (optional, for monitoring)

Redis (for streaming tests):

docker run -d --name redis -p 6379:6379 redis:latest
  • Port 6379: Redis server endpoint

Running Tests

The tests automatically start and stop worker processes for each sample.

Run all sample tests

uv run pytest packages/durabletask/tests/integration_tests -v

Run specific sample

uv run pytest packages/durabletask/tests/integration_tests/test_01_single_agent.py -v

Run with verbose output

uv run pytest packages/durabletask/tests/integration_tests -sv

How It Works

Each test file uses pytest markers to automatically configure and start the worker process:

pytestmark = [
    pytest.mark.sample("03_single_agent_streaming"),
    pytest.mark.integration_test,
    pytest.mark.requires_azure_openai,
    pytest.mark.requires_dts,
    pytest.mark.requires_redis,
]

Troubleshooting

Tests are skipped: Ensure RUN_INTEGRATION_TESTS=true is set in your .env file.

DTS connection failed: Check that the DTS emulator container is running: docker ps | grep dts-emulator

Redis connection failed: Check that Redis is running: docker ps | grep redis

Missing environment variables: Ensure your .env file contains all required variables from .env.example.

Tests timeout: Check that Azure OpenAI credentials are valid and the service is accessible.

If you see "DTS emulator is not available":

  • Ensure Docker container is running: docker ps | grep dts-emulator
  • Check port 8080 is not in use by another process
  • Restart the container if needed

Azure OpenAI Errors

If you see authentication or deployment errors:

  • Verify your AZURE_OPENAI_ENDPOINT is correct
  • Confirm AZURE_OPENAI_CHAT_DEPLOYMENT_NAME matches your deployment
  • If using API key, check AZURE_OPENAI_API_KEY is valid
  • If using Azure CLI, ensure you're logged in: az login

CI/CD

For automated testing in CI/CD pipelines:

  1. Use Docker Compose to start DTS emulator
  2. Set environment variables via CI/CD secrets
  3. Run tests with appropriate markers: pytest -m integration_test