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
|
# DTFIX5: review this test for removal, should have been superseded by test_serialization_profiles.py
# some tests will need to be under module_utils to verify target-only Python versions
# if kept, de-dupe
from __future__ import annotations
import json
import typing as t
import collections.abc as c
import pytest
from ansible.module_utils._internal._datatag import AnsibleTaggedObject, _untaggable_types, AnsibleTagHelper
from ansible.module_utils._internal._datatag._tags import Deprecated
from ansible._internal._datatag._tags import Origin, TrustedAsTemplate
from ansible.module_utils.common.json import get_encoder, get_decoder
from ansible.module_utils._internal._json._profiles import _module_legacy_m2c, _tagless, _module_legacy_c2m, _module_modern_c2m, _module_modern_m2c
from ansible._internal._json._profiles import _legacy
_simple_json_values = (
'hello',
1.1,
1,
True,
None,
[1],
dict(k='v'),
)
_converted_json_values = (
((1,), [1]),
({1}, [1]),
)
origin = Origin(path='/absolute/path/for/testing')
@pytest.mark.parametrize("value, expected", _converted_json_values, ids=str)
def test_modern_controller_to_module_converted_types(value: t.Any, expected: t.Any) -> None:
args = dict(untagged_value=value, tagged_value=origin.tag(value))
profile = _module_modern_c2m
payload = json.dumps(args, cls=get_encoder(profile))
result = json.loads(payload, cls=get_decoder(profile))
untagged_value = result['untagged_value']
tagged_value = result['tagged_value']
assert untagged_value == expected
assert tagged_value == expected
assert_has_no_tags(result)
@pytest.mark.parametrize("value, expected", _converted_json_values, ids=str)
def test_legacy_controller_to_module_converted_types(value: t.Any, expected: t.Any) -> None:
args = dict(untagged_value=value, tagged_value=origin.tag(value))
profile = _module_legacy_c2m
payload = json.dumps(args, cls=get_encoder(profile))
result = json.loads(payload, cls=get_decoder(profile))
untagged_value = result['untagged_value']
tagged_value = result['tagged_value']
assert untagged_value == expected
assert tagged_value == expected
assert_has_no_tags(result)
@pytest.mark.parametrize("value, expected", _converted_json_values, ids=str)
def test_modern_module_to_controller_converted_types(value: t.Any, expected: t.Any) -> None:
deprecation_tag = Deprecated(msg='go away')
args = dict(untagged_value=value, tagged_value=deprecation_tag.tag(value))
profile = _module_modern_m2c
payload = json.dumps(args, cls=get_encoder(profile))
result = json.loads(payload, cls=get_decoder(profile))
untagged_value = result['untagged_value']
tagged_value = result['tagged_value']
assert untagged_value == expected
assert tagged_value == expected
assert_has_no_tags(untagged_value)
if type(value) not in _untaggable_types:
tags = AnsibleTagHelper.tags(tagged_value)
assert tags == {deprecation_tag}
@pytest.mark.parametrize("value, expected", _converted_json_values, ids=str)
def test_legacy_module_to_controller_converted_types(value: t.Any, expected: t.Any) -> None:
args = dict(untagged_value=value)
profile = _module_modern_m2c
payload = json.dumps(args, cls=get_encoder(profile))
result = json.loads(payload, cls=get_decoder(profile))
untagged_value = result['untagged_value']
assert untagged_value == expected
assert_has_no_tags(result)
@pytest.mark.parametrize("value", _simple_json_values, ids=str)
def test_modern_controller_to_module(value: t.Any) -> None:
args = dict(untagged_value=value, tagged_value=origin.tag(value))
profile = _module_modern_c2m
payload = json.dumps(args, cls=get_encoder(profile))
result = json.loads(payload, cls=get_decoder(profile))
untagged_value = result['untagged_value']
tagged_value = result['tagged_value']
assert untagged_value == value
assert tagged_value == value
assert_has_no_tags(result)
@pytest.mark.parametrize("value", _simple_json_values, ids=str)
def test_legacy_controller_to_module(value: t.Any) -> None:
args = dict(untagged_value=value, tagged_value=origin.tag(value))
profile = _module_legacy_c2m
payload = json.dumps(args, cls=get_encoder(profile))
result = json.loads(payload, cls=get_decoder(profile))
untagged_value = result['untagged_value']
tagged_value = result['tagged_value']
assert untagged_value == value
assert tagged_value == value
assert_has_no_tags(result)
@pytest.mark.parametrize("value", _simple_json_values, ids=str)
def test_modern_module_to_controller(value: t.Any) -> None:
deprecation_tag = Deprecated(msg='go away')
args = dict(
untagged_value=value,
tagged_value=deprecation_tag.tag(value),
# tagged_with_unwanted_tag_only=origin.tag(value),
)
profile = _module_modern_m2c
payload = json.dumps(args, cls=get_encoder(profile))
result = json.loads(payload, cls=get_decoder(profile))
untagged_value = result['untagged_value']
tagged_value = result['tagged_value']
# tagged_with_unwanted_tag_only = result['tagged_with_unwanted_tag_only']
assert untagged_value == value
assert tagged_value == value
# assert tagged_with_unwanted_tag_only == value
assert_has_no_tags(untagged_value)
# assert_has_no_tags(tagged_with_unwanted_tag_only)
if type(value) not in _untaggable_types:
tags = AnsibleTagHelper.tags(tagged_value)
assert tags == {deprecation_tag}
@pytest.mark.parametrize("value", _simple_json_values, ids=str)
def test_legacy_module_to_controller(value: t.Any) -> None:
# deprecation_tag = Deprecated(msg='go away')
args = dict(
untagged_value=value,
# tagged_value=deprecation_tag.tag(value),
# tagged_with_unwanted_tag_only=origin.tag(value),
)
profile = _module_legacy_m2c
payload = json.dumps(args, cls=get_encoder(profile))
result = json.loads(payload, cls=get_decoder(profile))
untagged_value = result['untagged_value']
# tagged_value = result['tagged_value']
# tagged_with_unwanted_tag_only = result['tagged_with_unwanted_tag_only']
assert untagged_value == value
# assert tagged_value == value
# assert tagged_with_unwanted_tag_only == value
assert_has_no_tags(untagged_value)
# assert_has_no_tags(tagged_value)
# assert_has_no_tags(tagged_with_unwanted_tag_only)
@pytest.mark.parametrize("value", _simple_json_values, ids=str)
def test_legacy(value: t.Any) -> None:
args = dict(
untagged_value=value,
tagged_value=origin.tag(value),
trusted_value=apply_trust(value),
)
profile = _legacy
payload = json.dumps(args, cls=get_encoder(profile))
payload = TrustedAsTemplate().tag(payload)
result = json.loads(payload, cls=get_decoder(profile))
untagged_value = result['untagged_value']
tagged_value = result['tagged_value']
trusted_value = result['trusted_value']
assert untagged_value == value
assert tagged_value == value
assert trusted_value == value
assert_has_no_tags(untagged_value)
assert_has_no_tags(tagged_value)
assert_has_trusted_strings(trusted_value)
@pytest.mark.parametrize("value, expected", (
((1,), [1]),
({1}, [1]),
), ids=str)
def test_legacy_converted_types(value: t.Any, expected: t.Any) -> None:
args = dict(untagged_value=value, tagged_value=origin.tag(value))
profile = _legacy
payload = json.dumps(args, cls=get_encoder(profile))
result = json.loads(payload, cls=get_decoder(profile))
untagged_value = result['untagged_value']
tagged_value = result['tagged_value']
assert untagged_value == expected
assert tagged_value == expected
assert_has_no_tags(result)
@pytest.mark.parametrize("value", _simple_json_values, ids=str)
def test_tagless(value: t.Any) -> None:
args = dict(
untagged_value=value,
tagged_value=origin.tag(value),
trusted_value=apply_trust(value),
)
profile = _tagless
payload = json.dumps(args, cls=get_encoder(profile))
result = json.loads(payload, cls=get_decoder(profile))
untagged_value = result['untagged_value']
tagged_value = result['tagged_value']
trusted_value = result['trusted_value']
assert untagged_value == value
assert tagged_value == value
assert trusted_value == value
assert_has_no_tags(result)
@pytest.mark.parametrize("value, expected", _converted_json_values, ids=str)
def test_tagless_converted_types(value: t.Any, expected: t.Any) -> None:
args = dict(untagged_value=value, tagged_value=origin.tag(value))
profile = _tagless
payload = json.dumps(args, cls=get_encoder(profile))
result = json.loads(payload, cls=get_decoder(profile))
untagged_value = result['untagged_value']
tagged_value = result['tagged_value']
assert untagged_value == expected
assert tagged_value == expected
assert_has_no_tags(result)
def apply_trust(o: t.Any) -> t.Any:
if isinstance(o, str):
return TrustedAsTemplate().tag(o)
if isinstance(o, dict):
return {key: apply_trust(value) for key, value in o.items()}
if isinstance(o, (set, list, tuple)):
return type(o)(apply_trust(item) for item in o)
return o
def assert_has_trusted_strings(o: t.Any) -> None:
assert not isinstance(o, str) or TrustedAsTemplate.is_tagged_on(o)
if isinstance(o, c.Mapping):
for key, value in o.items():
assert_has_no_tags(key)
assert_has_trusted_strings(value)
elif not isinstance(o, str) and isinstance(o, c.Iterable):
for item in o:
assert_has_trusted_strings(item)
def assert_has_no_tags(o: t.Any) -> None:
assert not isinstance(o, AnsibleTaggedObject)
if isinstance(o, c.Mapping):
for key, value in o.items():
assert_has_no_tags(key)
assert_has_no_tags(value)
elif not isinstance(o, str) and isinstance(o, c.Iterable):
for item in o:
assert_has_no_tags(item)
|
