def test_regression_error_before_update(
pull_request: PullRequest,
config: V1,
branch_protection: BranchProtectionRule,
review: PRReview,
check_run: CheckRun,
) -> None:
branch_protection.requiresStatusChecks = True
branch_protection.requiredStatusCheckContexts = ["ci/backend", "wip-app"]
branch_protection.requiresStrictStatusChecks = True
pull_request.mergeStateStatus = MergeStateStatus.BEHIND
contexts = [StatusContext(context="ci/backend", state=StatusState.SUCCESS)]
check_run.name = "wip-app"
check_run.conclusion = CheckConclusionState.SUCCESS
with pytest.raises(NeedsBranchUpdate):
mergeable(
config=config,
pull_request=pull_request,
branch_protection=branch_protection,
review_requests_count=1,
reviews=[review],
check_runs=[check_run],
contexts=contexts,
valid_signature=False,
valid_merge_methods=[MergeMethod.squash],
)
def test_passing_checks(
pull_request: PullRequest,
config: V1,
branch_protection: BranchProtectionRule,
review: PRReview,
context: StatusContext,
check_run: CheckRun,
) -> None:
branch_protection.requiresStatusChecks = True
branch_protection.requiredStatusCheckContexts = ["ci/backend", "wip-app"]
context.context = "ci/backend"
context.state = StatusState.SUCCESS
check_run.name = "wip-app"
check_run.conclusion = CheckConclusionState.SUCCESS
mergeable(
config=config,
pull_request=pull_request,
branch_protection=branch_protection,
review_requests_count=0,
reviews=[review],
contexts=[context],
check_runs=[check_run],
valid_signature=False,
valid_merge_methods=[MergeMethod.squash],
)
def test_config_merge_optimistic_updates(
pull_request: PullRequest, config: V1, branch_protection: BranchProtectionRule
) -> None:
"""
If optimisitc_updates are enabled, branch updates should be prioritized over
waiting for running status checks to complete.
Otherwise, status checks should be checked before updating.
"""
branch_protection.requiredApprovingReviewCount = 0
branch_protection.requiresStrictStatusChecks = True
pull_request.mergeStateStatus = MergeStateStatus.BEHIND
branch_protection.requiresStatusChecks = True
branch_protection.requiredStatusCheckContexts = ["ci/lint", "ci/test"]
contexts: List[StatusContext] = []
config.merge.optimistic_updates = True
with pytest.raises(NeedsBranchUpdate):
mergeable(
app_id="1234",
config=config,
pull_request=pull_request,
branch_protection=branch_protection,
review_requests_count=0,
reviews=[],
contexts=contexts,
check_runs=[],
valid_signature=False,
valid_merge_methods=[MergeMethod.squash],
)
config.merge.optimistic_updates = False
with pytest.raises(WaitingForChecks):
mergeable(
app_id="1234",
config=config,
pull_request=pull_request,
branch_protection=branch_protection,
review_requests_count=0,
reviews=[],
contexts=contexts,
check_runs=[],
valid_signature=False,
valid_merge_methods=[MergeMethod.squash],
)
def test_unknown_blockage(
pull_request: PullRequest, config: V1, branch_protection: BranchProtectionRule
) -> None:
branch_protection.requiredApprovingReviewCount = 0
branch_protection.requiresStatusChecks = False
pull_request.mergeStateStatus = MergeStateStatus.BLOCKED
with pytest.raises(NotQueueable, match="determine why PR is blocked"):
mergeable(
config=config,
pull_request=pull_request,
branch_protection=branch_protection,
review_requests_count=0,
reviews=[],
contexts=[],
check_runs=[],
valid_signature=False,
valid_merge_methods=[MergeMethod.squash],
)