Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add digest to PR comment #303

Merged
merged 1 commit into from Jun 13, 2022
Merged

Add digest to PR comment #303

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 5 additions & 2 deletions python/publish/__init__.py
View file
Open in desktop
Expand Up @@ -685,7 +685,10 @@ def get_long_summary_without_runs_md(stats: UnitTestRunResultsOrDeltaResults,


def get_long_summary_with_digest_md(stats: UnitTestRunResultsOrDeltaResults,
digest_stats: Optional[UnitTestRunResults] = None) -> str:
digest_stats: Optional[UnitTestRunResults] = None,
details_url: Optional[str] = None,
test_changes: Optional[SomeTestChanges] = None,
test_list_changes_limit: Optional[int] = None) -> str:
"""
Provides the summary of stats with digest of digest_stats if given, otherwise
digest of stats. In that case, stats must be UnitTestRunResults.
Expand All @@ -696,7 +699,7 @@ def get_long_summary_with_digest_md(stats: UnitTestRunResultsOrDeltaResults,
"""
if digest_stats is None and isinstance(stats, UnitTestRunDeltaResults):
raise ValueError('stats must be UnitTestRunResults when no digest_stats is given')
summary = get_long_summary_md(stats)
summary = get_long_summary_md(stats, details_url, test_changes, test_list_changes_limit)
digest = get_digest_from_stats(stats if digest_stats is None else digest_stats)
return f'{summary}\n{digest_header}{digest}'

Expand Down
2 changes: 1 addition & 1 deletion python/publish/publisher.py
View file
Open in desktop
Expand Up @@ -444,7 +444,7 @@ def publish_comment(self,
test_changes = SomeTestChanges(before_all_tests, all_tests, before_skipped_tests, skipped_tests)

details_url = check_run.html_url if check_run else None
summary = get_long_summary_md(stats_with_delta, details_url, test_changes, self._settings.test_changes_limit)
summary = get_long_summary_with_digest_md(stats_with_delta, stats, details_url, test_changes, self._settings.test_changes_limit)
body = f'## {title}\n{summary}'

# reuse existing commend when comment_mode == comment_mode_update
Expand Down
56 changes: 45 additions & 11 deletions python/test/test_publisher.py
View file
Open in desktop
Expand Up @@ -453,7 +453,7 @@ def test_publish_comment_compare_earlier(self):
pr = mock.MagicMock()
cr = mock.MagicMock()
bcr = mock.MagicMock()
bs = mock.MagicMock()
bs = UnitTestRunResults(1, [], 1, 1, 3, 1, 2, 0, 0, 3, 1, 2, 0, 0, 'commit')
stats = self.stats
cases = UnitTestCaseResults(self.cases)
settings = self.create_settings(comment_mode=comment_mode_create, compare_earlier=True)
Expand All @@ -464,7 +464,7 @@ def test_publish_comment_compare_earlier(self):
publisher.get_stats_delta = mock.Mock(return_value=bs)
publisher.get_base_commit_sha = mock.Mock(return_value="base commit")
publisher.get_test_lists_from_check_run = mock.Mock(return_value=(None, None))
with mock.patch('publish.publisher.get_long_summary_md', return_value='body'):
with mock.patch('publish.publisher.get_long_summary_with_digest_md', return_value='body'):
Publisher.publish_comment(publisher, 'title', stats, pr, cr, cases)
mock_calls = publisher.mock_calls

Expand Down Expand Up @@ -537,7 +537,12 @@ def test_publish_comment_compare_earlier_with_restricted_unicode(self):
['class ‑ test \\U0001d482', 'class ‑ test \\U0001d483', 'class ‑ skipped \\U0001d484', 'class ‑ skipped \\U0001d485'],
['class ‑ skipped \\U0001d484', 'class ‑ skipped \\U0001d485']
))
Publisher.publish_comment(publisher, 'title', stats, pr, cr, cases)

# makes gzipped digest deterministic
with mock.patch('gzip.time.time', return_value=0):
Publisher.publish_comment(publisher, 'title', stats, pr, cr, cases)
expected_digest = f'{digest_header}{get_digest_from_stats(stats)}'

mock_calls = publisher.mock_calls

self.assertEqual(4, len(mock_calls))
Expand Down Expand Up @@ -609,7 +614,9 @@ def test_publish_comment_compare_earlier_with_restricted_unicode(self):
'```\n'
'class ‑ skipped \\U0001d486\n'
'```\n'
'</details>\n', ), args)
'</details>\n'
'\n'
f'{expected_digest}', ), args)
self.assertEqual({}, kwargs)

(method, args, kwargs) = mock_calls[1]
Expand Down Expand Up @@ -658,7 +665,7 @@ def test_publish_comment_compare_with_None(self):
publisher.get_check_run = mock.Mock(return_value=None)
publisher.get_base_commit_sha = mock.Mock(return_value=None)
publisher.get_test_lists_from_check_run = mock.Mock(return_value=(None, None))
with mock.patch('publish.publisher.get_long_summary_md', return_value='body'):
with mock.patch('publish.publisher.get_long_summary_with_digest_md', return_value='body'):
Publisher.publish_comment(publisher, 'title', stats, pr, cr, cases)
mock_calls = publisher.mock_calls

Expand Down Expand Up @@ -707,7 +714,7 @@ def do_test_publish_comment_with_reuse_comment(self, one_exists: bool):
publisher._settings = settings
publisher.get_test_lists_from_check_run = mock.Mock(return_value=(None, None))
publisher.reuse_comment = mock.Mock(return_value=one_exists)
with mock.patch('publish.publisher.get_long_summary_md', return_value='body'):
with mock.patch('publish.publisher.get_long_summary_with_digest_md', return_value='body'):
Publisher.publish_comment(publisher, 'title', stats, pr, cr, cases)
mock_calls = publisher.mock_calls

Expand Down Expand Up @@ -1770,7 +1777,10 @@ def test_publish_comment(self):
pr = self.create_github_pr(settings.repo, base_commit_sha=base_commit)
publisher = Publisher(settings, gh, gha)

publisher.publish_comment(settings.comment_title, self.stats, pr)
# makes gzipped digest deterministic
with mock.patch('gzip.time.time', return_value=0):
publisher.publish_comment(settings.comment_title, self.stats, pr)
expected_digest = f'{digest_header}{get_digest_from_stats(self.stats)}'

pr.create_issue_comment.assert_called_once_with(
'## Comment Title\n'
Expand All @@ -1779,6 +1789,8 @@ def test_publish_comment(self):
f'38 runs\u2006 +1\u2002\u20038 {passed_tests_label_md} \u2006-\u200a17\u2002\u20039 {skipped_tests_label_md} +2\u2002\u200310 {failed_tests_label_md} +6\u2002\u200311 {test_errors_label_md} +10\u2002\n'
'\n'
'Results for commit commit.\u2003± Comparison against base commit base.\n'
'\n'
f'{expected_digest}'
)

def test_publish_comment_without_base(self):
Expand All @@ -1791,7 +1803,11 @@ def test_publish_comment_without_base(self):
compare = mock.MagicMock()
compare.merge_base_commit.sha = None
repo.compare = mock.Mock(return_value=compare)
publisher.publish_comment(settings.comment_title, self.stats, pr)

# makes gzipped digest deterministic
with mock.patch('gzip.time.time', return_value=0):
publisher.publish_comment(settings.comment_title, self.stats, pr)
expected_digest = f'{digest_header}{get_digest_from_stats(self.stats)}'

pr.create_issue_comment.assert_called_once_with(
'## Comment Title\n'
Expand All @@ -1800,6 +1816,8 @@ def test_publish_comment_without_base(self):
f'38 runs\u2006\u20038 {passed_tests_label_md}\u20039 {skipped_tests_label_md}\u200310 {failed_tests_label_md}\u200311 {test_errors_label_md}\n'
'\n'
'Results for commit commit.\n'
'\n'
f'{expected_digest}'
)

def test_publish_comment_without_compare(self):
Expand All @@ -1810,7 +1828,10 @@ def test_publish_comment_without_compare(self):
pr = self.create_github_pr(settings.repo, base_commit_sha=base_commit)
publisher = Publisher(settings, gh, gha)

publisher.publish_comment(settings.comment_title, self.stats, pr)
# makes gzipped digest deterministic
with mock.patch('gzip.time.time', return_value=0):
publisher.publish_comment(settings.comment_title, self.stats, pr)
expected_digest = f'{digest_header}{get_digest_from_stats(self.stats)}'

pr.create_issue_comment.assert_called_once_with(
'## Comment Title\n'
Expand All @@ -1819,6 +1840,8 @@ def test_publish_comment_without_compare(self):
f'38 runs\u2006\u20038 {passed_tests_label_md}\u20039 {skipped_tests_label_md}\u200310 {failed_tests_label_md}\u200311 {test_errors_label_md}\n'
'\n'
'Results for commit commit.\n'
'\n'
f'{expected_digest}'
)

def test_publish_comment_with_check_run_with_annotations(self):
Expand All @@ -1830,7 +1853,10 @@ def test_publish_comment_with_check_run_with_annotations(self):
cr = mock.MagicMock(html_url='http://check-run.url')
publisher = Publisher(settings, gh, gha)

publisher.publish_comment(settings.comment_title, self.stats, pr, cr)
# makes gzipped digest deterministic
with mock.patch('gzip.time.time', return_value=0):
publisher.publish_comment(settings.comment_title, self.stats, pr, cr)
expected_digest = f'{digest_header}{get_digest_from_stats(self.stats)}'

pr.create_issue_comment.assert_called_once_with(
'## Comment Title\n'
Expand All @@ -1841,6 +1867,8 @@ def test_publish_comment_with_check_run_with_annotations(self):
'For more details on these failures and errors, see [this check](http://check-run.url).\n'
'\n'
'Results for commit commit.\u2003± Comparison against base commit base.\n'
'\n'
f'{expected_digest}'
)

def test_publish_comment_with_check_run_without_annotations(self):
Expand All @@ -1855,7 +1883,11 @@ def test_publish_comment_with_check_run_without_annotations(self):
stats = dict(self.stats.to_dict())
stats.update(tests_fail=0, tests_error=0, runs_fail=0, runs_error=0)
stats = UnitTestRunResults.from_dict(stats)
publisher.publish_comment(settings.comment_title, stats, pr, cr)

# makes gzipped digest deterministic
with mock.patch('gzip.time.time', return_value=0):
publisher.publish_comment(settings.comment_title, stats, pr, cr)
expected_digest = f'{digest_header}{get_digest_from_stats(stats)}'

pr.create_issue_comment.assert_called_once_with(
'## Comment Title\n'
Expand All @@ -1864,6 +1896,8 @@ def test_publish_comment_with_check_run_without_annotations(self):
f'38 runs\u2006 +1\u2002\u20038 {passed_tests_label_md} \u2006-\u200a17\u2002\u20039 {skipped_tests_label_md} +2\u2002\u20030 {failed_tests_label_md} \u2006-\u200a4\u2002\n'
'\n'
'Results for commit commit.\u2003± Comparison against base commit base.\n'
'\n'
f'{expected_digest}'
)

def test_get_base_commit_sha_none_event(self):
Expand Down