|
| 1 | +# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. |
| 2 | +# SPDX-License-Identifier: Apache-2.0 |
| 3 | +from typing import Dict, List |
| 4 | + |
| 5 | +from mock_collector_client import ResourceScopeMetric, ResourceScopeSpan |
| 6 | +from testcontainers.mysql import MySqlContainer |
| 7 | +from typing_extensions import override |
| 8 | + |
| 9 | +from amazon.base.contract_test_base import NETWORK_NAME, ContractTestBase |
| 10 | +from amazon.utils.application_signals_constants import ( |
| 11 | + AWS_LOCAL_OPERATION, |
| 12 | + AWS_LOCAL_SERVICE, |
| 13 | + AWS_REMOTE_OPERATION, |
| 14 | + AWS_REMOTE_RESOURCE_IDENTIFIER, |
| 15 | + AWS_REMOTE_RESOURCE_TYPE, |
| 16 | + AWS_REMOTE_SERVICE, |
| 17 | + AWS_SPAN_KIND, |
| 18 | +) |
| 19 | +from opentelemetry.proto.common.v1.common_pb2 import AnyValue, KeyValue |
| 20 | +from opentelemetry.proto.metrics.v1.metrics_pb2 import ExponentialHistogramDataPoint, Metric |
| 21 | +from opentelemetry.proto.trace.v1.trace_pb2 import Span |
| 22 | +from opentelemetry.trace import StatusCode |
| 23 | + |
| 24 | + |
| 25 | +class PyMysqlTest(ContractTestBase): |
| 26 | + @override |
| 27 | + @classmethod |
| 28 | + def set_up_dependency_container(cls) -> None: |
| 29 | + cls.container = ( |
| 30 | + MySqlContainer(MYSQL_USER="dbuser", MYSQL_PASSWORD="example", MYSQL_DATABASE="testdb") |
| 31 | + .with_kwargs(network=NETWORK_NAME) |
| 32 | + .with_name("mydb") |
| 33 | + ) |
| 34 | + cls.container.start() |
| 35 | + |
| 36 | + @override |
| 37 | + @classmethod |
| 38 | + def tear_down_dependency_container(cls) -> None: |
| 39 | + cls.container.stop() |
| 40 | + |
| 41 | + @override |
| 42 | + def get_application_extra_environment_variables(self) -> Dict[str, str]: |
| 43 | + return { |
| 44 | + "DB_HOST": "mydb", |
| 45 | + "DB_USER": "dbuser", |
| 46 | + "DB_PASS": "example", |
| 47 | + "DB_NAME": "testdb", |
| 48 | + } |
| 49 | + |
| 50 | + @override |
| 51 | + def get_application_image_name(self) -> str: |
| 52 | + return "aws-application-signals-tests-pymysql-app" |
| 53 | + |
| 54 | + def test_success(self) -> None: |
| 55 | + self.mock_collector_client.clear_signals() |
| 56 | + self.do_test_requests("success", "GET", 200, 0, 0, sql_command="DROP TABLE") |
| 57 | + |
| 58 | + def test_fault(self) -> None: |
| 59 | + self.mock_collector_client.clear_signals() |
| 60 | + self.do_test_requests("fault", "GET", 500, 0, 1, sql_command="SELECT DISTINCT") |
| 61 | + |
| 62 | + @override |
| 63 | + def _assert_aws_span_attributes(self, resource_scope_spans: List[ResourceScopeSpan], path: str, **kwargs) -> None: |
| 64 | + target_spans: List[Span] = [] |
| 65 | + for resource_scope_span in resource_scope_spans: |
| 66 | + # pylint: disable=no-member |
| 67 | + if resource_scope_span.span.kind == Span.SPAN_KIND_CLIENT: |
| 68 | + target_spans.append(resource_scope_span.span) |
| 69 | + |
| 70 | + self.assertEqual(len(target_spans), 1) |
| 71 | + self._assert_aws_attributes(target_spans[0].attributes, **kwargs) |
| 72 | + |
| 73 | + @override |
| 74 | + def _assert_aws_attributes(self, attributes_list: List[KeyValue], **kwargs) -> None: |
| 75 | + attributes_dict: Dict[str, AnyValue] = self._get_attributes_dict(attributes_list) |
| 76 | + self._assert_str_attribute(attributes_dict, AWS_LOCAL_SERVICE, self.get_application_otel_service_name()) |
| 77 | + # InternalOperation as OTEL does not instrument the basic server we are using, so the client span is a local |
| 78 | + # root. |
| 79 | + self._assert_str_attribute(attributes_dict, AWS_LOCAL_OPERATION, "InternalOperation") |
| 80 | + self._assert_str_attribute(attributes_dict, AWS_REMOTE_SERVICE, "mysql") |
| 81 | + command: str = kwargs.get("sql_command") |
| 82 | + self._assert_str_attribute(attributes_dict, AWS_REMOTE_OPERATION, f"{command}") |
| 83 | + self._assert_str_attribute(attributes_dict, AWS_REMOTE_RESOURCE_TYPE, "DB::Connection") |
| 84 | + self._assert_str_attribute(attributes_dict, AWS_REMOTE_RESOURCE_IDENTIFIER, "testdb|mydb|3306") |
| 85 | + # See comment above AWS_LOCAL_OPERATION |
| 86 | + self._assert_str_attribute(attributes_dict, AWS_SPAN_KIND, "LOCAL_ROOT") |
| 87 | + |
| 88 | + @override |
| 89 | + def _assert_semantic_conventions_span_attributes( |
| 90 | + self, resource_scope_spans: List[ResourceScopeSpan], method: str, path: str, status_code: int, **kwargs |
| 91 | + ) -> None: |
| 92 | + target_spans: List[Span] = [] |
| 93 | + for resource_scope_span in resource_scope_spans: |
| 94 | + # pylint: disable=no-member |
| 95 | + if resource_scope_span.span.kind == Span.SPAN_KIND_CLIENT: |
| 96 | + target_spans.append(resource_scope_span.span) |
| 97 | + |
| 98 | + self.assertEqual(target_spans[0].name, kwargs.get("sql_command").split()[0]) |
| 99 | + if status_code == 200: |
| 100 | + self.assertEqual(target_spans[0].status.code, StatusCode.UNSET.value) |
| 101 | + else: |
| 102 | + self.assertEqual(target_spans[0].status.code, StatusCode.ERROR.value) |
| 103 | + |
| 104 | + self._assert_semantic_conventions_attributes(target_spans[0].attributes, kwargs.get("sql_command")) |
| 105 | + |
| 106 | + def _assert_semantic_conventions_attributes(self, attributes_list: List[KeyValue], command: str) -> None: |
| 107 | + attributes_dict: Dict[str, AnyValue] = self._get_attributes_dict(attributes_list) |
| 108 | + self.assertTrue(attributes_dict.get("db.statement").string_value.startswith(command)) |
| 109 | + self._assert_str_attribute(attributes_dict, "db.system", "mysql") |
| 110 | + self._assert_str_attribute(attributes_dict, "db.name", "testdb") |
| 111 | + self._assert_str_attribute(attributes_dict, "net.peer.name", "mydb") |
| 112 | + self._assert_int_attribute(attributes_dict, "net.peer.port", 3306) |
| 113 | + self.assertTrue("server.address" not in attributes_dict) |
| 114 | + self.assertTrue("server.port" not in attributes_dict) |
| 115 | + self.assertTrue("db.operation" not in attributes_dict) |
| 116 | + |
| 117 | + @override |
| 118 | + def _assert_metric_attributes( |
| 119 | + self, resource_scope_metrics: List[ResourceScopeMetric], metric_name: str, expected_sum: int, **kwargs |
| 120 | + ) -> None: |
| 121 | + target_metrics: List[Metric] = [] |
| 122 | + for resource_scope_metric in resource_scope_metrics: |
| 123 | + if resource_scope_metric.metric.name.lower() == metric_name.lower(): |
| 124 | + target_metrics.append(resource_scope_metric.metric) |
| 125 | + |
| 126 | + self.assertEqual(len(target_metrics), 1) |
| 127 | + target_metric: Metric = target_metrics[0] |
| 128 | + dp_list: List[ExponentialHistogramDataPoint] = target_metric.exponential_histogram.data_points |
| 129 | + |
| 130 | + self.assertEqual(len(dp_list), 2) |
| 131 | + dependency_dp: ExponentialHistogramDataPoint = dp_list[0] |
| 132 | + service_dp: ExponentialHistogramDataPoint = dp_list[1] |
| 133 | + if len(dp_list[1].attributes) > len(dp_list[0].attributes): |
| 134 | + dependency_dp = dp_list[1] |
| 135 | + service_dp = dp_list[0] |
| 136 | + attribute_dict: Dict[str, AnyValue] = self._get_attributes_dict(dependency_dp.attributes) |
| 137 | + self._assert_str_attribute(attribute_dict, AWS_LOCAL_SERVICE, self.get_application_otel_service_name()) |
| 138 | + # See comment on AWS_LOCAL_OPERATION in _assert_aws_attributes |
| 139 | + self._assert_str_attribute(attribute_dict, AWS_LOCAL_OPERATION, "InternalOperation") |
| 140 | + self._assert_str_attribute(attribute_dict, AWS_REMOTE_SERVICE, "mysql") |
| 141 | + self._assert_str_attribute(attribute_dict, AWS_REMOTE_OPERATION, kwargs.get("sql_command")) |
| 142 | + self._assert_str_attribute(attribute_dict, AWS_REMOTE_RESOURCE_TYPE, "DB::Connection") |
| 143 | + self._assert_str_attribute(attribute_dict, AWS_REMOTE_RESOURCE_IDENTIFIER, "testdb|mydb|3306") |
| 144 | + self._assert_str_attribute(attribute_dict, AWS_SPAN_KIND, "CLIENT") |
| 145 | + self.check_sum(metric_name, dependency_dp.sum, expected_sum) |
| 146 | + |
| 147 | + attribute_dict: Dict[str, AnyValue] = self._get_attributes_dict(service_dp.attributes) |
| 148 | + # See comment on AWS_LOCAL_OPERATION in _assert_aws_attributes |
| 149 | + self._assert_str_attribute(attribute_dict, AWS_LOCAL_OPERATION, "InternalOperation") |
| 150 | + self._assert_str_attribute(attribute_dict, AWS_SPAN_KIND, "LOCAL_ROOT") |
| 151 | + self.check_sum(metric_name, service_dp.sum, expected_sum) |
0 commit comments