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
|
# Copyright The OpenTelemetry 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.
# type: ignore
import unittest
from typing import MutableSequence
from opentelemetry.attributes import (
BoundedAttributes,
_clean_attribute,
_clean_extended_attribute,
)
class TestAttributes(unittest.TestCase):
# pylint: disable=invalid-name
def assertValid(self, value, key="k"):
expected = value
if isinstance(value, MutableSequence):
expected = tuple(value)
self.assertEqual(_clean_attribute(key, value, None), expected)
def assertInvalid(self, value, key="k"):
self.assertIsNone(_clean_attribute(key, value, None))
def test_attribute_key_validation(self):
# only non-empty strings are valid keys
self.assertInvalid(1, "")
self.assertInvalid(1, 1)
self.assertInvalid(1, {})
self.assertInvalid(1, [])
self.assertInvalid(1, b"1")
self.assertValid(1, "k")
self.assertValid(1, "1")
def test_clean_attribute(self):
self.assertInvalid([1, 2, 3.4, "ss", 4])
self.assertInvalid([{}, 1, 2, 3.4, 4])
self.assertInvalid(["sw", "lf", 3.4, "ss"])
self.assertInvalid([1, 2, 3.4, 5])
self.assertInvalid({})
self.assertInvalid([1, True])
self.assertValid(True)
self.assertValid("hi")
self.assertValid(3.4)
self.assertValid(15)
self.assertValid([1, 2, 3, 5])
self.assertValid([1.2, 2.3, 3.4, 4.5])
self.assertValid([True, False])
self.assertValid(["ss", "dw", "fw"])
self.assertValid([])
# None in sequences are valid
self.assertValid(["A", None, None])
self.assertValid(["A", None, None, "B"])
self.assertValid([None, None])
self.assertInvalid(["A", None, 1])
self.assertInvalid([None, "A", None, 1])
# test keys
self.assertValid("value", "key")
self.assertInvalid("value", "")
self.assertInvalid("value", None)
def test_sequence_attr_decode(self):
seq = [
None,
b"Content-Disposition",
b"Content-Type",
b"\x81",
b"Keep-Alive",
]
expected = [
None,
"Content-Disposition",
"Content-Type",
None,
"Keep-Alive",
]
self.assertEqual(
_clean_attribute("headers", seq, None), tuple(expected)
)
class TestExtendedAttributes(unittest.TestCase):
# pylint: disable=invalid-name
def assertValid(self, value, key="k"):
expected = value
if isinstance(value, MutableSequence):
expected = tuple(value)
self.assertEqual(_clean_extended_attribute(key, value, None), expected)
def assertInvalid(self, value, key="k"):
self.assertIsNone(_clean_extended_attribute(key, value, None))
def test_attribute_key_validation(self):
# only non-empty strings are valid keys
self.assertInvalid(1, "")
self.assertInvalid(1, 1)
self.assertInvalid(1, {})
self.assertInvalid(1, [])
self.assertInvalid(1, b"1")
self.assertValid(1, "k")
self.assertValid(1, "1")
def test_clean_extended_attribute(self):
self.assertInvalid([1, 2, 3.4, "ss", 4])
self.assertInvalid([{}, 1, 2, 3.4, 4])
self.assertInvalid(["sw", "lf", 3.4, "ss"])
self.assertInvalid([1, 2, 3.4, 5])
self.assertInvalid([1, True])
self.assertValid(None)
self.assertValid(True)
self.assertValid("hi")
self.assertValid(3.4)
self.assertValid(15)
self.assertValid([1, 2, 3, 5])
self.assertValid([1.2, 2.3, 3.4, 4.5])
self.assertValid([True, False])
self.assertValid(["ss", "dw", "fw"])
self.assertValid([])
# None in sequences are valid
self.assertValid(["A", None, None])
self.assertValid(["A", None, None, "B"])
self.assertValid([None, None])
self.assertInvalid(["A", None, 1])
self.assertInvalid([None, "A", None, 1])
# mappings
self.assertValid({})
self.assertValid({"k": "v"})
# mappings in sequences
self.assertValid([{"k": "v"}])
# test keys
self.assertValid("value", "key")
self.assertInvalid("value", "")
self.assertInvalid("value", None)
def test_sequence_attr_decode(self):
seq = [
None,
b"Content-Disposition",
b"Content-Type",
b"\x81",
b"Keep-Alive",
]
self.assertEqual(
_clean_extended_attribute("headers", seq, None), tuple(seq)
)
def test_mapping(self):
mapping = {
"": "invalid",
b"bytes": "invalid",
"none": {"": "invalid"},
"valid_primitive": "str",
"valid_sequence": ["str"],
"invalid_sequence": ["str", 1],
"valid_mapping": {"str": 1},
"invalid_mapping": {"": 1},
}
expected = {
"none": {},
"valid_primitive": "str",
"valid_sequence": ("str",),
"invalid_sequence": None,
"valid_mapping": {"str": 1},
"invalid_mapping": {},
}
self.assertEqual(
_clean_extended_attribute("headers", mapping, None), expected
)
class TestBoundedAttributes(unittest.TestCase):
# pylint: disable=consider-using-dict-items
base = {
"name": "Firulais",
"age": 7,
"weight": 13,
"vaccinated": True,
}
def test_negative_maxlen(self):
with self.assertRaises(ValueError):
BoundedAttributes(-1)
def test_from_map(self):
dic_len = len(self.base)
base_copy = self.base.copy()
bdict = BoundedAttributes(dic_len, base_copy)
self.assertEqual(len(bdict), dic_len)
# modify base_copy and test that bdict is not changed
base_copy["name"] = "Bruno"
base_copy["age"] = 3
for key in self.base:
self.assertEqual(bdict[key], self.base[key])
# test that iter yields the correct number of elements
self.assertEqual(len(tuple(bdict)), dic_len)
# map too big
half_len = dic_len // 2
bdict = BoundedAttributes(half_len, self.base)
self.assertEqual(len(tuple(bdict)), half_len)
self.assertEqual(bdict.dropped, dic_len - half_len)
def test_bounded_dict(self):
# create empty dict
dic_len = len(self.base)
bdict = BoundedAttributes(dic_len, immutable=False)
self.assertEqual(len(bdict), 0)
# fill dict
for key in self.base:
bdict[key] = self.base[key]
self.assertEqual(len(bdict), dic_len)
self.assertEqual(bdict.dropped, 0)
for key in self.base:
self.assertEqual(bdict[key], self.base[key])
# test __iter__ in BoundedAttributes
for key in bdict:
self.assertEqual(bdict[key], self.base[key])
# updating an existing element should not drop
bdict["name"] = "Bruno"
self.assertEqual(bdict.dropped, 0)
# try to append more elements
for key in self.base:
bdict["new-" + key] = self.base[key]
self.assertEqual(len(bdict), dic_len)
self.assertEqual(bdict.dropped, dic_len)
# Invalid values shouldn't be considered for `dropped`
bdict["invalid-seq"] = [None, 1, "2"]
self.assertEqual(bdict.dropped, dic_len)
# test that elements in the dict are the new ones
for key in self.base:
self.assertEqual(bdict["new-" + key], self.base[key])
# delete an element
del bdict["new-name"]
self.assertEqual(len(bdict), dic_len - 1)
with self.assertRaises(KeyError):
_ = bdict["new-name"]
def test_no_limit_code(self):
bdict = BoundedAttributes(maxlen=None, immutable=False)
for num in range(100):
bdict[str(num)] = num
for num in range(100):
self.assertEqual(bdict[str(num)], num)
def test_immutable(self):
bdict = BoundedAttributes()
with self.assertRaises(TypeError):
bdict["should-not-work"] = "dict immutable"
def test_locking(self):
"""Supporting test case for a commit titled: Fix class BoundedAttributes to have RLock rather than Lock. See #3858.
The change was introduced because __iter__ of the class BoundedAttributes holds lock, and we observed some deadlock symptoms
in the codebase. This test case is to verify that the fix works as expected.
"""
bdict = BoundedAttributes(immutable=False)
with bdict._lock: # pylint: disable=protected-access
for num in range(100):
bdict[str(num)] = num
for num in range(100):
self.assertEqual(bdict[str(num)], num)
# pylint: disable=no-self-use
def test_extended_attributes(self):
bdict = BoundedAttributes(extended_attributes=True, immutable=False)
with unittest.mock.patch(
"opentelemetry.attributes._clean_extended_attribute",
return_value="mock_value",
) as clean_extended_attribute_mock:
bdict["key"] = "value"
clean_extended_attribute_mock.assert_called_once()
def test_wsgi_request_conversion_to_string(self):
"""Test that WSGI request objects are converted to strings when _clean_extended_attribute is called."""
class DummyWSGIRequest:
def __str__(self):
return "<DummyWSGIRequest method=GET path=/example/>"
wsgi_request = DummyWSGIRequest()
cleaned_value = _clean_extended_attribute(
"request", wsgi_request, None
)
# Verify we get a string back from the cleaner
self.assertIsInstance(cleaned_value, str)
self.assertEqual(
"<DummyWSGIRequest method=GET path=/example/>", cleaned_value
)
|
