Merge pull request #65228 from ClickHouse/ci_propagate_wf_error_to_finish_check

CI: FinishCheck to set failure if workflow failed

.github/workflows/backport_branches.yml

@@ -273,5 +273,5 @@ jobs:
       - name: Finish label
         run: |
           cd "$GITHUB_WORKSPACE/tests/ci"
-          python3 finish_check.py
+          python3 finish_check.py --wf-status ${{ contains(needs.*.result, 'failure') && 'failure' || 'success' }}
           python3 merge_pr.py

.github/workflows/master.yml

@@ -173,4 +173,4 @@ jobs:
       - name: Finish label
         run: |
           cd "$GITHUB_WORKSPACE/tests/ci"
-          python3 finish_check.py
+          python3 finish_check.py --wf-status ${{ contains(needs.*.result, 'failure') && 'failure' || 'success' }}

.github/workflows/merge_queue.yml

@@ -112,4 +112,4 @@ jobs:
       - name: Finish label
         run: |
           cd "$GITHUB_WORKSPACE/tests/ci"
-          python3 finish_check.py ${{ (contains(needs.*.result, 'failure') && github.event_name == 'merge_group') && '--pipeline-failure' || '' }}
+          python3 finish_check.py --wf-status ${{ contains(needs.*.result, 'failure') && 'failure' || 'success' }}

.github/workflows/pull_request.yml

@@ -191,7 +191,7 @@ jobs:
       - name: Finish label
         run: |
           cd "$GITHUB_WORKSPACE/tests/ci"
-          python3 finish_check.py
+          python3 finish_check.py --wf-status ${{ contains(needs.*.result, 'failure') && 'failure' || 'success' }}
 
 #############################################################################################
 ###################################### JEPSEN TESTS #########################################

.github/workflows/release_branches.yml

@@ -496,4 +496,4 @@ jobs:
       - name: Finish label
         run: |
           cd "$GITHUB_WORKSPACE/tests/ci"
-          python3 finish_check.py
+          python3 finish_check.py --wf-status ${{ contains(needs.*.result, 'failure') && 'failure' || 'success' }}

tests/ci/finish_check.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
+import argparse
 import logging
-import sys
 
 from github import Github
 
@@ -20,28 +20,40 @@ from report import FAILURE, PENDING, SUCCESS, StatusType
 from synchronizer_utils import SYNC_BRANCH_PREFIX
 
 
+def parse_args() -> argparse.Namespace:
+    parser = argparse.ArgumentParser(
+        formatter_class=argparse.ArgumentDefaultsHelpFormatter,
+        description="Script to merge the given PR. Additional checks for approved "
+        "status and green commit statuses could be done",
+    )
+    parser.add_argument(
+        "--wf-status",
+        type=str,
+        default="",
+        help="overall workflow status [success|failure]",
+    )
+    return parser.parse_args()
+
+
 def main():
     logging.basicConfig(level=logging.INFO)
+    args = parse_args()
 
-    has_failure = False
-
-    # FIXME: temporary hack to fail Mergeable Check in MQ if pipeline has any failed jobs
-    if len(sys.argv) > 1 and sys.argv[1] == "--pipeline-failure":
-        has_failure = True
+    has_workflow_failures = args.wf_status == FAILURE
 
     pr_info = PRInfo(need_orgs=True)
     gh = Github(get_best_robot_token(), per_page=100)
     commit = get_commit(gh, pr_info.sha)
-    statuses = None
 
     if pr_info.is_merge_queue:
-        # in MQ Mergeable check status must never be green if any failures in workflow
-        if has_failure:
-            set_mergeable_check(commit, "workflow failed", "failure")
+        # in MQ Mergeable check status must never be green if any failures in the workflow
+        if has_workflow_failures:
+            set_mergeable_check(commit, "workflow failed", FAILURE)
         else:
             # This must be the only place where green MCheck is set in the MQ (in the end of CI) to avoid early merge
-            set_mergeable_check(commit, "workflow passed", "success")
-    else:
+            set_mergeable_check(commit, "workflow passed", SUCCESS)
+        return
+
     statuses = get_commit_filtered_statuses(commit)
     state = trigger_mergeable_check(commit, statuses, set_if_green=True)
 
@@ -67,33 +79,35 @@ def main():
 
     has_failure = False
     has_pending = False
+    error_cnt = 0
     for status in statuses:
-            if status.context in (StatusNames.MERGEABLE, StatusNames.CI):
+        if status.context in (StatusNames.MERGEABLE, StatusNames.CI, StatusNames.SYNC):
             # do not account these statuses
             continue
         if status.state == PENDING:
-                if status.context == StatusNames.SYNC:
-                    # do not account sync status if pending - it's a different WF
-                    continue
             has_pending = True
-            elif status.state == SUCCESS:
-                continue
-            else:
+        elif status.state != SUCCESS:
             has_failure = True
+            error_cnt += 1
 
     ci_state = SUCCESS  # type: StatusType
+    description = "All checks finished"
     if has_failure:
         ci_state = FAILURE
+        description = f"All checks finished. {error_cnt} jobs failed"
+    elif has_workflow_failures:
+        ci_state = FAILURE
+        description = "All checks finished. Workflow has failures."
     elif has_pending:
         print("ERROR: CI must not have pending jobs by the time of finish check")
+        description = "ERROR: workflow has pending jobs"
         ci_state = FAILURE
 
-        if ci_status.state == PENDING:
     post_commit_status(
         commit,
         ci_state,
         ci_status.target_url,
-                "All checks finished",
+        description,
         StatusNames.CI,
         pr_info,
         dump_to_file=True,