Skip to content

Cherrypy instrumentation docs tests #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Dec 6, 2022
Merged

Cherrypy instrumentation docs tests #4

Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
7dd8d6b
added new testcases related to basic rest api calls and spans check f…
Nov 28, 2022
065a16a
added tox changes and metrices testcases and fixed review comments
Nov 29, 2022
358af86
added metrices testcases and review comments fixed
Nov 29, 2022
b0d3410
added fixes for review comments
Nov 29, 2022
b322709
Merge branch 'cherrypy-instrumentation' into cherrypy-instrumentation…
rahulmukherjee68 Nov 29, 2022
3f17446
added custom header testcases for instrumentation
Dec 5, 2022
243a234
Merge branch 'cherrypy-instrumentation-docs-tests' of https://github.…
Dec 5, 2022
60d0895
Merge branch 'cherrypy-instrumentation' into cherrypy-instrumentation…
rahulmukherjee68 Dec 5, 2022
4184b37
removed print statements
Dec 5, 2022
9e182d1
added return statement to cherrypy app
Dec 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
215 changes: 207 additions & 8 deletions instrumentation/opentelemetry-instrumentation-cherrypy/tests/test_cherrypy.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,17 @@
#
from timeit import default_timer
from unittest.mock import Mock, patch
import unittest

import pytest
import os
from cherrypy import __version__ as _cherrypy_verison
import cherrypy
from cherrypy.test import helper
from packaging import version as package_version

from opentelemetry import trace
from opentelemetry.test.globals_test import reset_trace_globals
from opentelemetry.instrumentation.cherrypy import CherryPyInstrumentor
from opentelemetry.instrumentation.propagators import (
TraceResponsePropagator,
Expand All @@ -44,6 +47,9 @@
from opentelemetry.util.http import (
OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_REQUEST,
OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_RESPONSE,
_active_requests_count_attrs,
_duration_attrs,
get_excluded_urls,
)


Expand All @@ -62,11 +68,16 @@ def setUp(self):
self.env_patch = patch.dict(
"os.environ",
{
"OTEL_PYTHON_CHERRYPY_EXCLUDED_URLS": "ping",
"OTEL_PYTHON_CHERRYPY_EXCLUDED_URLS": "exclude,healthzz",
"OTEL_PYTHON_CHERRYPY_TRACED_REQUEST_ATTRS": "query_string",
},
)
self.env_patch.start()
self.exclude_patch = patch(
"opentelemetry.instrumentation.cherrypy._excluded_urls_from_env",
get_excluded_urls("CHERRYPY"),
)
self.exclude_patch.start()

CherryPyInstrumentor().instrument(
request_hook=getattr(self, "request_hook", None),
Expand All @@ -90,8 +101,8 @@ def user(self, username):
return {"user": username}

@cherrypy.expose
def exclude(self, param):
return {"message": param}
def exclude(self):
return "excluded route"

@cherrypy.expose
def healthzz(self):
Expand All @@ -100,17 +111,25 @@ def healthzz(self):
@cherrypy.expose
def error(self):
raise cherrypy.HTTPError(500, 'error')

@cherrypy.expose
def check_header(self):
cherrypy.response.headers["custom-test-header-1"]="test-header-value-1"
cherrypy.response.headers["custom-test-header-2"]="test-header-value-2"
content = {"message": "hello world"}
return content

return cherrypy.tree.mount(CherryPyApp())

def tearDown(self):
super().tearDown()
self.exclude_patch.stop()
with self.disable_logging():
CherryPyInstrumentor().uninstrument()
self.env_patch.stop()


class TestCherryPyInstrumentation(TestCherryPyBase, WsgiTestBase):
class TestCherryPyAutoInstrumentation(TestCherryPyBase, WsgiTestBase):
def test_get(self):
self._test_method("GET")

Expand Down Expand Up @@ -212,7 +231,7 @@ def test_500(self):
self.memory_exporter.clear()

def test_uninstrument(self):
self.call(method="GET", url="/healthzz")
self.call(method="GET", url="/hello")
spans = self.memory_exporter.get_finished_spans()
self.assertEqual(len(spans), 1)

Expand All @@ -222,6 +241,14 @@ def test_uninstrument(self):
self.setup_server()
spans = self.memory_exporter.get_finished_spans()
self.assertEqual(len(spans), 0)

def test_exclude_lists(self):
self.call(method="GET", url="/exclude")
span_list = self.memory_exporter.get_finished_spans()
self.assertEqual(len(span_list), 0)
self.call(method="GET", url="/healthzz")
span_list = self.memory_exporter.get_finished_spans()
self.assertEqual(len(span_list), 0)

def test_cherrypy_metrics(self):
self.setup_server()
Expand Down Expand Up @@ -286,8 +313,6 @@ def test_basic_metric_success(self):
self.assertEqual(point.count, 1)
self.assertAlmostEqual(duration, point.sum, delta=30)
if isinstance(point, NumberDataPoint):
print(expected_requests_count_attributes)
print(dict(point.attributes))
self.assertDictEqual(
expected_requests_count_attributes,
dict(point.attributes),
Expand All @@ -309,6 +334,180 @@ def test_basic_post_request_metric_success(self):
self.assertAlmostEqual(duration, point.sum, delta=30)
if isinstance(point, NumberDataPoint):
self.assertEqual(point.value, 0)


class TestCherryPyCustomHeaders(TestBase, helper.CPWebCase):

def setUp(self):
super().setUp()
self.env_patch = patch.dict(
"os.environ",
{
OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_REQUEST: "Custom-Test-Header-1,Custom-Test-Header-2,Custom-Test-Header-3",
OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_RESPONSE: "Custom-Test-Header-1,Custom-Test-Header-2,Custom-Test-Header-3",
},
)
self.env_patch.start()
CherryPyInstrumentor().instrument()


def call(self, *args, **kwargs):
self.setup_server()
return self.getPage(*args, **kwargs)


@staticmethod
def setup_server():
class CherryPyApp(object):

@cherrypy.expose
def check_header(self):
cherrypy.response.headers["custom-test-header-1"]="test-header-value-1"
cherrypy.response.headers["custom-test-header-2"]="test-header-value-2"
content = {"message": "hello world"}
return content

return cherrypy.tree.mount(CherryPyApp())

def tearDown(self):
super().tearDown()
with self.disable_logging():
CherryPyInstrumentor().uninstrument()
self.env_patch.stop()

def test_http_custom_request_headers_in_span_attributes(self):
expected = {
"http.request.header.custom_test_header_1": (
"test-header-value-1",
),
"http.request.header.custom_test_header_2": (
"test-header-value-2",
),
}
resp = self.call(
url="/check_header",
headers=[
("custom-test-header-1","test-header-value-1"),
("custom-test-header-2","test-header-value-2"),
],
)
self.assertEqual('200 OK', resp[0])
span_list = self.memory_exporter.get_finished_spans()
self.assertEqual(len(span_list), 1)

server_span = [
span for span in span_list if span.kind == trace.SpanKind.SERVER
][0]

self.assertSpanHasAttributes(server_span, expected)

def test_http_custom_request_headers_not_in_span_attributes(self):
not_expected = {
"http.request.header.custom_test_header_3": (
"test-header-value-3",
),
}
resp = self.call(
url="/check_header",
headers=[
("custom-test-header-1","test-header-value-1"),
("custom-test-header-2","test-header-value-2"),
],
)
self.assertEqual('200 OK', resp[0])
span_list = self.memory_exporter.get_finished_spans()
self.assertEqual(len(span_list), 1)

server_span = [
span for span in span_list if span.kind == trace.SpanKind.SERVER
][0]

for key, _ in not_expected.items():
self.assertNotIn(key, server_span.attributes)

def test_http_custom_response_headers_in_span_attributes(self):
expected = {
"http.response.header.custom_test_header_1": (
"test-header-value-1",
),
"http.response.header.custom_test_header_2": (
"test-header-value-2",
),
}
resp = self.call(url="/check_header")
self.assertEqual('200 OK', resp[0])
span_list = self.memory_exporter.get_finished_spans()
self.assertEqual(len(span_list), 1)

server_span = [
span for span in span_list if span.kind == trace.SpanKind.SERVER
][0]
self.assertSpanHasAttributes(server_span, expected)

def test_http_custom_response_headers_not_in_span_attributes(self):
not_expected = {
"http.response.header.custom_test_header_3": (
"test-header-value-3",
),
}
resp = self.call(url="/check_header")
self.assertEqual('200 OK', resp[0])
span_list = self.memory_exporter.get_finished_spans()
self.assertEqual(len(span_list), 1)

server_span = [
span for span in span_list if span.kind == trace.SpanKind.SERVER
][0]

for key, _ in not_expected.items():
self.assertNotIn(key, server_span.attributes)

class TestNonRecordingSpanWithCustomHeaders(TestBase, helper.CPWebCase):
def setUp(self):
super().setUp()
self.env_patch = patch.dict(
"os.environ",
{
OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_REQUEST: "Custom-Test-Header-1,Custom-Test-Header-2,Custom-Test-Header-3",
},
)
self.env_patch.start()

reset_trace_globals()
tracer_provider = trace.NoOpTracerProvider()
trace.set_tracer_provider(tracer_provider=tracer_provider)

self._instrumentor = CherryPyInstrumentor()
self._instrumentor.instrument()

def call(self, *args, **kwargs):
self.setup_server()
return self.getPage(*args, **kwargs)

@staticmethod
def setup_server():
class CherryPyApp(object):

@cherrypy.expose
def check_header(self):
content = {"message": "hello world"}
return content

return cherrypy.tree.mount(CherryPyApp())

def tearDown(self):
super().tearDown()
with self.disable_logging():
CherryPyInstrumentor().uninstrument()
self.env_patch.stop()

def test_custom_header_not_present_in_non_recording_span(self):
resp = self.call(
url="/check_header",
headers=[
("custom-test-header-1","test-header-value-1"),
],
)
self.assertEqual('200 OK', resp[0])
span_list = self.memory_exporter.get_finished_spans()
self.assertEqual(len(span_list), 0)