Mike Frysinger | f1ba7ad | 2022-09-12 05:42:57 -0400 | [diff] [blame] | 1 | # Copyright 2017 The ChromiumOS Authors |
Steven Bennetts | ddf9bcd | 2017-06-14 14:07:43 -0700 | [diff] [blame] | 2 | # Use of this source code is governed by a BSD-style license that can be |
| 3 | # found in the LICENSE file. |
| 4 | |
| 5 | """Unit tests for the chrome_chromeos_lkgm program.""" |
| 6 | |
Ben Pastene | 6a8361a | 2021-08-19 19:52:05 -0700 | [diff] [blame] | 7 | from unittest import mock |
Steven Bennetts | ddf9bcd | 2017-06-14 14:07:43 -0700 | [diff] [blame] | 8 | |
Yoshiki Iguchi | d5bc792 | 2022-09-22 14:37:48 +0900 | [diff] [blame^] | 9 | from chromite.lib import chromeos_version |
Steven Bennetts | ddf9bcd | 2017-06-14 14:07:43 -0700 | [diff] [blame] | 10 | from chromite.lib import cros_test_lib |
Steven Bennetts | ddf9bcd | 2017-06-14 14:07:43 -0700 | [diff] [blame] | 11 | from chromite.scripts import chrome_chromeos_lkgm |
| 12 | |
Achuith Bhandarkar | ec8d7a7 | 2018-03-01 16:56:22 -0800 | [diff] [blame] | 13 | |
Yoshiki Iguchi | f8ab011 | 2022-09-15 16:57:26 +0900 | [diff] [blame] | 14 | class StubGerritChange: |
| 15 | """Stab class corresponding to cros_patch.GerritChange.""" |
| 16 | |
Yoshiki Iguchi | ab2c4c2 | 2022-09-22 18:43:21 +0900 | [diff] [blame] | 17 | def __init__( |
| 18 | self, |
| 19 | gerrit_number, |
| 20 | file_content, |
| 21 | subject, |
| 22 | mergeable=True, |
| 23 | original_file_content=None, |
| 24 | ): |
Yoshiki Iguchi | f8ab011 | 2022-09-15 16:57:26 +0900 | [diff] [blame] | 25 | self._gerrit_number = gerrit_number |
| 26 | self._subject = subject |
| 27 | self._file_content = file_content |
Yoshiki Iguchi | ab2c4c2 | 2022-09-22 18:43:21 +0900 | [diff] [blame] | 28 | self._mergeable = mergeable |
| 29 | self._original_file_content = original_file_content or file_content |
Yoshiki Iguchi | f8ab011 | 2022-09-15 16:57:26 +0900 | [diff] [blame] | 30 | |
| 31 | @property |
| 32 | def subject(self): |
| 33 | return self._subject |
| 34 | |
| 35 | @property |
| 36 | def gerrit_number(self): |
| 37 | return self._gerrit_number |
| 38 | |
| 39 | def GetFileContents(self, _path: str): |
| 40 | return self._file_content |
| 41 | |
Yoshiki Iguchi | ab2c4c2 | 2022-09-22 18:43:21 +0900 | [diff] [blame] | 42 | def GetOriginalFileContents(self, _path: str): |
| 43 | return self._original_file_content |
| 44 | |
| 45 | def IsMergeable(self): |
| 46 | return self._mergeable |
| 47 | |
| 48 | def Rebase(self, allow_conflicts: bool = False): |
| 49 | pass |
| 50 | |
Yoshiki Iguchi | f8ab011 | 2022-09-15 16:57:26 +0900 | [diff] [blame] | 51 | |
Steven Bennetts | ddf9bcd | 2017-06-14 14:07:43 -0700 | [diff] [blame] | 52 | # pylint: disable=protected-access |
Alex Klein | 1699fab | 2022-09-08 08:46:06 -0600 | [diff] [blame] | 53 | class ChromeLKGMCommitterTester( |
| 54 | cros_test_lib.RunCommandTestCase, cros_test_lib.MockTempDirTestCase |
| 55 | ): |
| 56 | """Test cros_chromeos_lkgm.Committer.""" |
Achuith Bhandarkar | ec8d7a7 | 2018-03-01 16:56:22 -0800 | [diff] [blame] | 57 | |
Yoshiki Iguchi | d5bc792 | 2022-09-22 14:37:48 +0900 | [diff] [blame^] | 58 | def testCommitNewLKGM(self): |
| 59 | """Tests that we can commit a new LKGM file.""" |
| 60 | committer = chrome_chromeos_lkgm.ChromeLKGMCommitter( |
| 61 | "1001.0.0", |
| 62 | "main", |
| 63 | chromeos_version.VersionInfo("999.0.0"), |
| 64 | False, |
Alex Klein | 1699fab | 2022-09-08 08:46:06 -0600 | [diff] [blame] | 65 | ) |
Steven Bennetts | ddf9bcd | 2017-06-14 14:07:43 -0700 | [diff] [blame] | 66 | |
Yoshiki Iguchi | d5bc792 | 2022-09-22 14:37:48 +0900 | [diff] [blame^] | 67 | with mock.patch.object(committer._gerrit_helper, "CreateChange") as cg: |
Alex Klein | 1699fab | 2022-09-08 08:46:06 -0600 | [diff] [blame] | 68 | cg.return_value = mock.MagicMock(gerrit_number=123456) |
| 69 | with mock.patch.object( |
Yoshiki Iguchi | d5bc792 | 2022-09-22 14:37:48 +0900 | [diff] [blame^] | 70 | committer._gerrit_helper, "ChangeEdit" |
Alex Klein | 1699fab | 2022-09-08 08:46:06 -0600 | [diff] [blame] | 71 | ) as ce: |
| 72 | with mock.patch.object( |
Yoshiki Iguchi | d5bc792 | 2022-09-22 14:37:48 +0900 | [diff] [blame^] | 73 | committer._gerrit_helper, "SetReview" |
Alex Klein | 1699fab | 2022-09-08 08:46:06 -0600 | [diff] [blame] | 74 | ) as bc: |
| 75 | with mock.patch.object( |
Yoshiki Iguchi | d5bc792 | 2022-09-22 14:37:48 +0900 | [diff] [blame^] | 76 | committer._gerrit_helper, "SetHashtags" |
Alex Klein | 1699fab | 2022-09-08 08:46:06 -0600 | [diff] [blame] | 77 | ): |
Yoshiki Iguchi | d5bc792 | 2022-09-22 14:37:48 +0900 | [diff] [blame^] | 78 | committer.UpdateLKGM() |
Alex Klein | 1699fab | 2022-09-08 08:46:06 -0600 | [diff] [blame] | 79 | ce.assert_called_once_with( |
| 80 | 123456, "chromeos/CHROMEOS_LKGM", "1001.0.0" |
| 81 | ) |
| 82 | bc.assert_called_once_with( |
Jack Neus | 624c8a5 | 2022-09-13 17:33:03 +0000 | [diff] [blame] | 83 | 123456, |
| 84 | labels={"Bot-Commit": 1, "Commit-Queue": 2}, |
| 85 | notify="NONE", |
Yoshiki Iguchi | dad2425 | 2022-09-22 14:21:30 +0900 | [diff] [blame] | 86 | ready=True, |
| 87 | reviewers=[ |
| 88 | "chrome-os-gardeners-reviews@google.com" |
| 89 | ], |
Alex Klein | 1699fab | 2022-09-08 08:46:06 -0600 | [diff] [blame] | 90 | ) |
Steven Bennetts | ddf9bcd | 2017-06-14 14:07:43 -0700 | [diff] [blame] | 91 | |
Yoshiki Iguchi | d5bc792 | 2022-09-22 14:37:48 +0900 | [diff] [blame^] | 92 | def testOlderLKGMFails(self): |
Alex Klein | 1699fab | 2022-09-08 08:46:06 -0600 | [diff] [blame] | 93 | """Tests that trying to update to an older lkgm version fails.""" |
Yoshiki Iguchi | d5bc792 | 2022-09-22 14:37:48 +0900 | [diff] [blame^] | 94 | committer = chrome_chromeos_lkgm.ChromeLKGMCommitter( |
| 95 | "1001.0.0", |
| 96 | "main", |
| 97 | chromeos_version.VersionInfo("1002.0.0"), |
| 98 | False, |
| 99 | ) |
| 100 | with mock.patch.object(committer._gerrit_helper, "CreateChange") as cg: |
Alex Klein | 1699fab | 2022-09-08 08:46:06 -0600 | [diff] [blame] | 101 | cg.return_value = mock.MagicMock(gerrit_number=123456) |
| 102 | with mock.patch.object( |
Yoshiki Iguchi | d5bc792 | 2022-09-22 14:37:48 +0900 | [diff] [blame^] | 103 | committer._gerrit_helper, "ChangeEdit" |
Alex Klein | 1699fab | 2022-09-08 08:46:06 -0600 | [diff] [blame] | 104 | ) as ce: |
| 105 | self.assertRaises( |
Yoshiki Iguchi | d5bc792 | 2022-09-22 14:37:48 +0900 | [diff] [blame^] | 106 | chrome_chromeos_lkgm.LKGMNotValid, committer.UpdateLKGM |
Alex Klein | 1699fab | 2022-09-08 08:46:06 -0600 | [diff] [blame] | 107 | ) |
| 108 | ce.assert_not_called() |
Ben Pastene | d3b93d4 | 2019-10-10 09:56:29 -0700 | [diff] [blame] | 109 | |
Yoshiki Iguchi | d5bc792 | 2022-09-22 14:37:48 +0900 | [diff] [blame^] | 110 | def testAbandonObsoleteLKGMs(self): |
Yoshiki Iguchi | f8ab011 | 2022-09-15 16:57:26 +0900 | [diff] [blame] | 111 | """Tests that trying to abandon the obsolete lkgm CLs.""" |
Yoshiki Iguchi | d5bc792 | 2022-09-22 14:37:48 +0900 | [diff] [blame^] | 112 | cleaner = chrome_chromeos_lkgm.ChromeLKGMCleaner( |
| 113 | "main", chromeos_version.VersionInfo("10002.0.0"), "USER_EMAIL" |
| 114 | ) |
Yoshiki Iguchi | f8ab011 | 2022-09-15 16:57:26 +0900 | [diff] [blame] | 115 | |
Yoshiki Iguchi | ab2c4c2 | 2022-09-22 18:43:21 +0900 | [diff] [blame] | 116 | older_change = StubGerritChange( |
| 117 | 3876550, "10001.0.0", "10001.0.0", mergeable=False |
| 118 | ) |
Yoshiki Iguchi | f8ab011 | 2022-09-15 16:57:26 +0900 | [diff] [blame] | 119 | newer_change = StubGerritChange(3876551, "10003.0.0", "10003.0.0") |
| 120 | open_issues = [older_change, newer_change] |
| 121 | |
| 122 | with mock.patch.object( |
Yoshiki Iguchi | d5bc792 | 2022-09-22 14:37:48 +0900 | [diff] [blame^] | 123 | cleaner._gerrit_helper, "Query", return_value=open_issues |
Yoshiki Iguchi | f8ab011 | 2022-09-15 16:57:26 +0900 | [diff] [blame] | 124 | ) as mock_query: |
| 125 | with mock.patch.object( |
Yoshiki Iguchi | d5bc792 | 2022-09-22 14:37:48 +0900 | [diff] [blame^] | 126 | cleaner._gerrit_helper, "AbandonChange" |
Yoshiki Iguchi | f8ab011 | 2022-09-15 16:57:26 +0900 | [diff] [blame] | 127 | ) as ac: |
Yoshiki Iguchi | d5bc792 | 2022-09-22 14:37:48 +0900 | [diff] [blame^] | 128 | cleaner.ProcessObsoleteLKGMRolls() |
Yoshiki Iguchi | f8ab011 | 2022-09-15 16:57:26 +0900 | [diff] [blame] | 129 | mock_query.assert_called_once() |
| 130 | ac.assert_called_once_with((older_change), msg=mock.ANY) |
| 131 | |
Yoshiki Iguchi | d5bc792 | 2022-09-22 14:37:48 +0900 | [diff] [blame^] | 132 | def testRebaseObsoleteLKGMs(self): |
Yoshiki Iguchi | ab2c4c2 | 2022-09-22 18:43:21 +0900 | [diff] [blame] | 133 | """Tests that trying to abandon the obsolete lkgm CLs.""" |
Yoshiki Iguchi | d5bc792 | 2022-09-22 14:37:48 +0900 | [diff] [blame^] | 134 | cleaner = chrome_chromeos_lkgm.ChromeLKGMCleaner( |
| 135 | "main", chromeos_version.VersionInfo("10002.0.0"), "USER_EMAIL" |
| 136 | ) |
Yoshiki Iguchi | ab2c4c2 | 2022-09-22 18:43:21 +0900 | [diff] [blame] | 137 | |
| 138 | # LKGM Roll CL from "10001.0.0" to "10003.0.0" should be in the |
| 139 | # merge-conflict state, since the current LKGM version is "10002.0.0". |
| 140 | ROLL_FROM = "10001.0.0" |
| 141 | ROLL_TO = "10003.0.0" |
| 142 | GERRIT_NUM = 3876551 |
| 143 | roll = StubGerritChange( |
| 144 | GERRIT_NUM, |
| 145 | ROLL_TO, |
| 146 | ROLL_TO, |
| 147 | mergeable=False, |
| 148 | original_file_content=ROLL_FROM, |
| 149 | ) |
| 150 | |
| 151 | with mock.patch.object( |
Yoshiki Iguchi | d5bc792 | 2022-09-22 14:37:48 +0900 | [diff] [blame^] | 152 | cleaner._gerrit_helper, "Query", return_value=[roll] |
Yoshiki Iguchi | ab2c4c2 | 2022-09-22 18:43:21 +0900 | [diff] [blame] | 153 | ) as mock_query: |
| 154 | with mock.patch.object(roll, "Rebase") as rebase: |
| 155 | with mock.patch.object( |
Yoshiki Iguchi | d5bc792 | 2022-09-22 14:37:48 +0900 | [diff] [blame^] | 156 | cleaner._gerrit_helper, "ChangeEdit" |
Yoshiki Iguchi | ab2c4c2 | 2022-09-22 18:43:21 +0900 | [diff] [blame] | 157 | ) as ce: |
Yoshiki Iguchi | d5bc792 | 2022-09-22 14:37:48 +0900 | [diff] [blame^] | 158 | cleaner.ProcessObsoleteLKGMRolls() |
Yoshiki Iguchi | ab2c4c2 | 2022-09-22 18:43:21 +0900 | [diff] [blame] | 159 | mock_query.assert_called_once() |
| 160 | |
| 161 | # Confirm that it does rebasing. |
| 162 | rebase.assert_called_once_with(allow_conflicts=True) |
| 163 | ce.assert_called_once_with(GERRIT_NUM, mock.ANY, ROLL_TO) |
| 164 | |
Yoshiki Iguchi | d5bc792 | 2022-09-22 14:37:48 +0900 | [diff] [blame^] | 165 | def testDoNothingObsoleteLKGMs(self): |
Yoshiki Iguchi | ab2c4c2 | 2022-09-22 18:43:21 +0900 | [diff] [blame] | 166 | """Tests that trying to abandon the obsolete lkgm CLs.""" |
Yoshiki Iguchi | d5bc792 | 2022-09-22 14:37:48 +0900 | [diff] [blame^] | 167 | cleaner = chrome_chromeos_lkgm.ChromeLKGMCleaner( |
| 168 | "main", chromeos_version.VersionInfo("10002.0.0"), "USER_EMAIL" |
| 169 | ) |
Yoshiki Iguchi | ab2c4c2 | 2022-09-22 18:43:21 +0900 | [diff] [blame] | 170 | |
| 171 | # LKGM Roll CL from "10002.0.0" to "10003.0.0" should NOT be in the |
| 172 | # merge-conflict state, since the current LKGM version is "10002.0.0". |
| 173 | ROLL_FROM = "10002.0.0" |
| 174 | ROLL_TO = "10003.0.0" |
| 175 | GERRIT_NUM = 3876551 |
| 176 | # Even if mergeable=False, the logic should not do nothing. |
| 177 | roll = StubGerritChange( |
| 178 | GERRIT_NUM, |
| 179 | ROLL_TO, |
| 180 | ROLL_TO, |
| 181 | mergeable=False, |
| 182 | original_file_content=ROLL_FROM, |
| 183 | ) |
| 184 | |
| 185 | with mock.patch.object( |
Yoshiki Iguchi | d5bc792 | 2022-09-22 14:37:48 +0900 | [diff] [blame^] | 186 | cleaner._gerrit_helper, "Query", return_value=[roll] |
Yoshiki Iguchi | ab2c4c2 | 2022-09-22 18:43:21 +0900 | [diff] [blame] | 187 | ) as mock_query: |
| 188 | with mock.patch.object(roll, "Rebase") as rebase: |
| 189 | with mock.patch.object( |
Yoshiki Iguchi | d5bc792 | 2022-09-22 14:37:48 +0900 | [diff] [blame^] | 190 | cleaner._gerrit_helper, "ChangeEdit" |
Yoshiki Iguchi | ab2c4c2 | 2022-09-22 18:43:21 +0900 | [diff] [blame] | 191 | ) as ce: |
Yoshiki Iguchi | d5bc792 | 2022-09-22 14:37:48 +0900 | [diff] [blame^] | 192 | cleaner.ProcessObsoleteLKGMRolls() |
Yoshiki Iguchi | ab2c4c2 | 2022-09-22 18:43:21 +0900 | [diff] [blame] | 193 | mock_query.assert_called_once() |
| 194 | |
| 195 | # Confirm that it does nothing. |
| 196 | rebase.assert_not_called() |
| 197 | ce.assert_not_called() |
| 198 | |
Yoshiki Iguchi | d5bc792 | 2022-09-22 14:37:48 +0900 | [diff] [blame^] | 199 | def testVersionWithChromeBranch(self): |
Alex Klein | 1699fab | 2022-09-08 08:46:06 -0600 | [diff] [blame] | 200 | """Tests passing a version with a chrome branch strips the branch.""" |
| 201 | branch = "refs/branch-heads/5000" |
Yoshiki Iguchi | d5bc792 | 2022-09-22 14:37:48 +0900 | [diff] [blame^] | 202 | committer = chrome_chromeos_lkgm.ChromeLKGMCommitter( |
| 203 | "1003.0.0-rc2", |
| 204 | branch, |
| 205 | chromeos_version.VersionInfo("1002.0.0"), |
| 206 | False, |
Alex Klein | 1699fab | 2022-09-08 08:46:06 -0600 | [diff] [blame] | 207 | ) |
Ben Pastene | 6a8361a | 2021-08-19 19:52:05 -0700 | [diff] [blame] | 208 | |
Yoshiki Iguchi | d5bc792 | 2022-09-22 14:37:48 +0900 | [diff] [blame^] | 209 | with mock.patch.object(committer._gerrit_helper, "CreateChange") as cg: |
Alex Klein | 1699fab | 2022-09-08 08:46:06 -0600 | [diff] [blame] | 210 | cg.return_value = mock.MagicMock(gerrit_number=123456) |
| 211 | with mock.patch.object( |
Yoshiki Iguchi | d5bc792 | 2022-09-22 14:37:48 +0900 | [diff] [blame^] | 212 | committer._gerrit_helper, "ChangeEdit" |
Alex Klein | 1699fab | 2022-09-08 08:46:06 -0600 | [diff] [blame] | 213 | ) as ce: |
| 214 | with mock.patch.object( |
Yoshiki Iguchi | d5bc792 | 2022-09-22 14:37:48 +0900 | [diff] [blame^] | 215 | committer._gerrit_helper, "SetReview" |
Alex Klein | 1699fab | 2022-09-08 08:46:06 -0600 | [diff] [blame] | 216 | ) as bc: |
| 217 | with mock.patch.object( |
Yoshiki Iguchi | d5bc792 | 2022-09-22 14:37:48 +0900 | [diff] [blame^] | 218 | committer._gerrit_helper, "SetHashtags" |
Alex Klein | 1699fab | 2022-09-08 08:46:06 -0600 | [diff] [blame] | 219 | ): |
| 220 | # Check the file was actually written out correctly. |
Yoshiki Iguchi | d5bc792 | 2022-09-22 14:37:48 +0900 | [diff] [blame^] | 221 | committer.UpdateLKGM() |
Alex Klein | 1699fab | 2022-09-08 08:46:06 -0600 | [diff] [blame] | 222 | cg.assert_called_once_with( |
| 223 | "chromium/src", branch, mock.ANY, False |
| 224 | ) |
| 225 | ce.assert_called_once_with( |
| 226 | 123456, "chromeos/CHROMEOS_LKGM", "1003.0.0" |
| 227 | ) |
| 228 | bc.assert_called_once_with( |
Jack Neus | 624c8a5 | 2022-09-13 17:33:03 +0000 | [diff] [blame] | 229 | 123456, |
| 230 | labels={"Bot-Commit": 1, "Commit-Queue": 2}, |
| 231 | notify="NONE", |
Yoshiki Iguchi | dad2425 | 2022-09-22 14:21:30 +0900 | [diff] [blame] | 232 | ready=True, |
| 233 | reviewers=[ |
| 234 | "chrome-os-gardeners-reviews@google.com" |
| 235 | ], |
Alex Klein | 1699fab | 2022-09-08 08:46:06 -0600 | [diff] [blame] | 236 | ) |
Ben Pastene | 6a8361a | 2021-08-19 19:52:05 -0700 | [diff] [blame] | 237 | |
Alex Klein | 1699fab | 2022-09-08 08:46:06 -0600 | [diff] [blame] | 238 | def testCommitMsg(self): |
| 239 | """Tests format of the commit message.""" |
Yoshiki Iguchi | d5bc792 | 2022-09-22 14:37:48 +0900 | [diff] [blame^] | 240 | committer = chrome_chromeos_lkgm.ChromeLKGMCommitter( |
| 241 | "1001.0.0", |
| 242 | "main", |
| 243 | chromeos_version.VersionInfo("999.0.0"), |
| 244 | False, |
| 245 | buildbucket_id="some-build-id", |
| 246 | ) |
| 247 | |
| 248 | committer._PRESUBMIT_BOTS = ["bot1", "bot2"] |
| 249 | commit_msg_lines = committer.ComposeCommitMsg().splitlines() |
Alex Klein | 1699fab | 2022-09-08 08:46:06 -0600 | [diff] [blame] | 250 | self.assertIn( |
| 251 | "Automated Commit: LKGM 1001.0.0 for chromeos.", commit_msg_lines |
| 252 | ) |
| 253 | self.assertIn( |
| 254 | "Uploaded by https://ci.chromium.org/b/some-build-id", |
| 255 | commit_msg_lines, |
| 256 | ) |
| 257 | self.assertIn( |
| 258 | "CQ_INCLUDE_TRYBOTS=luci.chrome.try:bot1", commit_msg_lines |
| 259 | ) |
| 260 | self.assertIn( |
| 261 | "CQ_INCLUDE_TRYBOTS=luci.chrome.try:bot2", commit_msg_lines |
| 262 | ) |