Store info about Koji tagging requests (#2648)

Store info about Koji tagging requests

Fixes #2576.

Reviewed-by: Laura Barcziová

Author: softwarefactory-project-zuul[bot]

alembic/versions/6f936840164c_add_koji_tag_request_groups_and_targets.py

@@ -0,0 +1,70 @@
+"""Add Koji tag request groups and targets
+
+Revision ID: 6f936840164c
+Revises: 4387d6ab90e9
+Create Date: 2024-11-14 13:20:07.918410
+
+"""
+
+import sqlalchemy as sa
+
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision = "6f936840164c"
+down_revision = "f69687c314c5"
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table(
+        "koji_tag_request_groups",
+        sa.Column("id", sa.Integer(), nullable=False),
+        sa.Column("submitted_time", sa.DateTime(), nullable=True),
+        sa.PrimaryKeyConstraint("id"),
+    )
+    op.create_table(
+        "koji_tag_request_targets",
+        sa.Column("id", sa.Integer(), nullable=False),
+        sa.Column("task_id", sa.String(), nullable=True),
+        sa.Column("target", sa.String(), nullable=True),
+        sa.Column("web_url", sa.String(), nullable=True),
+        sa.Column("tag_request_submitted_time", sa.DateTime(), nullable=True),
+        sa.Column("sidetag", sa.String(), nullable=True),
+        sa.Column("nvr", sa.String(), nullable=True),
+        sa.Column("koji_tag_request_group_id", sa.Integer(), nullable=True),
+        sa.ForeignKeyConstraint(["koji_tag_request_group_id"], ["koji_tag_request_groups.id"]),
+        sa.PrimaryKeyConstraint("id"),
+    )
+    op.create_index(
+        op.f("ix_koji_tag_request_targets_task_id"),
+        "koji_tag_request_targets",
+        ["task_id"],
+        unique=False,
+    )
+    op.add_column("pipelines", sa.Column("koji_tag_request_group_id", sa.Integer(), nullable=True))
+    op.create_index(
+        op.f("ix_pipelines_koji_tag_request_group_id"),
+        "pipelines",
+        ["koji_tag_request_group_id"],
+        unique=False,
+    )
+    op.create_foreign_key(
+        None, "pipelines", "koji_tag_request_groups", ["koji_tag_request_group_id"], ["id"]
+    )
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_constraint(None, "pipelines", type_="foreignkey")
+    op.drop_index(op.f("ix_pipelines_koji_tag_request_group_id"), table_name="pipelines")
+    op.drop_column("pipelines", "koji_tag_request_group_id")
+    op.drop_index(
+        op.f("ix_koji_tag_request_targets_task_id"), table_name="koji_tag_request_targets"
+    )
+    op.drop_table("koji_tag_request_targets")
+    op.drop_table("koji_tag_request_groups")
+    # ### end Alembic commands ###

packit_service/models.py

@@ -1865,6 +1865,12 @@ class PipelineModel(Base):
         index=True,
     )
     koji_build_group = relationship("KojiBuildGroupModel", back_populates="runs")
+    koji_tag_request_group_id = Column(
+        Integer,
+        ForeignKey("koji_tag_request_groups.id"),
+        index=True,
+    )
+    koji_tag_request_group = relationship("KojiTagRequestGroupModel", back_populates="runs")
     vm_image_build_id = Column(
         Integer,
         ForeignKey("vm_image_build_targets.id"),
@@ -2822,6 +2828,143 @@ def get_all_projects(cls) -> set["GitProjectModel"]:
             return set(projects)
 
 
+class KojiTagRequestGroupModel(ProjectAndEventsConnector, GroupModel, Base):
+    __tablename__ = "koji_tag_request_groups"
+    id = Column(Integer, primary_key=True)
+    submitted_time = Column(DateTime, default=datetime.utcnow)
+
+    runs = relationship("PipelineModel", back_populates="koji_tag_request_group")
+    koji_tag_request_targets = relationship(
+        "KojiTagRequestTargetModel",
+        back_populates="group_of_targets",
+    )
+
+    @property
+    def grouped_targets(self):
+        return self.koji_tag_request_targets
+
+    def __repr__(self) -> str:
+        return f"KojiTagRequestGroupModel(id={self.id}, submitted_time={self.submitted_time})"
+
+    @classmethod
+    def get_by_id(cls, id_: int) -> Optional["KojiTagRequestGroupModel"]:
+        with sa_session_transaction() as session:
+            return session.query(KojiTagRequestGroupModel).filter_by(id=id_).first()
+
+    @classmethod
+    def create(cls, run_model: "PipelineModel") -> "KojiTagRequestGroupModel":
+        with sa_session_transaction(commit=True) as session:
+            tag_request_group = cls()
+            session.add(tag_request_group)
+            if run_model.koji_tag_request_group:
+                # Clone run model
+                new_run_model = PipelineModel.create(
+                    project_event=run_model.project_event,
+                    package_name=run_model.package_name,
+                )
+                new_run_model.srpm_build = run_model.srpm_build
+                new_run_model.koji_tag_request_group = tag_request_group
+                session.add(new_run_model)
+            else:
+                run_model.koji_tag_request_group = tag_request_group
+                session.add(run_model)
+            return tag_request_group
+
+
+class KojiTagRequestTargetModel(GroupAndTargetModelConnector, Base):
+    """we create an entry for every target"""
+
+    __tablename__ = "koji_tag_request_targets"
+    id = Column(Integer, primary_key=True)
+    task_id = Column(String, index=True)  # ID of the Koji tag task
+
+    # chroot, but we use the word target in our docs
+    target = Column(String)
+    # URL to koji web ui for the particular build
+    web_url = Column(String)
+    # datetime.utcnow instead of datetime.utcnow() because its an argument to the function
+    # so it will run when the koji build is initiated, not when the table is made
+    tag_request_submitted_time = Column(DateTime, default=datetime.utcnow)
+
+    sidetag = Column(String)
+    nvr = Column(String)
+
+    koji_tag_request_group_id = Column(Integer, ForeignKey("koji_tag_request_groups.id"))
+
+    group_of_targets = relationship(
+        "KojiTagRequestGroupModel",
+        back_populates="koji_tag_request_targets",
+    )
+
+    def set_web_url(self, web_url: str):
+        with sa_session_transaction(commit=True) as session:
+            self.web_url = web_url
+            session.add(self)
+
+    def set_task_id(self, task_id: str):
+        with sa_session_transaction(commit=True) as session:
+            self.task_id = task_id
+            session.add(self)
+
+    def set_tag_request_submitted_time(self, tag_request_submitted_time: Optional[DateTime]):
+        with sa_session_transaction(commit=True) as session:
+            self.tag_request_submitted_time = tag_request_submitted_time
+            session.add(self)
+
+    @classmethod
+    def get_by_id(cls, id_: int) -> Optional["KojiTagRequestTargetModel"]:
+        with sa_session_transaction() as session:
+            return session.query(KojiTagRequestTargetModel).filter_by(id=id_).first()
+
+    @classmethod
+    def get_all(cls) -> Iterable["KojiTagRequestTargetModel"]:
+        with sa_session_transaction() as session:
+            return session.query(KojiTagRequestTargetModel)
+
+    @classmethod
+    def get_range(
+        cls,
+        first: int,
+        last: int,
+    ) -> Iterable["KojiTagRequestTargetModel"]:
+        with sa_session_transaction() as session:
+            query = session.query(KojiTagRequestTargetModel).order_by(
+                desc(KojiTagRequestTargetModel.id),
+            )
+
+            return query.slice(first, last)
+
+    @classmethod
+    def create(
+        cls,
+        task_id: Optional[str],
+        web_url: Optional[str],
+        target: str,
+        koji_tag_request_group: "KojiTagRequestGroupModel",
+        sidetag: Optional[str] = None,
+        nvr: Optional[str] = None,
+    ) -> "KojiTagRequestTargetModel":
+        with sa_session_transaction(commit=True) as session:
+            tag_request = cls()
+            tag_request.task_id = task_id
+            tag_request.web_url = web_url
+            tag_request.target = target
+            tag_request.sidetag = sidetag
+            tag_request.nvr = nvr
+            session.add(tag_request)
+
+            koji_tag_request_group.koji_tag_request_targets.append(tag_request)
+            session.add(koji_tag_request_group)
+
+            return tag_request
+
+    def __repr__(self):
+        return (
+            f"KojiTagRequestTargetModel(id={self.id}, "
+            f"tag_submitted_time={self.tag_request_submitted_time})"
+        )
+
+
 class SRPMBuildModel(ProjectAndEventsConnector, Base):
     __tablename__ = "srpm_builds"
     id = Column(Integer, primary_key=True)

packit_service/service/api/__init__.py

@@ -10,6 +10,7 @@
 from packit_service.service.api.healthz import ns as healthz_ns
 from packit_service.service.api.installations import ns as installations_ns
 from packit_service.service.api.koji_builds import koji_builds_ns
+from packit_service.service.api.koji_tag_requests import koji_tag_requests_ns
 from packit_service.service.api.osh_scans import ns as osh_scans_ns
 from packit_service.service.api.projects import ns as projects_ns
 from packit_service.service.api.propose_downstream import ns as propose_downstream_ns
@@ -38,6 +39,7 @@
 api.add_namespace(webhooks_ns)
 api.add_namespace(allowlist_ns)
 api.add_namespace(koji_builds_ns)
+api.add_namespace(koji_tag_requests_ns)
 api.add_namespace(srpm_builds_ns)
 api.add_namespace(runs_ns)
 api.add_namespace(propose_downstream_ns)

packit_service/service/api/koji_tag_requests.py

@@ -0,0 +1,124 @@
+# Copyright Contributors to the Packit project.
+# SPDX-License-Identifier: MIT
+
+from http import HTTPStatus
+from logging import getLogger
+
+from flask_restx import Namespace, Resource
+
+from packit_service.models import (
+    KojiTagRequestGroupModel,
+    KojiTagRequestTargetModel,
+    optional_timestamp,
+)
+from packit_service.service.api.parsers import indices, pagination_arguments
+from packit_service.service.api.utils import get_project_info_from_build, response_maker
+
+logger = getLogger("packit_service")
+
+koji_tag_requests_ns = Namespace("koji-tag-requests", description="Koji tagging requests")
+
+
+@koji_tag_requests_ns.route("")
+class KojiTagRequestsList(Resource):
+    @koji_tag_requests_ns.expect(pagination_arguments)
+    @koji_tag_requests_ns.response(HTTPStatus.PARTIAL_CONTENT, "Koji tagging requests list follows")
+    def get(self):
+        """List all Koji tagging requests."""
+        first, last = indices()
+        result = []
+
+        for tag_request in KojiTagRequestTargetModel.get_range(first, last):
+            tag_request_dict = {
+                "packit_id": tag_request.id,
+                "task_id": tag_request.task_id,
+                "tag_request_submitted_time": optional_timestamp(
+                    tag_request.tag_request_submitted_time
+                ),
+                "chroot": tag_request.target,
+                "sidetag": tag_request.sidetag,
+                "nvr": tag_request.nvr,
+                "web_url": tag_request.web_url,
+                "pr_id": tag_request.get_pr_id(),
+                "branch_name": tag_request.get_branch_name(),
+                "release": tag_request.get_release_tag(),
+            }
+
+            if project := tag_request.get_project():
+                tag_request_dict["project_url"] = project.project_url
+                tag_request_dict["repo_namespace"] = project.namespace
+                tag_request_dict["repo_name"] = project.repo_name
+
+            result.append(tag_request_dict)
+
+        resp = response_maker(
+            result,
+            status=HTTPStatus.PARTIAL_CONTENT,
+        )
+        resp.headers["Content-Range"] = f"koji-tag-requests {first + 1}-{last}/*"
+        return resp
+
+
+@koji_tag_requests_ns.route("/<int:id>")
+@koji_tag_requests_ns.param("id", "Packit id of the tagging request")
+class KojiTagRequestItem(Resource):
+    @koji_tag_requests_ns.response(HTTPStatus.OK, "OK, koji tagging request details follow")
+    @koji_tag_requests_ns.response(
+        HTTPStatus.NOT_FOUND.value,
+        "No info about tagging request stored in DB",
+    )
+    def get(self, id):
+        """A specific koji tagging request details."""
+        tag_request = KojiTagRequestTargetModel.get_by_id(int(id))
+
+        if not tag_request:
+            return response_maker(
+                {"error": "No info about tagging request stored in DB"},
+                status=HTTPStatus.NOT_FOUND,
+            )
+
+        tag_request_dict = {
+            "task_id": tag_request.task_id,
+            "chroot": tag_request.target,
+            "sidetag": tag_request.sidetag,
+            "nvr": tag_request.nvr,
+            "tag_request_submitted_time": optional_timestamp(
+                tag_request.tag_request_submitted_time
+            ),
+            "commit_sha": tag_request.commit_sha,
+            "web_url": tag_request.web_url,
+            "run_ids": sorted(run.id for run in tag_request.group_of_targets.runs),
+        }
+
+        tag_request_dict.update(get_project_info_from_build(tag_request))
+        return response_maker(tag_request_dict)
+
+
+@koji_tag_requests_ns.route("/groups/<int:id>")
+@koji_tag_requests_ns.param("id", "Packit id of the koji tagging request group")
+class KojiTagRequestGroup(Resource):
+    @koji_tag_requests_ns.response(HTTPStatus.OK, "OK, koji tagging request group details follow")
+    @koji_tag_requests_ns.response(
+        HTTPStatus.NOT_FOUND.value,
+        "No info about koji tagging request group stored in DB",
+    )
+    def get(self, id):
+        """A specific test run details."""
+        group_model = KojiTagRequestGroupModel.get_by_id(int(id))
+
+        if not group_model:
+            return response_maker(
+                {"error": "No info about group stored in DB"},
+                status=HTTPStatus.NOT_FOUND,
+            )
+
+        group_dict = {
+            "submitted_time": optional_timestamp(group_model.submitted_time),
+            "run_ids": sorted(run.id for run in group_model.runs),
+            "tag_request_target_ids": sorted(
+                tag_request.id for tag_request in group_model.grouped_targets
+            ),
+        }
+
+        group_dict.update(get_project_info_from_build(group_model))
+        return response_maker(group_dict)