ADD: Release version test for databento-python

Author: nmacholl

.github/workflows/test.yml

@@ -31,5 +31,9 @@ jobs:
           scripts/build.sh
 
       # Run tests
+      - name: Run tests in release mode
+        if: ${{ github.ref == 'refs/heads/main' }}
+        run: scripts/test.sh --release
       - name: Run tests
+        if: ${{ github.ref != 'refs/heads/main' }}
         run: scripts/test.sh

scripts/test.sh

@@ -1,2 +1,2 @@
 #! /usr/bin/env bash
-pytest tests .
+pytest tests . $@

tests/__init__.py

@@ -0,0 +1,5 @@
+import pathlib
+
+
+TESTS_ROOT = pathlib.Path(__file__).absolute().parent
+PROJECT_ROOT = pathlib.Path(__file__).absolute().parent.parent

tests/conftest.py

@@ -0,0 +1,129 @@
+"""Pytest fixtures"""
+import pathlib
+from typing import Callable, Iterable
+
+import pytest
+from databento import Schema
+
+from tests import TESTS_ROOT
+
+
+def pytest_addoption(parser: pytest.Parser) -> None:
+    """
+    Function to customize pytest cli options.
+    This should not be invoked directly.
+
+    Parameters
+    ----------
+    parser : pytest.Parser
+        The pytest argument parser.
+
+    See Also
+    --------
+    pytest.addoption
+
+    """
+    # Add a --release flag
+    parser.addoption(
+        "--release",
+        action="store_true",
+        help="indicates release tests should be run",
+    )
+
+
+def pytest_configure(config: pytest.Config) -> None:
+    """
+    Function to configure pytest.
+    This should not be invoked directly.
+
+    Parameters
+    ----------
+    config : pytest.Config
+        The pytest configuration.
+
+    """
+    # Add custom mark for `release`
+    config.addinivalue_line(
+        "markers",
+        "release: mark tests as release tests (run with --release)",
+    )
+
+
+def pytest_collection_modifyitems(
+    config: pytest.Config,
+    items: Iterable[pytest.Item],
+) -> None:
+    """
+    Function to customize test items.
+    This should not be invoked directly.
+
+    Parameters
+    ----------
+    config : pytest.Config
+        The pytest configuration.
+    items : Iterable[pytest.Item]
+        The pytest test item.
+
+    """
+    skip_release = pytest.mark.skip(
+        reason="skipping release test (invoke pytest with --release to execute)",
+    )
+
+    for item in items:
+        # Skip release tests if `--release` was not specified
+        if "release" in item.keywords and not config.getoption("--release"):
+            item.add_marker(skip_release)
+
+
+@pytest.fixture(name="test_data_path")
+def fixture_test_data_path() -> Callable[[Schema], pathlib.Path]:
+    """
+    Factory fixture for retrieving stub data paths.
+
+    Parameters
+    ----------
+    schema : Schema
+        The schema of the stub data path to request.
+
+    Returns
+    -------
+    Callable
+
+    See Also
+    --------
+    test_data
+
+    """
+
+    def func(schema: Schema) -> pathlib.Path:
+        return pathlib.Path(TESTS_ROOT) / "data" / f"test_data.{schema}.dbn.zst"
+
+    return func
+
+
+@pytest.fixture(name="test_data")
+def fixture_test_data(
+    test_data_path: Callable[[Schema], pathlib.Path],
+) -> Callable[[Schema], bytes]:
+    """
+    Factory fixture for retrieving stub test data.
+
+    Parameters
+    ----------
+    test_data_path : Callable
+        The test_data_path fixture.
+
+    Returns
+    -------
+    Callable
+
+    See Also
+    --------
+    test_data_path
+
+    """
+
+    def func(schema: Schema) -> bytes:
+        return test_data_path(schema).read_bytes()
+
+    return func

tests/fixtures.py

@@ -1,12 +1,14 @@
+import pathlib
+from typing import Callable
+
 import pytest
 from databento.common.dbnstore import FileDataSource, MemoryDataSource
 from databento.common.enums import Schema
 
-from tests.fixtures import get_test_data, get_test_data_path
-
 
 @pytest.mark.parametrize("schema", [pytest.param(x) for x in Schema])
 def test_memory_data_source(
+    test_data: Callable[[Schema], bytes],
     schema: Schema,
 ) -> None:
     """Test create of MemoryDataSource"""
@@ -18,7 +20,7 @@ def test_memory_data_source(
     ):
         pytest.skip(f"untested schema {schema}")
 
-    data = get_test_data(schema)
+    data = test_data(schema)
     data_source = MemoryDataSource(data)
 
     assert len(data) == data_source.nbytes
@@ -27,6 +29,7 @@ def test_memory_data_source(
 
 @pytest.mark.parametrize("schema", [pytest.param(x) for x in Schema])
 def test_file_data_source(
+    test_data_path: Callable[[Schema], pathlib.Path],
     schema: Schema,
 ) -> None:
     """Test create of FileDataSource"""
@@ -38,7 +41,7 @@ def test_file_data_source(
     ):
         pytest.skip(f"untested schema {schema}")
 
-    path = get_test_data_path(schema)
+    path = test_data_path(schema)
     data_source = FileDataSource(path)
 
     assert path.stat().st_size == data_source.nbytes