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 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344
|
#!/usr/bin/env vpython3
# Copyright 2023 The Chromium Authors
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
import json
import subprocess
import unittest
from unittest import mock
from unexpected_passes_common import data_types
from machine_times import get_machine_times
# pylint: disable=protected-access
class EnsureBuildbucketAuthUnittest(unittest.TestCase):
def testValidAuth(self): # pylint: disable=no-self-use
"""Tests behavior when bb auth is valid."""
with mock.patch.object(get_machine_times.subprocess, 'check_call'):
get_machine_times._EnsureBuildbucketAuth()
def testInvalidAuth(self):
"""Tests behavior when bb auth is invalid."""
def SideEffect(*args, **kwargs):
raise subprocess.CalledProcessError(1, [])
with mock.patch.object(get_machine_times.subprocess,
'check_call',
side_effect=SideEffect):
with self.assertRaisesRegex(
RuntimeError, 'You are not logged into bb - run `bb auth-login`'):
get_machine_times._EnsureBuildbucketAuth()
class GetTimesForBuilderUnittest(unittest.TestCase):
def testNoBuildbucketIds(self):
"""Tests behavior when no Buildbucket IDs are found."""
builder = data_types.BuilderEntry('builder', 'ci', False)
with mock.patch.object(get_machine_times,
'_GetBuildbucketIdsForBuilder',
return_value=[]):
with self.assertLogs(level='WARNING'):
retval = get_machine_times._GetTimesForBuilder((builder, 1))
self.assertEqual(retval, {'chromium/ci/builder': {}})
def testBasic(self):
"""Basic happy path test."""
builder = data_types.BuilderEntry('builder', 'ci', False)
step_output = {
'steps': [
{
'name':
'first step',
'summaryMarkdown':
('Max pending time: 2s (shard #1) '
'* [shard #0 (runtime (1s) + overhead (1s): 2s)]'
'* [shard #1 (runtime (2s) + overhead (2s): 4s)]'),
},
{
'name':
'second step',
'summaryMarkdown':
('Max pending time: 4s (shard #1) '
'* [shard #0 (runtime (3s) + overhead (3s): 6s)]'
'* [shard #1 (runtime (4s) + overhead (4s): 8s)]'),
},
],
}
expected_output = {
'chromium/ci/builder': {
'first step': [
(1, 1),
(2, 2),
],
'second step': [
(3, 3),
(4, 4),
],
},
}
with mock.patch.object(get_machine_times,
'_GetBuildbucketIdsForBuilder',
return_value=['1234']):
with mock.patch.object(get_machine_times,
'_GetStepOutputForBuild',
return_value=json.dumps(step_output)):
self.assertEqual(get_machine_times._GetTimesForBuilder((builder, 1)),
expected_output)
class GetBuildbucketIdsForBuilderUnittest(unittest.TestCase):
def testBasic(self):
"""Basic happy path test."""
builder = data_types.BuilderEntry('builder', 'ci', False)
mock_process = mock.Mock()
mock_process.stdout = '1\n2\n3'
with mock.patch.object(get_machine_times.subprocess,
'run',
return_value=mock_process) as mock_run:
self.assertEqual(
get_machine_times._GetBuildbucketIdsForBuilder(builder, 3),
['1', '2', '3'])
mock_run.assert_called_once_with(
['bb', 'ls', '-id', '-3', '-status', 'ended', 'chromium/ci/builder'],
text=True,
check=True,
stdout=subprocess.PIPE)
class GetStepOutputForBuildUnittest(unittest.TestCase):
def testBasic(self):
"""Basic happy path test."""
mock_process = mock.Mock()
mock_process.stdout = 'stdout'
with mock.patch.object(get_machine_times.subprocess,
'run',
return_value=mock_process) as mock_run:
self.assertEqual(get_machine_times._GetStepOutputForBuild('1234'),
'stdout')
mock_run.assert_called_once_with(['bb', 'get', '-json', '-steps', '1234'],
text=True,
check=True,
stdout=subprocess.PIPE)
class GetShardTimesFromStepOutputUnittest(unittest.TestCase):
def testNonSummaryIgnored(self):
"""Tests that steps without a summary are ignored."""
step_output = {
'steps': [
{
'name': 'builder cache|check if empty',
},
],
}
self.assertEqual(
get_machine_times._GetShardTimesFromStepOutput(json.dumps(step_output)),
{})
def testSummaryFiltering(self):
"""Tests that only steps with certain summaries are used."""
step_output = {
'steps': [
{
'name':
'bad step',
'summaryMarkdown':
'* [shard #0 (runtime (1s) + overhead (1s): 2s)]',
},
{
'name':
'Multi shard with pending time',
'summaryMarkdown':
('Max pending time: 38s (shard #5) '
'* [shard #0 (runtime (2s) + overhead (2s): 4s)]'),
},
{
'name':
'Single shard with pending time',
'summaryMarkdown':
('Pending time: 40s '
'* [shard #0 (runtime (3s) + overhead (3s): 6s)]'),
},
{
'name':
'Single shard with no pending time',
'summaryMarkdown':
('Shard runtime 4s '
'* [shard #0 (runtime (4s) + overhead (4s): 8s)]'),
},
],
}
expected_output = {
'Multi shard with pending time': [(2, 2)],
'Single shard with pending time': [(3, 3)],
'Single shard with no pending time': [(4, 4)],
}
self.assertEqual(
get_machine_times._GetShardTimesFromStepOutput(json.dumps(step_output)),
expected_output)
def testPassingMatch(self):
"""Tests that shard times can be extracted from passing shards."""
step_output = {
'steps': [
{
'name':
'All passing',
'summaryMarkdown':
('Max pending time: 2s (shard #1) '
'* [shard #0 (runtime (1s) + overhead (1s): 2s)]'
'* [shard #1 (runtime (2s) + overhead (2s): 4s)]'),
},
],
}
expected_output = {
'All passing': [(1, 1), (2, 2)],
}
self.assertEqual(
get_machine_times._GetShardTimesFromStepOutput(json.dumps(step_output)),
expected_output)
def testFailingMatch(self):
"""Tests that shard times can be extracted from failing shards."""
step_output = {
'steps': [
{
'name':
'All failing',
'summaryMarkdown': ('Max pending time: 2s (shard #1)'
'* [shard #0 (failed) (1s)]'
'* [shard #1 (failed) (2s)]'),
},
],
}
expected_output = {
'All failing': [(1, 0), (2, 0)],
}
self.assertEqual(
get_machine_times._GetShardTimesFromStepOutput(json.dumps(step_output)),
expected_output)
def testTimeoutMatch(self):
"""Tests that shard times can be extracted from timed out shards."""
step_output = {
'steps': [
{
'name':
'All timeout',
'summaryMarkdown': ('Max pending time: 2s (shard #1)'
'* [shard #0 timed out after 1s]'
'* [shard #1 timed out after 2s]'),
},
],
}
expected_output = {
'All timeout': [(1, 0), (2, 0)],
}
self.assertEqual(
get_machine_times._GetShardTimesFromStepOutput(json.dumps(step_output)),
expected_output)
def testSwarmingFailuresIgnored(self):
"""Tests that internal swarming failures are silently ignored."""
step_output = {
'steps': [
{
'name':
'All infra failure',
'summaryMarkdown':
('Max pending time: 2s (shard #1)'
'* [shard #0 had an internal swarming failure]'
'* [shard #1 had an internal swarming failure]'),
},
],
}
# assertNoLogs would be useful here, but is only available in Python 3.10
# and above.
with mock.patch.object(get_machine_times.logging,
'warning',
side_effect=RuntimeError):
self.assertEqual(
get_machine_times._GetShardTimesFromStepOutput(
json.dumps(step_output)), {})
def testNoDataReported(self):
"""Tests that a failure to get shard runtimes is reported to the user."""
step_output = {
'steps': [
{
'name': 'Missing',
'summaryMarkdown': 'Max pending time: 1s (shard #0)',
},
],
}
with self.assertLogs(level='WARNING'):
self.assertEqual(
get_machine_times._GetShardTimesFromStepOutput(
json.dumps(step_output)), {})
def testMixedShards(self):
"""Tests shard time extraction with a mix of different shards."""
step_output = {
'steps': [
{
'name':
'Mixed',
'summaryMarkdown':
('Max pending time: 3s (shard #2)'
'* [shard #0 (runtime (1s) + overhead (1s): 2s)]'
'* [shard #1 (failed) (2s)]'
'* [shard #2 timed out after 3s]'),
},
],
}
expected_output = {
'Mixed': [(1, 1), (2, 0), (3, 0)],
}
self.assertEqual(
get_machine_times._GetShardTimesFromStepOutput(json.dumps(step_output)),
expected_output)
def testDuplicateSteps(self):
"""Tests that duplicate shards are not supported."""
step_output = {
'id':
'build-id',
'steps': [
{
'name':
'I am the real one',
'summaryMarkdown':
('Max pending time: 2s (shard #1) '
'* [shard #0 (runtime (1s) + overhead (1s): 2s)]'
'* [shard #1 (runtime (2s) + overhead (2s): 4s)]'),
},
{
'name':
'I am the real one',
'summaryMarkdown':
('Max pending time: 2s (shard #1) '
'* [shard #0 (runtime (1s) + overhead (1s): 2s)]'
'* [shard #1 (runtime (2s) + overhead (2s): 4s)]'),
},
],
}
with self.assertRaises(AssertionError):
get_machine_times._GetShardTimesFromStepOutput(json.dumps(step_output))
class ConvertSummaryRuntimeToSecondsUnittest(unittest.TestCase):
def testMinutesAndSeconds(self):
"""Tests conversion with minutes and seconds present."""
self.assertEqual(get_machine_times._ConvertSummaryRuntimeToSeconds('1m 1s'),
61)
def testSecondsOnly(self):
"""Tests conversion with only seconds present."""
self.assertEqual(get_machine_times._ConvertSummaryRuntimeToSeconds('1s'), 1)
if __name__ == '__main__':
unittest.main(verbosity=2)
|