Files
carbon-lang/github_tools/check_dependent_pr_test.py
T
Chandler Carruth b7ea32c3a4 Support re-checking, overriding, and requiring the PR dependency check (#8120)
There are a world of reasons why the dependent state check can be wrong
or get stuck. We need ways to manually override inaccurate findings or
trigger a re-check when things change.

Overriding: removing the `dependent` label causes the job to run and
immediately report success to unblock merging. The `workflow_dispatch`
can also run with an `override` mode. This requires adding more tracked
state in the form of _ignored_ PRs that would otherwise be considered
dependencies.

Re-checking: the job now makes the status have a `Details` link that can
be used to re-run it, and editing the PR description also re-runs it.
However, adding the `dependent` label or doing an explicit
`workflow_dispatch` with mode `recheck` goes further: it drops any
overrides and recomputes the open dependencies from the current commits,
keeping the record of merged dependencies.

Hiding the comment still clears _all_ of the tracked state for the PR,
so the next check starts completely from scratch.

Lastly, this extends the workflow to support being marked as required by
letting it run in the merge queue and report success.

Works to keep the changes to `_process_pr` organized so that we first
collect and analyze the state, and only at the end mutate the PR's state
to the new configuration. Adds relevant unit tests for the new features.
Also added some basic documentation of this so that folks have a
reference when it has issues.

I considered the alternative of parsing mentions out of comments
(dependabot-style), but it ended up significantly more complicated and
brittle, so instead went with basing each change on an operation on the
PR that is already mechanically available.

Assisted-by: Antigravity with Opus
2026-11-13 05:19:44 +00:00

703 lines
25 KiB
Python

"""Tests for check_dependent_pr.py."""
__copyright__ = """
Part of the Carbon Language project, under the Apache License v2.0 with LLVM
Exceptions. See /LICENSE for license information.
SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
"""
import json
import os
import unittest
from typing import Any
from unittest import mock
import check_dependent_pr
import github_helpers
_OID1 = "1" * 40
_OID2 = "2" * 40
_OID3 = "3" * 40
_OID4 = "4" * 40
_OID9 = "9" * 40
class TestCheckDependentPR(unittest.TestCase):
def setUp(self) -> None:
self.mock_client = mock.MagicMock(spec=github_helpers.Client)
# Mock requests.post to avoid network calls and track status updates.
self.requests_post_patcher = mock.patch("requests.post")
self.mock_post = self.requests_post_patcher.start()
def tearDown(self) -> None:
self.requests_post_patcher.stop()
def _assert_status(self, sha: str, state: str, description: str) -> None:
"""Validates that requests.post was called to set the commit status."""
self.mock_post.assert_called_once()
args, kwargs = self.mock_post.call_args
self.assertIn(f"statuses/{sha}", args[0])
self.assertEqual(kwargs["json"]["state"], state)
self.assertEqual(kwargs["json"]["context"], "PR dependencies check")
self.assertEqual(kwargs["json"]["description"], description)
def _make_comment(
self,
open_deps: list[int],
merged_deps: list[int] = None,
first_commit: str = None,
ignored_deps: list[int] = None,
comment_id: str = "comment_id",
) -> dict[str, str]:
"""Builds a boilerplate PR comment."""
state: dict[str, Any] = {
"open": open_deps,
"merged": merged_deps if merged_deps else [],
}
if first_commit:
state["first_commit"] = first_commit
if ignored_deps:
state["ignored"] = ignored_deps
return {
"id": comment_id,
"body": f"<!-- check_dependent_pr {json.dumps(state)} -->",
}
def _make_pr_response(
self,
pr_id: str,
head_ref_oid: str,
commits: list[str],
comments: list[dict[str, str]] = None,
has_dependent_label: bool = False,
) -> dict[str, Any]:
"""Builds a boilerplate GitHub response for a PR."""
labels = (
[{"name": "dependent", "id": "label_dependent"}]
if has_dependent_label
else []
)
return {
"repository": {
"pullRequest": {
"id": pr_id,
"headRefOid": head_ref_oid,
"labels": {"nodes": labels},
"commits": {
"nodes": [{"commit": {"oid": oid}} for oid in commits]
},
"comments": {"nodes": comments if comments else []},
}
}
}
def test_process_pr_no_overlap(self) -> None:
self.mock_client.execute.return_value = self._make_pr_response(
pr_id="pr_1",
head_ref_oid=_OID1,
commits=[_OID1],
)
check_dependent_pr._process_pr(
self.mock_client,
pr_number=1,
pr_to_commits={1: {_OID1}},
pr_to_head={1: _OID1},
open_pr_numbers={1},
label_id="label_id",
token="test_token",
)
self.assertEqual(self.mock_client.execute.call_count, 1)
self._assert_status(
_OID1, "success", "This PR has no open dependencies"
)
def test_process_pr_with_overlap(self) -> None:
self.mock_client.execute.return_value = self._make_pr_response(
pr_id="pr_2",
head_ref_oid=_OID2,
commits=[_OID1, _OID2],
)
check_dependent_pr._process_pr(
self.mock_client,
pr_number=2,
pr_to_commits={1: {_OID1}, 2: {_OID1, _OID2}},
pr_to_head={1: _OID1, 2: _OID2},
open_pr_numbers={1, 2},
label_id="label_dependent",
token="test_token",
)
self.assertEqual(self.mock_client.execute.call_count, 3)
calls = self.mock_client.execute.call_args_list
self.assertIn("addLabelsToLabelable", calls[1][0][0])
self.assertIn("addComment", calls[2][0][0])
self.assertIn(
check_dependent_pr._DOCS_URL,
calls[2][1]["variable_values"]["body"],
)
self._assert_status(
_OID2, "pending", "This PR has open dependencies: #1"
)
def test_process_pr_dependencies_merged(self) -> None:
self.mock_client.execute.return_value = self._make_pr_response(
pr_id="pr_3",
head_ref_oid=_OID2,
commits=[_OID1, _OID2],
comments=[self._make_comment(open_deps=[1])],
has_dependent_label=True,
)
check_dependent_pr._process_pr(
self.mock_client,
pr_number=3,
pr_to_commits={3: {_OID1, _OID2}},
pr_to_head={3: _OID2},
open_pr_numbers={3},
label_id="label_dependent",
token="test_token",
)
calls = self.mock_client.execute.call_args_list
self.assertIn("removeLabelsFromLabelable", calls[1][0][0])
self.assertIn("updateIssueComment", calls[2][0][0])
self._assert_status(
_OID2, "success", "This PR has no open dependencies"
)
def test_process_pr_dependency_got_new_commits(self) -> None:
self.mock_client.execute.return_value = self._make_pr_response(
pr_id="pr_3",
head_ref_oid=_OID2,
commits=[_OID1, _OID2],
comments=[self._make_comment(open_deps=[1, 2])],
has_dependent_label=True,
)
check_dependent_pr._process_pr(
self.mock_client,
pr_number=3,
pr_to_commits={1: {_OID1, _OID4}, 3: {_OID1, _OID2}},
pr_to_head={1: _OID4, 3: _OID2},
open_pr_numbers={1, 3},
label_id="label_dependent",
token="test_token",
)
calls = self.mock_client.execute.call_args_list
update_mutation = calls[1][0][0]
self.assertIn("updateIssueComment", update_mutation)
variable_values = calls[1][1]["variable_values"]
self.assertIn('"open": [1]', variable_values["body"])
self.assertIn('"merged": [2]', variable_values["body"])
self._assert_status(
_OID2, "pending", "This PR has open dependencies: #1"
)
def test_process_pr_non_coherent_prefix(self) -> None:
self.mock_client.execute.return_value = self._make_pr_response(
pr_id="pr_10",
head_ref_oid=_OID2,
commits=[_OID1, _OID2],
)
check_dependent_pr._process_pr(
self.mock_client,
pr_number=10,
pr_to_commits={10: {_OID1, _OID2}, 11: {_OID1, _OID3}},
pr_to_head={10: _OID2, 11: _OID3},
open_pr_numbers={10, 11},
label_id="label_dependent",
token="test_token",
)
self.assertEqual(self.mock_client.execute.call_count, 1)
self._assert_status(
_OID2, "success", "This PR has no open dependencies"
)
def test_process_pr_overlap_only_on_head_ref(self) -> None:
self.mock_client.execute.return_value = self._make_pr_response(
pr_id="pr_9",
head_ref_oid=_OID2,
commits=[_OID1, _OID2],
)
check_dependent_pr._process_pr(
self.mock_client,
pr_number=9,
pr_to_commits={1: {_OID2}, 9: {_OID1, _OID2}},
pr_to_head={1: _OID2, 9: _OID2},
open_pr_numbers={1, 9},
label_id="label_dependent",
token="test_token",
)
self.assertEqual(self.mock_client.execute.call_count, 3)
calls = self.mock_client.execute.call_args_list
self.assertIn("addLabelsToLabelable", calls[1][0][0])
self.assertIn("addComment", calls[2][0][0])
self.assertIn(
check_dependent_pr._DOCS_URL,
calls[2][1]["variable_values"]["body"],
)
self._assert_status(
_OID2, "pending", "This PR has open dependencies: #1"
)
def test_process_pr_scanning_no_add(self) -> None:
self.mock_client.execute.return_value = self._make_pr_response(
pr_id="pr_7",
head_ref_oid=_OID2,
commits=[_OID1, _OID2],
)
check_dependent_pr._process_pr(
self.mock_client,
pr_number=7,
pr_to_commits={1: {_OID1}, 7: {_OID1, _OID2}},
pr_to_head={1: _OID1, 7: _OID2},
open_pr_numbers={1, 7},
label_id="label_dependent",
token="test_token",
scanning=True,
)
self.assertEqual(self.mock_client.execute.call_count, 1)
self._assert_status(
_OID2, "pending", "This PR has open dependencies: #1"
)
def test_process_pr_no_changes_needed(self) -> None:
self.mock_client.execute.return_value = self._make_pr_response(
pr_id="pr_6",
head_ref_oid=_OID2,
commits=[_OID1, _OID2],
comments=[self._make_comment(open_deps=[1], first_commit=_OID2)],
has_dependent_label=True,
)
check_dependent_pr._process_pr(
self.mock_client,
pr_number=6,
pr_to_commits={1: {_OID1}, 6: {_OID1, _OID2}},
pr_to_head={1: _OID1, 6: _OID2},
open_pr_numbers={1, 6},
label_id="label_dependent",
token="test_token",
)
self.assertEqual(self.mock_client.execute.call_count, 1)
self._assert_status(
_OID2, "pending", "This PR has open dependencies: #1"
)
def test_process_pr_invalid_marker(self) -> None:
self.mock_client.execute.return_value = self._make_pr_response(
pr_id="pr_5",
head_ref_oid=_OID1,
commits=[_OID1],
comments=[
{
"id": "comment_id",
"body": "<!-- check_dependent_pr {invalid_json} -->",
}
],
)
import json
self.assertRaises(
json.decoder.JSONDecodeError,
check_dependent_pr._process_pr,
self.mock_client,
pr_number=5,
pr_to_commits={5: {_OID1}},
pr_to_head={5: _OID1},
open_pr_numbers={5},
label_id="label_dependent",
token="test_token",
)
def test_process_pr_hidden_comment(self) -> None:
self.mock_client.execute.return_value = self._make_pr_response(
pr_id="pr_14",
head_ref_oid=_OID2,
commits=[_OID1, _OID2],
comments=[
{
"id": "hidden_comment_id",
"body": '<!-- check_dependent_pr {"open": [1]} -->',
"isMinimized": True,
}
],
has_dependent_label=True,
)
check_dependent_pr._process_pr(
self.mock_client,
pr_number=14,
pr_to_commits={1: {_OID1}, 14: {_OID1, _OID2}},
pr_to_head={1: _OID1, 14: _OID2},
open_pr_numbers={1, 14},
label_id="label_dependent",
token="test_token",
)
calls = self.mock_client.execute.call_args_list
self.assertEqual(self.mock_client.execute.call_count, 2)
self.assertIn("addComment", calls[1][0][0])
self._assert_status(
_OID2, "pending", "This PR has open dependencies: #1"
)
def test_process_pr_sticky_first_commit(self) -> None:
self.mock_client.execute.return_value = self._make_pr_response(
pr_id="pr_11",
head_ref_oid=_OID3,
commits=[_OID1, _OID2, _OID3],
comments=[self._make_comment(open_deps=[1, 2], first_commit=_OID2)],
has_dependent_label=True,
)
check_dependent_pr._process_pr(
self.mock_client,
pr_number=11,
pr_to_commits={1: {_OID1}, 11: {_OID1, _OID2, _OID3}},
pr_to_head={1: _OID1, 11: _OID3},
open_pr_numbers={1, 11},
label_id="label_dependent",
token="test_token",
)
calls = self.mock_client.execute.call_args_list
variable_values = calls[1][1]["variable_values"]
# Uses the last dependency's HEAD (_OID1) instead of sticky first
# commit (_OID2)
self.assertIn(_OID1[:8], variable_values["body"])
self._assert_status(
_OID3, "pending", "This PR has open dependencies: #1"
)
def test_process_pr_rebase_first_commit(self) -> None:
self.mock_client.execute.return_value = self._make_pr_response(
pr_id="pr_12",
head_ref_oid=_OID2,
commits=[_OID1, _OID2],
comments=[self._make_comment(open_deps=[1, 2])],
has_dependent_label=True,
)
check_dependent_pr._process_pr(
self.mock_client,
pr_number=12,
pr_to_commits={1: {_OID9}, 12: {_OID1, _OID2}},
pr_to_head={1: _OID9, 12: _OID2},
open_pr_numbers={1, 12},
label_id="label_dependent",
token="test_token",
)
calls = self.mock_client.execute.call_args_list
variable_values = calls[1][1]["variable_values"]
self.assertIn(
"unable to identify starting review commit", variable_values["body"]
)
self._assert_status(
_OID2, "pending", "This PR has open dependencies: #1"
)
def test_process_pr_fallback_no_independent_commit(self) -> None:
self.mock_client.execute.return_value = self._make_pr_response(
pr_id="pr_13",
head_ref_oid=_OID2,
commits=[_OID1, _OID2],
comments=[self._make_comment(open_deps=[1, 2])],
has_dependent_label=True,
)
check_dependent_pr._process_pr(
self.mock_client,
pr_number=13,
pr_to_commits={1: {_OID1, _OID2}, 13: {_OID1, _OID2}},
pr_to_head={1: _OID2, 13: _OID2},
open_pr_numbers={1, 13},
label_id="label_dependent",
token="test_token",
)
calls = self.mock_client.execute.call_args_list
variable_values = calls[1][1]["variable_values"]
# Uses the last dependency's HEAD even if there are no independent
# commits
self.assertIn(_OID2[:8], variable_values["body"])
self._assert_status(
_OID2, "pending", "This PR has open dependencies: #1"
)
def test_process_pr_sequence_failure(self) -> None:
self.mock_client.execute.return_value = self._make_pr_response(
pr_id="pr_1",
head_ref_oid=_OID1,
commits=[_OID1],
)
check_dependent_pr._process_pr(
self.mock_client,
pr_number=1,
pr_to_commits={1: {_OID1}, 2: {_OID1, _OID2}},
pr_to_head={1: _OID1, 2: _OID2},
open_pr_numbers={1, 2},
label_id="label_dependent",
token="test_token",
)
self.assertEqual(self.mock_client.execute.call_count, 1)
self._assert_status(
_OID1, "success", "This PR has no open dependencies"
)
def test_process_pr_no_overlap_different_commits(self) -> None:
self.mock_client.execute.return_value = self._make_pr_response(
pr_id="pr_2",
head_ref_oid=_OID2,
commits=[_OID2],
)
check_dependent_pr._process_pr(
self.mock_client,
pr_number=2,
pr_to_commits={1: {_OID1}, 2: {_OID2}},
pr_to_head={1: _OID1, 2: _OID2},
open_pr_numbers={1, 2},
label_id="label_dependent",
token="test_token",
)
self.assertEqual(self.mock_client.execute.call_count, 1)
self._assert_status(
_OID2, "success", "This PR has no open dependencies"
)
def test_process_pr_no_unique_commit(self) -> None:
self.mock_client.execute.return_value = self._make_pr_response(
pr_id="pr_2",
head_ref_oid=_OID2,
commits=[_OID1, _OID2],
)
check_dependent_pr._process_pr(
self.mock_client,
pr_number=2,
pr_to_commits={1: {_OID1, _OID2, _OID3}, 2: {_OID1, _OID2}},
pr_to_head={1: _OID3, 2: _OID2},
open_pr_numbers={1, 2},
label_id="label_dependent",
token="test_token",
)
self.assertEqual(self.mock_client.execute.call_count, 1)
self._assert_status(
_OID2, "success", "This PR has no open dependencies"
)
def test_process_pr_multiple_non_overlapping_commits(self) -> None:
self.mock_client.execute.return_value = self._make_pr_response(
pr_id="pr_2",
head_ref_oid=_OID4,
commits=[_OID1, _OID3, _OID4],
)
check_dependent_pr._process_pr(
self.mock_client,
pr_number=2,
pr_to_commits={1: {_OID1, _OID2}, 2: {_OID1, _OID3, _OID4}},
pr_to_head={1: _OID2, 2: _OID4},
open_pr_numbers={1, 2},
label_id="label_dependent",
token="test_token",
)
self.assertEqual(self.mock_client.execute.call_count, 3)
calls = self.mock_client.execute.call_args_list
self.assertIn("addLabelsToLabelable", calls[1][0][0])
self._assert_status(
_OID4, "pending", "This PR has open dependencies: #1"
)
def test_always_sets_status_check_success(self) -> None:
self.mock_client.execute.return_value = self._make_pr_response(
pr_id="pr_1",
head_ref_oid=_OID1,
commits=[_OID1],
)
check_dependent_pr._process_pr(
self.mock_client,
pr_number=1,
pr_to_commits={1: {_OID1}},
pr_to_head={1: _OID1},
open_pr_numbers={1},
label_id="label_id",
token="test_token",
)
self._assert_status(
_OID1, "success", "This PR has no open dependencies"
)
def test_always_sets_status_check_pending(self) -> None:
self.mock_client.execute.return_value = self._make_pr_response(
pr_id="pr_2",
head_ref_oid=_OID2,
commits=[_OID1, _OID2],
)
check_dependent_pr._process_pr(
self.mock_client,
pr_number=2,
pr_to_commits={1: {_OID1}, 2: {_OID1, _OID2}},
pr_to_head={1: _OID1, 2: _OID2},
open_pr_numbers={1, 2},
label_id="label_dependent",
token="test_token",
)
self._assert_status(
_OID2, "pending", "This PR has open dependencies: #1"
)
def test_process_pr_sibling_prs(self) -> None:
# PR 1: [_OID1]
# PR 2: [_OID1, _OID2]
# PR 3: [_OID1, _OID3]
# PR 3 depends on PR 1, but not PR 2.
self.mock_client.execute.return_value = self._make_pr_response(
pr_id="pr_3",
head_ref_oid=_OID3,
commits=[_OID1, _OID3],
)
check_dependent_pr._process_pr(
self.mock_client,
pr_number=3,
pr_to_commits={
1: {_OID1},
2: {_OID1, _OID2},
3: {_OID1, _OID3},
},
pr_to_head={1: _OID1, 2: _OID2, 3: _OID3},
open_pr_numbers={1, 2, 3},
label_id="label_dependent",
token="test_token",
)
self.assertEqual(self.mock_client.execute.call_count, 3)
calls = self.mock_client.execute.call_args_list
self.assertIn("addLabelsToLabelable", calls[1][0][0])
# Link should only mention PR #1
variable_values = calls[2][1]["variable_values"]
self.assertIn("Depends on #1", variable_values["body"])
self.assertNotIn("#2", variable_values["body"])
self._assert_status(
_OID3, "pending", "This PR has open dependencies: #1"
)
def test_query_max_merged_pr_explicit_orderBy_and_first_one(self) -> None:
self.assertIn(
"orderBy: {field: CREATED_AT, direction: DESC}",
check_dependent_pr._QUERY_MAX_MERGED_PR,
)
self.assertIn(
"first: 1",
check_dependent_pr._QUERY_MAX_MERGED_PR,
)
def test_process_pr_override(self) -> None:
self.mock_client.execute.return_value = self._make_pr_response(
pr_id="pr_3",
head_ref_oid=_OID3,
commits=[_OID1, _OID3],
comments=[self._make_comment(open_deps=[1], first_commit=_OID3)],
has_dependent_label=True,
)
check_dependent_pr._process_pr(
self.mock_client,
pr_number=3,
pr_to_commits={1: {_OID1}, 3: {_OID1, _OID3}},
pr_to_head={1: _OID1, 3: _OID3},
open_pr_numbers={1, 3},
label_id="label_dependent",
token="test_token",
override=True,
)
calls = self.mock_client.execute.call_args_list
self.assertIn("removeLabelsFromLabelable", calls[1][0][0])
self.assertIn('"ignored": [1]', calls[2][1]["variable_values"]["body"])
self._assert_status(
_OID3, "success", "Dependency check overridden (ignoring #1)"
)
# Subsequent push keeps #1 ignored, while still catching new dep #2.
self.mock_post.reset_mock()
self.mock_client.reset_mock()
self.mock_client.execute.return_value = self._make_pr_response(
pr_id="pr_3",
head_ref_oid=_OID4,
commits=[_OID1, _OID2, _OID4],
comments=[self._make_comment(open_deps=[], ignored_deps=[1])],
)
check_dependent_pr._process_pr(
self.mock_client,
pr_number=3,
pr_to_commits={
1: {_OID1},
2: {_OID1, _OID2},
3: {_OID1, _OID2, _OID4},
},
pr_to_head={1: _OID1, 2: _OID2, 3: _OID4},
open_pr_numbers={1, 2, 3},
label_id="label_dependent",
token="test_token",
)
self._assert_status(
_OID4, "pending", "This PR has open dependencies: #2"
)
def test_process_pr_recheck(self) -> None:
self.mock_client.execute.return_value = self._make_pr_response(
pr_id="pr_2",
head_ref_oid=_OID2,
commits=[_OID2],
comments=[self._make_comment(open_deps=[1], ignored_deps=[3])],
has_dependent_label=True,
)
check_dependent_pr._process_pr(
self.mock_client,
pr_number=2,
pr_to_commits={1: {_OID1}, 2: {_OID2}, 3: {_OID3}},
pr_to_head={1: _OID1, 2: _OID2, 3: _OID3},
open_pr_numbers={1, 2, 3},
label_id="label_dependent",
token="test_token",
recheck=True,
)
calls = self.mock_client.execute.call_args_list
self.assertIn("removeLabelsFromLabelable", calls[1][0][0])
self.assertIn("updateIssueComment", calls[2][0][0])
self._assert_status(
_OID2, "success", "This PR has no open dependencies"
)
def test_process_pr_recheck_removes_label_without_comment(self) -> None:
# Adding `dependent` to an independent PR forces a re-check, which
# removes the label again without posting a comment.
self.mock_client.execute.return_value = self._make_pr_response(
pr_id="pr_2",
head_ref_oid=_OID2,
commits=[_OID2],
has_dependent_label=True,
)
check_dependent_pr._process_pr(
self.mock_client,
pr_number=2,
pr_to_commits={2: {_OID2}},
pr_to_head={2: _OID2},
open_pr_numbers={2},
label_id="label_dependent",
token="test_token",
recheck=True,
)
calls = self.mock_client.execute.call_args_list
self.assertEqual(len(calls), 2)
self.assertIn("removeLabelsFromLabelable", calls[1][0][0])
self._assert_status(
_OID2, "success", "This PR has no open dependencies"
)
def test_set_commit_status_links_workflow_run(self) -> None:
with mock.patch.dict(
os.environ,
{
"GITHUB_SERVER_URL": "https://github.com",
"GITHUB_REPOSITORY": "carbon-language/carbon-lang",
"GITHUB_RUN_ID": "42",
},
):
check_dependent_pr._set_commit_status(
_OID1, "success", "ok", "test_token", dry_run=False
)
_, kwargs = self.mock_post.call_args
self.assertEqual(
kwargs["json"]["target_url"],
"https://github.com/carbon-language/carbon-lang/actions/runs/42",
)
if __name__ == "__main__":
unittest.main()