aboutsummaryrefslogtreecommitdiff
path: root/llvm_tools/nightly_revert_checker_test.py
blob: 86b7898a746b7864d59ebf578b4fabe47a100daa (plain)
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
#!/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

import cros_utils.tiny_render as 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)

    def test_llvm_ebuild_parsing_appears_to_function(self):
        llvm_ebuild = io.StringIO(
            "\n".join(
                (
                    "foo",
                    '#LLVM_HASH="123"',
                    'LLVM_HASH="123" # comment',
                    'LLVM_NEXT_HASH="456"',
                )
            )
        )

        shas = nightly_revert_checker._parse_llvm_ebuild_for_shas(llvm_ebuild)
        self.assertEqual(
            shas,
            [
                ("llvm", "123"),
                ("llvm-next", "456"),
            ],
        )

    def test_llvm_ebuild_parsing_fails_if_both_hashes_arent_present(self):
        bad_bodies = [
            "",
            'LLVM_HASH="123" # comment',
            'LLVM_NEXT_HASH="123" # comment',
            'LLVM_NEXT_HASH="123" # comment\n#LLVM_HASH="123"',
        ]

        for bad in bad_bodies:
            with self.assertRaises(ValueError) as e:
                nightly_revert_checker._parse_llvm_ebuild_for_shas(
                    io.StringIO(bad)
                )

            self.assertIn("Failed to detect SHAs", str(e.exception))

    @patch("revert_checker.find_reverts")
    @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",
            interesting_shas=[("12345abcdef", "fedcba54321")],
            state={},
            reviewers=["meow@chromium.org"],
            cc=["purr@chromium.org"],
        )

        do_cherrypick.assert_called_once()
        find_reverts.assert_called_once()

    @patch("revert_checker.find_reverts")
    @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",
            interesting_shas=[("12345abcdef", "fedcba54321")],
            state={},
            reviewers=["meow@chromium.org"],
            cc=["purr@chromium.org"],
        )

        do_cherrypick.assert_called_once()
        find_reverts.assert_called_once()


if __name__ == "__main__":
    unittest.main()