add initial auto-merge capability

Author: tomasmatus

lib/bots_automerge.py

@@ -0,0 +1,79 @@
+# This file is part of Cockpit.
+#
+# Copyright (C) 2025 Red Hat, Inc.
+#
+# Cockpit is free software; you can redistribute it and/or modify it
+# under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation; either version 2.1 of the License, or
+# (at your option) any later version.
+#
+# Cockpit is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Cockpit; If not, see <http://www.gnu.org/licenses/>.
+
+import logging
+
+from lib.aio.jsonutil import get_int, get_str
+from task import github
+
+logger = logging.getLogger(__name__)
+
+# TODO: verify if this is always the same
+GITHUB_CI = {
+    'login': 'github-actions[bot]',
+    'id': 41898282,
+}
+
+COCKPITUOUS = {
+    'login': 'cockpituous',
+    'id': 14330603,
+}
+
+
+def is_ci_bot(api: github.GitHub, pr: int) -> bool:
+    author = api.get_author(pr)
+    login = get_str(author, 'login')
+    login_id = get_int(author, 'id')
+
+    return ((login == GITHUB_CI['login'] and login_id == GITHUB_CI['id']) or
+        (login == COCKPITUOUS['login'] and login_id == COCKPITUOUS['id']))
+
+
+def all_checks_pass(api: github.GitHub, commit_hash: str) -> bool:
+    statuses = api.statuses(commit_hash)
+
+    logger.info("Checking statuses:")
+    if len(statuses) == 0:
+        logger.info("No statuses found for commit %s", commit_hash)
+        return False
+
+    for context in statuses:
+        status = statuses[context]
+        status_state = get_str(status, 'state')
+        logger.info("Status for context '%s': %s", context, status_state)
+        if status_state != 'success':
+            return False
+
+    return True
+
+
+def auto_merge_bots_pr(repo: str, pr: int, sha: str) -> None:
+    api = github.GitHub(repo=repo)
+
+    # Make sure that the PR was made by cockpituous or github actions
+    # if not is_ci_bot(api, pr_num):
+    #     logger.info("PR not made by CI bot, skipping automerge")
+    #     return
+
+    # check that all checks are green
+    if not all_checks_pass(api, sha):
+        logger.info("Not every check has passed, skipping automerge")
+        return
+
+    logger.info("All checks green, can automerge")
+    # merge the PR
+    api.approve_pr(pr, sha)

run-queue

@@ -31,6 +31,8 @@ from collections.abc import Sequence
 
 import pika
 
+from lib.aio.jsonutil import JsonObject, get_int, get_str
+from lib.bots_automerge import auto_merge_bots_pr
 from lib.directories import get_images_data_dir
 from lib.network import redhat_network
 from lib.stores import LOG_STORE
@@ -43,7 +45,9 @@ statistics_queue = os.environ.get("RUN_STATISTICS_QUEUE")
 # as per pika docs
 DeliveryTag = int
 
-ConsumeResult = tuple[Sequence[str] | str | None, DeliveryTag | None]
+JobSubject = JsonObject
+
+ConsumeResult = tuple[Sequence[str] | str | None, DeliveryTag | None, JobSubject | None]
 
 
 # Returns a command argv to execute and the delivery tag needed to ack the message
@@ -52,7 +56,7 @@ def consume_webhook_queue(dq: distributed_queue.DistributedQueue) -> ConsumeResu
     # call tests-scan or issue-scan appropriately
     method_frame, _header_frame, message = dq.channel.basic_get(queue='webhook')
     if not method_frame or not message:
-        return None, None
+        return None, None, None
 
     body = json.loads(message)
     event = body['event']
@@ -97,9 +101,9 @@ def consume_webhook_queue(dq: distributed_queue.DistributedQueue) -> ConsumeResu
             cmd = ['./issue-scan', '--issues-data', json.dumps(request), '--amqp', dq.address]
     else:
         logging.error('Unkown event type in the webhook queue')
-        return None, None
+        return None, None, None
 
-    return cmd, method_frame.delivery_tag
+    return cmd, method_frame.delivery_tag, None
 
 
 # Returns a command to execute and the delivery tag needed to ack the message
@@ -119,18 +123,20 @@ def consume_task_queue(dq: distributed_queue.DistributedQueue) -> ConsumeResult:
                 queue = ['public', 'rhel'][random.randrange(2)]
     else:
         # nothing to do
-        return None, None
+        return None, None, None
 
     method_frame, _header_frame, message = dq.channel.basic_get(queue=queue)
     if not method_frame or not message:
-        return None, None
+        return None, None, None
 
     body = json.loads(message)
     if job := body.get('job'):
         command = ['./job-runner', 'json', json.dumps(job)]
+        job_subject = job.get('subject')
     else:
         command = body['command']
-    return command, method_frame.delivery_tag
+        job_subject = None
+    return command, method_frame.delivery_tag, job_subject
 
 
 def mail_notification(body: str) -> None:
@@ -159,14 +165,14 @@ def main() -> int:
     opts = parser.parse_args()
 
     with distributed_queue.DistributedQueue(opts.amqp, ['webhook', 'rhel', 'public', 'statistics']) as dq:
-        cmd, delivery_tag = consume_webhook_queue(dq)
+        cmd, delivery_tag, job_subj = consume_webhook_queue(dq)
         if not cmd and delivery_tag:
             logging.info("Webhook message interpretation generated no command")
             dq.channel.basic_ack(delivery_tag)
             return 0
 
         if not cmd:
-            cmd, delivery_tag = consume_task_queue(dq)
+            cmd, delivery_tag, job_subj = consume_task_queue(dq)
         if not cmd:
             logging.info("All queues are empty")
             return 1
@@ -191,6 +197,16 @@ failed with exit code %i. Please check the container logs for details.""" % (cmd
         if delivery_tag is not None:
             dq.channel.basic_ack(delivery_tag)
 
+        if job_subj is not None:
+            repo = get_str(job_subj, 'repo')
+            pull = get_int(job_subj, 'pull')
+            sha = get_str(job_subj, 'sha')
+            # skip automerge if jobs don't run against a PR
+            if repo is not None and pull is not None and sha is not None:
+                auto_merge_bots_pr(repo, pull, sha)
+            else:
+                logging.info("Skipping automerge for job: %s", job_subj)
+
     return 0
 
 

task/github.py

@@ -426,7 +426,6 @@ def get_author(self, pr: int) -> JsonObject:
 
     def approve_pr(self, pr: int, sha: str) -> None:
         # https://docs.github.com/en/rest/pulls/reviews?apiVersion=2022-11-28#create-a-review-for-a-pull-request
-
         data = {
             'commit_id': sha,
             'event': 'APPROVE',