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
|
# Copyright 2017 The Abseil Authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Tests for test sharding protocol."""
import os
import subprocess
import sys
from absl.testing import _bazelize_command
from absl.testing import absltest
from absl.testing import parameterized
from absl.testing.tests import absltest_env
NUM_TEST_METHODS = 8 # Hard-coded, based on absltest_sharding_test_helper.py
class TestShardingTest(parameterized.TestCase):
"""Integration tests: Runs a test binary with sharding.
This is done by setting the sharding environment variables.
"""
def setUp(self):
super().setUp()
self._shard_file = None
def tearDown(self):
super().tearDown()
if self._shard_file is not None and os.path.exists(self._shard_file):
os.unlink(self._shard_file)
def _run_sharded(
self,
total_shards,
shard_index,
shard_file=None,
additional_env=None,
helper_name='absltest_sharding_test_helper',
):
"""Runs the py_test binary in a subprocess.
Args:
total_shards: int, the total number of shards.
shard_index: int, the shard index.
shard_file: string, if not 'None', the path to the shard file. This method
asserts it is properly created.
additional_env: Additional environment variables to be set for the py_test
binary.
helper_name: The name of the helper binary.
Returns:
(stdout, exit_code) tuple of (string, int).
"""
env = absltest_env.inherited_env()
if additional_env:
env.update(additional_env)
env.update({
'TEST_TOTAL_SHARDS': str(total_shards),
'TEST_SHARD_INDEX': str(shard_index)
})
if shard_file:
self._shard_file = shard_file
env['TEST_SHARD_STATUS_FILE'] = shard_file
if os.path.exists(shard_file):
os.unlink(shard_file)
helper = 'absl/testing/tests/' + helper_name
proc = subprocess.Popen(
args=[_bazelize_command.get_executable_path(helper)],
env=env,
stdout=subprocess.PIPE,
stderr=subprocess.STDOUT,
universal_newlines=True,
)
stdout = proc.communicate()[0]
if shard_file:
self.assertTrue(os.path.exists(shard_file))
return (stdout, proc.wait())
def _assert_sharding_correctness(self, total_shards):
"""Assert the primary correctness and performance of sharding.
1. Completeness (all methods are run)
2. Partition (each method run at most once)
3. Balance (for performance)
Args:
total_shards: int, total number of shards.
"""
outerr_by_shard = [] # A list of lists of strings
combined_outerr = [] # A list of strings
exit_code_by_shard = [] # A list of ints
for i in range(total_shards):
(out, exit_code) = self._run_sharded(total_shards, i)
method_list = [x for x in out.split('\n') if x.startswith('class')]
outerr_by_shard.append(method_list)
combined_outerr.extend(method_list)
exit_code_by_shard.append(exit_code)
self.assertLen([x for x in exit_code_by_shard if x != 0], 1,
'Expected exactly one failure')
# Test completeness and partition properties.
self.assertLen(combined_outerr, NUM_TEST_METHODS,
'Partition requirement not met')
self.assertLen(set(combined_outerr), NUM_TEST_METHODS,
'Completeness requirement not met')
# Test balance:
for i in range(len(outerr_by_shard)):
self.assertGreaterEqual(len(outerr_by_shard[i]),
(NUM_TEST_METHODS / total_shards) - 1,
'Shard %d of %d out of balance' %
(i, len(outerr_by_shard)))
def test_shard_file(self):
self._run_sharded(3, 1, os.path.join(
absltest.TEST_TMPDIR.value, 'shard_file'))
def test_zero_shards(self):
out, exit_code = self._run_sharded(0, 0)
self.assertEqual(1, exit_code)
self.assertGreaterEqual(out.find('Bad sharding values. index=0, total=0'),
0, 'Bad output: %s' % (out))
def test_with_four_shards(self):
self._assert_sharding_correctness(4)
def test_with_one_shard(self):
self._assert_sharding_correctness(1)
def test_with_ten_shards(self):
shards = 10
# This test relies on the shard count to be greater than the number of
# tests, to ensure that the non-zero shards won't fail even if no tests ran
# on Python 3.12+.
self.assertGreater(shards, NUM_TEST_METHODS)
self._assert_sharding_correctness(shards)
def test_sharding_with_randomization(self):
# If we're both sharding *and* randomizing, we need to confirm that we
# randomize within the shard; we use two seeds to confirm we're seeing the
# same tests (sharding is consistent) in a different order.
tests_seen = []
for seed in ('7', '17'):
out, exit_code = self._run_sharded(
2, 0, additional_env={'TEST_RANDOMIZE_ORDERING_SEED': seed})
self.assertEqual(0, exit_code)
tests_seen.append([x for x in out.splitlines() if x.startswith('class')])
first_tests, second_tests = tests_seen # pylint: disable=unbalanced-tuple-unpacking
self.assertEqual(set(first_tests), set(second_tests))
self.assertNotEqual(first_tests, second_tests)
@parameterized.named_parameters(
('total_1_index_0', 1, 0, None),
('total_2_index_0', 2, 0, None),
# The 2nd shard (index=1) should not fail.
('total_2_index_1', 2, 1, 0),
)
def test_no_tests_ran(
self, total_shards, shard_index, override_expected_exit_code
):
if override_expected_exit_code is not None:
expected_exit_code = override_expected_exit_code
elif sys.version_info[:2] >= (3, 12):
expected_exit_code = 5
else:
expected_exit_code = 0
out, exit_code = self._run_sharded(
total_shards,
shard_index,
helper_name='absltest_sharding_test_helper_no_tests',
)
self.assertEqual(
expected_exit_code,
exit_code,
'Unexpected exit code, output:\n{}'.format(out),
)
if __name__ == '__main__':
absltest.main()
|
