opentelemetry-instrumentation-falcon: prepare tests for v4

Author: stevapple

instrumentation/opentelemetry-instrumentation-falcon/tests/app.py

@@ -4,12 +4,13 @@
 # pylint:disable=R0201,W0613,E0602
 
 
+_parsed_falcon_version = package_version.parse(falcon.__version__)
+
 class HelloWorldResource:
     def _handle_request(self, _, resp):
         # pylint: disable=no-member
         resp.status = falcon.HTTP_201
 
-        _parsed_falcon_version = package_version.parse(falcon.__version__)
         if _parsed_falcon_version < package_version.parse("3.0.0"):
             # Falcon 1 and Falcon 2
             resp.body = "Hello World"
@@ -65,11 +66,15 @@ class UserResource:
     def on_get(self, req, resp, user_id):
         # pylint: disable=no-member
         resp.status = falcon.HTTP_200
-        resp.body = f"Hello user {user_id}"
+
+        if _parsed_falcon_version < package_version.parse("3.0.0"):
+            # Falcon 1 and Falcon 2
+            resp.body = f"Hello user {user_id}"
+        else:
+            resp.text = f"Hello user {user_id}"
 
 
 def make_app():
-    _parsed_falcon_version = package_version.parse(falcon.__version__)
     if _parsed_falcon_version < package_version.parse("3.0.0"):
         # Falcon 1 and Falcon 2
         app = falcon.API()

instrumentation/opentelemetry-instrumentation-falcon/tests/test_falcon.py

@@ -124,20 +124,30 @@ def _test_method(self, method):
                 SpanAttributes.HTTP_SCHEME: "http",
                 SpanAttributes.NET_HOST_PORT: 80,
                 SpanAttributes.HTTP_HOST: "falconframework.org",
-                SpanAttributes.HTTP_TARGET: "/",
                 SpanAttributes.NET_PEER_PORT: 65133,
                 SpanAttributes.HTTP_FLAVOR: "1.1",
                 "falcon.resource": "HelloWorldResource",
                 SpanAttributes.HTTP_STATUS_CODE: 201,
             },
         )
         # In falcon<3, NET_PEER_IP is always set by default to 127.0.0.1
-        # In falcon>3, NET_PEER_IP is not set to anything by default to
+        # In falcon>=3, NET_PEER_IP is not set to anything by default
         # https://github.com/falconry/falcon/blob/5233d0abed977d9dab78ebadf305f5abe2eef07c/falcon/testing/helpers.py#L1168-L1172 # noqa
         if SpanAttributes.NET_PEER_IP in span.attributes:
             self.assertEqual(
                 span.attributes[SpanAttributes.NET_PEER_IP], "127.0.0.1"
             )
+        # In falcon<3.1.2, HTTP_TARGET is always set to / in TestClient
+        # In falcon>=3.1.2, HTTP_TARGET is set to unencoded path by default
+        # https://github.com/falconry/falcon/blob/69cdcd6edd2ee33f4ac9f7793e1cc3c4f99da692/falcon/testing/helpers.py#L1153-1156 # noqa
+        if package_version.parse(_falcon_version) < package_version.parse("3.1.2"):
+            self.assertEqual(
+                span.attributes[SpanAttributes.HTTP_TARGET], "/"
+            )
+        else:
+            self.assertEqual(
+                span.attributes[SpanAttributes.HTTP_TARGET], "/hello"
+            )
         self.memory_exporter.clear()
 
     def test_404(self):
@@ -155,19 +165,29 @@ def test_404(self):
                 SpanAttributes.HTTP_SCHEME: "http",
                 SpanAttributes.NET_HOST_PORT: 80,
                 SpanAttributes.HTTP_HOST: "falconframework.org",
-                SpanAttributes.HTTP_TARGET: "/",
                 SpanAttributes.NET_PEER_PORT: 65133,
                 SpanAttributes.HTTP_FLAVOR: "1.1",
                 SpanAttributes.HTTP_STATUS_CODE: 404,
             },
         )
         # In falcon<3, NET_PEER_IP is always set by default to 127.0.0.1
-        # In falcon>3, NET_PEER_IP is not set to anything by default to
+        # In falcon>=3.1.2, HTTP_TARGET is set to unencoded path by default
         # https://github.com/falconry/falcon/blob/5233d0abed977d9dab78ebadf305f5abe2eef07c/falcon/testing/helpers.py#L1168-L1172 # noqa
         if SpanAttributes.NET_PEER_IP in span.attributes:
             self.assertEqual(
                 span.attributes[SpanAttributes.NET_PEER_IP], "127.0.0.1"
             )
+        # In falcon<3.1.2, HTTP_TARGET is always set to / in TestClient
+        # In falcon>=3.1.2, HTTP_TARGET is set to unencoded path by default
+        # https://github.com/falconry/falcon/blob/69cdcd6edd2ee33f4ac9f7793e1cc3c4f99da692/falcon/testing/helpers.py#L1153-1156 # noqa
+        if package_version.parse(_falcon_version) < package_version.parse("3.1.2"):
+            self.assertEqual(
+                span.attributes[SpanAttributes.HTTP_TARGET], "/"
+            )
+        else:
+            self.assertEqual(
+                span.attributes[SpanAttributes.HTTP_TARGET], "/does-not-exist"
+            )
 
     def test_500(self):
         try:
@@ -192,19 +212,29 @@ def test_500(self):
                 SpanAttributes.HTTP_SCHEME: "http",
                 SpanAttributes.NET_HOST_PORT: 80,
                 SpanAttributes.HTTP_HOST: "falconframework.org",
-                SpanAttributes.HTTP_TARGET: "/",
                 SpanAttributes.NET_PEER_PORT: 65133,
                 SpanAttributes.HTTP_FLAVOR: "1.1",
                 SpanAttributes.HTTP_STATUS_CODE: 500,
             },
         )
         # In falcon<3, NET_PEER_IP is always set by default to 127.0.0.1
-        # In falcon>3, NET_PEER_IP is not set to anything by default to
+        # In falcon>=3, NET_PEER_IP is not set to anything by default
         # https://github.com/falconry/falcon/blob/5233d0abed977d9dab78ebadf305f5abe2eef07c/falcon/testing/helpers.py#L1168-L1172 # noqa
         if SpanAttributes.NET_PEER_IP in span.attributes:
             self.assertEqual(
                 span.attributes[SpanAttributes.NET_PEER_IP], "127.0.0.1"
             )
+        # In falcon<3.1.2, HTTP_TARGET is always set to / in TestClient
+        # In falcon>=3.1.2, HTTP_TARGET is set to unencoded path by default
+        # https://github.com/falconry/falcon/blob/69cdcd6edd2ee33f4ac9f7793e1cc3c4f99da692/falcon/testing/helpers.py#L1153-1156 # noqa
+        if package_version.parse(_falcon_version) < package_version.parse("3.1.2"):
+            self.assertEqual(
+                span.attributes[SpanAttributes.HTTP_TARGET], "/"
+            )
+        else:
+            self.assertEqual(
+                span.attributes[SpanAttributes.HTTP_TARGET], "/error"
+            )
 
     def test_url_template(self):
         self.client().simulate_get("/user/123")
@@ -225,13 +255,23 @@ def test_url_template(self):
                 SpanAttributes.HTTP_SCHEME: "http",
                 SpanAttributes.NET_HOST_PORT: 80,
                 SpanAttributes.HTTP_HOST: "falconframework.org",
-                SpanAttributes.HTTP_TARGET: "/",
                 SpanAttributes.NET_PEER_PORT: 65133,
                 SpanAttributes.HTTP_FLAVOR: "1.1",
                 "falcon.resource": "UserResource",
                 SpanAttributes.HTTP_STATUS_CODE: 200,
             },
         )
+        # In falcon<3.1.2, HTTP_TARGET is always set to / in TestClient
+        # In falcon>=3.1.2, HTTP_TARGET is set to unencoded path by default
+        # https://github.com/falconry/falcon/blob/69cdcd6edd2ee33f4ac9f7793e1cc3c4f99da692/falcon/testing/helpers.py#L1153-1156 # noqa
+        if package_version.parse(_falcon_version) < package_version.parse("3.1.2"):
+            self.assertEqual(
+                span.attributes[SpanAttributes.HTTP_TARGET], "/"
+            )
+        else:
+            self.assertEqual(
+                span.attributes[SpanAttributes.HTTP_TARGET], "/user/123"
+            )
 
     def test_uninstrument(self):
         self.client().simulate_get(path="/hello")