feat(integration-tests): Test the startup and teardown of the clp-text and clp-json packages.

integration-tests/.pytest.ini

@@ -3,6 +3,7 @@ addopts =
     --capture=no
     --code-highlight=yes
     --color=yes
+    -rA
     --strict-config
     --strict-markers
     --verbose
@@ -18,3 +19,4 @@ markers =
     clp: mark tests that use the CLP storage engine
     clp_s: mark tests that use the CLP-S storage engine
     core: mark tests that test the CLP core binaries
+    package: mark tests that run when the CLP package is active

integration-tests/pyproject.toml

@@ -17,14 +17,18 @@ build-backend = "hatchling.build"
 
 [dependency-groups]
 dev = [
+    "clp-py-utils",
     "mypy>=1.16.0",
     "ruff>=0.11.12",
     "pytest>=8.4.1",
     "pytest-env>=1.1.5",
+    "PyYAML>=6.0",
+    "types-PyYAML>=6.0.12.20240808",
 ]
 
 [tool.mypy]
 strict = true
+ignore_missing_imports = true
 
 # Additional output
 pretty = true
@@ -69,3 +73,6 @@ isort.order-by-type = false
 [tool.ruff.format]
 docstring-code-format = true
 docstring-code-line-length = 100
+
+[tool.uv.sources]
+clp-py-utils = { path = "../components/clp-py-utils" }

integration-tests/tests/conftest.py

@@ -3,4 +3,6 @@
 pytest_plugins = [
     "tests.fixtures.integration_test_config",
     "tests.fixtures.integration_test_logs",
+    "tests.fixtures.package_instance_fixtures",
+    "tests.fixtures.package_config_fixtures",
 ]

integration-tests/tests/fixtures/integration_test_config.py

@@ -7,7 +7,6 @@
 from tests.utils.config import (
     CoreConfig,
     IntegrationTestConfig,
-    PackageConfig,
 )
 from tests.utils.utils import get_env_var
 
@@ -20,14 +19,6 @@ def core_config() -> CoreConfig:
     )
 
 
-@pytest.fixture(scope="session")
-def package_config() -> PackageConfig:
-    """Fixture that provides a PackageConfig shared across tests."""
-    return PackageConfig(
-        clp_package_dir=Path(get_env_var("CLP_PACKAGE_DIR")).expanduser().resolve()
-    )
-
-
 @pytest.fixture(scope="session")
 def integration_test_config() -> IntegrationTestConfig:
     """Fixture that provides an IntegrationTestConfig shared across tests."""

integration-tests/tests/fixtures/package_config_fixtures.py

@@ -0,0 +1,70 @@
+"""Fixtures that create and remove temporary config files for CLP packages."""
+
+import logging
+from collections.abc import Iterator
+from pathlib import Path
+
+import pytest
+
+from tests.utils.config import PackageConfig
+from tests.utils.package_utils import (
+    CLP_MODE_CONFIGS,
+    write_temp_config_file,
+)
+from tests.utils.utils import get_env_var
+
+logger = logging.getLogger(__name__)
+
+
+def _build_package_config_for_mode(mode_name: str) -> PackageConfig:
+    """Construct a PackageConfig for the given `mode_name`."""
+    if mode_name not in CLP_MODE_CONFIGS:
+        err_msg = f"Unknown CLP mode '{mode_name}'."
+        raise KeyError(err_msg)
+
+    clp_package_dir = Path(get_env_var("CLP_PACKAGE_DIR")).expanduser().resolve()
+    test_root_dir = Path(get_env_var("CLP_BUILD_DIR")).expanduser().resolve() / "integration-tests"
+
+    build_config = CLP_MODE_CONFIGS[mode_name][0]
+    required_components = CLP_MODE_CONFIGS[mode_name][1]
+    package_config = PackageConfig(
+        clp_package_dir=clp_package_dir,
+        test_root_dir=test_root_dir,
+        mode_name=mode_name,
+        build_config=build_config,
+        component_list=required_components,
+    )
+
+    # Write the temporary config file that the package will use.
+    clp_config_obj = build_config()
+    temp_config_file_path: Path = write_temp_config_file(
+        clp_config=clp_config_obj,
+        temp_config_dir=package_config.temp_config_dir,
+        mode_name=mode_name,
+    )
+    object.__setattr__(package_config, "temp_config_file_path", temp_config_file_path)
+
+    return package_config
+
+
+@pytest.fixture
+def clp_config(
+    request: pytest.FixtureRequest,
+) -> Iterator[PackageConfig]:
+    """
+    Parameterized fixture that creates and maintains a PackageConfig object for a specific mode of
+    operation.
+    """
+    mode_name: str = request.param
+    logger.info("Creating a temporary config file for the %s package...", mode_name)
+
+    package_config = _build_package_config_for_mode(mode_name)
+
+    logger.info("The temporary config file has been written for the %s package.", mode_name)
+
+    try:
+        yield package_config
+    finally:
+        logger.info("Removing the temporary config file...")
+        package_config.temp_config_file_path.unlink()
+        logger.info("The temporary config file has been removed.")

integration-tests/tests/fixtures/package_instance_fixtures.py

@@ -0,0 +1,50 @@
+"""Fixtures that start and stop CLP package instances for integration tests."""
+
+import logging
+import subprocess
+from collections.abc import Iterator
+
+import pytest
+
+from tests.utils.config import (
+    PackageConfig,
+    PackageInstance,
+)
+from tests.utils.package_utils import (
+    start_clp_package,
+    stop_clp_package,
+)
+
+logger = logging.getLogger(__name__)
+
+
+@pytest.fixture
+def clp_package(
+    clp_config: PackageConfig,
+) -> Iterator[PackageInstance]:
+    """
+    Parameterized fixture that starts a instance of the CLP package in the configuration described
+    in PackageConfig, and gracefully stops it at teardown.
+    """
+    mode_name = clp_config.mode_name
+    logger.info("Starting up the %s package...", mode_name)
+
+    start_clp_package(clp_config)
+
+    try:
+        instance = PackageInstance(package_config=clp_config)
+        instance_id = instance.clp_instance_id
+        logger.info(
+            "An instance of the %s package was started successfully. Its instance ID is '%s'",
+            mode_name,
+            instance_id,
+        )
+        yield instance
+    finally:
+        logger.info("Now stopping the %s package...", mode_name)
+        if instance is not None:
+            stop_clp_package(instance)
+        else:
+            # This means setup failed after start; fall back to calling stop script directly
+            subprocess.run([str(clp_config.stop_script_path)], check=True)
+        logger.info("The %s package was stopped successfully.", mode_name)

integration-tests/tests/test_package_start.py

@@ -0,0 +1,65 @@
+"""Integration tests verifying that the CLP package can be started and stopped."""
+
+import logging
+
+import pytest
+
+from tests.utils.config import PackageInstance
+from tests.utils.package_utils import (
+    CLP_MODE_CONFIGS,
+    is_package_running,
+    is_running_mode_correct,
+)
+
+TEST_MODES = CLP_MODE_CONFIGS.keys()
+
+logger = logging.getLogger(__name__)
+
+
+@pytest.mark.package
+@pytest.mark.parametrize("clp_config", TEST_MODES, indirect=True)
+def test_clp_package(clp_package: PackageInstance) -> None:
+    """
+    Validate that all of the components of the CLP package start up successfully for the selected
+    mode of operation.
+    """
+    # Spin up the package by getting the PackageInstance fixture.
+    package_instance = clp_package
+    mode_name = package_instance.package_config.mode_name
+    instance_id = package_instance.clp_instance_id
+
+    # Ensure that all package components are running.
+    logger.info(
+        "Checking if all components of %s package with instance ID '%s' are running properly...",
+        mode_name,
+        instance_id,
+    )
+
+    running, fail_msg = is_package_running(package_instance)
+    if not running:
+        assert fail_msg is not None
+        pytest.fail(fail_msg)
+
+    logger.info(
+        "All components of the %s package with instance ID '%s' are running properly.",
+        mode_name,
+        instance_id,
+    )
+
+    # Ensure that the package is running in the correct mode.
+    logger.info(
+        "Checking that the %s package with instance ID '%s' is running in the correct mode...",
+        mode_name,
+        instance_id,
+    )
+
+    correct, fail_msg = is_running_mode_correct(package_instance)
+    if not correct:
+        assert fail_msg is not None
+        pytest.fail(fail_msg)
+
+    logger.info(
+        "The %s package with instance ID '%s' is running in the correct mode.",
+        mode_name,
+        instance_id,
+    )