File: test_contextvars.py

package info (click to toggle)
python-opentracing 2.4.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 816 kB
  • sloc: python: 3,489; makefile: 98
file content (344 lines) | stat: -rw-r--r-- 11,179 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
from __future__ import print_function


import asyncio

from opentracing.mocktracer import MockTracer
from opentracing.scope_managers.contextvars import ContextVarsScopeManager, \
    no_parent_scope
from ..testcase import OpenTracingTestCase
from ..utils import stop_loop_when


class TestAsyncioContextVars(OpenTracingTestCase):

    def setUp(self):
        self.tracer = MockTracer(ContextVarsScopeManager())
        self.loop = asyncio.get_event_loop()

    def test_main(self):

        def submit():
            span = self.tracer.scope_manager.active.span

            async def task1():
                self.assertEqual(span, self.tracer.active_span)
                self.tracer.active_span.set_tag('key1', '1')

                async def task2():
                    self.assertEqual(span, self.tracer.active_span)
                    self.tracer.active_span.set_tag('key2', '2')

                    async def task3():
                        self.assertEqual(span, self.tracer.active_span)
                        self.tracer.active_span.set_tag('key3', '3')
                        self.tracer.active_span.finish()

                    self.loop.create_task(task3())

                self.loop.create_task(task2())

            self.loop.create_task(task1())

        # Start a Span and let the callback-chain
        # finish it when the task is done
        async def task():
            with self.tracer.start_active_span('one', finish_on_close=False):
                submit()

        self.loop.create_task(task())

        stop_loop_when(self.loop,
                       lambda: len(self.tracer.finished_spans()) == 1)
        self.loop.run_forever()

        span, = self.tracer.finished_spans()
        self.assertEqual(span.operation_name, 'one')

        for i in range(1, 4):
            self.assertEqual(span.tags.get('key%s' % i, None), str(i))


class TestAsyncioContextVarsScheduleInLoop(OpenTracingTestCase):

    # TODO: move the test-case to another file

    def setUp(self):
        self.tracer = MockTracer(ContextVarsScopeManager())
        self.loop = asyncio.get_event_loop()

    def test_schedule_callbacks(self):

        def callback(op_name):
            with self.tracer.start_active_span(
                operation_name=op_name,
                child_of=self.tracer.active_span,
            ):
                pass

        def callback_with_nested_callback(op_name):
            with self.tracer.start_active_span(
                operation_name=op_name,
                child_of=self.tracer.active_span,
            ):
                self.loop.call_soon(callback, 'childof:{}'.format(op_name))

        with self.tracer.start_active_span('root'):
            self.loop.call_soon(callback_with_nested_callback, 'first')
            self.loop.call_soon(callback, 'second')

        stop_loop_when(self.loop,
                       lambda: len(self.tracer.finished_spans()) == 4)
        self.loop.run_forever()

        root, first, second, childof_first = self.tracer.finished_spans()
        self.assertEmptySpan(root, 'root')
        self.assertEmptySpan(first, 'first')
        self.assertEmptySpan(second, 'second')
        self.assertEmptySpan(childof_first, 'childof:first')

        self.assertIsChildOf(first, root)
        self.assertIsChildOf(childof_first, first)
        self.assertIsChildOf(second, root)

    def test_coroutines_schedule_callbacks(self):

        def callback(op_name):
            with self.tracer.start_active_span(
                operation_name=op_name,
                child_of=self.tracer.active_span
            ):
                pass

        async def task(op_name):
            with self.tracer.start_active_span(
                operation_name=op_name,
                child_of=self.tracer.active_span
            ):
                self.loop.call_later(
                    0.1, callback, 'childof:{}'.format(op_name)
                )
        with self.tracer.start_active_span('root'):
            self.loop.create_task(task('task1'))
            self.loop.create_task(task('task2'))

        stop_loop_when(self.loop,
                       lambda: len(self.tracer.finished_spans()) == 5)
        self.loop.run_forever()

        root, task1, task2, child1, child2 = self.tracer.finished_spans()

        self.assertEmptySpan(root, 'root')
        self.assertEmptySpan(task1, 'task1')
        self.assertEmptySpan(task2, 'task2')
        self.assertEmptySpan(child1, 'childof:task1')
        self.assertEmptySpan(child2, 'childof:task2')

        self.assertIsChildOf(task1, root)
        self.assertIsChildOf(task2, root)
        self.assertIsChildOf(child1, task1)
        self.assertIsChildOf(child2, task2)

    def test_coroutines_scheduling_task(self):

        async def _task(op_name):
            await asyncio.sleep(0.1)
            with self.tracer.start_active_span(
                operation_name=op_name,
                child_of=self.tracer.active_span
            ):
                pass

        async def task(op_name):
            with self.tracer.start_active_span(
                operation_name=op_name,
                child_of=self.tracer.active_span
            ):
                self.loop.create_task(_task('childof:{}'.format(op_name)))

        with self.tracer.start_active_span('root'):
            self.loop.create_task(task('task1'))
            self.loop.create_task(task('task2'))

        stop_loop_when(self.loop,
                       lambda: len(self.tracer.finished_spans()) == 5)
        self.loop.run_forever()

        root, task1, task2, child1, child2 = self.tracer.finished_spans()

        self.assertEmptySpan(root, 'root')
        self.assertEmptySpan(task1, 'task1')
        self.assertEmptySpan(task2, 'task2')
        self.assertEmptySpan(child1, 'childof:task1')
        self.assertEmptySpan(child2, 'childof:task2')

        self.assertIsChildOf(task1, root)
        self.assertIsChildOf(task2, root)
        self.assertIsChildOf(child1, task1)
        self.assertIsChildOf(child2, task2)

    def test_recursive_scheduling_task(self):

        tasks = 4

        async def task(n=0):
            await asyncio.sleep(0.1)
            with self.tracer.start_active_span(
                operation_name=str(n),
                child_of=self.tracer.active_span
            ):
                if n < tasks:
                    self.loop.create_task(task(n+1))

        self.loop.create_task(task())

        stop_loop_when(self.loop,
                       lambda: len(self.tracer.finished_spans()) == tasks)
        self.loop.run_forever()

        spans = self.tracer.finished_spans()

        for i in range(tasks):
            self.assertEmptySpan(spans[i], str(i))
            if i == 0:
                self.assertIsNone(spans[i].parent_id)
            else:
                self.assertIsChildOf(spans[i], spans[i-1])

    def test_recursive_scheduling_with_ignoring_active_span(self):

        tasks = 4

        async def task(n=0):
            await asyncio.sleep(0.1)
            if n < tasks / 2:
                with self.tracer.start_active_span(str(n)):
                    self.loop.create_task(task(n+1))
            elif n < tasks:
                with self.tracer.start_active_span(
                    operation_name=str(n),
                    ignore_active_span=True
                ):
                    self.loop.create_task(task(n+1))

        self.loop.create_task(task())

        stop_loop_when(self.loop,
                       lambda: len(self.tracer.finished_spans()) == tasks)
        self.loop.run_forever()

        s0, s1, s2, s3 = self.tracer.finished_spans()

        self.assertEmptySpan(s0, '0')
        self.assertHasNoParent(s0)

        self.assertEmptySpan(s1, '1')
        self.assertIsChildOf(s1, s0)

        self.assertEmptySpan(s2, '2')
        self.assertHasNoParent(s2)

        self.assertEmptySpan(s3, '3')
        self.assertHasNoParent(s3)

    def test_tasks_with_no_parent_scope(self):

        async def task(name):
            await asyncio.sleep(0.1)
            with self.tracer.start_active_span(name):
                await asyncio.sleep(0.1)

        async def tasks():
            self.loop.create_task(task('task_1'))
            with no_parent_scope():
                self.loop.create_task(task('task_2'))
            self.loop.create_task(task('task_3'))

        with self.tracer.start_active_span('root'):
            self.loop.create_task(tasks())

        stop_loop_when(self.loop,
                       lambda: len(self.tracer.finished_spans()) == 4)
        self.loop.run_forever()

        root, task1, task2, task3 = self.tracer.finished_spans()

        self.assertEmptySpan(root, 'root')

        self.assertEmptySpan(task1, 'task_1')
        self.assertIsChildOf(task1, root)

        # Third task was scheduled out `no_parent_scope`.
        self.assertEmptySpan(task3, 'task_3')
        self.assertIsChildOf(task3, root)

        # Second task "wrapped" by `no_parent_scope`.
        self.assertEmptySpan(task2, 'task_2')
        self.assertHasNoParent(task2)

    def test_callbacks_with_no_parent_scope(self):

        def callback(name):
            with self.tracer.start_active_span(name):
                pass

        def callbacks():
            self.loop.call_soon(callback, 'task_1')
            with no_parent_scope():
                self.loop.call_soon(callback, 'task_2')
            self.loop.call_soon(callback, 'task_3')

        with self.tracer.start_active_span('root'):
            self.loop.call_soon(callbacks)

        stop_loop_when(self.loop,
                       lambda: len(self.tracer.finished_spans()) == 4)
        self.loop.run_forever()

        root, task1, task2, task3 = self.tracer.finished_spans()

        self.assertEmptySpan(root, 'root')

        self.assertEmptySpan(task1, 'task_1')
        self.assertIsChildOf(task1, root)

        # Third task was scheduled out `no_parent_scope`.
        self.assertEmptySpan(task3, 'task_3')
        self.assertIsChildOf(task3, root)

        # Second task "wrapped" by `no_parent_scope`.
        self.assertEmptySpan(task2, 'task_2')
        self.assertHasNoParent(task2)

    def test_await_with_no_parent_scope(self):

        async def coro(name):
            with self.tracer.start_active_span(name):
                pass

        async def main_coro():
            await coro('coro_1')
            with no_parent_scope():
                await coro('coro_2')
            await coro('coro_3')

        with self.tracer.start_active_span('root'):
            self.loop.create_task(main_coro())

        stop_loop_when(self.loop,
                       lambda: len(self.tracer.finished_spans()) == 4)
        self.loop.run_forever()

        root, coro1, coro2, coro3 = self.tracer.finished_spans()

        self.assertEmptySpan(root, 'root')

        self.assertEmptySpan(coro1, 'coro_1')
        self.assertIsChildOf(coro1, root)

        # second coroutine "wrapped" by `no_parent_scope`.
        self.assertEmptySpan(coro2, 'coro_2')
        self.assertHasNoParent(coro2)

        self.assertEmptySpan(coro3, 'coro_3')
        self.assertIsChildOf(coro3, root)