1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
|
#!/usr/bin/env python3
# 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 unittest
from unittest import mock
from cros_utils import tiny_render
import get_upstream_patch
import nightly_revert_checker
import revert_checker
# pylint: disable=protected-access
class Test(unittest.TestCase):
"""Tests for nightly_revert_checker."""
def test_email_rendering_works_for_singular_revert(self):
def prettify_sha(sha: str) -> tiny_render.Piece:
return "pretty_" + sha
def get_sha_description(sha: str) -> tiny_render.Piece:
return "subject_" + sha
email = nightly_revert_checker._generate_revert_email(
repository_name="${repo}",
friendly_name="${name}",
sha="${sha}",
prettify_sha=prettify_sha,
get_sha_description=get_sha_description,
new_reverts=[
revert_checker.Revert(
sha="${revert_sha}", reverted_sha="${reverted_sha}"
)
],
)
expected_email = nightly_revert_checker._Email(
subject="[revert-checker/${repo}] new revert discovered across "
"${name}",
body=[
"It looks like there may be a new revert across ${name} (",
"pretty_${sha}",
").",
tiny_render.line_break,
tiny_render.line_break,
"That is:",
tiny_render.UnorderedList(
[
[
"pretty_${revert_sha}",
" (appears to revert ",
"pretty_${reverted_sha}",
"): ",
"subject_${revert_sha}",
]
]
),
tiny_render.line_break,
"PTAL and consider reverting them locally.",
],
)
self.assertEqual(email, expected_email)
def test_email_rendering_works_for_multiple_reverts(self):
def prettify_sha(sha: str) -> tiny_render.Piece:
return "pretty_" + sha
def get_sha_description(sha: str) -> tiny_render.Piece:
return "subject_" + sha
email = nightly_revert_checker._generate_revert_email(
repository_name="${repo}",
friendly_name="${name}",
sha="${sha}",
prettify_sha=prettify_sha,
get_sha_description=get_sha_description,
new_reverts=[
revert_checker.Revert(
sha="${revert_sha1}", reverted_sha="${reverted_sha1}"
),
revert_checker.Revert(
sha="${revert_sha2}", reverted_sha="${reverted_sha2}"
),
# Keep this out-of-order to check that we sort based on SHAs
revert_checker.Revert(
sha="${revert_sha0}", reverted_sha="${reverted_sha0}"
),
],
)
expected_email = nightly_revert_checker._Email(
subject="[revert-checker/${repo}] new reverts discovered across "
"${name}",
body=[
"It looks like there may be new reverts across ${name} (",
"pretty_${sha}",
").",
tiny_render.line_break,
tiny_render.line_break,
"These are:",
tiny_render.UnorderedList(
[
[
"pretty_${revert_sha0}",
" (appears to revert ",
"pretty_${reverted_sha0}",
"): ",
"subject_${revert_sha0}",
],
[
"pretty_${revert_sha1}",
" (appears to revert ",
"pretty_${reverted_sha1}",
"): ",
"subject_${revert_sha1}",
],
[
"pretty_${revert_sha2}",
" (appears to revert ",
"pretty_${reverted_sha2}",
"): ",
"subject_${revert_sha2}",
],
]
),
tiny_render.line_break,
"PTAL and consider reverting them locally.",
],
)
self.assertEqual(email, expected_email)
@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")
]
nightly_revert_checker.do_cherrypick(
chroot_path="/path/to/chroot",
llvm_dir="/path/to/llvm",
repository="repository_name",
interesting_shas=[("12345abcdef", "fedcba54321")],
state=nightly_revert_checker.State(),
reviewers=["meow@chromium.org"],
cc=["purr@chromium.org"],
)
do_cherrypick.assert_called_once()
find_reverts.assert_called_once()
@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
):
find_reverts.return_value = [
revert_checker.Revert("12345abcdef", "fedcba54321")
]
do_cherrypick.side_effect = get_upstream_patch.CherrypickError(
"Patch at 12345abcdef already exists in PATCHES.json"
)
nightly_revert_checker.do_cherrypick(
chroot_path="/path/to/chroot",
llvm_dir="/path/to/llvm",
repository="repository_name",
interesting_shas=[("12345abcdef", "fedcba54321")],
state=nightly_revert_checker.State(),
reviewers=["meow@chromium.org"],
cc=["purr@chromium.org"],
)
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()
|
