chore(ci-issues): add junit upload CLI

Adds the cli `mergify ci-issues junit-upload` to upload JUnit xml reports to CI Issues.

Fixes MRGFY-4339

Author: leoecrepont

mergify_cli/ci_issues/__init__.py

@@ -0,0 +1,70 @@
+import click
+
+from mergify_cli import utils
+from mergify_cli.ci_issues import junit_upload as junit_upload_mod
+
+
+ci_issues = click.Group(
+    "ci-issues",
+    help="Interact with Mergify's CI Issues",
+)
+
+
+@ci_issues.command(help="Upload JUnit XML reports")
+@click.option(
+    "--api-url",
+    "-u",
+    help="URL of the Mergify API",
+    default="https://api.mergify.com/v1",
+    show_default=True,
+)
+@click.option(
+    "--token",
+    "-t",
+    help="CI Issues Application Key",
+)
+@click.option(
+    "--repository",
+    "-r",
+    help="Repository URL or full name (owner/repo)",
+)
+@click.option(
+    "--files",
+    "-f",
+    help="Paths to JUnit XML reports (comma separated)",
+)
+@click.option(
+    "--head-sha",
+    "-s",
+    help="Head SHA of the triggered job",
+)
+@click.option(
+    "--job-name",
+    "-j",
+    help="Job's name",
+)
+@click.option(
+    "--provider",
+    "-p",
+    help="CI provider",
+    default=None,
+)
+@utils.run_with_asyncio
+async def junit_upload(  # noqa: PLR0913, PLR0917
+    api_url: str,
+    token: str,
+    repository: str,
+    files: str,
+    head_sha: str,
+    job_name: str,
+    provider: str | None,
+) -> None:
+    await junit_upload_mod.upload(
+        api_url=api_url,
+        token=token,
+        repository=repository,
+        files=files,
+        head_sha=head_sha,
+        job_name=job_name,
+        provider=provider,
+    )

mergify_cli/ci_issues/cli.py

@@ -0,0 +1,35 @@
+import re
+import typing
+
+import pydantic
+
+
+def validate_repository_full_name(repository: str) -> str:
+    match = re.match(
+        r"(https?://[\w.-]+/)?(?P<full_name>[\w.-]+/[\w.-]+)/?$",
+        repository,
+    )
+    if match is not None:
+        return match.group("full_name")
+
+    message = "Provide repository URL or 'owner/repo' format"
+    raise ValueError(message)
+
+
+RepositoryT = typing.Annotated[
+    str,
+    pydantic.Field(min_length=1),
+    pydantic.AfterValidator(
+        validate_repository_full_name,
+    ),
+]
+
+
+class CIIssuesJunitUploadParameters(pydantic.BaseModel):
+    api_url: pydantic.HttpUrl
+    token: str = pydantic.Field(min_length=1)
+    repository: RepositoryT
+    files: str = pydantic.Field(min_length=1)
+    head_sha: str = pydantic.Field(min_length=1)
+    job_name: str = pydantic.Field(min_length=1)
+    provider: str | None

mergify_cli/ci_issues/custom_types.py

@@ -0,0 +1,63 @@
+import sys
+
+import httpx
+import pydantic
+
+from mergify_cli import console
+from mergify_cli.ci_issues import utils
+from mergify_cli.ci_issues.custom_types import CIIssuesJunitUploadParameters
+
+
+async def upload(  # noqa: PLR0913, PLR0917
+    api_url: str,
+    token: str,
+    repository: str,
+    files: str,
+    head_sha: str,
+    job_name: str,
+    provider: str | None,
+) -> None:
+    try:
+        # NOTE(leo): perform a first validation of the input parameters in CLI
+        # before the back-end handles the rest
+        valid_params = CIIssuesJunitUploadParameters.model_validate(
+            {
+                "api_url": api_url,
+                "token": token,
+                "repository": repository,
+                "files": files,
+                "head_sha": head_sha,
+                "job_name": job_name,
+                "provider": provider,
+            },
+        )
+    except pydantic.ValidationError as e:
+        console.log(f"[red]Invalid parameters: \nDetails: {e!s}[/]")
+        sys.exit(1)
+
+    try:
+        files_to_upload = utils.get_files_to_upload(files)
+    except utils.InvalidFileError as e:
+        console.log(f"[red]{e!s}[/]")
+        sys.exit(1)
+
+    client = utils.CIIssuesClient(api_url, token)
+
+    form_data = {
+        "head_sha": head_sha,
+        "name": job_name,
+    }
+    if provider is not None:
+        form_data["provider"] = provider
+
+    try:
+        await client.post(
+            f"/repos/{valid_params.repository}/ci_issues_upload",
+            data=form_data,
+            files=files_to_upload,
+        )
+    except httpx.HTTPStatusError as e:
+        console.log(f"[red]{e!s}[/]")
+        sys.exit(1)
+
+    console.log("[green]File(s) uploaded :tada:[/]")

mergify_cli/ci_issues/junit_upload.py

@@ -0,0 +1,65 @@
+import pathlib
+import typing
+
+import httpx
+from httpx import _types as httpx_types
+
+
+def raise_for_status(response: httpx.Response) -> None:
+    if response.is_error:
+        details = response.text or "<empty-response>"
+        error_type = "Client error" if response.is_client_error else "Server error"
+        message = (
+            f"{response.status_code} {error_type}: {response.reason_phrase} for url `{response.url}`"
+            f"\nDetails: {details}"
+        )
+        raise httpx.HTTPStatusError(
+            message,
+            request=response.request,
+            response=response,
+        )
+
+
+class CIIssuesClient(httpx.AsyncClient):
+    def __init__(self, base_url: str, token: str) -> None:
+        super().__init__(
+            base_url=base_url,
+            headers={
+                "Authorization": f"Bearer {token}",
+            },
+            timeout=10.0,
+        )
+
+    async def request(
+        self,
+        method: str,
+        url: httpx_types.URLTypes,
+        *args: typing.Any,  # noqa: ANN401
+        **kwargs: typing.Any,  # noqa: ANN401
+    ) -> httpx.Response:
+        r = await super().request(method, url, *args, **kwargs)
+        raise_for_status(r)
+        return r
+
+
+class InvalidFileError(Exception):
+    pass
+
+
+def get_files_to_upload(
+    files: str,
+) -> list[tuple[str, tuple[str, bytes, str]]]:
+    files_to_upload = []
+
+    for file in set(files.split(",")):
+        file_path = pathlib.Path(file)
+        if not file_path.is_file():
+            message = f"File invalid or not found: '{file_path!s}'"
+            raise InvalidFileError(message)
+
+        with file_path.open("rb") as f:
+            files_to_upload.append(
+                ("files", (file_path.name, f.read(), "application/xml")),
+            )
+
+    return files_to_upload

mergify_cli/ci_issues/utils.py

@@ -26,6 +26,7 @@
 from mergify_cli import VERSION
 from mergify_cli import console
 from mergify_cli import utils
+from mergify_cli.ci_issues import cli as ci_issues_cli_mod
 from mergify_cli.stack import cli as stack_cli_mod
 
 
@@ -91,6 +92,7 @@ def cli(
 
 
 cli.add_command(stack_cli_mod.stack)
+cli.add_command(ci_issues_cli_mod.ci_issues)
 
 
 def main() -> None:

mergify_cli/cli.py

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="utf-8"?>
+<testsuites>
+    <testsuite name="pytest" errors="0" failures="1" skipped="0" tests="2" time="0.026"
+               timestamp="2024-08-14T12:25:18.210796+02:00" hostname="mergify-MBP">
+        <testcase classname="mergify.tests.test_junit" name="test_success" time="0.000"/>
+        <testcase classname="mergify.tests.test_junit" name="test_failed" time="0.000">
+            <failure message="assert 1 == 0">def test_failed() -&gt; None:
+                &gt; assert 1 == 0
+                E assert 1 == 0
+
+                mergify/tests/test_junit.py:6: AssertionError
+            </failure>
+        </testcase>
+    </testsuite>
+</testsuites>