Skip to content

feat: implement per-test timeout limits for slow test investigation #780

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat: implement per-test timeout limits for slow test investigation #780

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6415232
feat: implement per-test timeout limits for slow test investigation
devin-ai-integration[bot] Sep 9, 2025
61d117c
fix: resolve timeout configuration conflict in pyproject.toml
devin-ai-integration[bot] Sep 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/workflows/python_pytest.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,8 @@ jobs:
run: >
poetry run coverage run -m pytest
--verbose
--timeout=300
--session-timeout=3600
-m "not linting and not super_slow and not flaky"

- name: Print Coverage Report
Expand Down
40 changes: 40 additions & 0 deletions docs/timeout_configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Test Timeout Configuration

This document explains PyAirbyte's test timeout configuration to prevent CI timeouts, particularly on Windows.

## Current Configuration

- **Global test timeout**: 600 seconds (10 minutes) per test
- **CI job timeout**: 60 minutes for pytest jobs
- **pytest-timeout plugin**: v2.4.0 installed

Comment on lines +7 to +10
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Version mismatch: plugin version in doc vs dependency.

Doc says “pytest-timeout v2.4.0 installed,” but pyproject pins ^2.3.1. Either bump the dep or reword to “pytest-timeout >=2.3.0,” wdyt? Note: --session-timeout is available since 2.3.0. (pypi.org)

🤖 Prompt for AI Agents 
In docs/timeout_configuration.md around lines 7 to 10, the documented
pytest-timeout version (v2.4.0) conflicts with pyproject which pins ^2.3.1;
update the doc to match the dependency by either changing the text to
“pytest-timeout >=2.3.0” (or “pytest-timeout v2.3.x”) or bumping the pyproject
dependency to >=2.4.0, and mention that --session-timeout is available since
2.3.0 if you keep the lower bound.

## Timeout Strategy

### Per-Test Timeouts
- **Unit tests**: 60 seconds (fast execution expected)
- **Integration tests**: 180 seconds (3 minutes for data operations)
- **Slow tests**: Use existing 600 second global timeout

### Session Timeouts
- **Full test suite**: 3600 seconds (1 hour maximum)
- **Windows CI**: Limited to unit tests only to prevent timeouts

Comment on lines +18 to +21
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Windows scope is inaccurate.

Doc says “Windows CI: Limited to unit tests,” but the workflow runs the full matrix on Windows. Shall we update this to reflect current behavior, wdyt?

🤖 Prompt for AI Agents 
In docs/timeout_configuration.md around lines 18 to 21, the "Windows CI: Limited
to unit tests only" bullet is inaccurate; replace that line to state that
Windows CI runs the full workflow/matrix (not just unit tests) and is subject to
the same session timeout as other platforms (e.g., "Windows CI: Runs full
matrix; subject to the same 3600s session timeout"), and ensure the phrasing
matches surrounding bullets and CI behavior.

## Usage Examples

```bash
# Run tests with custom per-test timeout
pytest --timeout=120 tests/unit_tests/

# Run integration tests with timeout and duration reporting
poetry run poe test-integration-timeout

# Analyze slow test patterns
poetry run poe test-slow-analysis
```

## Slow Test Analysis

The following integration tests are marked as slow and may cause Windows CI timeouts:
- source-faker tests with 200-300 record scales
- Tests parametrized across multiple cache types (DuckDB, Postgres, BigQuery, Snowflake)
- Docker-based tests (slower on Windows due to Docker performance)
Loading