| # Copyright 2024 The Chromium Authors |
| # Use of this source code is governed by a BSD-style license that can be |
| # found in the LICENSE file. |
| |
| import textwrap |
| import unittest |
| from unittest import mock |
| |
| from blinkpy.common.net.web_mock import MockWeb |
| from blinkpy.w3c.buganizer import ( |
| BuganizerClient, |
| BuganizerError, |
| BuganizerIssue, |
| Status, |
| Priority, |
| Severity, |
| ) |
| |
| |
| class BuganizerIssueTest(unittest.TestCase): |
| |
| @staticmethod |
| def create_mock_issue_payload(issue_id='12345'): |
| return { |
| 'issueId': issue_id, |
| 'issueState': { |
| 'title': 'test title', |
| 'componentId': 999, |
| 'status': 'NEW', |
| 'severity': 'S2', |
| 'priority': 'P1', |
| # `emailAddress` may be blank if the user is not visible to the |
| # caller. |
| 'ccs': [{}, { |
| 'emailAddress': 'test@chromium.org', |
| }], |
| }, |
| 'issueComment': { |
| 'comment': 'test description', |
| }, |
| } |
| |
| def test_display(self): |
| issue = BuganizerIssue(title='test', |
| description='ABC~‾¥≈¤･・•∙·☼★星🌟星★☼·∙•・･¤≈¥‾~XYZ', |
| component_id='999', |
| issue_id=12345, |
| cc=['foo@chromium.org', 'bar@chromium.org'], |
| status=Status.ASSIGNED, |
| priority=Priority.P0, |
| severity=Severity.S0) |
| self.assertEqual( |
| str(issue), |
| textwrap.dedent("""\ |
| Issue https://crbug.com/12345: test |
| Status: ASSIGNED |
| Component ID: 999 |
| CC: foo@chromium.org, bar@chromium.org |
| Priority: P0 |
| Severity: S0 |
| Description: |
| ABC~‾¥≈¤･・•∙·☼★星🌟星★☼·∙•・･¤≈¥‾~XYZ |
| """)) |
| |
| def test_display_minimal(self): |
| issue = BuganizerIssue(title='test', |
| description=textwrap.dedent("""\ |
| line 1 |
| line 2 |
| line 3 |
| """), |
| component_id='999') |
| self.assertEqual( |
| str(issue), |
| textwrap.dedent("""\ |
| Issue: test |
| Status: NEW |
| Component ID: 999 |
| CC: (none) |
| Priority: P3 |
| Severity: S4 |
| Description: |
| line 1 |
| line 2 |
| line 3 |
| """)) |
| |
| def test_crbug_link(self): |
| issue = BuganizerIssue(title='test', |
| description='test', |
| component_id='999', |
| issue_id=12345) |
| self.assertEqual(issue.link, 'https://crbug.com/12345') |
| issue = BuganizerIssue(title='test', |
| description='test', |
| component_id='999') |
| self.assertIsNone(issue.link) |
| |
| def test_build_from_payload(self): |
| issue = BuganizerIssue.from_payload(self.create_mock_issue_payload()) |
| self.assertEqual(issue.issue_id, '12345') |
| self.assertEqual(issue.title, 'test title') |
| self.assertEqual(issue.component_id, '999') |
| self.assertIs(issue.status, Status.NEW) |
| self.assertIs(issue.severity, Severity.S2) |
| self.assertIs(issue.priority, Priority.P1) |
| self.assertEqual(issue.cc, ['test@chromium.org']) |
| self.assertEqual(issue.description, 'test description') |
| |
| |
| class BuganizerClientTest(unittest.TestCase): |
| |
| def setUp(self): |
| self.service = mock.Mock() |
| self.web = MockWeb() |
| self.client = BuganizerClient(self.service, self.web) |
| |
| def test_resolve_id_already_valid(self): |
| self.client.GetIssue(12_345_678) |
| fake_get = self.service.issues.return_value.get |
| fake_get.assert_called_once_with(issueId=12_345_678) |
| |
| def test_resolve_id_already_valid_url(self): |
| self.client.GetIssue('crbug.com/12345678') |
| fake_get = self.service.issues.return_value.get |
| fake_get.assert_called_once_with(issueId=12_345_678) |
| |
| def test_resolve_historic(self): |
| self.web.urls['https://crbug.com/123'] = ( |
| b'window.location = "https://issues.chromium.org/12345678";') |
| self.client.GetIssue(123) |
| fake_get = self.service.issues.return_value.get |
| fake_get.assert_called_once_with(issueId=12_345_678) |
| |
| def test_resolve_historic_url(self): |
| self.web.urls['https://crbug.com/123'] = ( |
| b'window.location = "https://issues.chromium.org/12345678";') |
| self.client.GetIssue('crbug.com/123') |
| fake_get = self.service.issues.return_value.get |
| fake_get.assert_called_once_with(issueId=12_345_678) |
| |
| def test_resolve_non_chromium_project(self): |
| self.web.urls['https://skbug.com/123'] = ( |
| b'window.location = "https://issues.skia.org/12345678";') |
| self.client.GetIssue('https://skbug.com/123') |
| fake_get = self.service.issues.return_value.get |
| fake_get.assert_called_once_with(issueId=12_345_678) |
| |
| def test_unsuccessful_resolve(self): |
| self.web.urls['https://crbug.com/123'] = b'404 not found' |
| with self.assertRaises(BuganizerError): |
| self.client.GetIssue(123) |
| fake_get = self.service.issues.return_value.get |
| fake_get.assert_not_called() |
| |
| def test_get_issue_list_with_pagination(self): |
| first_page_response = { |
| 'issues': [ |
| BuganizerIssueTest.create_mock_issue_payload(issue_id='1'), |
| BuganizerIssueTest.create_mock_issue_payload(issue_id='2') |
| ], |
| 'nextPageToken': |
| 'next_page_token', |
| } |
| second_page_response = { |
| 'issues': [ |
| BuganizerIssueTest.create_mock_issue_payload(issue_id='3'), |
| BuganizerIssueTest.create_mock_issue_payload(issue_id='4') |
| ], |
| } |
| |
| self.service.issues.return_value.list.side_effect = [ |
| mock.Mock(execute=mock.Mock(return_value=first_page_response)), |
| mock.Mock(execute=mock.Mock(return_value=second_page_response)), |
| ] |
| |
| issues = self.client.GetIssueList('test query', limit=3) |
| |
| self.assertEqual(len(issues), 3) |
| self.assertEqual(issues[0].issue_id, '1') |
| self.assertEqual(issues[1].issue_id, '2') |
| self.assertEqual(issues[2].issue_id, '3') |
| |
| self.service.issues.return_value.list.assert_has_calls([ |
| mock.call(query='test query', |
| pageSize=3, |
| view='FULL', |
| pageToken=None), |
| mock.call(query='test query', |
| pageSize=1, |
| view='FULL', |
| pageToken='next_page_token'), |
| ]) |
