Implement Brew artifact provider (teemtee#4202)

resolves: teemtee#4174

Author: AthreyVinay

tests/core/about/test.sh

@@ -8,7 +8,7 @@ export.story: dict json rst template yaml
 export.test: dict json nitrate polarion template yaml
 package_managers: apk apt bootc dnf dnf5 mock-dnf mock-dnf5 mock-yum rpm-ostree yum
 plan_shapers: max-tests repeat
-prepare.artifact.providers: brew koji koji.build koji.nvr koji.task
+prepare.artifact.providers: brew brew.build brew.nvr brew.task koji koji.build koji.nvr koji.task
 prepare.feature: crb epel fips profile
 step.cleanup: tmt
 step.discover: fmf shell

tests/unit/artifact/test_brew.py

@@ -0,0 +1,60 @@
+import pytest
+
+from tmt.steps.prepare.artifact.providers.brew import BrewArtifactProvider
+
+
+@pytest.mark.skip(reason="would be replaced by mocks")
+@pytest.mark.integration
+def test_brew_valid_build(root_logger):
+    provider = BrewArtifactProvider("brew.build:3866328", root_logger)
+    assert len(provider.artifacts) == 21
+
+
+@pytest.mark.skip(reason="would be replaced by mocks")
+@pytest.mark.integration
+def test_brew_valid_draft_build(root_logger):
+    provider = BrewArtifactProvider("brew.build:3525300", root_logger)
+    assert len(provider.artifacts) == 2
+    assert any(
+        "draft_3525300" in artifact._raw_artifact['url'] for artifact in provider.artifacts
+    ), "No artifact URL contains 'draft_3525300'"
+
+
+@pytest.mark.skip(reason="would be replaced by mocks")
+@pytest.mark.integration
+def test_brew_valid_nvr(root_logger):
+    provider = BrewArtifactProvider("brew.nvr:unixODBC-2.3.12-1.el9", root_logger)
+    assert len(provider.artifacts) == 21
+    assert provider.build_id == 3866328  # Known build ID for this NVR
+
+
+@pytest.mark.skip(reason="would be replaced by mocks")
+@pytest.mark.integration
+def test_brew_invalid_nvr(root_logger):
+    from tmt.utils import GeneralError
+
+    provider = BrewArtifactProvider("brew.nvr:nonexistent-1.0-1.fc43", root_logger)
+
+    with pytest.raises(GeneralError, match=r"No build found for NVR 'nonexistent-1\.0-1\.fc43'\."):
+        _ = provider.build_id
+
+
+@pytest.mark.skip(reason="would be replaced by mocks")
+@pytest.mark.integration
+def test_brew_valid_task_id_actual_build(root_logger):
+    provider = BrewArtifactProvider("brew.task:69098388", root_logger)
+    assert provider.build_id == 3866328  # Known build ID for this task
+    assert len(provider.artifacts) == 21
+
+
+@pytest.mark.skip(reason="would be replaced by mocks")
+@pytest.mark.integration
+def test_brew_valid_task_id_scratch_build(root_logger):
+    task_id = 69111304
+    provider = BrewArtifactProvider(f"brew.task:{task_id}", root_logger)
+    tasks = list(provider._get_task_children(task_id))
+
+    assert len(tasks) == 6
+    assert task_id in tasks
+    assert provider.build_id is None
+    assert len(provider.artifacts) == 12

tmt/steps/prepare/artifact/providers/brew.py

@@ -2,14 +2,103 @@
 Brew Artifact Provider
 """
 
+from collections.abc import Sequence
+from functools import cached_property
+from typing import Any, ClassVar, Optional
+from urllib.parse import urljoin
+
+import tmt.log
 from tmt.steps.prepare.artifact.providers import provides_artifact_provider
-from tmt.steps.prepare.artifact.providers.koji import KojiArtifactProvider
+from tmt.steps.prepare.artifact.providers.koji import (
+    KojiArtifactProvider,
+    KojiBuild,
+    KojiNvr,
+    KojiTask,
+)
 
 
 # ignore[type-arg]: TypeVar in provider registry annotations is
 # puzzling for type checkers. And not a good idea in general, probably.
 @provides_artifact_provider('brew')  # type: ignore[arg-type]
-class BrewProvider(KojiArtifactProvider):
+class BrewArtifactProvider(KojiArtifactProvider):
     """
+    Provider for downloading artifacts from Brew builds.
+
     Brew builds are just a special case of Koji builds
+
+    .. note::
+
+        Only RPMs are supported currently.
+
+    .. code-block:: python
+
+        provider = BrewArtifactProvider("brew.build:123456", logger)
+        artifacts = provider.fetch_contents(guest, Path("/tmp"))
     """
+
+    SUPPORTED_PREFIXES: ClassVar[tuple[str, ...]] = ()
+
+    def __new__(cls, raw_provider_id: str, logger: tmt.log.Logger) -> Any:
+        """
+        Create a specific Brew provider based on the ``raw_provider_id`` prefix.
+
+        The supported providers are:
+        :py:class:`BrewBuild`,
+        :py:class:`BrewTask`,
+        :py:class:`BrewNvr`.
+
+        :raises ValueError: If the prefix is not supported
+        """
+        return cls._dispatch_subclass(raw_provider_id, cls._REGISTRY)
+
+    def __init__(self, raw_provider_id: str, logger: tmt.log.Logger):
+        super().__init__(raw_provider_id, logger)
+        self._session = self._initialize_session(
+            api_url="https://brewhub.engineering.redhat.com/brewhub",
+            top_url="https://download.eng.bos.redhat.com/brew",
+        )
+
+    @cached_property
+    def build_provider(self) -> Optional['BrewBuild']:
+        return self._make_build_provider(BrewBuild, "brew.build")
+
+    def _rpm_url(self, rpm_meta: dict[str, str]) -> str:
+        """Construct Brew RPM URL."""
+        name = rpm_meta["name"]
+        version = rpm_meta["version"]
+        release = rpm_meta["release"]
+        arch = rpm_meta["arch"]
+        assert self.build_info is not None
+        volume = self.build_info["volume_name"]
+        draft_suffix = f",draft_{self.build_id}" if self.build_info["draft"] else ""
+
+        path = (
+            f"vol/{volume}/packages/{name}/{version}/"
+            f"{release}{draft_suffix}/{arch}/"
+            f"{name}-{version}-{release}.{arch}.rpm"
+        )
+
+        return urljoin(self._top_url, path)
+
+
+@provides_artifact_provider("brew.build")  # type: ignore[arg-type]
+class BrewBuild(BrewArtifactProvider, KojiBuild):
+    pass
+
+
+@provides_artifact_provider("brew.task")  # type: ignore[arg-type]
+class BrewTask(BrewArtifactProvider, KojiTask):
+    pass
+
+
+@provides_artifact_provider("brew.nvr")  # type: ignore[arg-type]
+class BrewNvr(BrewArtifactProvider, KojiNvr):
+    pass
+
+
+BrewArtifactProvider._REGISTRY = {
+    "brew.build": BrewBuild,
+    "brew.task": BrewTask,
+    "brew.nvr": BrewNvr,
+}
+BrewArtifactProvider.SUPPORTED_PREFIXES = tuple(BrewArtifactProvider._REGISTRY.keys())