feat: dynaconf fixture with environments

.github/workflows/ci.yml

@@ -37,7 +37,7 @@ jobs:
 
       - name: Run tests
         run: |
-          pytest 
+          pytest
 
   install-test:
     name: "test as installed"

CONFIGURATION.md

@@ -0,0 +1,58 @@
+# Configuration and common usecases
+## Tests are run in upstream environment
+
+Pytest will run local candlepin service in a container.
+
+Dynaconf will load all configuration from a file `settings.toml`
+
+```bash
+$ export ENVIRONMENTS_FOR_DYNACONF=True
+$ export ENV_FOR_DYNACONF=upstream
+$
+$ pytest -v
+```
+Pytest will run all tests that are available for `upstream`
+environment.
+
+There is a section `[upstream]` in the settings file that contains of
+all properties that tests require.
+
+## Tests are run in CI environment
+Jenkins does not require dynaconf to use environments.
+Jenkins provides all config properties directly - using environment
+variables.
+
+```bash
+$ export ENVIRONMENTS_FOR_DYNACONF=False
+$
+$ pytest -v
+```
+
+## Tests are run in stage environment
+Properties that describe a development environment must be stored in a
+secret file that is not part of the repo. Default name of the file is
+`.secrets.toml`
+
+```bash
+$ export ENVIRONMENTS_FOR_DYNACONF=True
+$ export ENV_FOR_DYNACONF=stage
+$
+$ pytest -v
+```
+
+`stage` environment is used for most of the tests. It requires all
+services to be available.
+
+All properties are defined in a custom file `.secrets.toml` This file
+is not part of this repo.
+
+# Example of `.secrets.toml`
+
+```toml
+[stage.candlepin]
+hostname=TO_BE_CONFIGURED
+
+[stage.account]
+username=TO_BE_REDACTED
+password=TO_BE_REDACTED
+```

README.md

@@ -27,6 +27,19 @@ and some helper bits:
 - `insights_client` -- `insights-client`
 - `rhc` -- `rhc`
 
+## Configuration
+The library provides dynaconf object to load all config properties
+required by tests. see  [Dynaconf library](https://dynaconf.com) for
+more details.
+
+There are a few cases the library can be used at
+1) upstream environment
+2) CI environment
+3) stage environment
+4) production environment
+
+For more details see [Configuration](CONFIGURATION.md)
+
 ## License
 
 Distributed under the terms of the `MIT`_ license.

pytest_client_tools/config.py

@@ -0,0 +1,32 @@
+# SPDX-FileCopyrightText: Red Hat
+# SPDX-License-Identifier: MIT
+
+import pytest
+from dynaconf import Dynaconf, Validator
+
+#
+# it is necessary to use define global variable since dynaconf settings object
+# is used even in pytest hooks to get config properties
+#
+_settings = Dynaconf(
+    envvar_prefix="PYTEST_CLIENT_TOOLS",
+    settings_files=["settings.toml", ".secrets.toml"],
+)
+
+
+@pytest.fixture
+def settings(scope="session"):
+    _settings.validators.register(
+        Validator("candlepin.host"),
+        Validator("candlepin.port", gt=0, lt=65536, cast=int, is_type_of=int),
+        Validator("candlepin.prefix", startswith="/"),
+        Validator("candlepin.insecure", cast=bool, is_type_of=bool),
+        Validator("candlepin.username"),
+        Validator(
+            "candlepin.password",
+            must_exist=True,
+            when=Validator("candlepin.username", must_exist=True),
+        ),
+    )
+    _settings.validators.validate()
+    return _settings

pytest_client_tools/plugin.py

@@ -7,13 +7,15 @@
 import logging
 import shutil
 import subprocess
-
 import pytest
 
+
 from .candlepin import Candlepin, ping_candlepin
 from .insights_client import InsightsClient, INSIGHTS_CLIENT_FILES_TO_SAVE
 from .logger import LOGGER
 from .podman import Podman
+
+
 from .subscription_manager import (
     SubscriptionManager,
     SUBMAN_FILES_TO_SAVE,
@@ -22,7 +24,7 @@
 from .rhc import Rhc, RHC_FILES_TO_SAVE
 from .test_config import TestConfig
 from .util import NodeRunningData
-
+from .config import _settings
 
 _MARKERS = {
     "candlepin": "tests requiring a self-deployed Candlepin",
@@ -233,6 +235,11 @@ def pytest_configure(config):
     for mark, description in _MARKERS.items():
         config.addinivalue_line("markers", f"{mark}: {description}")
     config.addinivalue_line("markers", "jira(id): test for jira cards")
+    config.addinivalue_line(
+        "markers",
+        "env(name): required Dynaconf environment for a test",
+    )
+
     locale.setlocale(locale.LC_ALL, "C.UTF-8")
 
 
@@ -256,3 +263,12 @@ def pytest_runtest_logfinish(nodeid, location):
     if node_running_data.logfile.exists():
         node_running_data.artifacts.copy(node_running_data.logfile)
     logging.getLogger().handlers.remove(node_running_data.handler)
+
+
+def pytest_runtest_setup(item):
+    envnames = [mark.args[0] for mark in item.iter_markers(name="env")]
+    the_environment = _settings.get("env_for_dynaconf") or "development"
+    if envnames and the_environment not in envnames:
+        pytest.skip(
+            f"test requires a Dynaconf environment to be one of those: {envnames}",
+        )