diff options
Diffstat (limited to 'llvm_tools/nightly_revert_checker_test.py')
| -rwxr-xr-x | llvm_tools/nightly_revert_checker_test.py | 145 |
1 files changed, 134 insertions, 11 deletions
diff --git a/llvm_tools/nightly_revert_checker_test.py b/llvm_tools/nightly_revert_checker_test.py index 86b7898a..722ad125 100755 --- a/llvm_tools/nightly_revert_checker_test.py +++ b/llvm_tools/nightly_revert_checker_test.py @@ -1,17 +1,15 @@ #!/usr/bin/env python3 -# -*- coding: utf-8 -*- # Copyright 2020 The ChromiumOS Authors # Use of this source code is governed by a BSD-style license that can be # found in the LICENSE file. """Tests for nightly_revert_checker.""" - import io import unittest -from unittest.mock import patch +from unittest import mock -import cros_utils.tiny_render as tiny_render +from cros_utils import tiny_render import get_upstream_patch import nightly_revert_checker import revert_checker @@ -44,7 +42,8 @@ class Test(unittest.TestCase): ) expected_email = nightly_revert_checker._Email( - subject="[revert-checker/${repo}] new revert discovered across ${name}", + subject="[revert-checker/${repo}] new revert discovered across " + "${name}", body=[ "It looks like there may be a new revert across ${name} (", "pretty_${sha}", @@ -176,8 +175,8 @@ class Test(unittest.TestCase): self.assertIn("Failed to detect SHAs", str(e.exception)) - @patch("revert_checker.find_reverts") - @patch("get_upstream_patch.get_from_upstream") + @mock.patch("revert_checker.find_reverts") + @mock.patch("get_upstream_patch.get_from_upstream") def test_do_cherrypick_is_called(self, do_cherrypick, find_reverts): find_reverts.return_value = [ revert_checker.Revert("12345abcdef", "fedcba54321") @@ -185,8 +184,9 @@ class Test(unittest.TestCase): nightly_revert_checker.do_cherrypick( chroot_path="/path/to/chroot", llvm_dir="/path/to/llvm", + repository="repository_name", interesting_shas=[("12345abcdef", "fedcba54321")], - state={}, + state=nightly_revert_checker.State(), reviewers=["meow@chromium.org"], cc=["purr@chromium.org"], ) @@ -194,8 +194,8 @@ class Test(unittest.TestCase): do_cherrypick.assert_called_once() find_reverts.assert_called_once() - @patch("revert_checker.find_reverts") - @patch("get_upstream_patch.get_from_upstream") + @mock.patch("revert_checker.find_reverts") + @mock.patch("get_upstream_patch.get_from_upstream") def test_do_cherrypick_handles_cherrypick_error( self, do_cherrypick, find_reverts ): @@ -208,8 +208,9 @@ class Test(unittest.TestCase): nightly_revert_checker.do_cherrypick( chroot_path="/path/to/chroot", llvm_dir="/path/to/llvm", + repository="repository_name", interesting_shas=[("12345abcdef", "fedcba54321")], - state={}, + state=nightly_revert_checker.State(), reviewers=["meow@chromium.org"], cc=["purr@chromium.org"], ) @@ -217,6 +218,128 @@ class Test(unittest.TestCase): do_cherrypick.assert_called_once() find_reverts.assert_called_once() + def test_sha_prettification_for_email(self): + sha = "a" * 40 + rev = 123456 + self.assertEqual( + nightly_revert_checker.prettify_sha_for_email(sha, rev), + tiny_render.Switch( + text=f"r{rev} ({sha[:12]})", + html=tiny_render.Link( + href=f"https://github.com/llvm/llvm-project/commit/{sha}", + inner=f"r{rev}", + ), + ), + ) + + @mock.patch("time.time") + def test_emailing_about_stale_heads_skips_in_simple_cases(self, time_time): + now = 1_000_000_000 + time_time.return_value = now + + def assert_no_email(state: nightly_revert_checker.State): + self.assertFalse( + nightly_revert_checker.maybe_email_about_stale_heads( + state, + repository_name="foo", + recipients=nightly_revert_checker._EmailRecipients( + well_known=[], direct=[] + ), + prettify_sha=lambda *args: self.fail( + "SHAs shouldn't be prettified" + ), + is_dry_run=True, + ) + ) + + assert_no_email(nightly_revert_checker.State()) + assert_no_email( + nightly_revert_checker.State( + heads={ + "foo": nightly_revert_checker.HeadInfo( + last_sha="", + first_seen_timestamp=0, + next_notification_timestamp=now + 1, + ), + "bar": nightly_revert_checker.HeadInfo( + last_sha="", + first_seen_timestamp=0, + next_notification_timestamp=now * 2, + ), + } + ) + ) + + def test_state_autoupgrades_from_json_properly(self): + state = nightly_revert_checker.State.from_json({"abc123": ["def456"]}) + self.assertEqual(state.seen_reverts, {"abc123": ["def456"]}) + self.assertEqual(state.heads, {}) + + def test_state_round_trips_through_json(self): + state = nightly_revert_checker.State( + seen_reverts={"abc123": ["def456"]}, + heads={ + "head_name": nightly_revert_checker.HeadInfo( + last_sha="abc", + first_seen_timestamp=123, + next_notification_timestamp=456, + ), + }, + ) + self.assertEqual( + state, nightly_revert_checker.State.from_json(state.to_json()) + ) + + @mock.patch("time.time") + @mock.patch("nightly_revert_checker._send_revert_email") + def test_emailing_about_stale_with_one_report( + self, send_revert_email, time_time + ): + def prettify_sha(sha: str) -> str: + return f"pretty({sha})" + + now = 1_000_000_000 + two_days_ago = now - 2 * nightly_revert_checker.ONE_DAY_SECS + time_time.return_value = now + recipients = nightly_revert_checker._EmailRecipients( + well_known=[], direct=[] + ) + self.assertTrue( + nightly_revert_checker.maybe_email_about_stale_heads( + nightly_revert_checker.State( + heads={ + "foo": nightly_revert_checker.HeadInfo( + last_sha="<foo sha>", + first_seen_timestamp=two_days_ago, + next_notification_timestamp=now - 1, + ), + "bar": nightly_revert_checker.HeadInfo( + last_sha="", + first_seen_timestamp=0, + next_notification_timestamp=now + 1, + ), + } + ), + repository_name="repo", + recipients=recipients, + prettify_sha=prettify_sha, + is_dry_run=False, + ) + ) + send_revert_email.assert_called_once() + recipients, email = send_revert_email.call_args[0] + + self.assertEqual( + tiny_render.render_text_pieces(email.body), + "Hi! This is a friendly notification that the current upstream " + "LLVM SHA is being tracked by the LLVM revert checker:\n" + " - foo at pretty(<foo sha>), which was last updated ~2 days " + "ago.\n" + "If that's still correct, great! If it looks wrong, the revert " + "checker's SHA autodetection may need an update. Please file a " + "bug at go/crostc-bug if an update is needed. Thanks!", + ) + if __name__ == "__main__": unittest.main() |