feat(api tests): switch schemathesis invocation to harness-test; move auth header generation into get_schemathesis_command and remove TokenAuth hooks

Author: afonsobspinto

libraries/cloudharness-utils/cloudharness_utils/testing/api.py

@@ -1,8 +1,10 @@
 import os
+import logging
 
 from ruamel.yaml import YAML
 
 from cloudharness_model.models import ApiTestsConfig, ApplicationHarnessConfig
+from cloudharness.auth import get_token
 
 yaml = YAML(typ='safe')
 
@@ -11,19 +13,67 @@ def get_api_filename(app_dir):
     return os.path.join(app_dir, "api", "openapi.yaml")
 
 
-def get_schemathesis_command(api_filename, app_config: ApplicationHarnessConfig, app_domain: str):
-    # Make sure to set SCHEMATHESIS_HOOKS=cloudharness_test.apitest_init in environment to use the custom hooks
-    return ["st", "run", api_filename, *get_schemathesis_params(app_config, app_domain)]
+def get_schemathesis_command(api_filename, app_config: ApplicationHarnessConfig, app_domain: str, app_env: dict | None = None):
+    """
+    Build the schemathesis command for running API tests.
 
+    Extended to support runtime authentication header generation directly in the command instead of relying on hooks.
+    """
+    return ["st", "run", api_filename, *get_schemathesis_params(app_config, app_domain, app_env)]
 
-def get_schemathesis_params(app_config: ApplicationHarnessConfig, app_domain: str):
+
+def _get_auth_headers(app_env: dict):
+    """Return list of CLI flags setting auth & headers based on environment.
+
+    Supported:
+    - USERNAME/PASSWORD -> basic auth OR bearer token if token retrievable
+    - API_KEY -> X-API-Key header
+    - BEARER_TOKEN explicit -> Authorization header
+    Priority order:
+      1. Explicit BEARER_TOKEN
+      2. USERNAME/PASSWORD -> try get_token (Keycloak) then fallback to --auth basic
+      3. API_KEY header
+    """
+    if not app_env:
+        return []
+    flags = []
+
+    bearer = app_env.get("BEARER_TOKEN")
+    username = app_env.get("USERNAME")
+    password = app_env.get("PASSWORD")
+    api_key = app_env.get("API_KEY")
+
+    if bearer:
+        flags += ["--header", f"Authorization: Bearer {bearer}"]
+    elif username and password:
+        # Attempt to retrieve token; if fails, fallback to basic auth
+        try:
+            token = get_token(username, password)
+            if token:
+                flags += ["--header", f"Authorization: Bearer {token}"]
+                # also cookie header if needed by backend
+                flags += ["--header", f"Cookie: kc-access={token}"]
+            else:
+                flags += ["--auth", f"{username}:{password}"]
+        except Exception as e:
+            logging.warning("Failed to retrieve bearer token; fallback to basic auth: %s", e)
+            flags += ["--auth", f"{username}:{password}"]
+
+    if api_key:
+        flags += ["--header", f"X-API-Key: {api_key}"]
+    return flags
+
+
+def get_schemathesis_params(app_config: ApplicationHarnessConfig, app_domain: str, app_env: dict | None = None):
     params = ["--url", app_domain]
     api_config: ApiTestsConfig = app_config.test.api
     if api_config.checks:
         for c in api_config.checks:
             params += ["-c", c]
 
-    return [*params, *api_config.run_params]
+    params.extend(api_config.run_params)
+    params.extend(_get_auth_headers(app_env or {}))
+    return params
 
 
 def get_urls_from_api_file(api_filename):

tools/cloudharness-test/cloudharness_test/api.py

@@ -69,7 +69,7 @@ def run_api_tests(root_paths, helm_values: HarnessMainConfig, base_domain, inclu
 
             if api_config.autotest:
                 logging.info("Running auto api tests")
-                cmd = get_schemathesis_command(api_filename, app_config, app_domain)
+                cmd = get_schemathesis_command(api_filename, app_config, app_domain, app_env)
                 logging.info("Running: %s", " ".join(cmd))
                 result = subprocess.run(cmd,
                                         env=app_env, cwd=app_dir)

tools/cloudharness-test/cloudharness_test/apitest_init.py

@@ -4,8 +4,6 @@
 import schemathesis as st
 from schemathesis.hooks import HookContext
 
-from cloudharness.auth import get_token
-
 
 if "APP_URL" or "APP_SCHEMA_FILE" in os.environ:
     app_schema = os.environ.get("APP_SCHEMA_FILE", None)
@@ -45,31 +43,7 @@
         if not schema:
             raise Exception("Cannot setup API tests: No valid schema found. Check your deployment and configuration.")
 
-    if "USERNAME" in os.environ and "PASSWORD" in os.environ:
-        logging.info("Setting token from username and password")
-
-        @st.auth()
-        class TokenAuth:
-            def get(self, case, ctx):
-                username = os.environ["USERNAME"]
-                password = os.environ["PASSWORD"]
-
-                return get_token(username, password)
-
-            def set(self, case, data, context):
-                case.headers = case.headers or {}
-                case.headers["Authorization"] = f"Bearer {data}"
-                case.headers["Cookie"] = f"kc-access={data}"
-    else:
-        @st.auth()
-        class TokenAuth:
-            def get(self, case, ctx):
-                return ""
-
-            def set(self, case, data, context):
-                case.headers = case.headers or {}
-                case.headers["Authorization"] = f"Bearer {data}"
-                case.headers["Cookie"] = f"kc-access={data}"
+    # Authentication headers are now passed directly via CLI flags; no auth hook required.
 
     UNSAFE_VALUES = ("%", )
 

tools/deployment-cli-tools/ch_cli_tools/codefresh.py

@@ -450,13 +450,21 @@ def codefresh_template_spec(template_path, **kwargs):
 
 
 def api_tests_commands(app_config: ApplicationHarnessConfig, run_custom_tests, api_url):
+    """Return commands to execute API tests for Codefresh pipeline.
+
+    Harness-test is now the unified entrypoint; it internally builds schemathesis command with headers.
+    We invoke harness-test with -a flag targeting only API tests & include specific app.
+    Custom pytest tests run separately inside the same container.
+    """
     api_config: ApiTestsConfig = app_config.test.api
     commands = []
+    app_name = app_config.name
     if api_config.autotest:
-        commands.append(" ".join(get_schemathesis_command(
-            get_api_filename(""), app_config, api_url)))
+        # harness-test requires values.yaml generated & domain; Codefresh sets environment accordingly.
+        # We limit to the specific app using -i and run only api tests with -a
+        commands.append(f"harness-test . -i {app_name} -a")
     if run_custom_tests:
-        commands.append(f"pytest -v test/api")
+        commands.append("pytest -v test/api")
     return commands