Skip to content

Commit

Permalink
instrumentation/asyncio: catch CancelledError exception in tests (#2690)
Browse files Browse the repository at this point in the history
* instrumentation/asyncio: catch CancelledError exception in tests

After a29242f we are re-raising the
CancelledError so we need to catch it on the caller side.

Fix #2688

* instrument/asyncio: don't test anext on python < 3.10

Since it's not available there.

* instrumentation/asyncio: use unittest.skipIf instead of reimplementing it

---------

Co-authored-by: Leighton Chen <lechen@microsoft.com>
  • Loading branch information
xrmx and lzchen committed Jul 10, 2024
1 parent 0b20c95 commit 60fb936
Show file tree
Hide file tree
Showing 4 changed files with 42 additions and 36 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@
# See the License for the specific language governing permissions and
# limitations under the License.
import asyncio
import sys
from unittest import skipIf
from unittest.mock import patch

# pylint: disable=no-name-in-module
Expand Down Expand Up @@ -41,6 +43,9 @@ def tearDown(self):

# Asyncio anext() does not have __name__ attribute, which is used to determine if the coroutine should be traced.
# This test is to ensure that the instrumentation does not break when the coroutine does not have __name__ attribute.
@skipIf(
sys.version_info < (3, 10), "anext is only available in Python 3.10+"
)
def test_asyncio_anext(self):
async def main():
async def async_gen():
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,10 @@ def tearDown(self):

def test_cancel(self):
with self._tracer.start_as_current_span("root", kind=SpanKind.SERVER):
asyncio.run(cancellation_create_task())
try:
asyncio.run(cancellation_create_task())
except asyncio.CancelledError:
pass
spans = self.memory_exporter.get_finished_spans()
self.assertEqual(len(spans), 3)
self.assertEqual(spans[0].context.trace_id, spans[1].context.trace_id)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
# limitations under the License.
import asyncio
import sys
from unittest import skipIf
from unittest.mock import patch

# pylint: disable=no-name-in-module
Expand All @@ -25,10 +26,6 @@

from .common_test_func import async_func

py11 = False
if sys.version_info >= (3, 11):
py11 = True


class TestAsyncioTaskgroup(TestBase):
@patch.dict(
Expand All @@ -46,11 +43,11 @@ def tearDown(self):
super().tearDown()
AsyncioInstrumentor().uninstrument()

@skipIf(
sys.version_info < (3, 11),
"TaskGroup is only available in Python 3.11+",
)
def test_task_group_create_task(self):
# TaskGroup is only available in Python 3.11+
if not py11:
return

async def main():
async with asyncio.TaskGroup() as tg: # pylint: disable=no-member
for _ in range(10):
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
# limitations under the License.
import asyncio
import sys
from unittest import skipIf
from unittest.mock import patch

# pylint: disable=no-name-in-module
Expand Down Expand Up @@ -40,34 +41,34 @@ def tearDown(self):
super().tearDown()
AsyncioInstrumentor().uninstrument()

@skipIf(
sys.version_info < (3, 9), "to_thread is only available in Python 3.9+"
)
def test_to_thread(self):
# to_thread is only available in Python 3.9+
if sys.version_info >= (3, 9):

def multiply(x, y):
return x * y
def multiply(x, y):
return x * y

async def to_thread():
result = await asyncio.to_thread(multiply, 2, 3)
assert result == 6
async def to_thread():
result = await asyncio.to_thread(multiply, 2, 3)
assert result == 6

with self._tracer.start_as_current_span("root"):
asyncio.run(to_thread())
spans = self.memory_exporter.get_finished_spans()
with self._tracer.start_as_current_span("root"):
asyncio.run(to_thread())
spans = self.memory_exporter.get_finished_spans()

self.assertEqual(len(spans), 2)
assert spans[0].name == "asyncio to_thread-multiply"
for metric in (
self.memory_metrics_reader.get_metrics_data()
.resource_metrics[0]
.scope_metrics[0]
.metrics
):
if metric.name == "asyncio.process.duration":
for point in metric.data.data_points:
self.assertEqual(point.attributes["type"], "to_thread")
self.assertEqual(point.attributes["name"], "multiply")
if metric.name == "asyncio.process.created":
for point in metric.data.data_points:
self.assertEqual(point.attributes["type"], "to_thread")
self.assertEqual(point.attributes["name"], "multiply")
self.assertEqual(len(spans), 2)
assert spans[0].name == "asyncio to_thread-multiply"
for metric in (
self.memory_metrics_reader.get_metrics_data()
.resource_metrics[0]
.scope_metrics[0]
.metrics
):
if metric.name == "asyncio.process.duration":
for point in metric.data.data_points:
self.assertEqual(point.attributes["type"], "to_thread")
self.assertEqual(point.attributes["name"], "multiply")
if metric.name == "asyncio.process.created":
for point in metric.data.data_points:
self.assertEqual(point.attributes["type"], "to_thread")
self.assertEqual(point.attributes["name"], "multiply")

0 comments on commit 60fb936

Please sign in to comment.