opentelemetry-python/shim/opentelemetry-opencensus-shim/tests/test_patch.py at 487a6e262454eb473335f66a546bece7bdca7edd · open-telemetry/opentelemetry-python · GitHub

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
# 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.

import unittest

from opencensus.trace.tracer import Tracer
from opencensus.trace.tracers.noop_tracer import NoopTracer

from opentelemetry.shim.opencensus import install_shim, uninstall_shim
from opentelemetry.shim.opencensus._shim_tracer import ShimTracer


class TestPatch(unittest.TestCase):
    def setUp(self):
        uninstall_shim()

    def tearDown(self):
        uninstall_shim()

    def test_install_shim(self):
        # Initially the shim is not installed. The Tracer class has no tracer property, it is
        # instance level only.
        self.assertFalse(hasattr(Tracer, "tracer"))

        install_shim()

        # The actual Tracer class should now be patched with a tracer property
        self.assertTrue(hasattr(Tracer, "tracer"))
        self.assertIsInstance(Tracer.tracer, property)

    def test_install_shim_affects_existing_tracers(self):
        # Initially the shim is not installed. Store the original tracer instance.
        oc_tracer = Tracer()
        original_tracer = oc_tracer.tracer
        self.assertNotIsInstance(original_tracer, ShimTracer)

        install_shim()

        # The property should cause existing instances to get the singleton ShimTracer
        self.assertIsInstance(oc_tracer.tracer, ShimTracer)
        # The ShimTracer wraps a NoopTracer, which should look like a NoopTracer
        self.assertIsInstance(oc_tracer.tracer, NoopTracer)

    def test_install_shim_affects_new_tracers(self):
        install_shim()

        # The property should cause existing instances to get the singleton ShimTracer
        oc_tracer = Tracer()
        self.assertIsInstance(oc_tracer.tracer, ShimTracer)

    def test_uninstall_shim_resets_tracer(self):
        install_shim()
        uninstall_shim()

        # The actual Tracer class should not be patched
        self.assertFalse(hasattr(Tracer, "tracer"))

    def test_uninstall_shim_resets_existing_tracers(self):
        oc_tracer = Tracer()
        orig = oc_tracer.tracer
        install_shim()
        uninstall_shim()

        # Accessing the tracer member should no longer use the property, and instead should get
        # its original NoopTracer
        self.assertIs(oc_tracer.tracer, orig)

    def test_uninstall_shim_resets_new_tracers(self):
        install_shim()
        uninstall_shim()

        # Accessing the tracer member should get the NoopTracer
        oc_tracer = Tracer()
        self.assertIsInstance(oc_tracer.tracer, NoopTracer)
        self.assertNotIsInstance(oc_tracer.tracer, ShimTracer)