blob: 6d8f79bcc738beb838205b7b8795c71a39e5e951 [file] [log] [blame]
Mike Frysingere58c0e22017-10-04 15:43:30 -04001# -*- coding: utf-8 -*-
Mike Frysingerd5fcb3a2013-05-30 21:10:50 -04002# Copyright (c) 2013 The Chromium OS Authors. All rights reserved.
3# Use of this source code is governed by a BSD-style license that can be
4# found in the LICENSE file.
5
Mike Frysingereb753bf2013-11-22 16:05:35 -05006"""Unittests for upload_symbols.py"""
7
Mike Frysinger7f9be142014-01-15 02:16:42 -05008from __future__ import print_function
9
Mike Frysinger0a2fd922014-09-12 20:23:42 -070010import BaseHTTPServer
Mike Frysinger06da5202014-09-26 17:30:33 -050011import errno
Don Garretta28be6d2016-06-16 18:09:35 -070012import itertools
Mike Frysingerea838d12014-12-08 11:55:32 -050013import mock
Mike Frysingerd5fcb3a2013-05-30 21:10:50 -040014import os
Mike Frysinger0a2fd922014-09-12 20:23:42 -070015import signal
Mike Frysinger06da5202014-09-26 17:30:33 -050016import socket
Mike Frysinger0a2fd922014-09-12 20:23:42 -070017import SocketServer
Mike Frysingerd5fcb3a2013-05-30 21:10:50 -040018import sys
Aviv Keshetd1f04632014-05-09 11:33:46 -070019import time
Mike Frysinger094a2172013-08-14 12:54:35 -040020import urllib2
Mike Frysingerd5fcb3a2013-05-30 21:10:50 -040021
Mike Frysinger079863c2014-10-09 23:16:46 -040022# We specifically set up a local server to connect to, so make sure we
23# delete any proxy settings that might screw that up. We also need to
24# do it here because modules that are imported below will implicitly
25# initialize with this proxy setting rather than dynamically pull it
26# on the fly :(.
27os.environ.pop('http_proxy', None)
28
Aviv Keshetb7519e12016-10-04 00:50:00 -070029from chromite.lib import constants
Mike Frysingerbbd1f112016-09-08 18:25:11 -040030
31# The isolateserver includes a bunch of third_party python packages that clash
32# with chromite's bundled third_party python packages (like oauth2client).
33# Since upload_symbols is not imported in to other parts of chromite, and there
34# are no deps in third_party we care about, purge the chromite copy. This way
35# we can use isolateserver for deduping.
36# TODO: If we ever sort out third_party/ handling and make it per-script opt-in,
37# we can purge this logic.
38third_party = os.path.join(constants.CHROMITE_DIR, 'third_party')
39while True:
40 try:
41 sys.path.remove(third_party)
42 except ValueError:
43 break
44sys.path.insert(0, os.path.join(third_party, 'swarming.client'))
45del third_party
46
Ralph Nathan446aee92015-03-23 14:44:56 -070047from chromite.lib import cros_logging as logging
Mike Frysingerd5fcb3a2013-05-30 21:10:50 -040048from chromite.lib import cros_test_lib
49from chromite.lib import osutils
50from chromite.lib import parallel
Mike Frysinger0a2fd922014-09-12 20:23:42 -070051from chromite.lib import remote_access
Mike Frysinger5e30a4b2014-02-12 20:23:04 -050052from chromite.scripts import cros_generate_breakpad_symbols
Mike Frysingerd5fcb3a2013-05-30 21:10:50 -040053from chromite.scripts import upload_symbols
54
Mike Frysingerbbd1f112016-09-08 18:25:11 -040055# And our sys.path muckery confuses pylint.
Xixuan Wu3e840592018-05-30 15:27:03 -070056import isolate_storage # pylint: disable=import-error
Mike Frysingerbbd1f112016-09-08 18:25:11 -040057
Mike Frysinger0c0efa22014-02-09 23:32:23 -050058
Don Garretta28be6d2016-06-16 18:09:35 -070059class SymbolsTestBase(cros_test_lib.MockTempDirTestCase):
60 """Base class for most symbols tests."""
61
62 SLIM_CONTENT = """
63some junk
64"""
65
66 FAT_CONTENT = """
67STACK CFI 1234
68some junk
69STACK CFI 1234
70"""
71
72 def setUp(self):
73 # Make certain we don't use the network.
Xixuan Wu3e840592018-05-30 15:27:03 -070074 self.isolate_mock = self.PatchObject(isolate_storage, 'get_storage_api')
Don Garretta28be6d2016-06-16 18:09:35 -070075 self.urlopen_mock = self.PatchObject(urllib2, 'urlopen')
Mike Nichols90f7c152019-04-09 15:14:08 -060076 self.request_mock = self.PatchObject(upload_symbols, 'ExecRequest',
77 return_value={'uploadUrl':
78 'testurl',
79 'uploadKey':
80 'asdgasgas'})
Don Garretta28be6d2016-06-16 18:09:35 -070081
82 # Make 'uploads' go fast.
83 self.PatchObject(upload_symbols, 'SLEEP_DELAY', 0)
84 self.PatchObject(upload_symbols, 'INITIAL_RETRY_DELAY', 0)
85
86 # So our symbol file content doesn't have to be real.
87 self.PatchObject(cros_generate_breakpad_symbols, 'ReadSymsHeader',
88 return_value=cros_generate_breakpad_symbols.SymbolHeader(
89 os='os', cpu='cpu', id='id', name='name'))
90
91 self.working = os.path.join(self.tempdir, 'expand')
92 osutils.SafeMakedirs(self.working)
93
94 self.data = os.path.join(self.tempdir, 'data')
95 osutils.SafeMakedirs(self.data)
96
97 def createSymbolFile(self, filename, content=FAT_CONTENT, size=0,
98 status=None, dedupe=False):
99 fullname = os.path.join(self.data, filename)
100 osutils.SafeMakedirs(os.path.dirname(fullname))
101
102 # If a file size is given, force that to be the minimum file size. Create
103 # a sparse file so large files are practical.
104 with open(fullname, 'w+b') as f:
105 f.truncate(size)
106 f.seek(0)
107 f.write(content)
108
109 result = upload_symbols.SymbolFile(display_path=filename,
110 file_name=fullname)
111
112 if status:
113 result.status = status
114
115 if dedupe:
116 result.dedupe_item = upload_symbols.DedupeItem(result)
117 result.dedupe_push_state = 'push_state'
118
119 return result
120
Mike Frysingerd5fcb3a2013-05-30 21:10:50 -0400121
Mike Frysinger0a2fd922014-09-12 20:23:42 -0700122class SymbolServerRequestHandler(BaseHTTPServer.BaseHTTPRequestHandler):
123 """HTTP handler for symbol POSTs"""
124
125 RESP_CODE = None
126 RESP_MSG = None
127
128 def do_POST(self):
129 """Handle a POST request"""
130 # Drain the data from the client. If we don't, we might write the response
131 # and close the socket before the client finishes, so they die with EPIPE.
132 clen = int(self.headers.get('Content-Length', '0'))
133 self.rfile.read(clen)
134
135 self.send_response(self.RESP_CODE, self.RESP_MSG)
136 self.end_headers()
137
138 def log_message(self, *args, **kwargs):
139 """Stub the logger as it writes to stderr"""
140 pass
141
142
143class SymbolServer(SocketServer.ThreadingTCPServer, BaseHTTPServer.HTTPServer):
144 """Simple HTTP server that forks each request"""
145
146
147class UploadSymbolsServerTest(cros_test_lib.MockTempDirTestCase):
148 """Tests for UploadSymbols() and a local HTTP server"""
149
150 SYM_CONTENTS = """MODULE Linux arm 123-456 blkid
151PUBLIC 1471 0 main"""
152
153 def SpawnServer(self, RequestHandler):
154 """Spawn a new http server"""
Mike Frysinger06da5202014-09-26 17:30:33 -0500155 while True:
156 try:
157 port = remote_access.GetUnusedPort()
158 address = ('', port)
159 self.httpd = SymbolServer(address, RequestHandler)
160 break
161 except socket.error as e:
162 if e.errno == errno.EADDRINUSE:
163 continue
164 raise
Don Garretta28be6d2016-06-16 18:09:35 -0700165 self.server_url = 'http://localhost:%i/post/path' % port
Mike Frysinger0a2fd922014-09-12 20:23:42 -0700166 self.httpd_pid = os.fork()
167 if self.httpd_pid == 0:
168 self.httpd.serve_forever(poll_interval=0.1)
169 sys.exit(0)
170
171 def setUp(self):
172 self.httpd_pid = None
173 self.httpd = None
Don Garretta28be6d2016-06-16 18:09:35 -0700174 self.server_url = None
Mike Frysinger0a2fd922014-09-12 20:23:42 -0700175 self.sym_file = os.path.join(self.tempdir, 'test.sym')
176 osutils.WriteFile(self.sym_file, self.SYM_CONTENTS)
177
Don Garretta28be6d2016-06-16 18:09:35 -0700178 # Stop sleeps and retries for these tests.
179 self.PatchObject(upload_symbols, 'SLEEP_DELAY', 0)
180 self.PatchObject(upload_symbols, 'INITIAL_RETRY_DELAY', 0)
181 self.PatchObject(upload_symbols, 'MAX_RETRIES', 0)
182
183 # Just to be certain we don't really contact it.
Xixuan Wu3e840592018-05-30 15:27:03 -0700184 self.PatchObject(isolate_storage, 'get_storage_api')
Don Garretta28be6d2016-06-16 18:09:35 -0700185
Mike Frysinger0a2fd922014-09-12 20:23:42 -0700186 def tearDown(self):
187 # Only kill the server if we forked one.
188 if self.httpd_pid:
189 os.kill(self.httpd_pid, signal.SIGUSR1)
190
191 def testSuccess(self):
192 """The server returns success for all uploads"""
193 class Handler(SymbolServerRequestHandler):
194 """Always return 200"""
195 RESP_CODE = 200
Mike Nichols90f7c152019-04-09 15:14:08 -0600196 self.PatchObject(upload_symbols, 'ExecRequest',
197 return_value={'uploadUrl': 'testurl',
198 'uploadKey': 'testSuccess'})
Mike Frysinger0a2fd922014-09-12 20:23:42 -0700199
200 self.SpawnServer(Handler)
Don Garretta28be6d2016-06-16 18:09:35 -0700201 ret = upload_symbols.UploadSymbols(
202 sym_paths=[self.sym_file] * 10,
203 upload_url=self.server_url,
Mike Nichols90f7c152019-04-09 15:14:08 -0600204 api_key='testSuccess')
Mike Frysinger0a2fd922014-09-12 20:23:42 -0700205 self.assertEqual(ret, 0)
206
207 def testError(self):
208 """The server returns errors for all uploads"""
209 class Handler(SymbolServerRequestHandler):
Mike Nichols90f7c152019-04-09 15:14:08 -0600210 """All connections error"""
Mike Frysinger0a2fd922014-09-12 20:23:42 -0700211 RESP_CODE = 500
212 RESP_MSG = 'Internal Server Error'
213
214 self.SpawnServer(Handler)
Don Garretta28be6d2016-06-16 18:09:35 -0700215 ret = upload_symbols.UploadSymbols(
216 sym_paths=[self.sym_file] * 10,
217 upload_url=self.server_url,
Mike Nichols90f7c152019-04-09 15:14:08 -0600218 api_key='testkey')
Don Garretta28be6d2016-06-16 18:09:35 -0700219 self.assertEqual(ret, 10)
Mike Frysinger0a2fd922014-09-12 20:23:42 -0700220
221 def testHungServer(self):
222 """The server chokes, but we recover"""
223 class Handler(SymbolServerRequestHandler):
224 """All connections choke forever"""
225 def do_POST(self):
226 while True:
227 time.sleep(1000)
228
229 self.SpawnServer(Handler)
230 with mock.patch.object(upload_symbols, 'GetUploadTimeout') as m:
Don Garretta28be6d2016-06-16 18:09:35 -0700231 m.return_value = 0.01
Mike Frysinger58312e92014-03-18 04:18:36 -0400232 ret = upload_symbols.UploadSymbols(
Don Garretta28be6d2016-06-16 18:09:35 -0700233 sym_paths=[self.sym_file] * 10,
234 upload_url=self.server_url,
Mike Nichols90f7c152019-04-09 15:14:08 -0600235 api_key='testkey')
Don Garretta28be6d2016-06-16 18:09:35 -0700236 self.assertEqual(ret, 10)
Aviv Keshetd1f04632014-05-09 11:33:46 -0700237
Mike Frysingerd5fcb3a2013-05-30 21:10:50 -0400238
Don Garretta28be6d2016-06-16 18:09:35 -0700239class UploadSymbolsHelpersTest(cros_test_lib.TestCase):
240 """Test assorted helper functions and classes."""
Don Garretta28be6d2016-06-16 18:09:35 -0700241 def testIsTarball(self):
242 notTar = [
243 '/foo/bar/test.bin',
244 '/foo/bar/test.tar.bin',
245 '/foo/bar/test.faketar.gz',
246 '/foo/bar/test.nottgz',
Mike Frysinger0c0efa22014-02-09 23:32:23 -0500247 ]
Mike Frysinger0c0efa22014-02-09 23:32:23 -0500248
Don Garretta28be6d2016-06-16 18:09:35 -0700249 isTar = [
250 '/foo/bar/test.tar',
251 '/foo/bar/test.bin.tar',
252 '/foo/bar/test.bin.tar.bz2',
253 '/foo/bar/test.bin.tar.gz',
254 '/foo/bar/test.bin.tar.xz',
255 '/foo/bar/test.tbz2',
256 '/foo/bar/test.tbz',
257 '/foo/bar/test.tgz',
258 '/foo/bar/test.txz',
259 ]
Mike Frysinger0c0efa22014-02-09 23:32:23 -0500260
Don Garretta28be6d2016-06-16 18:09:35 -0700261 for p in notTar:
262 self.assertFalse(upload_symbols.IsTarball(p))
263
264 for p in isTar:
265 self.assertTrue(upload_symbols.IsTarball(p))
266
267 def testBatchGenerator(self):
268 result = upload_symbols.BatchGenerator([], 2)
269 self.assertEqual(list(result), [])
270
271 result = upload_symbols.BatchGenerator(xrange(6), 2)
272 self.assertEqual(list(result), [[0, 1], [2, 3], [4, 5]])
273
274 result = upload_symbols.BatchGenerator(xrange(7), 2)
275 self.assertEqual(list(result), [[0, 1], [2, 3], [4, 5], [6]])
276
277 # Prove that we are streaming the results, not generating them all at once.
278 result = upload_symbols.BatchGenerator(itertools.repeat(0), 2)
279 self.assertEqual(result.next(), [0, 0])
280
281
282class FindSymbolFilesTest(SymbolsTestBase):
283 """Test FindSymbolFiles."""
284 def setUp(self):
285 self.symfile = self.createSymbolFile('root.sym').file_name
286 self.innerfile = self.createSymbolFile(
287 os.path.join('nested', 'inner.sym')).file_name
288
289 # CreateTarball is having issues outside the chroot from open file tests.
290 #
291 # self.tarball = os.path.join(self.tempdir, 'syms.tar.gz')
292 # cros_build_lib.CreateTarball(
293 # 'syms.tar.gz', self.tempdir, inputs=(self.data))
294
295 def testEmpty(self):
296 symbols = list(upload_symbols.FindSymbolFiles(
297 self.working, []))
298 self.assertEqual(symbols, [])
299
300 def testFile(self):
301 symbols = list(upload_symbols.FindSymbolFiles(
302 self.working, [self.symfile]))
303
304 self.assertEqual(len(symbols), 1)
305 sf = symbols[0]
306
307 self.assertEqual(sf.display_name, 'root.sym')
308 self.assertEqual(sf.display_path, self.symfile)
309 self.assertEqual(sf.file_name, self.symfile)
310 self.assertEqual(sf.status, upload_symbols.SymbolFile.INITIAL)
311 self.assertEqual(sf.FileSize(), len(self.FAT_CONTENT))
312
313 def testDir(self):
314 symbols = list(upload_symbols.FindSymbolFiles(
315 self.working, [self.data]))
316
317 self.assertEqual(len(symbols), 2)
318 root = symbols[0]
319 nested = symbols[1]
320
321 self.assertEqual(root.display_name, 'root.sym')
322 self.assertEqual(root.display_path, 'root.sym')
323 self.assertEqual(root.file_name, self.symfile)
324 self.assertEqual(root.status, upload_symbols.SymbolFile.INITIAL)
325 self.assertEqual(root.FileSize(), len(self.FAT_CONTENT))
326
327 self.assertEqual(nested.display_name, 'inner.sym')
328 self.assertEqual(nested.display_path, 'nested/inner.sym')
329 self.assertEqual(nested.file_name, self.innerfile)
330 self.assertEqual(nested.status, upload_symbols.SymbolFile.INITIAL)
331 self.assertEqual(nested.FileSize(), len(self.FAT_CONTENT))
332
333
334class AdjustSymbolFileSizeTest(SymbolsTestBase):
335 """Test AdjustSymbolFileSize."""
336 def setUp(self):
337 self.slim = self.createSymbolFile('slim.sym', self.SLIM_CONTENT)
338 self.fat = self.createSymbolFile('fat.sym', self.FAT_CONTENT)
339
340 self.warn_mock = self.PatchObject(logging, 'PrintBuildbotStepWarnings')
341
342 def _testNotStripped(self, symbol, size=None, content=None):
343 start_file = symbol.file_name
344 after = upload_symbols.AdjustSymbolFileSize(
345 symbol, self.working, size)
346 self.assertIs(after, symbol)
347 self.assertEqual(after.file_name, start_file)
348 if content is not None:
349 self.assertEqual(osutils.ReadFile(after.file_name), content)
350
351 def _testStripped(self, symbol, size=None, content=None):
352 after = upload_symbols.AdjustSymbolFileSize(
353 symbol, self.working, size)
354 self.assertIs(after, symbol)
355 self.assertTrue(after.file_name.startswith(self.working))
356 if content is not None:
357 self.assertEqual(osutils.ReadFile(after.file_name), content)
358
359 def testSmall(self):
360 """Ensure that files smaller than the limit are not modified."""
361 self._testNotStripped(self.slim, 1024, self.SLIM_CONTENT)
362 self._testNotStripped(self.fat, 1024, self.FAT_CONTENT)
363
364 def testLarge(self):
365 """Ensure that files larger than the limit are modified."""
366 self._testStripped(self.slim, 1, self.SLIM_CONTENT)
367 self._testStripped(self.fat, 1, self.SLIM_CONTENT)
368
369 def testMixed(self):
370 """Test mix of large and small."""
371 strip_size = len(self.SLIM_CONTENT) + 1
372
373 self._testNotStripped(self.slim, strip_size, self.SLIM_CONTENT)
374 self._testStripped(self.fat, strip_size, self.SLIM_CONTENT)
375
376 def testSizeWarnings(self):
377 large = self.createSymbolFile(
378 'large.sym', content=self.SLIM_CONTENT,
379 size=upload_symbols.CRASH_SERVER_FILE_LIMIT*2)
380
381 # Would like to Strip as part of this test, but that really copies all
382 # of the sparse file content, which is too expensive for a unittest.
383 self._testNotStripped(large, None, None)
384
385 self.assertEqual(self.warn_mock.call_count, 1)
386
387
388class DeduplicateTest(SymbolsTestBase):
389 """Test Isolate server Deduplication."""
390 def setUp(self):
391 self.connection_mock = self.isolate_mock.return_value
392 self.contains_mock = self.connection_mock.contains
393 self.push_mock = self.connection_mock.push
394
395 def testConnection(self):
396 result = upload_symbols.OpenDeduplicateConnection('namespace')
397 self.assertTrue(result is not None)
398 self.assertEqual(
399 self.isolate_mock.mock_calls,
400 [mock.call('https://isolateserver.appspot.com', 'namespace')])
401
402 def testConnectionFail(self):
403 self.isolate_mock.side_effect = Exception
404 result = upload_symbols.OpenDeduplicateConnection('namespace')
405 self.assertEqual(result, None)
406
407 def testFindDuplicates(self):
408 # The first symbol will new new, the second a duplicate.
409 def containsOneNew(items):
410 return {items[0]: 'state'}
411 self.contains_mock.side_effect = containsOneNew
412
413 sym1 = self.createSymbolFile('sym1.sym')
414 sym2 = self.createSymbolFile('sym2.sym')
415
416 result = upload_symbols.FindDuplicates((sym1, sym2), 'namespace')
417 self.assertEqual(list(result), [sym1, sym2])
418
419 self.assertEqual(sym1.status, upload_symbols.SymbolFile.INITIAL)
420 self.assertIsInstance(sym1.dedupe_item, upload_symbols.DedupeItem)
421 self.assertEqual(sym1.dedupe_push_state, 'state')
422
423 self.assertEqual(sym2.status, upload_symbols.SymbolFile.DUPLICATE)
424 self.assertIsNone(sym2.dedupe_item)
425 self.assertIsNone(sym2.dedupe_push_state)
426
427 def testFindDuplicatesConnectFail(self):
428 self.isolate_mock.side_effect = Exception
429
430 sym1 = self.createSymbolFile('sym1.sym')
431 sym2 = self.createSymbolFile('sym2.sym')
432
433 result = upload_symbols.FindDuplicates((sym1, sym2), 'namespace')
434 self.assertEqual(list(result), [sym1, sym2])
435
436 self.assertFalse(self.contains_mock.called)
437
438 self.assertEqual(sym1.status, upload_symbols.SymbolFile.INITIAL)
439 self.assertIsNone(sym1.dedupe_item)
440 self.assertIsNone(sym1.dedupe_push_state)
441
442 self.assertEqual(sym2.status, upload_symbols.SymbolFile.INITIAL)
443 self.assertIsNone(sym2.dedupe_item)
444 self.assertIsNone(sym2.dedupe_push_state)
445
446 def testFindDuplicatesContainsFail(self):
447 self.contains_mock.side_effect = Exception
448
449 sym1 = self.createSymbolFile('sym1.sym')
450 sym2 = self.createSymbolFile('sym2.sym')
451
452 result = upload_symbols.FindDuplicates((sym1, sym2), 'namespace')
453 self.assertEqual(list(result), [sym1, sym2])
454
455 self.assertEqual(sym1.status, upload_symbols.SymbolFile.INITIAL)
456 self.assertIsNone(sym1.dedupe_item)
457 self.assertIsNone(sym1.dedupe_push_state)
458
459 self.assertEqual(sym2.status, upload_symbols.SymbolFile.INITIAL)
460 self.assertIsNone(sym2.dedupe_item)
461 self.assertIsNone(sym2.dedupe_push_state)
462
463 def testPostForDeduplication(self):
464 symInitial = self.createSymbolFile(
465 'initial.sym')
466 symDup = self.createSymbolFile(
467 'dup.sym', status=upload_symbols.SymbolFile.DUPLICATE)
468 symUploaded = self.createSymbolFile(
469 'uploaded.sym', status=upload_symbols.SymbolFile.UPLOADED)
470
471 symInitialItem = self.createSymbolFile(
472 'initialItem.sym', dedupe=True)
473
474 symDupItem = self.createSymbolFile(
475 'dupItem.sym', status=upload_symbols.SymbolFile.DUPLICATE, dedupe=True)
476 # This is the only symbol file which should be pushed to isolate.
477 symUploadedItem = self.createSymbolFile(
478 'upItem.sym', status=upload_symbols.SymbolFile.UPLOADED, dedupe=True)
479
480 symbols = (symInitial, symDup, symUploaded,
481 symInitialItem, symDupItem, symUploadedItem)
482
483 result = upload_symbols.PostForDeduplication(symbols, 'namespace')
484 self.assertEqual(list(result), list(symbols))
485 self.assertEqual(
486 self.push_mock.mock_calls,
487 [
488 mock.call(
489 symUploadedItem.dedupe_item, 'push_state',
490 ["SymbolHeader(cpu='cpu', id='id', name='name', os='os')"])
491 ])
492
493 def testPostForDeduplicationConnectFail(self):
494 self.isolate_mock.side_effect = Exception
495
496 sym1 = self.createSymbolFile(
497 'sym1.sym', status=upload_symbols.SymbolFile.UPLOADED, dedupe=True)
498 sym2 = self.createSymbolFile(
499 'sym2.sym', status=upload_symbols.SymbolFile.UPLOADED, dedupe=True)
500
501 result = upload_symbols.PostForDeduplication((sym1, sym2), 'namespace')
502 self.assertEqual(list(result), [sym1, sym2])
503 self.assertEqual(self.push_mock.call_count, 0)
504
505 def testPostForDeduplicationPushFail(self):
506 self.push_mock.side_effect = Exception
507
508 sym1 = self.createSymbolFile(
509 'sym1.sym', status=upload_symbols.SymbolFile.UPLOADED, dedupe=True)
510 sym2 = self.createSymbolFile(
511 'sym2.sym', status=upload_symbols.SymbolFile.UPLOADED, dedupe=True)
512
513 result = upload_symbols.PostForDeduplication((sym1, sym2), 'namespace')
514 self.assertEqual(list(result), [sym1, sym2])
515 self.assertEqual(self.push_mock.call_count, 1)
516
517
Don Garrettdeb2e032016-07-06 16:44:14 -0700518class PerformSymbolFilesUploadTest(SymbolsTestBase):
Don Garretta28be6d2016-06-16 18:09:35 -0700519 """Test PerformSymbolFile, and it's helper methods."""
520 def setUp(self):
Don Garrettdeb2e032016-07-06 16:44:14 -0700521 self.sym_initial = self.createSymbolFile(
522 'initial.sym')
523 self.sym_error = self.createSymbolFile(
524 'error.sym', status=upload_symbols.SymbolFile.ERROR)
525 self.sym_duplicate = self.createSymbolFile(
526 'duplicate.sym', status=upload_symbols.SymbolFile.DUPLICATE)
527 self.sym_uploaded = self.createSymbolFile(
528 'uploaded.sym', status=upload_symbols.SymbolFile.UPLOADED)
Don Garretta28be6d2016-06-16 18:09:35 -0700529
530 def testGetUploadTimeout(self):
531 """Test GetUploadTimeout helper function."""
532 # Timeout for small file.
Don Garrettdeb2e032016-07-06 16:44:14 -0700533 self.assertEqual(upload_symbols.GetUploadTimeout(self.sym_initial),
Don Garretta28be6d2016-06-16 18:09:35 -0700534 upload_symbols.UPLOAD_MIN_TIMEOUT)
535
536 # Timeout for 300M file.
537 large = self.createSymbolFile('large.sym', size=(300 * 1024 * 1024))
Ryo Hashimotof864c0e2017-02-14 12:46:08 +0900538 self.assertEqual(upload_symbols.GetUploadTimeout(large), 771)
Don Garretta28be6d2016-06-16 18:09:35 -0700539
540 def testUploadSymbolFile(self):
Mike Nichols90f7c152019-04-09 15:14:08 -0600541 upload_symbols.UploadSymbolFile('fake_url', self.sym_initial,
542 api_key='testkey')
Don Garretta28be6d2016-06-16 18:09:35 -0700543 # TODO: Examine mock in more detail to make sure request is correct.
Mike Nichols90f7c152019-04-09 15:14:08 -0600544 self.assertEqual(self.request_mock.call_count, 3)
Don Garretta28be6d2016-06-16 18:09:35 -0700545
Don Garrettdeb2e032016-07-06 16:44:14 -0700546 def testPerformSymbolsFileUpload(self):
Don Garretta28be6d2016-06-16 18:09:35 -0700547 """We upload on first try."""
Don Garrettdeb2e032016-07-06 16:44:14 -0700548 symbols = [self.sym_initial]
Don Garretta28be6d2016-06-16 18:09:35 -0700549
Don Garrettdeb2e032016-07-06 16:44:14 -0700550 result = upload_symbols.PerformSymbolsFileUpload(
Mike Nichols90f7c152019-04-09 15:14:08 -0600551 symbols, 'fake_url', api_key='testkey')
Don Garrettdeb2e032016-07-06 16:44:14 -0700552
553 self.assertEqual(list(result), symbols)
554 self.assertEqual(self.sym_initial.status,
555 upload_symbols.SymbolFile.UPLOADED)
Mike Nichols90f7c152019-04-09 15:14:08 -0600556 self.assertEqual(self.request_mock.call_count, 3)
Don Garretta28be6d2016-06-16 18:09:35 -0700557
Don Garrettdeb2e032016-07-06 16:44:14 -0700558 def testPerformSymbolsFileUploadFailure(self):
Don Garretta28be6d2016-06-16 18:09:35 -0700559 """All network requests fail."""
Mike Nichols90f7c152019-04-09 15:14:08 -0600560 self.request_mock.side_effect = urllib2.URLError('network failure')
Don Garrettdeb2e032016-07-06 16:44:14 -0700561 symbols = [self.sym_initial]
Don Garretta28be6d2016-06-16 18:09:35 -0700562
Don Garrettdeb2e032016-07-06 16:44:14 -0700563 result = upload_symbols.PerformSymbolsFileUpload(
Mike Nichols90f7c152019-04-09 15:14:08 -0600564 symbols, 'fake_url', api_key='testkey')
Don Garretta28be6d2016-06-16 18:09:35 -0700565
Don Garrettdeb2e032016-07-06 16:44:14 -0700566 self.assertEqual(list(result), symbols)
567 self.assertEqual(self.sym_initial.status, upload_symbols.SymbolFile.ERROR)
Mike Nichols90f7c152019-04-09 15:14:08 -0600568 self.assertEqual(self.request_mock.call_count, 7)
Don Garretta28be6d2016-06-16 18:09:35 -0700569
Don Garrettdeb2e032016-07-06 16:44:14 -0700570 def testPerformSymbolsFileUploadTransisentFailure(self):
Don Garretta28be6d2016-06-16 18:09:35 -0700571 """We fail once, then succeed."""
572 self.urlopen_mock.side_effect = (urllib2.URLError('network failure'), None)
Don Garrettdeb2e032016-07-06 16:44:14 -0700573 symbols = [self.sym_initial]
Don Garretta28be6d2016-06-16 18:09:35 -0700574
Don Garrettdeb2e032016-07-06 16:44:14 -0700575 result = upload_symbols.PerformSymbolsFileUpload(
Mike Nichols90f7c152019-04-09 15:14:08 -0600576 symbols, 'fake_url', api_key='testkey')
Don Garretta28be6d2016-06-16 18:09:35 -0700577
Don Garrettdeb2e032016-07-06 16:44:14 -0700578 self.assertEqual(list(result), symbols)
579 self.assertEqual(self.sym_initial.status,
580 upload_symbols.SymbolFile.UPLOADED)
Mike Nichols90f7c152019-04-09 15:14:08 -0600581 self.assertEqual(self.request_mock.call_count, 3)
Don Garrettdeb2e032016-07-06 16:44:14 -0700582
583 def testPerformSymbolsFileUploadMixed(self):
584 """Upload symbols in mixed starting states.
585
586 Demonstrate that INITIAL and ERROR are uploaded, but DUPLICATE/UPLOADED are
587 ignored.
588 """
589 symbols = [self.sym_initial, self.sym_error,
590 self.sym_duplicate, self.sym_uploaded]
591
592 result = upload_symbols.PerformSymbolsFileUpload(
Mike Nichols90f7c152019-04-09 15:14:08 -0600593 symbols, 'fake_url', api_key='testkey')
Don Garrettdeb2e032016-07-06 16:44:14 -0700594
595 #
596 self.assertEqual(list(result), symbols)
597 self.assertEqual(self.sym_initial.status,
598 upload_symbols.SymbolFile.UPLOADED)
599 self.assertEqual(self.sym_error.status,
600 upload_symbols.SymbolFile.UPLOADED)
601 self.assertEqual(self.sym_duplicate.status,
602 upload_symbols.SymbolFile.DUPLICATE)
603 self.assertEqual(self.sym_uploaded.status,
604 upload_symbols.SymbolFile.UPLOADED)
Mike Nichols90f7c152019-04-09 15:14:08 -0600605 self.assertEqual(self.request_mock.call_count, 6)
Don Garrettdeb2e032016-07-06 16:44:14 -0700606
607
608 def testPerformSymbolsFileUploadErrorOut(self):
609 """Demonstate we exit only after X errors."""
610
611 symbol_count = upload_symbols.MAX_TOTAL_ERRORS_FOR_RETRY + 10
612 symbols = []
613 fail_file = None
614
615 # potentially twice as many errors as we should attempt.
616 for _ in xrange(symbol_count):
617 # Each loop will get unique SymbolFile instances that use the same files.
618 fail = self.createSymbolFile('fail.sym')
619 fail_file = fail.file_name
620 symbols.append(self.createSymbolFile('pass.sym'))
621 symbols.append(fail)
622
623 # Mock out UploadSymbolFile and fail for fail.sym files.
Mike Nichols90f7c152019-04-09 15:14:08 -0600624 def failSome(_url, symbol, _api_key):
Don Garrettdeb2e032016-07-06 16:44:14 -0700625 if symbol.file_name == fail_file:
626 raise urllib2.URLError('network failure')
627
Luigi Semenzato5104f3c2016-10-12 12:37:42 -0700628 upload_mock = self.PatchObject(upload_symbols, 'UploadSymbolFile',
629 side_effect=failSome)
630 upload_mock.__name__ = 'UploadSymbolFileMock2'
Don Garrettdeb2e032016-07-06 16:44:14 -0700631
632 result = upload_symbols.PerformSymbolsFileUpload(
Mike Nichols90f7c152019-04-09 15:14:08 -0600633 symbols, 'fake_url', api_key='testkey')
Don Garrettdeb2e032016-07-06 16:44:14 -0700634
635 self.assertEqual(list(result), symbols)
636
637 passed = sum(s.status == upload_symbols.SymbolFile.UPLOADED
638 for s in symbols)
639 failed = sum(s.status == upload_symbols.SymbolFile.ERROR
640 for s in symbols)
641 skipped = sum(s.status == upload_symbols.SymbolFile.INITIAL
642 for s in symbols)
643
644 # Shows we all pass.sym files worked until limit hit.
645 self.assertEqual(passed, upload_symbols.MAX_TOTAL_ERRORS_FOR_RETRY)
646
647 # Shows we all fail.sym files failed until limit hit.
648 self.assertEqual(failed, upload_symbols.MAX_TOTAL_ERRORS_FOR_RETRY)
649
650 # Shows both pass/fail were skipped after limit hit.
651 self.assertEqual(skipped, 10 * 2)
Don Garretta28be6d2016-06-16 18:09:35 -0700652
653
654class UploadSymbolsTest(SymbolsTestBase):
655 """Test UploadSymbols, along with most helper methods."""
656 def setUp(self):
657 # Results gathering.
658 self.failure_file = os.path.join(self.tempdir, 'failures.txt')
659
660 def testUploadSymbolsEmpty(self):
661 """Upload dir is empty."""
662 result = upload_symbols.UploadSymbols(
663 [self.data], 'fake_url', 'product')
664
665 self.assertEquals(result, 0)
666 self.assertEqual(self.urlopen_mock.call_count, 0)
667
668 def testUploadSymbols(self):
669 """Upload a few files."""
670 self.createSymbolFile('slim.sym', self.SLIM_CONTENT)
671 self.createSymbolFile(os.path.join('nested', 'inner.sym'))
672 self.createSymbolFile('fat.sym', self.FAT_CONTENT)
673
674 result = upload_symbols.UploadSymbols(
Mike Nichols90f7c152019-04-09 15:14:08 -0600675 [self.data], 'fake_url',
676 failed_list=self.failure_file, strip_cfi=len(self.SLIM_CONTENT)+1,
677 api_key='testkey')
Don Garretta28be6d2016-06-16 18:09:35 -0700678
679 self.assertEquals(result, 0)
Mike Nichols90f7c152019-04-09 15:14:08 -0600680 self.assertEqual(self.request_mock.call_count, 9)
Don Garretta28be6d2016-06-16 18:09:35 -0700681 self.assertEquals(osutils.ReadFile(self.failure_file), '')
682
683 def testUploadSymbolsLimited(self):
684 """Upload a few files."""
685 self.createSymbolFile('slim.sym', self.SLIM_CONTENT)
686 self.createSymbolFile(os.path.join('nested', 'inner.sym'))
687 self.createSymbolFile('fat.sym', self.FAT_CONTENT)
688
689 result = upload_symbols.UploadSymbols(
Mike Nichols90f7c152019-04-09 15:14:08 -0600690 [self.data], 'fake_url', upload_limit=2,
691 api_key='testkey')
Don Garretta28be6d2016-06-16 18:09:35 -0700692
693 self.assertEquals(result, 0)
Mike Nichols90f7c152019-04-09 15:14:08 -0600694 self.assertEqual(self.request_mock.call_count, 6)
Mike Frysingerf2fa7d62017-12-14 18:33:59 -0500695 self.assertNotExists(self.failure_file)
Don Garretta28be6d2016-06-16 18:09:35 -0700696
697 def testUploadSymbolsFailures(self):
698 """Upload a few files."""
699 self.createSymbolFile('pass.sym')
700 fail = self.createSymbolFile('fail.sym')
701
Mike Nichols90f7c152019-04-09 15:14:08 -0600702 def failSome(_url, symbol, _api_key):
Don Garretta28be6d2016-06-16 18:09:35 -0700703 if symbol.file_name == fail.file_name:
704 raise urllib2.URLError('network failure')
705
706 # Mock out UploadSymbolFile so it's easy to see which file to fail for.
707 upload_mock = self.PatchObject(upload_symbols, 'UploadSymbolFile',
708 side_effect=failSome)
Luigi Semenzato5104f3c2016-10-12 12:37:42 -0700709 # Mock __name__ for logging.
710 upload_mock.__name__ = 'UploadSymbolFileMock'
Don Garretta28be6d2016-06-16 18:09:35 -0700711
712 result = upload_symbols.UploadSymbols(
Mike Nichols90f7c152019-04-09 15:14:08 -0600713 [self.data], 'fake_url',
714 failed_list=self.failure_file, api_key='testkey')
Don Garretta28be6d2016-06-16 18:09:35 -0700715
716 self.assertEquals(result, 1)
717 self.assertEqual(upload_mock.call_count, 8)
718 self.assertEquals(osutils.ReadFile(self.failure_file), 'fail.sym\n')
719
Don Garretta28be6d2016-06-16 18:09:35 -0700720# TODO: We removed --network integration tests.
Mike Frysinger0c0efa22014-02-09 23:32:23 -0500721
722
Mike Frysingerea838d12014-12-08 11:55:32 -0500723def main(_argv):
Mike Frysinger27e21b72018-07-12 14:20:21 -0400724 # pylint: disable=protected-access
Mike Frysingerd5fcb3a2013-05-30 21:10:50 -0400725 # Set timeouts small so that if the unit test hangs, it won't hang for long.
726 parallel._BackgroundTask.STARTUP_TIMEOUT = 5
727 parallel._BackgroundTask.EXIT_TIMEOUT = 5
728
Mike Frysingerd5fcb3a2013-05-30 21:10:50 -0400729 # Run the tests.
Mike Frysingerba167372015-01-21 10:37:03 -0500730 cros_test_lib.main(level='info', module=__name__)