Skip to content

RUNNING_TESTS.md

Latest commit

 

History

History
158 lines (108 loc) · 3.78 KB

RUNNING_TESTS.md

File metadata and controls

158 lines (108 loc) · 3.78 KB
Raw

Running Unit Tests for Agent365-Python SDK

This guide covers setting up and running tests.

Prerequisites

1. Create Virtual Environment

# Create virtual environment using uv
uv venv

# Activate the virtual environment
.\.venv\Scripts\Activate.ps1

2. Configure Python Environment

  1. Press Ctrl+Shift+P
  2. Type "Python: Select Interpreter"
  3. Choose the .venv interpreter from the list

3. Install Dependencies

# Install all eight remaining workspace libraries and their test/development extras.
$env:PYTHONPATH = Join-Path (Get-Location) "versioning\helper"
uv sync --locked --all-extras --dev

Test Structure

Note: This structure will be updated as new tests are added.

tests/
├── runtime/                           # Runtime tests
├── tooling/                           # Tooling tests
└── test_*.py                          # Build, distribution metadata, constraints, release gates

All remaining tests are offline/mocked. The retired observability suite contained the live integration tests, so its credential-only examples and CI/tox integration job have been removed. The integration marker is reserved for future real-service tests; selecting it currently collects no tests.

Running Tests in VS Code (Optional)

Test Explorer

  1. Click the beaker icon in the Activity Bar or press Ctrl+Shift+P → "Test: Focus on Test Explorer View"
  2. Click the play button to run tests (all/folder/file/individual)
  3. Right-click → "Debug Test" to debug with breakpoints

Command Palette

  • Test: Run All Tests
  • Test: Run Tests in Current File
  • Test: Debug Tests in Current File

Running Tests from Command Line

# Run all tests
python -m pytest tests/

# Run specific module/file
python -m pytest tests/runtime/
python -m pytest tests/runtime/test_environment_utils.py

# Run with options
python -m pytest tests/ -v                    # Verbose
python -m pytest tests/ -x                    # Stop on first failure
python -m pytest tests/ -k "environment"      # Pattern matching
python -m pytest --lf                         # Re-run failed tests

Generating Reports

HTML Reports

# Coverage report
python -m pytest tests/ --cov=libraries --cov-report=html -v

# View reports
start htmlcov\index.html

# Test report (requires: uv pip install pytest-html)
python -m pytest tests/ --html=test-report.html --self-contained-html

# View reports
start test-report.html

# Combined (requires: uv pip install pytest-html)
python -m pytest tests/ --cov=libraries --cov-report=html --html=test-report.html --self-contained-html -v

# View reports
start htmlcov\index.html

CI/CD Reports

# XML reports for CI/CD pipelines
python -m pytest tests/ --cov=libraries --cov-report=xml --junitxml=test-results.xml

# View reports
start test-results.xml
start coverage.xml

Troubleshooting

Common Issues

Issue Solution
Test loading failed Clean pyproject.toml, reinstall packages, restart VS Code
ImportError: No module named 'pytest' uv pip install pytest pytest-asyncio pytest-mock
ImportError: No module named 'microsoft_agents_a365' uv sync --locked --all-extras --dev
Tests not discovered Refresh Test Explorer or restart VS Code

Fix Steps

If tests fail to discover or import errors occur:

1. Clean pyproject.toml

$content = Get-Content "pyproject.toml" -Raw
$fixed = $content -replace "`r`n", "`n"
$fixed | Set-Content "pyproject.toml" -NoNewline

2. Reinstall packages

uv sync --locked --all-extras --dev

3. Restart VS Code

  • Close completely and reopen
  • Wait for Python extension to reload
  • Refresh Test Explorer