Skip to content

Commit a36d6a9

Browse files
committed
add usage docs
1 parent dc95a71 commit a36d6a9

File tree

2 files changed

+26
-4
lines changed

2 files changed

+26
-4
lines changed

airbyte_cdk/test/standard_tests/__init__.py

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,31 @@
11
# Copyright (c) 2024 Airbyte, Inc., all rights reserved.
2-
"""Declarative test suites.
2+
'''FAST Airbyte Standard Tests
33
4-
Here we have base classes for a robust set of declarative connector test suites.
5-
"""
4+
This module provides a set of base classes for declarative connector test suites.
5+
The goal of this module is to provide a robust and extensible framework for testing Airbyte
6+
connectors.
7+
8+
Example usage:
9+
10+
```python
11+
# `test_airbyte_standards.py`
12+
from airbyte_cdk.test import standard_tests
13+
14+
pytest_plugins = [
15+
"airbyte_cdk.test.standard_tests.pytest_hooks",
16+
]
17+
18+
19+
class TestSuiteSourcePokeAPI(standard_tests.DeclarativeSourceTestSuite):
20+
"""Test suite for the source."""
21+
```
22+
23+
Available test suites base classes:
24+
- `DeclarativeSourceTestSuite`: A test suite for declarative sources.
25+
- `SourceTestSuiteBase`: A test suite for sources.
26+
- `DestinationTestSuiteBase`: A test suite for destinations.
27+
28+
'''
629

730
from airbyte_cdk.test.standard_tests.connector_base import (
831
ConnectorTestScenario,

airbyte_cdk/test/standard_tests/connector_base.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,6 @@
2828
MANIFEST_YAML = "manifest.yaml"
2929

3030

31-
3231
class ConnectorTestSuiteBase(abc.ABC):
3332
"""Base class for connector test suites."""
3433

0 commit comments

Comments
 (0)