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
|
# 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.
"""Additional tests for Flag classes.
Most of the Flag classes are covered in the flags_test.py.
"""
import copy
import enum
import pickle
from absl.flags import _argument_parser
from absl.flags import _exceptions
from absl.flags import _flag
from absl.testing import absltest
from absl.testing import parameterized
class FlagTest(absltest.TestCase):
def setUp(self):
super().setUp()
self.flag = _flag.Flag(
_argument_parser.ArgumentParser(),
_argument_parser.ArgumentSerializer(),
'fruit', 'apple', 'help')
def test_default_unparsed(self):
flag = _flag.Flag(
_argument_parser.ArgumentParser(),
_argument_parser.ArgumentSerializer(),
'fruit', 'apple', 'help')
self.assertEqual('apple', flag.default_unparsed)
flag = _flag.Flag(
_argument_parser.IntegerParser(),
_argument_parser.ArgumentSerializer(),
'number', '1', 'help')
self.assertEqual('1', flag.default_unparsed)
flag = _flag.Flag(
_argument_parser.IntegerParser(),
_argument_parser.ArgumentSerializer(),
'number', 1, 'help')
self.assertEqual(1, flag.default_unparsed)
def test_no_truthiness(self):
with self.assertRaises(TypeError):
if self.flag:
self.fail('Flag instances must raise rather than be truthy.')
def test_set_default_overrides_current_value(self):
self.assertEqual('apple', self.flag.value)
self.flag._set_default('orange')
self.assertEqual('orange', self.flag.value)
def test_set_default_overrides_current_value_when_not_using_default(self):
self.flag.using_default_value = False
self.assertEqual('apple', self.flag.value)
self.flag._set_default('orange')
self.assertEqual('apple', self.flag.value)
def test_pickle(self):
with self.assertRaisesRegex(TypeError, "can't pickle Flag objects"):
pickle.dumps(self.flag)
def test_copy(self):
self.flag.value = 'orange'
with self.assertRaisesRegex(TypeError,
'Flag does not support shallow copies'):
copy.copy(self.flag)
flag2 = copy.deepcopy(self.flag)
self.assertEqual(flag2.value, 'orange')
flag2.value = 'mango'
self.assertEqual(flag2.value, 'mango')
self.assertEqual(self.flag.value, 'orange')
class BooleanFlagTest(parameterized.TestCase):
@parameterized.parameters(('', '(no help available)'),
('Is my test brilliant?', 'Is my test brilliant?'))
def test_help_text(self, helptext_input, helptext_output):
f = _flag.BooleanFlag('a_bool', False, helptext_input)
self.assertEqual(helptext_output, f.help)
class EnumFlagTest(parameterized.TestCase):
@parameterized.parameters(
('', '<apple|orange>: (no help available)'),
('Type of fruit.', '<apple|orange>: Type of fruit.'))
def test_help_text(self, helptext_input, helptext_output):
f = _flag.EnumFlag('fruit', 'apple', helptext_input, ['apple', 'orange'])
self.assertEqual(helptext_output, f.help)
def test_empty_values(self):
with self.assertRaises(ValueError):
_flag.EnumFlag('fruit', None, 'help', [])
class Fruit(enum.Enum):
APPLE = 1
ORANGE = 2
class EmptyEnum(enum.Enum):
pass
class EnumClassFlagTest(parameterized.TestCase):
@parameterized.parameters(
('', '<apple|orange>: (no help available)'),
('Type of fruit.', '<apple|orange>: Type of fruit.'))
def test_help_text_case_insensitive(self, helptext_input, helptext_output):
f = _flag.EnumClassFlag('fruit', None, helptext_input, Fruit)
self.assertEqual(helptext_output, f.help)
@parameterized.parameters(
('', '<APPLE|ORANGE>: (no help available)'),
('Type of fruit.', '<APPLE|ORANGE>: Type of fruit.'))
def test_help_text_case_sensitive(self, helptext_input, helptext_output):
f = _flag.EnumClassFlag(
'fruit', None, helptext_input, Fruit, case_sensitive=True)
self.assertEqual(helptext_output, f.help)
def test_requires_enum(self):
with self.assertRaises(TypeError):
_flag.EnumClassFlag('fruit', None, 'help', ['apple', 'orange']) # type: ignore
def test_requires_non_empty_enum_class(self):
with self.assertRaises(ValueError):
_flag.EnumClassFlag('empty', None, 'help', EmptyEnum)
def test_accepts_literal_default(self):
f = _flag.EnumClassFlag('fruit', Fruit.APPLE, 'A sample enum flag.', Fruit)
self.assertEqual(Fruit.APPLE, f.value)
def test_accepts_string_default(self):
f = _flag.EnumClassFlag('fruit', 'ORANGE', 'A sample enum flag.', Fruit)
self.assertEqual(Fruit.ORANGE, f.value)
def test_case_sensitive_rejects_default_with_wrong_case(self):
with self.assertRaises(_exceptions.IllegalFlagValueError):
_flag.EnumClassFlag(
'fruit', 'oranGe', 'A sample enum flag.', Fruit, case_sensitive=True)
def test_case_insensitive_accepts_string_default(self):
f = _flag.EnumClassFlag(
'fruit', 'oranGe', 'A sample enum flag.', Fruit, case_sensitive=False)
self.assertEqual(Fruit.ORANGE, f.value)
def test_default_value_does_not_exist(self):
with self.assertRaises(_exceptions.IllegalFlagValueError):
_flag.EnumClassFlag('fruit', 'BANANA', 'help', Fruit)
class MultiEnumClassFlagTest(parameterized.TestCase):
@parameterized.named_parameters(
('NoHelpSupplied', '', '<apple|orange>: (no help available);\n ' +
'repeat this option to specify a list of values', False),
('WithHelpSupplied', 'Type of fruit.',
'<APPLE|ORANGE>: Type of fruit.;\n ' +
'repeat this option to specify a list of values', True))
def test_help_text(self, helptext_input, helptext_output, case_sensitive):
f = _flag.MultiEnumClassFlag(
'fruit', None, helptext_input, Fruit, case_sensitive=case_sensitive)
self.assertEqual(helptext_output, f.help)
def test_requires_enum(self):
with self.assertRaises(TypeError):
_flag.MultiEnumClassFlag('fruit', None, 'help', ['apple', 'orange']) # type: ignore
def test_requires_non_empty_enum_class(self):
with self.assertRaises(ValueError):
_flag.MultiEnumClassFlag('empty', None, 'help', EmptyEnum)
def test_rejects_wrong_case_when_case_sensitive(self):
with self.assertRaisesRegex(_exceptions.IllegalFlagValueError,
'<APPLE|ORANGE>'):
_flag.MultiEnumClassFlag(
'fruit', ['APPLE', 'Orange'],
'A sample enum flag.',
Fruit,
case_sensitive=True)
def test_accepts_case_insensitive(self):
f = _flag.MultiEnumClassFlag('fruit', ['apple', 'APPLE'],
'A sample enum flag.', Fruit)
self.assertListEqual([Fruit.APPLE, Fruit.APPLE], f.value)
def test_accepts_literal_default(self):
f = _flag.MultiEnumClassFlag('fruit', Fruit.APPLE, 'A sample enum flag.',
Fruit)
self.assertListEqual([Fruit.APPLE], f.value)
def test_accepts_list_of_literal_default(self):
f = _flag.MultiEnumClassFlag('fruit', [Fruit.APPLE, Fruit.ORANGE],
'A sample enum flag.', Fruit)
self.assertListEqual([Fruit.APPLE, Fruit.ORANGE], f.value)
def test_accepts_string_default(self):
f = _flag.MultiEnumClassFlag('fruit', 'ORANGE', 'A sample enum flag.',
Fruit)
self.assertListEqual([Fruit.ORANGE], f.value)
def test_accepts_list_of_string_default(self):
f = _flag.MultiEnumClassFlag('fruit', ['ORANGE', 'APPLE'],
'A sample enum flag.', Fruit)
self.assertListEqual([Fruit.ORANGE, Fruit.APPLE], f.value)
def test_default_value_does_not_exist(self):
with self.assertRaisesRegex(_exceptions.IllegalFlagValueError,
'<apple|banana>'):
_flag.MultiEnumClassFlag('fruit', 'BANANA', 'help', Fruit)
if __name__ == '__main__':
absltest.main()
|
