File: test_userdata.py

package info (click to toggle)
behave 1.2.6-6
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 4,160 kB
  • sloc: python: 19,857; makefile: 137; sh: 18
file content (362 lines) | stat: -rw-r--r-- 13,473 bytes parent folder | download | duplicates (3)
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
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
# -*- coding: UTF-8 -*-

from __future__ import absolute_import
from behave.userdata import parse_user_define, UserData, UserDataNamespace
from behave._types import Unknown
import pytest


class TestParseUserDefine(object):
    """Test parse_user_define() function."""

    def test_parse__name_value(self):
        parts = parse_user_define("person=Alice")
        assert parts == ("person", "Alice")

    def test_parse__name_only_for_boolean_flag(self):
        parts = parse_user_define("boolean_flag")
        assert parts == ("boolean_flag", "true")


    @pytest.mark.parametrize("text", [
        "  person=Alice",
        "person=Alice  ",
        "person = Alice",
    ])
    def test_parse__name_value_with_padded_whitespace(self, text):
        parts = parse_user_define(text)
        assert parts == ("person", "Alice")


    @pytest.mark.parametrize("text", [
        '"person=Alice and Bob"',
        "'person=Alice and Bob'",
    ])
    def test_parse__name_value_with_quoted_name_value_pair(self, text):
        parts = parse_user_define(text)
        assert parts == ("person", "Alice and Bob")

    @pytest.mark.parametrize("text", [
        'person="Alice and Bob"',
        "person='Alice and Bob'",
    ])
    def test_parse__name_value_with_quoted_value(self, text):
        parts = parse_user_define(text)
        assert parts == ("person", "Alice and Bob")




class TestUserData(object):
    """Test UserData class."""

    def test_userdata_is_dictlike(self):
        userdata = UserData(name="Foo", number=42)
        value1 = userdata["name"]
        value2 = userdata.get("number")
        value3 = userdata.get("unknown", Unknown)
        assert isinstance(userdata, dict)
        assert value1 == "Foo"
        assert value2 == 42
        assert value3 is Unknown

    def test_getas__with_known_param_and_valid_text(self):
        userdata = UserData(param="42")
        assert "param" in userdata, "ENSURE: known param"

        value = userdata.getas(int, "param")
        assert isinstance(value, int)
        assert value == 42

    def test_getas__with_known_param_and_invalid_text_raises_ValueError(self):
        userdata = UserData(param="__BAD_NUMBER__")
        assert "param" in userdata, "ENSURE: known param"
        with pytest.raises(ValueError):
            userdata.getas(int, "param")

    def test_getas__with_known_param_and_preconverted_value(self):
        userdata = UserData(param=42)
        assert "param" in userdata, "ENSURE: known param"

        value = userdata.getas(int, "param")
        assert isinstance(value, int)
        assert value == 42

    def test_getas__with_known_param_and_preconverted_value_and_valuetype(self):
        userdata = UserData(param=42)
        assert "param" in userdata, "ENSURE: known param"

        def parse_int(text):
            return int(text)

        value = userdata.getas(parse_int, "param", valuetype=int)
        assert isinstance(value, int)
        assert value == 42

    def test_getas__with_unknown_param_without_default_returns_none(self):
        userdata = UserData()
        assert "param" not in userdata, "ENSURE: unknown param"

        value = userdata.getas(int, "param")
        assert value is None

    def test_getas__with_unknown_param_returns_default_value(self):
        userdata = UserData()
        assert "param" not in userdata, "ENSURE: unknown param"

        value = userdata.getas(int, "param", 123)
        assert isinstance(value, int)
        assert value == 123


    def test_getint__with_known_param_and_valid_text(self):
        userdata = UserData(param="42")
        value = userdata.getint("param")
        assert isinstance(value, int)
        assert value ==  42

    def test_getint__with_known_param_and_invalid_text_raises_ValueError(self):
        userdata = UserData(param="__BAD_NUMBER__")
        with pytest.raises(ValueError):
            userdata.getint("param")

    def test_getint__with_unknown_param_without_default_returns_zero(self):
        userdata = UserData()
        value = userdata.getint("param")
        assert value == 0

    def test_getint__with_unknown_param_returns_default_value(self):
        userdata = UserData()
        value = userdata.getint("param", 123)
        assert isinstance(value, int)
        assert value == 123

    def test_getfloat__with_known_param_and_valid_text(self):
        for valid_text in ["1.2", "2", "-1E+3", "+2.34E-5"]:
            userdata = UserData(param=valid_text)
            value = userdata.getfloat("param")
            assert isinstance(value, float)
            assert value == float(valid_text)

    def test_getfloat__with_known_param_and_invalid_text_raises_ValueError(self):
        userdata = UserData(param="__BAD_NUMBER__")
        with pytest.raises(ValueError):
            userdata.getfloat("param")

    def test_getfloat__with_unknown_param_without_default_returns_zero(self):
        userdata = UserData()
        value = userdata.getfloat("param")
        assert value == 0.0

    def test_getfloat__with_unknown_param_returns_default_value(self):
        userdata = UserData()
        value = userdata.getint("param", 1.2)
        assert isinstance(value, float)
        assert value == 1.2


    @pytest.mark.parametrize("text", [
        "true", "TRUE", "True", "yes", "on", "1"
    ])
    def test_getbool__with_known_param_and_valid_true_text(self, text):
        true_text = text
        userdata = UserData(param=true_text)
        value = userdata.getbool("param")
        assert isinstance(value, bool), "text=%s" % true_text
        assert value is True

    @pytest.mark.parametrize("text", [
        "false", "FALSE", "False", "no", "off", "0"
    ])
    def test_getbool__with_known_param_and_valid_false_text(self, text):
        false_text = text
        userdata = UserData(param=false_text)
        value = userdata.getbool("param")
        assert isinstance(value, bool), "text=%s" % false_text
        assert value is False

    def test_getbool__with_known_param_and_invalid_text_raises_ValueError(self):
        userdata = UserData(param="__BAD_VALUE__")
        with pytest.raises(ValueError):
            userdata.getbool("param")

    def test_getbool__with_unknown_param_without_default_returns_false(self):
        userdata = UserData()
        value = userdata.getfloat("param")
        assert value == False

    def test_getbool__with_unknown_param_returns_default_value(self):
        userdata = UserData()
        value = userdata.getint("param", 1.2)
        assert isinstance(value, float)
        assert value == 1.2


class TestUserDataNamespace(object):

    def test_make_scoped(self):
        scoped_name = UserDataNamespace.make_scoped("my.scope", "param")
        assert scoped_name == "my.scope.param"

    def test_make_scoped__with_empty_scope(self):
        scoped_name = UserDataNamespace.make_scoped("", "param")
        assert scoped_name == "param"

    def test_ctor__converts_dict_into_userdata(self):
        userdata = {"my.scope.param1": 12}
        config = UserDataNamespace("my.scope", userdata)
        assert isinstance(config.data, UserData)
        assert config.data is not userdata
        assert config.data == userdata

    def test_ctor__converts_items_into_userdata(self):
        userdata = {"my.scope.param1": 12}
        config = UserDataNamespace("my.scope", userdata.items())
        assert isinstance(config.data, UserData)
        assert config.data is not userdata
        assert config.data == userdata

    def test_ctor__can_assign_userdata_afterwards(self):
        userdata = UserData({"my.scope.param1": 12})
        config = UserDataNamespace("my.scope")
        config.data = userdata
        assert isinstance(config.data, UserData)
        assert config.data is userdata

    def test_get__retrieves_value_when_scoped_param_exists(self):
        userdata = UserData({"my.scope.param1": 12})
        config = UserDataNamespace("my.scope", userdata)
        assert config.get("param1") == 12
        assert config["param1"] == 12

    def test_get__returns_default_when_scoped_param_not_exists(self):
        config = UserDataNamespace("my.scope", UserData({}))
        assert config.get("UNKNOWN_PARAM", "DEFAULT1") == "DEFAULT1"
        assert config.get("UNKNOWN_PARAM", "DEFAULT2") == "DEFAULT2"

    def test_getint__retrieves_value_when_scoped_param_exists(self):
        userdata = UserData({"my.scope.param1": "12"})
        config = UserDataNamespace("my.scope", userdata)
        assert config.getint("param1") == 12

    def test_getint__retrieves_value_when_scoped_param_exists(self):
        userdata = UserData({"my.scope.param2": "12"})
        config = UserDataNamespace("my.scope", userdata)
        assert config.getint("param2") == 12

    def test_getint__returns_default_when_scoped_param_not_exists(self):
        userdata = UserData({})
        config = UserDataNamespace("my.scope", userdata)
        assert config.getint("UNKNOWN_PARAM", 123) == 123
        assert config.getint("UNKNOWN_PARAM", 321) == 321

    def test_getbool__retrieves_value_when_scoped_param_exists(self):
        userdata = UserData({"my.scope.param3": "yes"})
        config = UserDataNamespace("my.scope", userdata)
        assert config.getbool("param3") == True

    def test_getbool__returns_default_when_scoped_param_not_exists(self):
        userdata = UserData({})
        config = UserDataNamespace("my.scope", userdata)
        assert config.getint("UNKNOWN_PARAM", True)  == True
        assert config.getint("UNKNOWN_PARAM", False) == False

    def test_contains__when_scoped_param_exists(self):
        userdata = UserData({"my.scope.param": 12})
        config = UserDataNamespace("my.scope", userdata)
        assert "param" in config
        assert not("param" not in config)

    def test_contains__when_scoped_param_not_exists(self):
        userdata = UserData({"my.scope.param": 12})
        config = UserDataNamespace("my.scope", userdata)
        assert "UNKNOWN_PARAM" not in config
        assert not ("UNKNOWN_PARAM" in config)

    def test_getitem__returns_value_when_param_exists(self):
        userdata = UserData({"my.scope.param": "123"})
        config = UserDataNamespace("my.scope", userdata)
        assert config["param"] == "123"

    def test_getitem__raises_error_when_param_not_exists(self):
        userdata = UserData({"my.scope.param": "123"})
        config = UserDataNamespace("my.scope", userdata)
        with pytest.raises(KeyError):
            _ = config["UNKNOWN_PARAM"]

    def test_setitem__stores_value(self):
        userdata = UserData({"my.scope.param1": "123"})
        config = UserDataNamespace("my.scope", userdata)
        scoped_name = "my.scope.new_param"
        config["new_param"] = 1234
        assert "new_param" in config
        assert config["new_param"] == 1234
        assert scoped_name in config.data
        assert config.data[scoped_name] == 1234

    def test_length__returns_zero_without_params(self):
        userdata = UserData({"my.other_scope.param1": "123"})
        config = UserDataNamespace("my.scope", userdata)
        assert len(config) == 0

    def test_length__with_scoped_params(self):
        userdata1 = UserData({"my.scope.param1": "123"})
        userdata2 = UserData({
            "my.other_scope.param1": "123",
            "my.scope.param1": "123",
            "my.scope.param2": "456",
        })
        userdata3 = UserData({
            "my.other_scope.param1": "123",
            "my.scope.param1": "123",
            "my.scope.param2": "456",
            "my.scope.param3": "789",
            "my.other_scope.param2": "123",
        })
        config = UserDataNamespace("my.scope")
        config.data = userdata1
        assert len(config) == 1
        config.data = userdata2
        assert len(config) == 2
        config.data = userdata3
        assert len(config) == 3

    def test_scoped_keys__with_scoped_params(self):
        userdata = UserData({
            "my.other_scope.param1": "123",
            "my.scope.param1": "123",
            "my.scope.param2": "456",
            "my.other_scope.param2": "123",
        })
        config = UserDataNamespace("my.scope", userdata)
        assert sorted(config.scoped_keys()) == ["my.scope.param1", "my.scope.param2"]

    def test_keys__with_scoped_params(self):
        userdata = UserData({
            "my.other_scope.param1": "__OTHER1__",
            "my.scope.param1": "123",
            "my.scope.param2": "456",
            "my.other_scope.param2": "__OTHER2__",
        })
        config = UserDataNamespace("my.scope", userdata)
        assert sorted(config.keys()) == ["param1", "param2"]

    def test_values__with_scoped_params(self):
        userdata = UserData({
            "my.other_scope.param1": "__OTHER1__",
            "my.scope.param1": "123",
            "my.scope.param2": "456",
            "my.other_scope.param2": "__OTHER2__",
        })
        config = UserDataNamespace("my.scope", userdata)
        assert sorted(config.values()) == ["123", "456"]

    def test_items__with_scoped_params(self):
        userdata = UserData({
            "my.other_scope.param1": "__OTHER1__",
            "my.scope.param1": "123",
            "my.scope.param2": "456",
            "my.other_scope.param2": "__OTHER2__",
        })
        config = UserDataNamespace("my.scope", userdata)
        assert sorted(config.items()) == [("param1", "123"), ("param2", "456")]