| {emoji} Contribution time estimate (best, average, worst case): " @@ -272,7 +275,6 @@ def convert_to_markdown_v2(output_data: dict, issues = value if gfm_supported: markdown_text += f" |
| "
- # markdown_text += f"{emoji} {key_nice} \n\n" markdown_text += f"{emoji} Recommended focus areas for review \n\n" else: markdown_text += f"### {emoji} Recommended focus areas for review\n\n#### \n" @@ -320,12 +322,23 @@ def convert_to_markdown_v2(output_data: dict, else: markdown_text += f"### {emoji} {key_nice}: {value}\n\n" + if ('score' in key_nice.lower() and not ticket_compliance_rendered and + (ticket_compliance_value is not None or ticket_note)): + markdown_text = ticket_markdown_logic( + emojis['Ticket compliance check'], markdown_text, ticket_compliance_value, gfm_supported, ticket_note + ) + ticket_compliance_rendered = True + + if not ticket_compliance_rendered and (ticket_compliance_value is not None or ticket_note): + markdown_text = ticket_markdown_logic( + emojis['Ticket compliance check'], markdown_text, ticket_compliance_value, gfm_supported, ticket_note + ) + if gfm_supported: markdown_text += " |
Hello world
"}, + } + + monkeypatch.setattr(jira_cloud, "_fetch_issue_json", fake_fetch_issue_json) + + ticket = asyncio.run(jira_cloud.try_fetch_jira_ticket("FAKE-1234 new feature", "MOCK-9999-ignored")) + assert ticket is not None + assert ticket["ticket_id"] == "FAKE-1234" + assert ticket["ticket_url"] == "https://example.atlassian.net/browse/FAKE-1234" + assert ticket["title"] == "Implement Jira support" + assert "Hello" in ticket["body"] + assert ticket["labels"] == "backend, review" + + assert "sub_issues" in ticket + assert ticket["sub_issues"][0]["ticket_url"] == "https://example.atlassian.net/browse/SUB-2" + assert ticket["sub_issues"][0]["title"] == "Subtask 1" + assert ticket["sub_issues"][0]["body"] == "" + + def test_fetch_jira_ticket_context_uses_scoped_token_with_cloud_id(self, monkeypatch): + monkeypatch.setenv("JIRA_BASE_URL", "https://example.atlassian.net") + monkeypatch.setenv("JIRA_API_EMAIL", "user@example.com") + monkeypatch.setenv("JIRA_API_TOKEN", "token") + monkeypatch.setenv("JIRA_AUTH_TYPE", "scoped") + monkeypatch.setenv("JIRA_CLOUD_ID", "2672de8d-bce7-4cb5-9e65-128f96b0bd9a") + + async def fake_fetch_issue_json(session, auth, key): + assert auth.auth_mode == "scoped" + assert auth.site_base_url == "https://example.atlassian.net" + assert auth.api_base_url == "https://api.atlassian.com/ex/jira/2672de8d-bce7-4cb5-9e65-128f96b0bd9a" + assert key == "FAKE-1234" + return { + "fields": { + "summary": "Implement Jira support", + "labels": [], + "subtasks": [], + }, + "renderedFields": {"description": "Hello world
"}, + } + + monkeypatch.setattr(jira_cloud, "_fetch_issue_json", fake_fetch_issue_json) + + result = asyncio.run(jira_cloud.fetch_jira_ticket_context("FAKE-1234 new feature", "MOCK-9999-ignored")) + assert result.status == "fetched" + assert result.ticket is not None + assert result.ticket["ticket_url"] == "https://example.atlassian.net/browse/FAKE-1234" + + def test_fetch_jira_ticket_context_returns_mismatch_note_when_ticket_is_fetched(self, monkeypatch): + monkeypatch.setenv("JIRA_BASE_URL", "https://example.atlassian.net") + monkeypatch.setenv("JIRA_API_EMAIL", "user@example.com") + monkeypatch.setenv("JIRA_API_TOKEN", "token") + + async def fake_fetch_issue_json(session, auth, key): + return { + "fields": { + "summary": "Implement Jira support", + "labels": [], + "subtasks": [], + }, + "renderedFields": {"description": "Hello world
"}, + } + + monkeypatch.setattr(jira_cloud, "_fetch_issue_json", fake_fetch_issue_json) + + result = asyncio.run(jira_cloud.fetch_jira_ticket_context("FAKE-1234 new feature", "MOCK-9999-ignored")) + + assert result.status == "fetched" + assert result.ticket is not None + assert "FAKE-1234" in result.note + assert "MOCK-9999" in result.note + + def test_fetch_jira_ticket_context_uses_scoped_token_with_implicit_detection(self, monkeypatch): + monkeypatch.setenv("JIRA_BASE_URL", "https://example.atlassian.net") + monkeypatch.setenv("JIRA_API_EMAIL", "user@example.com") + monkeypatch.setenv("JIRA_API_TOKEN", "token") + monkeypatch.delenv("JIRA_AUTH_TYPE", raising=False) + monkeypatch.setenv("JIRA_CLOUD_ID", "2672de8d-bce7-4cb5-9e65-128f96b0bd9a") + + async def fake_fetch_issue_json(session, auth, key): + assert auth.auth_mode == "scoped" + assert auth.api_base_url == "https://api.atlassian.com/ex/jira/2672de8d-bce7-4cb5-9e65-128f96b0bd9a" + return { + "fields": { + "summary": "Implement Jira support", + "labels": [], + "subtasks": [], + }, + "renderedFields": {"description": "Hello world
"}, + } + + monkeypatch.setattr(jira_cloud, "_fetch_issue_json", fake_fetch_issue_json) + + result = asyncio.run(jira_cloud.fetch_jira_ticket_context("FAKE-1234 new feature", "MOCK-9999-ignored")) + assert result.status == "fetched" + assert result.ticket is not None + + def test_fetch_jira_ticket_context_discovers_cloud_id_for_bearer_token(self, monkeypatch): + monkeypatch.setenv("JIRA_BASE_URL", "https://example.atlassian.net") + monkeypatch.setenv("JIRA_API_TOKEN", "token") + monkeypatch.setenv("JIRA_AUTH_TYPE", "oauth") + monkeypatch.delenv("JIRA_CLOUD_ID", raising=False) + monkeypatch.delenv("JIRA_API_EMAIL", raising=False) + + async def fake_discover_cloud_id(session, site_base_url): + assert site_base_url == "https://example.atlassian.net" + return "2672de8d-bce7-4cb5-9e65-128f96b0bd9a" + + async def fake_fetch_issue_json(session, auth, key): + assert auth.auth_mode == "bearer" + assert auth.api_base_url == "https://api.atlassian.com/ex/jira/2672de8d-bce7-4cb5-9e65-128f96b0bd9a" + return { + "fields": { + "summary": "Implement Jira support", + "labels": [], + "subtasks": [], + }, + "renderedFields": {"description": "Hello world
"}, + } + + monkeypatch.setattr(jira_cloud, "_discover_cloud_id", fake_discover_cloud_id) + monkeypatch.setattr(jira_cloud, "_fetch_issue_json", fake_fetch_issue_json) + + result = asyncio.run(jira_cloud.fetch_jira_ticket_context("FAKE-1234 new feature", "MOCK-9999-ignored")) + assert result.status == "fetched" + assert result.ticket is not None + + def test_explicit_bearer_auth_takes_precedence_over_implicit_scoped_detection(self, monkeypatch): + monkeypatch.setenv("JIRA_BASE_URL", "https://example.atlassian.net") + monkeypatch.setenv("JIRA_API_EMAIL", "user@example.com") + monkeypatch.setenv("JIRA_API_TOKEN", "token") + monkeypatch.setenv("JIRA_AUTH_TYPE", "bearer") + monkeypatch.setenv("JIRA_CLOUD_ID", "2672de8d-bce7-4cb5-9e65-128f96b0bd9a") + + async def fake_fetch_issue_json(session, auth, key): + assert auth.auth_mode == "bearer" + assert auth.api_base_url == "https://api.atlassian.com/ex/jira/2672de8d-bce7-4cb5-9e65-128f96b0bd9a" + return { + "fields": { + "summary": "Implement Jira support", + "labels": [], + "subtasks": [], + }, + "renderedFields": {"description": "Hello world
"}, + } + + monkeypatch.setattr(jira_cloud, "_fetch_issue_json", fake_fetch_issue_json) + + result = asyncio.run(jira_cloud.fetch_jira_ticket_context("FAKE-1234 new feature", "MOCK-9999-ignored")) + assert result.status == "fetched" + assert result.ticket is not None + + def test_fetch_jira_ticket_context_returns_note_when_scoped_token_missing_cloud_id(self, monkeypatch): + monkeypatch.setenv("JIRA_BASE_URL", "https://example.atlassian.net") + monkeypatch.setenv("JIRA_API_EMAIL", "user@example.com") + monkeypatch.setenv("JIRA_API_TOKEN", "token") + monkeypatch.setenv("JIRA_AUTH_TYPE", "scoped") + monkeypatch.delenv("JIRA_CLOUD_ID", raising=False) + + result = asyncio.run(jira_cloud.fetch_jira_ticket_context("FAKE-1234 new feature", "FAKE-1234-new")) + assert result.status == "missing_config" + assert result.key == "FAKE-1234" + assert result.ticket is None + assert "configuration is missing" in result.note + + def test_fetch_jira_ticket_context_returns_note_when_scoped_token_missing_email(self, monkeypatch): + monkeypatch.setenv("JIRA_BASE_URL", "https://example.atlassian.net") + monkeypatch.delenv("JIRA_API_EMAIL", raising=False) + monkeypatch.setenv("JIRA_API_TOKEN", "token") + monkeypatch.setenv("JIRA_AUTH_TYPE", "scoped") + monkeypatch.setenv("JIRA_CLOUD_ID", "2672de8d-bce7-4cb5-9e65-128f96b0bd9a") + + result = asyncio.run(jira_cloud.fetch_jira_ticket_context("FAKE-1234 new feature", "FAKE-1234-new")) + assert result.status == "missing_config" + assert result.key == "FAKE-1234" + assert result.ticket is None + assert "configuration is missing" in result.note + + def test_fetch_jira_ticket_context_returns_note_when_auth_type_is_unknown(self, monkeypatch): + monkeypatch.setenv("JIRA_BASE_URL", "https://example.atlassian.net") + monkeypatch.setenv("JIRA_API_EMAIL", "user@example.com") + monkeypatch.setenv("JIRA_API_TOKEN", "token") + monkeypatch.setenv("JIRA_AUTH_TYPE", "pat") + + result = asyncio.run(jira_cloud.fetch_jira_ticket_context("FAKE-1234 new feature", "FAKE-1234-new")) + assert result.status == "missing_config" + assert result.key == "FAKE-1234" + assert result.ticket is None + assert "configuration is missing" in result.note + + def test_try_fetch_jira_ticket_returns_none_without_env(self, monkeypatch): + monkeypatch.delenv("JIRA_BASE_URL", raising=False) + monkeypatch.delenv("JIRA_API_EMAIL", raising=False) + monkeypatch.delenv("JIRA_API_TOKEN", raising=False) + monkeypatch.delenv("JIRA_AUTH_TYPE", raising=False) + monkeypatch.delenv("JIRA_CLOUD_ID", raising=False) + + ticket = asyncio.run(jira_cloud.try_fetch_jira_ticket("FAKE-1234 new feature", "FAKE-1234-new")) + assert ticket is None + + def test_fetch_jira_ticket_context_returns_note_when_ticket_missing(self, monkeypatch): + monkeypatch.setenv("JIRA_BASE_URL", "https://example.atlassian.net") + monkeypatch.setenv("JIRA_API_EMAIL", "user@example.com") + monkeypatch.setenv("JIRA_API_TOKEN", "token") + + async def fake_fetch_issue_json(session, auth, key): + return None + + monkeypatch.setattr(jira_cloud, "_fetch_issue_json", fake_fetch_issue_json) + + result = asyncio.run(jira_cloud.fetch_jira_ticket_context("FAKE-1234 new feature", "MOCK-9999-ignored")) + assert result.status == "not_found" + assert result.key == "FAKE-1234" + assert result.ticket is None + assert "FAKE-1234" in result.note + assert "ticket compliance analysis was skipped" in result.note + + def test_fetch_jira_ticket_context_returns_note_when_env_missing(self, monkeypatch): + monkeypatch.delenv("JIRA_BASE_URL", raising=False) + monkeypatch.delenv("JIRA_API_EMAIL", raising=False) + monkeypatch.setenv("JIRA_API_TOKEN", "token") + monkeypatch.delenv("JIRA_AUTH_TYPE", raising=False) + monkeypatch.delenv("JIRA_CLOUD_ID", raising=False) + + result = asyncio.run(jira_cloud.fetch_jira_ticket_context("FAKE-1234 new feature", "FAKE-1234-new")) + assert result.status == "missing_config" + assert result.key == "FAKE-1234" + assert result.ticket is None + assert "configuration is missing" in result.note + + def test_fetch_jira_ticket_context_returns_no_note_when_jira_not_configured(self, monkeypatch): + monkeypatch.delenv("JIRA_BASE_URL", raising=False) + monkeypatch.delenv("JIRA_API_EMAIL", raising=False) + monkeypatch.delenv("JIRA_API_TOKEN", raising=False) + monkeypatch.delenv("JIRA_AUTH_TYPE", raising=False) + monkeypatch.delenv("JIRA_CLOUD_ID", raising=False) + + result = asyncio.run(jira_cloud.fetch_jira_ticket_context("FAKE-1234 new feature", "FAKE-1234-new")) + assert result.status == "not_configured" + assert result.key == "FAKE-1234" + assert result.ticket is None + assert result.note == "" diff --git a/tests/unittest/test_pr_reviewer_ticket_note.py b/tests/unittest/test_pr_reviewer_ticket_note.py new file mode 100644 index 0000000000..a9ca14d2f4 --- /dev/null +++ b/tests/unittest/test_pr_reviewer_ticket_note.py @@ -0,0 +1,94 @@ +from pr_agent.tools.pr_reviewer import append_ticket_compliance_note +from pr_agent.tools.pr_reviewer import build_suspected_ticket_mismatch_note + + +def test_append_ticket_compliance_note(): + note = "First note" + extra_note = "Second note" + + result = append_ticket_compliance_note(note, extra_note) + + assert result == "First note\n\nSecond note" + + +def test_build_suspected_ticket_mismatch_note_when_all_requirements_are_non_compliant(): + result = build_suspected_ticket_mismatch_note( + [ + { + "fully_compliant_requirements": "", + "not_compliant_requirements": "- Requirement 1\n", + } + ] + ) + + assert "wrong Jira ticket" in result + + +def test_build_suspected_ticket_mismatch_note_skips_when_any_requirement_is_compliant(): + result = build_suspected_ticket_mismatch_note( + [ + { + "fully_compliant_requirements": "- Requirement 1\n", + "not_compliant_requirements": "", + } + ] + ) + + assert result == "" + + +def test_build_suspected_ticket_mismatch_note_ignores_empty_ticket_entries(): + result = build_suspected_ticket_mismatch_note( + [ + { + "fully_compliant_requirements": "", + "not_compliant_requirements": "- Requirement 1\n", + }, + { + "fully_compliant_requirements": "", + "not_compliant_requirements": "", + }, + ] + ) + + assert "wrong Jira ticket" in result + + +def test_build_suspected_ticket_mismatch_note_ignores_placeholder_bullets(): + result = build_suspected_ticket_mismatch_note( + [ + { + "fully_compliant_requirements": "-\n", + "not_compliant_requirements": "- Requirement 1\n", + } + ] + ) + + assert "wrong Jira ticket" in result + + +def test_build_suspected_ticket_mismatch_note_ignores_none_placeholders(): + result = build_suspected_ticket_mismatch_note( + [ + { + "fully_compliant_requirements": "(none)\n", + "not_compliant_requirements": "- Requirement 1\n", + } + ] + ) + + assert "wrong Jira ticket" in result + + +def test_build_suspected_ticket_mismatch_note_skips_non_dict_entries(): + result = build_suspected_ticket_mismatch_note( + [ + { + "fully_compliant_requirements": "", + "not_compliant_requirements": "- Requirement 1\n", + }, + "unexpected", + ] + ) + + assert "wrong Jira ticket" in result diff --git a/tests/unittest/test_ticket_pr_compliance_check.py b/tests/unittest/test_ticket_pr_compliance_check.py new file mode 100644 index 0000000000..fe364be8a4 --- /dev/null +++ b/tests/unittest/test_ticket_pr_compliance_check.py @@ -0,0 +1,158 @@ +import asyncio + +from pr_agent.config_loader import get_settings +from pr_agent.tools import ticket_pr_compliance_check + + +class FakeGitProvider: + def __init__(self, title: str, branch: str): + self.pr = type("PR", (), {"title": title})() + self._branch = branch + + def get_pr_branch(self): + return self._branch + + +def test_extract_tickets_prefers_title_ticket_on_mismatch(monkeypatch): + async def fake_fetch_jira_ticket_context(pr_title, branch): + if pr_title == "FAKE-1234 add sample feature flow": + return type( + "Result", + (), + { + "note": ( + "PR title references Jira ticket `FAKE-1234` but branch name references `MOCK-5678`. " + "Please verify that the correct Jira ticket is used in the PR metadata." + ), + "ticket": { + "ticket_id": "FAKE-1234", + "ticket_url": "https://example.com/FAKE-1234", + "title": "Wrong ticket", + "body": "", + "labels": "", + }, + }, + )() + + raise AssertionError(f"Unexpected fetch args: {pr_title!r}, {branch!r}") + + monkeypatch.setattr(ticket_pr_compliance_check, "fetch_jira_ticket_context", fake_fetch_jira_ticket_context) + + tickets, note = asyncio.run( + ticket_pr_compliance_check.extract_tickets( + FakeGitProvider( + "FAKE-1234 add sample feature flow", + "MOCK-5678-sample-feature-flow", + ) + ) + ) + + assert [ticket["ticket_id"] for ticket in tickets] == ["FAKE-1234"] + assert "FAKE-1234" in note + assert "MOCK-5678" in note + assert note.count("PR title references Jira ticket") == 1 + + +def test_extract_and_cache_pr_tickets_preserves_cached_ticket_note(monkeypatch): + async def fake_extract_tickets(_git_provider): + return ( + [{"ticket_id": "FAKE-5678", "ticket_url": "https://example.com/FAKE-5678", "title": "Ticket"}], + "cached note", + ) + + monkeypatch.setattr(ticket_pr_compliance_check, "extract_tickets", fake_extract_tickets) + + settings = get_settings() + previous_require_ticket_analysis = settings.get("pr_reviewer.require_ticket_analysis_review", False) + previous_related_tickets = settings.get("related_tickets", []) + previous_ticket_note = settings.get("ticket_compliance_note", "") + + try: + settings.set("pr_reviewer.require_ticket_analysis_review", True) + settings.set("related_tickets", []) + settings.set("ticket_compliance_note", "") + + first_vars = {} + asyncio.run(ticket_pr_compliance_check.extract_and_cache_pr_tickets(object(), first_vars)) + + second_vars = {} + asyncio.run(ticket_pr_compliance_check.extract_and_cache_pr_tickets(object(), second_vars)) + + assert first_vars["ticket_compliance_note"] == "cached note" + assert second_vars["ticket_compliance_note"] == "cached note" + finally: + settings.set("pr_reviewer.require_ticket_analysis_review", previous_require_ticket_analysis) + settings.set("related_tickets", previous_related_tickets) + settings.set("ticket_compliance_note", previous_ticket_note) + + +def test_extract_tickets_preserves_title_fetch_note_on_mismatch(monkeypatch): + async def fake_fetch_jira_ticket_context(pr_title, branch): + if pr_title == "FAKE-1234 add sample feature flow": + return type( + "Result", + (), + { + "note": "Title ticket note", + "ticket": { + "ticket_id": "FAKE-1234", + "ticket_url": "https://example.com/FAKE-1234", + "title": "Wrong ticket", + "body": "", + "labels": "", + }, + }, + )() + + raise AssertionError(f"Unexpected fetch args: {pr_title!r}, {branch!r}") + + monkeypatch.setattr(ticket_pr_compliance_check, "fetch_jira_ticket_context", fake_fetch_jira_ticket_context) + + tickets, note = asyncio.run( + ticket_pr_compliance_check.extract_tickets( + FakeGitProvider( + "FAKE-1234 add sample feature flow", + "MOCK-5678-sample-feature-flow", + ) + ) + ) + + assert [ticket["ticket_id"] for ticket in tickets] == ["FAKE-1234"] + assert "Title ticket note" in note + assert "MOCK-5678" not in note + + +def test_extract_tickets_preserves_title_failure_note_on_mismatch(monkeypatch): + async def fake_fetch_jira_ticket_context(pr_title, branch): + if pr_title == "FAKE-1234 add sample feature flow": + return type( + "Result", + (), + { + "note": ( + "Jira ticket `FAKE-1234` was detected in the PR title but was not found.\n\n" + "PR title references Jira ticket `FAKE-1234` but branch name references `MOCK-5678`. " + "Please verify that the correct Jira ticket is used in the PR metadata." + ), + "ticket": None, + }, + )() + + raise AssertionError(f"Unexpected fetch args: {pr_title!r}, {branch!r}") + + monkeypatch.setattr(ticket_pr_compliance_check, "fetch_jira_ticket_context", fake_fetch_jira_ticket_context) + + tickets, note = asyncio.run( + ticket_pr_compliance_check.extract_tickets( + FakeGitProvider( + "FAKE-1234 add sample feature flow", + "MOCK-5678-sample-feature-flow", + ) + ) + ) + + assert tickets is None + assert "FAKE-1234" in note + assert "MOCK-5678" in note + assert "not found" in note + assert note.count("PR title references Jira ticket") == 1