Oleh Prypin | 69c0222 | 2018-05-23 15:18:12 +0200 | [diff] [blame] | 1 | #!/usr/bin/env python |
| 2 | |
| 3 | # Copyright (c) 2018 The WebRTC project authors. All Rights Reserved. |
| 4 | # |
| 5 | # Use of this source code is governed by a BSD-style license |
| 6 | # that can be found in the LICENSE file in the root of the source |
| 7 | # tree. An additional intellectual property rights grant can be found |
| 8 | # in the file PATENTS. All contributing project authors may |
| 9 | # be found in the AUTHORS file in the root of the source tree. |
| 10 | |
Mirko Bonadei | dac422f | 2018-06-05 09:12:34 +0200 | [diff] [blame] | 11 | from contextlib import contextmanager |
| 12 | |
Yves Gerey | ea766fa | 2018-09-25 15:34:27 +0200 | [diff] [blame] | 13 | import multiprocessing |
Mirko Bonadei | dac422f | 2018-06-05 09:12:34 +0200 | [diff] [blame] | 14 | import os |
| 15 | import tempfile |
Oleh Prypin | 69c0222 | 2018-05-23 15:18:12 +0200 | [diff] [blame] | 16 | import unittest |
| 17 | |
Yves Gerey | ea766fa | 2018-09-25 15:34:27 +0200 | [diff] [blame] | 18 | # pylint: disable=invalid-name |
| 19 | gtest_parallel_wrapper = __import__('gtest-parallel-wrapper') |
Oleh Prypin | 69c0222 | 2018-05-23 15:18:12 +0200 | [diff] [blame] | 20 | |
| 21 | |
Mirko Bonadei | dac422f | 2018-06-05 09:12:34 +0200 | [diff] [blame] | 22 | @contextmanager |
| 23 | def TemporaryDirectory(): |
| 24 | tmp_dir = tempfile.mkdtemp() |
| 25 | yield tmp_dir |
| 26 | os.rmdir(tmp_dir) |
| 27 | |
| 28 | |
Yves Gerey | ea766fa | 2018-09-25 15:34:27 +0200 | [diff] [blame] | 29 | class GtestParallelWrapperHelpersTest(unittest.TestCase): |
| 30 | |
| 31 | def testGetWorkersAsIs(self): |
| 32 | # pylint: disable=protected-access |
| 33 | self.assertEqual(gtest_parallel_wrapper._ParseWorkersOption('12'), 12) |
| 34 | |
| 35 | def testGetTwiceWorkers(self): |
| 36 | expected = 2 * multiprocessing.cpu_count() |
| 37 | # pylint: disable=protected-access |
| 38 | self.assertEqual(gtest_parallel_wrapper._ParseWorkersOption('2x'), expected) |
| 39 | |
| 40 | def testGetHalfWorkers(self): |
| 41 | expected = max(multiprocessing.cpu_count() // 2, 1) |
| 42 | # pylint: disable=protected-access |
| 43 | self.assertEqual( |
| 44 | gtest_parallel_wrapper._ParseWorkersOption('0.5x'), expected) |
| 45 | |
| 46 | |
Oleh Prypin | 69c0222 | 2018-05-23 15:18:12 +0200 | [diff] [blame] | 47 | class GtestParallelWrapperTest(unittest.TestCase): |
Yves Gerey | ea766fa | 2018-09-25 15:34:27 +0200 | [diff] [blame] | 48 | |
Oleh Prypin | 69c0222 | 2018-05-23 15:18:12 +0200 | [diff] [blame] | 49 | @classmethod |
| 50 | def _Expected(cls, gtest_parallel_args): |
| 51 | return ['--shard_index=0', '--shard_count=1'] + gtest_parallel_args |
| 52 | |
| 53 | def testOverwrite(self): |
Yves Gerey | ea766fa | 2018-09-25 15:34:27 +0200 | [diff] [blame] | 54 | result = gtest_parallel_wrapper.ParseArgs( |
| 55 | ['--timeout=123', 'exec', '--timeout', '124']) |
Oleh Prypin | 69c0222 | 2018-05-23 15:18:12 +0200 | [diff] [blame] | 56 | expected = self._Expected(['--timeout=124', 'exec']) |
| 57 | self.assertEqual(result.gtest_parallel_args, expected) |
| 58 | |
| 59 | def testMixing(self): |
Yves Gerey | ea766fa | 2018-09-25 15:34:27 +0200 | [diff] [blame] | 60 | result = gtest_parallel_wrapper.ParseArgs( |
Oleh Prypin | 69c0222 | 2018-05-23 15:18:12 +0200 | [diff] [blame] | 61 | ['--timeout=123', '--param1', 'exec', '--param2', '--timeout', '124']) |
| 62 | expected = self._Expected( |
| 63 | ['--timeout=124', 'exec', '--', '--param1', '--param2']) |
| 64 | self.assertEqual(result.gtest_parallel_args, expected) |
| 65 | |
| 66 | def testMixingPositional(self): |
Yves Gerey | ea766fa | 2018-09-25 15:34:27 +0200 | [diff] [blame] | 67 | result = gtest_parallel_wrapper.ParseArgs([ |
| 68 | '--timeout=123', 'exec', '--foo1', 'bar1', '--timeout', '124', '--foo2', |
| 69 | 'bar2' |
| 70 | ]) |
| 71 | expected = self._Expected( |
| 72 | ['--timeout=124', 'exec', '--', '--foo1', 'bar1', '--foo2', 'bar2']) |
Oleh Prypin | 69c0222 | 2018-05-23 15:18:12 +0200 | [diff] [blame] | 73 | self.assertEqual(result.gtest_parallel_args, expected) |
| 74 | |
| 75 | def testDoubleDash1(self): |
Yves Gerey | ea766fa | 2018-09-25 15:34:27 +0200 | [diff] [blame] | 76 | result = gtest_parallel_wrapper.ParseArgs( |
Oleh Prypin | 69c0222 | 2018-05-23 15:18:12 +0200 | [diff] [blame] | 77 | ['--timeout', '123', 'exec', '--', '--timeout', '124']) |
| 78 | expected = self._Expected( |
| 79 | ['--timeout=123', 'exec', '--', '--timeout', '124']) |
| 80 | self.assertEqual(result.gtest_parallel_args, expected) |
| 81 | |
| 82 | def testDoubleDash2(self): |
Yves Gerey | ea766fa | 2018-09-25 15:34:27 +0200 | [diff] [blame] | 83 | result = gtest_parallel_wrapper.ParseArgs( |
| 84 | ['--timeout=123', '--', 'exec', '--timeout=124']) |
Oleh Prypin | 69c0222 | 2018-05-23 15:18:12 +0200 | [diff] [blame] | 85 | expected = self._Expected(['--timeout=123', 'exec', '--', '--timeout=124']) |
| 86 | self.assertEqual(result.gtest_parallel_args, expected) |
| 87 | |
| 88 | def testArtifacts(self): |
Mirko Bonadei | dac422f | 2018-06-05 09:12:34 +0200 | [diff] [blame] | 89 | with TemporaryDirectory() as tmp_dir: |
| 90 | output_dir = os.path.join(tmp_dir, 'foo') |
Yves Gerey | ea766fa | 2018-09-25 15:34:27 +0200 | [diff] [blame] | 91 | result = gtest_parallel_wrapper.ParseArgs( |
| 92 | ['exec', '--store-test-artifacts', '--output_dir', output_dir]) |
Mirko Bonadei | dac422f | 2018-06-05 09:12:34 +0200 | [diff] [blame] | 93 | exp_artifacts_dir = os.path.join(output_dir, 'test_artifacts') |
Yves Gerey | ea766fa | 2018-09-25 15:34:27 +0200 | [diff] [blame] | 94 | exp = self._Expected([ |
| 95 | '--output_dir=' + output_dir, 'exec', '--', |
| 96 | '--test_artifacts_dir=' + exp_artifacts_dir |
| 97 | ]) |
Mirko Bonadei | dac422f | 2018-06-05 09:12:34 +0200 | [diff] [blame] | 98 | self.assertEqual(result.gtest_parallel_args, exp) |
| 99 | self.assertEqual(result.output_dir, output_dir) |
Mirko Bonadei | 40f876d | 2018-08-27 16:32:50 +0200 | [diff] [blame] | 100 | self.assertEqual(result.test_artifacts_dir, exp_artifacts_dir) |
Oleh Prypin | 69c0222 | 2018-05-23 15:18:12 +0200 | [diff] [blame] | 101 | |
| 102 | def testNoDirsSpecified(self): |
Yves Gerey | ea766fa | 2018-09-25 15:34:27 +0200 | [diff] [blame] | 103 | result = gtest_parallel_wrapper.ParseArgs(['exec']) |
Oleh Prypin | 69c0222 | 2018-05-23 15:18:12 +0200 | [diff] [blame] | 104 | self.assertEqual(result.output_dir, None) |
| 105 | self.assertEqual(result.test_artifacts_dir, None) |
| 106 | |
| 107 | def testOutputDirSpecified(self): |
Yves Gerey | ea766fa | 2018-09-25 15:34:27 +0200 | [diff] [blame] | 108 | result = gtest_parallel_wrapper.ParseArgs( |
| 109 | ['exec', '--output_dir', '/tmp/foo']) |
Oleh Prypin | 69c0222 | 2018-05-23 15:18:12 +0200 | [diff] [blame] | 110 | self.assertEqual(result.output_dir, '/tmp/foo') |
| 111 | self.assertEqual(result.test_artifacts_dir, None) |
| 112 | |
Oleh Prypin | 69c0222 | 2018-05-23 15:18:12 +0200 | [diff] [blame] | 113 | def testShortArg(self): |
Yves Gerey | ea766fa | 2018-09-25 15:34:27 +0200 | [diff] [blame] | 114 | result = gtest_parallel_wrapper.ParseArgs(['-d', '/tmp/foo', 'exec']) |
Oleh Prypin | 69c0222 | 2018-05-23 15:18:12 +0200 | [diff] [blame] | 115 | expected = self._Expected(['--output_dir=/tmp/foo', 'exec']) |
| 116 | self.assertEqual(result.gtest_parallel_args, expected) |
| 117 | self.assertEqual(result.output_dir, '/tmp/foo') |
| 118 | |
| 119 | def testBoolArg(self): |
Yves Gerey | ea766fa | 2018-09-25 15:34:27 +0200 | [diff] [blame] | 120 | result = gtest_parallel_wrapper.ParseArgs( |
| 121 | ['--gtest_also_run_disabled_tests', 'exec']) |
Oleh Prypin | 69c0222 | 2018-05-23 15:18:12 +0200 | [diff] [blame] | 122 | expected = self._Expected(['--gtest_also_run_disabled_tests', 'exec']) |
| 123 | self.assertEqual(result.gtest_parallel_args, expected) |
| 124 | |
| 125 | def testNoArgs(self): |
Yves Gerey | ea766fa | 2018-09-25 15:34:27 +0200 | [diff] [blame] | 126 | result = gtest_parallel_wrapper.ParseArgs(['exec']) |
Oleh Prypin | 69c0222 | 2018-05-23 15:18:12 +0200 | [diff] [blame] | 127 | expected = self._Expected(['exec']) |
| 128 | self.assertEqual(result.gtest_parallel_args, expected) |
| 129 | |
| 130 | def testDocExample(self): |
Mirko Bonadei | dac422f | 2018-06-05 09:12:34 +0200 | [diff] [blame] | 131 | with TemporaryDirectory() as tmp_dir: |
| 132 | output_dir = os.path.join(tmp_dir, 'foo') |
Yves Gerey | ea766fa | 2018-09-25 15:34:27 +0200 | [diff] [blame] | 133 | result = gtest_parallel_wrapper.ParseArgs([ |
Mirko Bonadei | dac422f | 2018-06-05 09:12:34 +0200 | [diff] [blame] | 134 | 'some_test', '--some_flag=some_value', '--another_flag', |
| 135 | '--output_dir=' + output_dir, '--store-test-artifacts', |
Patrik Höglund | 28b8a0b | 2020-03-26 20:30:50 +0100 | [diff] [blame] | 136 | '--isolated-script-test-perf-output=SOME_OTHER_DIR', '--foo=bar', |
Yves Gerey | ea766fa | 2018-09-25 15:34:27 +0200 | [diff] [blame] | 137 | '--baz' |
| 138 | ]) |
Mirko Bonadei | dac422f | 2018-06-05 09:12:34 +0200 | [diff] [blame] | 139 | expected_artifacts_dir = os.path.join(output_dir, 'test_artifacts') |
| 140 | expected = self._Expected([ |
Patrik Höglund | 1b20c41 | 2020-03-25 08:58:51 +0100 | [diff] [blame] | 141 | '--output_dir=' + output_dir, |
Yves Gerey | ea766fa | 2018-09-25 15:34:27 +0200 | [diff] [blame] | 142 | 'some_test', '--', '--test_artifacts_dir=' + expected_artifacts_dir, |
Mirko Bonadei | dac422f | 2018-06-05 09:12:34 +0200 | [diff] [blame] | 143 | '--some_flag=some_value', '--another_flag', |
Mirko Bonadei | 2ab97f6 | 2019-07-18 13:44:12 +0200 | [diff] [blame] | 144 | '--isolated_script_test_perf_output=SOME_OTHER_DIR', '--foo=bar', |
Yves Gerey | ea766fa | 2018-09-25 15:34:27 +0200 | [diff] [blame] | 145 | '--baz' |
| 146 | ]) |
Mirko Bonadei | dac422f | 2018-06-05 09:12:34 +0200 | [diff] [blame] | 147 | self.assertEqual(result.gtest_parallel_args, expected) |
Oleh Prypin | 69c0222 | 2018-05-23 15:18:12 +0200 | [diff] [blame] | 148 | |
Yves Gerey | ea766fa | 2018-09-25 15:34:27 +0200 | [diff] [blame] | 149 | def testStandardWorkers(self): |
| 150 | """Check integer value is passed as-is.""" |
| 151 | result = gtest_parallel_wrapper.ParseArgs(['--workers', '17', 'exec']) |
| 152 | expected = self._Expected(['--workers=17', 'exec']) |
| 153 | self.assertEqual(result.gtest_parallel_args, expected) |
| 154 | |
| 155 | def testTwoWorkersPerCpuCore(self): |
| 156 | result = gtest_parallel_wrapper.ParseArgs(['--workers', '2x', 'exec']) |
| 157 | workers = 2 * multiprocessing.cpu_count() |
| 158 | expected = self._Expected(['--workers=%s' % workers, 'exec']) |
| 159 | self.assertEqual(result.gtest_parallel_args, expected) |
| 160 | |
| 161 | def testUseHalfTheCpuCores(self): |
| 162 | result = gtest_parallel_wrapper.ParseArgs(['--workers', '0.5x', 'exec']) |
| 163 | workers = max(multiprocessing.cpu_count() // 2, 1) |
| 164 | expected = self._Expected(['--workers=%s' % workers, 'exec']) |
| 165 | self.assertEqual(result.gtest_parallel_args, expected) |
| 166 | |
Oleh Prypin | 69c0222 | 2018-05-23 15:18:12 +0200 | [diff] [blame] | 167 | |
| 168 | if __name__ == '__main__': |
| 169 | unittest.main() |