Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 67 additions & 0 deletions .github/reviewer-bot-tests/test_reviewer_bot.py
Original file line number Diff line number Diff line change
Expand Up @@ -947,6 +947,73 @@ def test_execute_pending_privileged_command_fails_closed_without_live_fls_audit_
assert pending["result"] == "live_revalidation_failed"


def test_assign_command_posts_pr_guidance_on_success(monkeypatch):
state = make_state()
state["queue"] = [{"github": "felix91gr", "name": "Félix Fischer"}]
monkeypatch.setenv("IS_PULL_REQUEST", "true")
monkeypatch.setenv("ISSUE_AUTHOR", "PLeVasseur")
monkeypatch.setattr(reviewer_bot, "get_issue_assignees", lambda issue_number: [])
monkeypatch.setattr(reviewer_bot, "request_reviewer_assignment", lambda issue_number, username: reviewer_bot.AssignmentAttempt(success=True, status_code=201))
posted = []
monkeypatch.setattr(reviewer_bot, "post_comment", lambda issue_number, body: posted.append(body) or True)
response, success = reviewer_bot.handle_assign_command(state, 42, "@felix91gr")
assert success is True
assert response == "✅ @felix91gr has been assigned as reviewer."
assert posted == [reviewer_bot.get_pr_guidance("felix91gr", "PLeVasseur")]


def test_claim_command_posts_pr_guidance_on_success(monkeypatch):
state = make_state()
state["queue"] = [{"github": "felix91gr", "name": "Félix Fischer"}]
monkeypatch.setenv("IS_PULL_REQUEST", "true")
monkeypatch.setenv("ISSUE_AUTHOR", "PLeVasseur")
monkeypatch.setattr(reviewer_bot, "get_issue_assignees", lambda issue_number: [])
monkeypatch.setattr(reviewer_bot, "request_reviewer_assignment", lambda issue_number, username: reviewer_bot.AssignmentAttempt(success=True, status_code=201))
posted = []
monkeypatch.setattr(reviewer_bot, "post_comment", lambda issue_number, body: posted.append(body) or True)
response, success = reviewer_bot.handle_claim_command(state, 42, "felix91gr")
assert success is True
assert response == "✅ @felix91gr has claimed this review."
assert posted == [reviewer_bot.get_pr_guidance("felix91gr", "PLeVasseur")]


def test_pass_command_posts_pr_guidance_for_new_reviewer(monkeypatch):
state = make_state()
state["queue"] = [
{"github": "alice", "name": "Alice"},
{"github": "felix91gr", "name": "Félix Fischer"},
]
review = reviewer_bot.ensure_review_entry(state, 42, create=True)
assert review is not None
review["current_reviewer"] = "alice"
monkeypatch.setenv("IS_PULL_REQUEST", "true")
monkeypatch.setenv("ISSUE_AUTHOR", "PLeVasseur")
monkeypatch.setattr(reviewer_bot, "get_issue_assignees", lambda issue_number: ["alice"])
monkeypatch.setattr(reviewer_bot, "request_reviewer_assignment", lambda issue_number, username: reviewer_bot.AssignmentAttempt(success=True, status_code=201))
monkeypatch.setattr(reviewer_bot, "unassign_reviewer", lambda issue_number, username: True)
posted = []
monkeypatch.setattr(reviewer_bot, "post_comment", lambda issue_number, body: posted.append(body) or True)
response, success = reviewer_bot.handle_pass_command(state, 42, "alice", None)
assert success is True
assert "@felix91gr is now assigned as the reviewer." in response
assert posted == [reviewer_bot.get_pr_guidance("felix91gr", "PLeVasseur")]


def test_assign_from_queue_posts_guidance_only_once(monkeypatch):
state = make_state()
state["queue"] = [{"github": "felix91gr", "name": "Félix Fischer"}]
monkeypatch.setenv("IS_PULL_REQUEST", "true")
monkeypatch.setenv("ISSUE_AUTHOR", "PLeVasseur")
monkeypatch.setattr(reviewer_bot, "get_issue_assignees", lambda issue_number: [])
monkeypatch.setattr(reviewer_bot, "request_reviewer_assignment", lambda issue_number, username: reviewer_bot.AssignmentAttempt(success=True, status_code=201))
posted = []
monkeypatch.setattr(reviewer_bot, "post_comment", lambda issue_number, body: posted.append(body) or True)
response, success = reviewer_bot.handle_assign_from_queue_command(state, 42)
assert success is True
assert response == "✅ @felix91gr (next in queue) has been assigned as reviewer."
assert posted == [reviewer_bot.get_pr_guidance("felix91gr", "PLeVasseur")]


def test_list_changed_files_ignores_untracked_bootstrap_noise(monkeypatch, tmp_path):
commands_seen = []

Expand Down
106 changes: 72 additions & 34 deletions scripts/reviewer_bot_lib/commands.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
from datetime import datetime, timezone
from pathlib import Path

from .config import AssignmentAttempt
from .guidance import get_issue_guidance, get_pr_guidance


Expand Down Expand Up @@ -80,6 +81,35 @@ def parse_command(bot, comment_body: str) -> tuple[str, list[str]] | None:
return command, args


def _apply_assignment_side_effects(
bot,
state: dict,
issue_number: int,
reviewer: str,
assignment_method: str,
issue_author: str,
) -> tuple[AssignmentAttempt, str | None]:
is_pr = os.environ.get("IS_PULL_REQUEST", "false").lower() == "true"
assignment_attempt = bot.request_reviewer_assignment(issue_number, reviewer)
bot.set_current_reviewer(state, issue_number, reviewer, assignment_method=assignment_method)
bot.record_assignment(state, reviewer, issue_number, "pr" if is_pr else "issue")
failure_comment = bot.get_assignment_failure_comment(reviewer, assignment_attempt)
if failure_comment:
bot.post_comment(issue_number, failure_comment)
if assignment_attempt.success:
if is_pr:
bot.post_comment(issue_number, get_pr_guidance(reviewer, issue_author))
else:
labels = set(parse_issue_labels())
guidance = (
bot.get_fls_audit_guidance(reviewer, issue_author)
if bot.FLS_AUDIT_LABEL in labels
else get_issue_guidance(reviewer, issue_author)
)
bot.post_comment(issue_number, guidance)
return assignment_attempt, failure_comment


def handle_pass_command(bot, state: dict, issue_number: int, comment_author: str, reason: str | None) -> tuple[str, bool]:
issue_data = bot.ensure_review_entry(state, issue_number, create=True)
if issue_data is None:
Expand All @@ -104,13 +134,16 @@ def handle_pass_command(bot, state: dict, issue_number: int, comment_author: str
return ("❌ No other reviewers available. Everyone in the queue has either passed on this issue or is the author."), False
bot.reposition_member_as_next(state, passed_reviewer)
bot.unassign_reviewer(issue_number, passed_reviewer)
is_pr = os.environ.get("IS_PULL_REQUEST", "false").lower() == "true"
assignment_attempt = bot.request_reviewer_assignment(issue_number, next_reviewer)
bot.set_current_reviewer(state, issue_number, next_reviewer)
bot.record_assignment(state, next_reviewer, issue_number, "pr" if is_pr else "issue")
assignment_attempt, failure_comment = _apply_assignment_side_effects(
bot,
state,
issue_number,
next_reviewer,
"round-robin",
issue_author,
)
assignment_line = f"@{next_reviewer} is now assigned as the reviewer."
if not assignment_attempt.success:
failure_comment = bot.get_assignment_failure_comment(next_reviewer, assignment_attempt)
if failure_comment:
assignment_line = failure_comment
else:
Expand Down Expand Up @@ -171,14 +204,17 @@ def handle_pass_until_command(bot, state: dict, issue_number: int, comment_autho
skip_set = {issue_author} if issue_author else set()
next_reviewer = bot.get_next_reviewer(state, skip_usernames=skip_set)
if next_reviewer:
is_pr = os.environ.get("IS_PULL_REQUEST", "false").lower() == "true"
assignment_attempt = bot.request_reviewer_assignment(issue_number, next_reviewer)
bot.set_current_reviewer(state, issue_number, next_reviewer)
bot.record_assignment(state, next_reviewer, issue_number, "pr" if is_pr else "issue")
assignment_attempt, failure_comment = _apply_assignment_side_effects(
bot,
state,
issue_number,
next_reviewer,
"round-robin",
issue_author,
)
if assignment_attempt.success:
reassigned_msg = f"\n\n@{next_reviewer} has been assigned as the new reviewer for this issue."
else:
failure_comment = bot.get_assignment_failure_comment(next_reviewer, assignment_attempt)
if failure_comment:
reassigned_msg = f"\n\n{failure_comment}"
else:
Expand Down Expand Up @@ -441,14 +477,18 @@ def handle_claim_command(bot, state: dict, issue_number: int, comment_author: st
current_assignees = bot.get_issue_assignees(issue_number)
for assignee in current_assignees:
bot.unassign_reviewer(issue_number, assignee)
is_pr = os.environ.get("IS_PULL_REQUEST", "false").lower() == "true"
assignment_attempt = bot.request_reviewer_assignment(issue_number, comment_author)
bot.set_current_reviewer(state, issue_number, comment_author, assignment_method="claim")
bot.record_assignment(state, comment_author, issue_number, "pr" if is_pr else "issue")
issue_author = os.environ.get("ISSUE_AUTHOR", "")
assignment_attempt, failure_comment = _apply_assignment_side_effects(
bot,
state,
issue_number,
comment_author,
"claim",
issue_author,
)
prev_text = f" (previously: @{', @'.join(current_assignees)})" if current_assignees else ""
response = f"✅ @{comment_author} has claimed this review{prev_text}."
if not assignment_attempt.success:
failure_comment = bot.get_assignment_failure_comment(comment_author, assignment_attempt)
if failure_comment:
response = f"{response}\n\n{failure_comment}"
return response, True
Expand Down Expand Up @@ -518,15 +558,19 @@ def handle_assign_command(bot, state: dict, issue_number: int, username: str) ->
current_assignees = bot.get_issue_assignees(issue_number)
for assignee in current_assignees:
bot.unassign_reviewer(issue_number, assignee)
is_pr = os.environ.get("IS_PULL_REQUEST", "false").lower() == "true"
assignment_attempt = bot.request_reviewer_assignment(issue_number, username)
bot.set_current_reviewer(state, issue_number, username, assignment_method="manual")
bot.record_assignment(state, username, issue_number, "pr" if is_pr else "issue")
issue_author = os.environ.get("ISSUE_AUTHOR", "")
assignment_attempt, failure_comment = _apply_assignment_side_effects(
bot,
state,
issue_number,
username,
"manual",
issue_author,
)
prev_text = f" (previously: @{', @'.join(current_assignees)})" if current_assignees else ""
if assignment_attempt.success:
return f"✅ @{username} has been assigned as reviewer{prev_text}.", True
response = f"✅ @{username} remains designated as reviewer in bot state{prev_text}. GitHub reviewer assignment could not be completed."
failure_comment = bot.get_assignment_failure_comment(username, assignment_attempt)
if failure_comment:
response = f"{response}\n\n{failure_comment}"
return response, True
Expand All @@ -541,21 +585,15 @@ def handle_assign_from_queue_command(bot, state: dict, issue_number: int) -> tup
next_reviewer = bot.get_next_reviewer(state, skip_usernames=skip_set)
if not next_reviewer:
return (f"❌ No reviewers available in the queue. Please use `{bot.BOT_MENTION} /sync-members` to update the queue."), False
is_pr = os.environ.get("IS_PULL_REQUEST", "false").lower() == "true"
assignment_attempt = bot.request_reviewer_assignment(issue_number, next_reviewer)
bot.set_current_reviewer(state, issue_number, next_reviewer)
bot.record_assignment(state, next_reviewer, issue_number, "pr" if is_pr else "issue")
assignment_attempt, _failure_comment = _apply_assignment_side_effects(
bot,
state,
issue_number,
next_reviewer,
"round-robin",
issue_author,
)
prev_text = f" (previously: @{', @'.join(current_assignees)})" if current_assignees else ""
failure_comment = bot.get_assignment_failure_comment(next_reviewer, assignment_attempt)
if failure_comment:
bot.post_comment(issue_number, failure_comment)
if is_pr:
if assignment_attempt.success:
guidance = get_pr_guidance(next_reviewer, issue_author)
bot.post_comment(issue_number, guidance)
else:
guidance = get_issue_guidance(next_reviewer, issue_author)
bot.post_comment(issue_number, guidance)
if assignment_attempt.success:
return f"✅ @{next_reviewer} (next in queue) has been assigned as reviewer{prev_text}.", True
return (f"✅ @{next_reviewer} remains designated as reviewer in bot state{prev_text}. GitHub reviewer assignment could not be completed."), True
Loading