clean up test module structure and pytest hooks

aaronsteers · aaronsteers · commit b045532d83ae · 2025-04-14T19:03:33.000-07:00
diff --git a/airbyte_cdk/test/pytest_config/plugin.py b/airbyte_cdk/test/pytest_config/plugin.py
@@ -1,29 +1,12 @@
 """Global pytest configuration for the Airbyte CDK tests."""
 
-from pathlib import Path
-from typing import cast
-
 import pytest
 
 
-def pytest_collect_file(parent: pytest.Module | None, path: Path) -> pytest.Module | None:
-    """Collect test files based on their names."""
-    if path.name == "test_connector.py":
-        return cast(pytest.Module, pytest.Module.from_parent(parent, path=path))
-
-    return None
-
-
 def pytest_configure(config: pytest.Config) -> None:
-    config.addinivalue_line("markers", "connector: mark test as a connector test")
-
-
-def pytest_addoption(parser: pytest.Parser) -> None:
-    parser.addoption(
-        "--run-connector",
-        action="store_true",
-        default=False,
-        help="run connector tests",
+    config.addinivalue_line(
+        name="markers",
+        line="requires_creds: mark test as a test that requires credentials",
     )
 
 
@@ -34,13 +17,3 @@ def pytest_collection_modifyitems(config: pytest.Config, items: list[pytest.Item
     for item in items:
         if "connector" in item.keywords:
             item.add_marker(skip_connector)
-
-
-def pytest_runtest_setup(item: pytest.Item) -> None:
-    # This hook is called before each test function is executed
-    print(f"Setting up test: {item.name}")
-
-
-def pytest_runtest_teardown(item: pytest.Item, nextitem: pytest.Item | None) -> None:
-    # This hook is called after each test function is executed
-    print(f"Tearing down test: {item.name}")
diff --git a/airbyte_cdk/test/standard_tests/__init__.py b/airbyte_cdk/test/standard_tests/__init__.py
@@ -4,22 +4,20 @@
 Here we have base classes for a robust set of declarative connector test suites.
 """
 
-from airbyte_cdk.test.declarative.test_suites.connector_base import (
+from airbyte_cdk.test.standard_tests.connector_base import (
     ConnectorTestScenario,
     ConnectorTestSuiteBase,
-    generate_tests,
 )
-from airbyte_cdk.test.declarative.test_suites.declarative_sources import (
+from airbyte_cdk.test.standard_tests.declarative_sources import (
     DeclarativeSourceTestSuite,
 )
-from airbyte_cdk.test.declarative.test_suites.destination_base import DestinationTestSuiteBase
-from airbyte_cdk.test.declarative.test_suites.source_base import SourceTestSuiteBase
+from airbyte_cdk.test.standard_tests.destination_base import DestinationTestSuiteBase
+from airbyte_cdk.test.standard_tests.source_base import SourceTestSuiteBase
 
 __all__ = [
     "ConnectorTestScenario",
     "ConnectorTestSuiteBase",
     "DeclarativeSourceTestSuite",
     "DestinationTestSuiteBase",
     "SourceTestSuiteBase",
-    "generate_tests",
 ]
diff --git a/airbyte_cdk/test/standard_tests/connector_base.py b/airbyte_cdk/test/standard_tests/connector_base.py
@@ -28,49 +28,6 @@
 MANIFEST_YAML = "manifest.yaml"
 
 
-def generate_tests(metafunc: pytest.Metafunc) -> None:
-    """
-    A helper for pytest_generate_tests hook.
-
-    If a test method (in a class subclassed from our base class)
-    declares an argument 'scenario', this function retrieves the
-    'scenarios' attribute from the test class and parametrizes that
-    test with the values from 'scenarios'.
-
-    ## Usage
-
-    ```python
-    from airbyte_cdk.test.declarative.test_suites.connector_base import (
-        generate_tests,
-        ConnectorTestSuiteBase,
-    )
-
-    def pytest_generate_tests(metafunc):
-        generate_tests(metafunc)
-
-    class TestMyConnector(ConnectorTestSuiteBase):
-        ...
-
-    ```
-    """
-    # Check if the test function requires an 'scenario' argument
-    if "scenario" in metafunc.fixturenames:
-        # Retrieve the test class
-        test_class = metafunc.cls
-        if test_class is None:
-            raise ValueError("Expected a class here.")
-        # Get the 'scenarios' attribute from the class
-        scenarios_attr = getattr(test_class, "get_scenarios", None)
-        if scenarios_attr is None:
-            raise ValueError(
-                f"Test class {test_class} does not have a 'scenarios' attribute. "
-                "Please define the 'scenarios' attribute in the test class."
-            )
-
-        scenarios = test_class.get_scenarios()
-        ids = [str(scenario) for scenario in scenarios]
-        metafunc.parametrize("scenario", scenarios, ids=ids)
-
 
 class ConnectorTestSuiteBase(abc.ABC):
     """Base class for connector test suites."""
diff --git a/airbyte_cdk/test/standard_tests/declarative_sources.py b/airbyte_cdk/test/standard_tests/declarative_sources.py
@@ -10,11 +10,9 @@
     ConcurrentDeclarativeSource,
 )
 from airbyte_cdk.test.declarative.models import ConnectorTestScenario
-from airbyte_cdk.test.declarative.test_suites.connector_base import MANIFEST_YAML
-from airbyte_cdk.test.declarative.test_suites.source_base import (
-    SourceTestSuiteBase,
-)
 from airbyte_cdk.test.declarative.utils.job_runner import IConnector
+from airbyte_cdk.test.standard_tests.connector_base import MANIFEST_YAML
+from airbyte_cdk.test.standard_tests.source_base import SourceTestSuiteBase
 
 
 def md5_checksum(file_path: Path) -> str:
diff --git a/airbyte_cdk/test/standard_tests/destination_base.py b/airbyte_cdk/test/standard_tests/destination_base.py
@@ -1,7 +1,7 @@
 # Copyright (c) 2024 Airbyte, Inc., all rights reserved.
 """Base class for destination test suites."""
 
-from airbyte_cdk.test.declarative.test_suites.connector_base import ConnectorTestSuiteBase
+from airbyte_cdk.test.standard_tests.connector_base import ConnectorTestSuiteBase
 
 
 class DestinationTestSuiteBase(ConnectorTestSuiteBase):
diff --git a/airbyte_cdk/test/standard_tests/pytest_hooks.py b/airbyte_cdk/test/standard_tests/pytest_hooks.py
@@ -0,0 +1,60 @@
+# Copyright (c) 2025 Airbyte, Inc., all rights reserved.
+"""Pytest hooks for Airbyte CDK tests.
+
+These hooks are used to customize the behavior of pytest during test discovery and execution.
+
+To use these hooks within a connector, add the following lines to the connector's `conftest.py`
+file, or to another file that is imported during test discovery:
+
+```python
+pytest_plugins = [
+    "airbyte_cdk.test.standard_tests.pytest_hooks",
+]
+```
+"""
+import pytest
+
+
+def pytest_generate_tests(metafunc: pytest.Metafunc) -> None:
+    """
+    A helper for pytest_generate_tests hook.
+
+    If a test method (in a class subclassed from our base class)
+    declares an argument 'scenario', this function retrieves the
+    'scenarios' attribute from the test class and parametrizes that
+    test with the values from 'scenarios'.
+
+    ## Usage
+
+    ```python
+    from airbyte_cdk.test.standard_tests.connector_base import (
+        generate_tests,
+        ConnectorTestSuiteBase,
+    )
+
+    def pytest_generate_tests(metafunc):
+        generate_tests(metafunc)
+
+    class TestMyConnector(ConnectorTestSuiteBase):
+        ...
+
+    ```
+    """
+    # Check if the test function requires an 'scenario' argument
+    if "scenario" in metafunc.fixturenames:
+        # Retrieve the test class
+        test_class = metafunc.cls
+        if test_class is None:
+            return
+
+        # Get the 'scenarios' attribute from the class
+        scenarios_attr = getattr(test_class, "get_scenarios", None)
+        if scenarios_attr is None:
+            raise ValueError(
+                f"Test class {test_class} does not have a 'scenarios' attribute. "
+                "Please define the 'scenarios' attribute in the test class."
+            )
+
+        scenarios = test_class.get_scenarios()
+        ids = [str(scenario) for scenario in scenarios]
+        metafunc.parametrize("scenario", scenarios, ids=ids)
diff --git a/airbyte_cdk/test/standard_tests/source_base.py b/airbyte_cdk/test/standard_tests/source_base.py
@@ -16,10 +16,10 @@
 from airbyte_cdk.test.declarative.models import (
     ConnectorTestScenario,
 )
-from airbyte_cdk.test.declarative.test_suites.connector_base import (
+from airbyte_cdk.test.declarative.utils.job_runner import run_test_job
+from airbyte_cdk.test.standard_tests.connector_base import (
     ConnectorTestSuiteBase,
 )
-from airbyte_cdk.test.declarative.utils.job_runner import run_test_job
 
 
 class SourceTestSuiteBase(ConnectorTestSuiteBase):
diff --git a/unit_tests/resources/source_pokeapi_w_components_py/components.py b/unit_tests/resources/source_pokeapi_w_components_py/components.py
@@ -1,7 +1,7 @@
 """A sample implementation of custom components that does nothing but will cause syncs to fail if missing."""
 
 from collections.abc import Iterable, MutableMapping
-from typing import Any, Mapping
+from typing import Any
 
 import requests
 
diff --git a/unit_tests/resources/source_pokeapi_w_components_py/integration_tests/test_airbyte_standards.py b/unit_tests/resources/source_pokeapi_w_components_py/integration_tests/test_airbyte_standards.py
@@ -1,14 +1,11 @@
 # Copyright (c) 2025 Airbyte, Inc., all rights reserved.
 """FAST Airbyte Standard Tests for the source_pokeapi_w_components source."""
 
-from airbyte_cdk.test.declarative.test_suites import (
-    DeclarativeSourceTestSuite,
-    generate_tests,
-)
+from airbyte_cdk.test.standard_tests import DeclarativeSourceTestSuite
 
-
-def pytest_generate_tests(metafunc) -> None:
-    generate_tests(metafunc)
+pytest_plugins = [
+    "airbyte_cdk.test.standard_tests.pytest_hooks",
+]
 
 
 class TestSuiteSourcePokeAPI(DeclarativeSourceTestSuite):
diff --git a/unit_tests/source_declarative_manifest/test_source_declarative_w_custom_components.py b/unit_tests/source_declarative_manifest/test_source_declarative_w_custom_components.py
@@ -32,7 +32,7 @@
     custom_code_execution_permitted,
     register_components_module_from_string,
 )
-from airbyte_cdk.test.declarative.test_suites.connector_base import MANIFEST_YAML
+from airbyte_cdk.test.standard_tests.connector_base import MANIFEST_YAML
 
 SAMPLE_COMPONENTS_PY_TEXT = """
 def sample_function() -> str:

Original file line number	Diff line number	Diff line change
`@@ -16,10 +16,10 @@`
`16`	`16`	`from airbyte_cdk.test.declarative.models import (`
`17`	`17`	`ConnectorTestScenario,`
`18`	`18`	`)`
`19`		`-from airbyte_cdk.test.declarative.test_suites.connector_base import (`
	`19`	`+from airbyte_cdk.test.declarative.utils.job_runner import run_test_job`
	`20`	`+from airbyte_cdk.test.standard_tests.connector_base import (`
`20`	`21`	`ConnectorTestSuiteBase,`
`21`	`22`	`)`
`22`		`-from airbyte_cdk.test.declarative.utils.job_runner import run_test_job`
`23`	`23`
`24`	`24`
`25`	`25`	`class SourceTestSuiteBase(ConnectorTestSuiteBase):`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@`
`32`	`32`	`custom_code_execution_permitted,`
`33`	`33`	`register_components_module_from_string,`
`34`	`34`	`)`
`35`		`-from airbyte_cdk.test.declarative.test_suites.connector_base import MANIFEST_YAML`
	`35`	`+from airbyte_cdk.test.standard_tests.connector_base import MANIFEST_YAML`
`36`	`36`
`37`	`37`	`SAMPLE_COMPONENTS_PY_TEXT = """`
`38`	`38`	`def sample_function() -> str:`