supervisor: Add testing_farm_utils.py for Testing Farm integration

We'll want to start Testing Farm tests when we hit test
failures so that we can see if they happened with the previous
build - add a new module to handle Testing Farm API interactions,
with a specific function to cover recreating a Testing Farm request
based on an existing one but changing the build NVR.

Author: owtaylor

openshift/README.md

@@ -19,6 +19,11 @@
   oc create secret generic jotnar-bot-keytab --from-file=jotnar-bot.keytab
   ```
 
+  `testing-farm-env`:
+  ```
+  TESTING_FARM_API_TOKEN
+  ```
+
   Values of these secrets are documented in [README](https://github.com/packit/jotnar?tab=readme-ov-file#service-accounts--authentication).
 
 - Create RHEL configuration ConfigMap manually:

supervisor/main.py

@@ -34,7 +34,11 @@ class State:
 
 
 def check_env(
-    chat: bool = False, jira: bool = False, redis: bool = False, gitlab: bool = False
+    chat: bool = False,
+    jira: bool = False,
+    redis: bool = False,
+    gitlab: bool = False,
+    testing_farm: bool = False,
 ):
     required_vars = []
     if chat:
@@ -51,6 +55,8 @@ def check_env(
         )
     if gitlab:
         required_vars.append(("GITLAB_TOKEN", "Gitlab authentication token"))
+    if testing_farm:
+        required_vars.append(("TESTING_FARM_API_TOKEN", "Testing Farm API token"))
 
     missing_vars = [var for var in required_vars if not os.getenv(var[0])]
 

supervisor/supervisor_types.py

@@ -1,6 +1,6 @@
 from datetime import datetime
 from enum import StrEnum
-from typing import Optional
+from typing import Any, Optional
 
 from pydantic import BaseModel, Field
 from typing_extensions import Literal
@@ -113,6 +113,54 @@ class FullIssue(Issue):
     comments: list[JiraComment]
 
 
+class TestingFarmRequestState(StrEnum):
+    NEW = "new"
+    QUEUED = "queued"
+    RUNNING = "running"
+    ERROR = "error"
+    CANCELED = "canceled"
+    CANCEL_REQUESTED = "cancel-requested"
+    COMPLETE = "complete"
+
+
+class TestingFarmRequestResult(StrEnum):
+    PASSED = "passed"
+    FAILED = "failed"
+    SKIPPED = "skipped"
+    UNKNOWN = "unknown"
+    ERROR = "error"
+
+
+class TestingFarmRequest(BaseModel):
+    id: str
+    url: str
+    state: TestingFarmRequestState
+    result: TestingFarmRequestResult = TestingFarmRequestResult.UNKNOWN
+    result_xunit_url: str | None = None
+    created: datetime
+    updated: datetime
+
+    # We save the raw data to use during test reproduction
+    test_data: dict[str, Any]
+    environments_data: list[dict[str, Any]]
+
+    @property
+    def arches(self) -> list[str]:
+        return [env["arch"] for env in self.environments_data]
+
+    @property
+    def build_nvr(self) -> str:
+        versions = {
+            variables["BUILDS"]
+            for env in self.environments_data
+            if (variables := env.get("variables")) and "BUILDS" in variables
+        }
+        if len(versions) != 1:
+            raise ValueError("Can't determine package version for request")
+
+        return versions.pop()
+
+
 class JotnarTag(BaseModel):
     """
     A magic string appearing in the description of an issue that

supervisor/testing_farm_utils.py

@@ -0,0 +1,172 @@
+from datetime import datetime, timezone
+from functools import cache
+from json import dumps as json_dumps
+import logging
+import os
+from typing import Any
+
+
+from .http_utils import requests_session
+from .supervisor_types import (
+    TestingFarmRequest,
+    TestingFarmRequestResult,
+    TestingFarmRequestState,
+)
+
+
+TESTING_FARM_URL = "https://api.testing-farm.io/v0.1"
+
+
+logger = logging.getLogger(__name__)
+
+
+@cache
+def testing_farm_headers() -> dict[str, str]:
+    token = os.environ["TESTING_FARM_API_TOKEN"]
+
+    return {
+        "Authorization": f"Bearer {token}",
+        "Content-Type": "application/json",
+    }
+
+
+def testing_farm_api_get(path: str, *, params: dict | None = None) -> Any:
+    url = f"{TESTING_FARM_URL}/{path}"
+    response = requests_session().get(
+        url, headers=testing_farm_headers(), params=params
+    )
+    if not response.ok:
+        logger.error(
+            "GET %s%s failed.\nerror:\n%s",
+            url,
+            f" (params={params})" if params else "",
+            response.text,
+        )
+    response.raise_for_status()
+    return response.json()
+
+
+def testing_farm_api_post(
+    path: str,
+    json: dict[str, Any],
+) -> Any:
+    url = f"{TESTING_FARM_URL}/{path}"
+    response = requests_session().post(url, headers=testing_farm_headers(), json=json)
+    if not response.ok:
+        logger.error(
+            "POST to %s failed\nbody:\n%s\nerror:\n%s",
+            url,
+            json_dumps(json, indent=2),
+            response.text,
+        )
+    response.raise_for_status()
+    return response.json()
+
+
+fake_testing_id_counter = 0
+
+
+def testing_farm_reproduce_request_with_build(
+    request: TestingFarmRequest,
+    build_nvr: str,
+    dry_run: bool = False,
+) -> TestingFarmRequest:
+    """
+    Create a Testing Farm request to reproduce an existing request with a different build.
+
+    Args:
+        request: The original Testing Farm request.
+        build_nvr: The NVR of the build to use for reproduction.
+
+    Returns:
+        The new Testing Farm request.
+
+    Raises:
+        HTTPError: If the API request fails.
+    """
+    original_environments = request.environments_data
+
+    # We manually construct the environment to replace the build
+    # and skip newa_ variables. There are some other keys in the
+    # environment dict that we don't copy over - in particular
+    # "hardware" and "kickstart" - these shouldn't be relevant.
+    environments = [
+        {
+            "arch": env["arch"],
+            "os": env["os"],
+            "variables": env["variables"] | {"BUILDS": build_nvr},
+            "tmt": {
+                "context": {
+                    k: v
+                    for k, v in env["tmt"]["context"].items()
+                    if not k.startswith("newa_")
+                }
+            },
+        }
+        for env in original_environments
+    ]
+
+    body = {
+        "test": request.test_data,
+        "environments": environments,
+    }
+    if dry_run:
+        logger.info(
+            "Dry run: would start Testing Farm request reproducing %s with build %s",
+            request.id,
+            build_nvr,
+        )
+        logger.debug("Dry run: would post %s to %s", body, "requests")
+        global fake_testing_id_counter
+        fake_testing_id_counter += 1
+        test_id = f"fake-testing-id-{fake_testing_id_counter}"
+        return TestingFarmRequest(
+            id=test_id,
+            url=f"{TESTING_FARM_URL}/requests/{test_id}",
+            state=TestingFarmRequestState.NEW,
+            created=datetime.now(tz=timezone.utc),
+            updated=datetime.now(tz=timezone.utc),
+            test_data=body["test"],
+            environments_data=body["environments"],
+        )
+
+    response = testing_farm_api_post("requests", json=body)
+
+    return TestingFarmRequest(
+        id=response["id"],
+        url=f"{TESTING_FARM_URL}/requests/{response['id']}",
+        state=response["state"],
+        created=datetime.fromisoformat(response["created"]),
+        updated=datetime.fromisoformat(response["updated"]),
+        test_data=response["test"],
+        environments_data=response["environments"],
+    )
+
+
+def testing_farm_get_request(request_id: str) -> TestingFarmRequest:
+    """
+    Retrieve details about a Testing Farm request by its ID.
+
+    Args:
+        request_id: The ID of the Testing Farm request.
+
+    Returns:
+        The Testing Farm request.
+    """
+    response = testing_farm_api_get(f"requests/{request_id}")
+
+    result_data = response.get("result")
+
+    return TestingFarmRequest(
+        id=response["id"],
+        url=f"{TESTING_FARM_URL}/requests/{response['id']}",
+        state=response["state"],
+        result=(
+            result_data["overall"] if result_data else TestingFarmRequestResult.UNKNOWN
+        ),
+        result_xunit_url=result_data.get("xunit_url") if result_data else None,
+        created=datetime.fromisoformat(response["created"]),
+        updated=datetime.fromisoformat(response["updated"]),
+        test_data=response["test"],
+        environments_data=response["environments_requested"],
+    )

templates/supervisor.env

@@ -12,3 +12,7 @@ JIRA_URL=https://issues.redhat.com
 # Required: Jira API token (Bearer token)
 # Get this from: https://issues.redhat.com/secure/ViewProfile.jspa?selectedTab=com.atlassian.pats.pats-plugin:jira-user-personal-access-tokens
 JIRA_TOKEN=
+
+# Required: testing farm API token (Bearer token)
+# Get this from https://testing-farm.io/tokens/ (select the "Red Hat" ranch)
+TESTING_FARM_API_TOKEN=