test: Adding functional tests for MySQL integration (#526)

E2E verification for span creation using mysql and dbapi integrations

Author: hectorhdzg

ext/opentelemetry-ext-docker-tests/tests/check_availability.py

@@ -1,4 +1,4 @@
-# Copyright 2020, OpenTelemetry Authors
+# 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.
@@ -11,17 +11,23 @@
 # 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 logging
 import os
 import time
-import traceback
 
+import mysql.connector
 import psycopg2
 import pymongo
 
 MONGODB_COLLECTION_NAME = "test"
 MONGODB_DB_NAME = os.getenv("MONGODB_DB_NAME", "opentelemetry-tests")
 MONGODB_HOST = os.getenv("MONGODB_HOST", "localhost")
 MONGODB_PORT = int(os.getenv("MONGODB_PORT", "27017"))
+MYSQL_DB_NAME = os.getenv("MYSQL_DB_NAME ", "opentelemetry-tests")
+MYSQL_HOST = os.getenv("MYSQL_HOST ", "localhost")
+MYSQL_PORT = int(os.getenv("MYSQL_PORT ", "3306"))
+MYSQL_USER = os.getenv("MYSQL_USER ", "testuser")
+MYSQL_PASSWORD = os.getenv("MYSQL_PASSWORD ", "testpassword")
 POSTGRES_DB_NAME = os.getenv("POSTGRESQL_DB_NAME", "opentelemetry-tests")
 POSTGRES_HOST = os.getenv("POSTGRESQL_HOST", "localhost")
 POSTGRES_PASSWORD = os.getenv("POSTGRESQL_HOST", "testpassword")
@@ -30,6 +36,8 @@
 RETRY_COUNT = 5
 RETRY_INTERVAL = 5  # Seconds
 
+logger = logging.getLogger(__name__)
+
 
 def check_pymongo_connection():
     # Try to connect to DB
@@ -46,7 +54,27 @@ def check_pymongo_connection():
         except Exception as ex:
             if i == RETRY_COUNT - 1:
                 raise (ex)
-            traceback.print_exc()
+            logger.exception(ex)
+        time.sleep(RETRY_INTERVAL)
+
+
+def check_mysql_connection():
+    # Try to connect to DB
+    for i in range(RETRY_COUNT):
+        try:
+            connection = mysql.connector.connect(
+                user=MYSQL_USER,
+                password=MYSQL_PASSWORD,
+                host=MYSQL_HOST,
+                port=MYSQL_PORT,
+                database=MYSQL_DB_NAME,
+            )
+            connection.close()
+            break
+        except Exception as ex:
+            if i == RETRY_COUNT - 1:
+                raise (ex)
+            logger.exception(ex)
         time.sleep(RETRY_INTERVAL)
 
 
@@ -66,13 +94,14 @@ def check_postgres_connection():
         except Exception as ex:
             if i == RETRY_COUNT - 1:
                 raise (ex)
-            traceback.print_exc()
+            logger.exception(ex)
         time.sleep(RETRY_INTERVAL)
 
 
 def check_docker_services_availability():
     # Check if Docker services accept connections
     check_pymongo_connection()
+    check_mysql_connection()
     check_postgres_connection()
 
 

ext/opentelemetry-ext-docker-tests/tests/docker-compose.yml

@@ -5,7 +5,16 @@ services:
     ports:
      - "27017:27017"
     image: mongo:latest
-
+  otmysql:
+      ports:
+       - "3306:3306"
+      image: mysql:latest
+      restart: always
+      environment:
+        MYSQL_USER: testuser
+        MYSQL_PASSWORD: testpassword
+        MYSQL_ALLOW_EMPTY_PASSWORD: "yes"
+        MYSQL_DATABASE: opentelemetry-tests
   otpostgres:
     image: postgres
     ports:

ext/opentelemetry-ext-docker-tests/tests/mysql/test_mysql_functional.py

@@ -0,0 +1,108 @@
+# 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 os
+import time
+import unittest
+
+import mysql.connector
+
+from opentelemetry import trace as trace_api
+from opentelemetry.ext.mysql import trace_integration
+from opentelemetry.sdk.trace import Tracer, TracerProvider
+from opentelemetry.sdk.trace.export import SimpleExportSpanProcessor
+from opentelemetry.sdk.trace.export.in_memory_span_exporter import (
+    InMemorySpanExporter,
+)
+
+MYSQL_USER = os.getenv("MYSQL_USER ", "testuser")
+MYSQL_PASSWORD = os.getenv("MYSQL_PASSWORD ", "testpassword")
+MYSQL_HOST = os.getenv("MYSQL_HOST ", "localhost")
+MYSQL_PORT = int(os.getenv("MYSQL_PORT ", "3306"))
+MYSQL_DB_NAME = os.getenv("MYSQL_DB_NAME ", "opentelemetry-tests")
+
+
+class TestFunctionalMysql(unittest.TestCase):
+    @classmethod
+    def setUpClass(cls):
+        cls._connection = None
+        cls._cursor = None
+        cls._tracer_provider = TracerProvider()
+        cls._tracer = Tracer(cls._tracer_provider, None)
+        cls._span_exporter = InMemorySpanExporter()
+        cls._span_processor = SimpleExportSpanProcessor(cls._span_exporter)
+        cls._tracer_provider.add_span_processor(cls._span_processor)
+        trace_integration(cls._tracer)
+        cls._connection = mysql.connector.connect(
+            user=MYSQL_USER,
+            password=MYSQL_PASSWORD,
+            host=MYSQL_HOST,
+            port=MYSQL_PORT,
+            database=MYSQL_DB_NAME,
+        )
+        cls._cursor = cls._connection.cursor()
+
+    @classmethod
+    def tearDownClass(cls):
+        if cls._connection:
+            cls._connection.close()
+
+    def setUp(self):
+        self._span_exporter.clear()
+
+    def validate_spans(self):
+        spans = self._span_exporter.get_finished_spans()
+        self.assertEqual(len(spans), 2)
+        for span in spans:
+            if span.name == "rootSpan":
+                root_span = span
+            else:
+                db_span = span
+            self.assertIsInstance(span.start_time, int)
+            self.assertIsInstance(span.end_time, int)
+        self.assertIsNotNone(root_span)
+        self.assertIsNotNone(db_span)
+        self.assertEqual(root_span.name, "rootSpan")
+        self.assertEqual(db_span.name, "mysql.opentelemetry-tests")
+        self.assertIsNotNone(db_span.parent)
+        self.assertEqual(db_span.parent.name, root_span.name)
+        self.assertIs(db_span.kind, trace_api.SpanKind.CLIENT)
+        self.assertEqual(db_span.attributes["db.instance"], MYSQL_DB_NAME)
+        self.assertEqual(db_span.attributes["net.peer.name"], MYSQL_HOST)
+        self.assertEqual(db_span.attributes["net.peer.port"], MYSQL_PORT)
+
+    def test_execute(self):
+        """Should create a child span for execute
+        """
+        with self._tracer.start_as_current_span("rootSpan"):
+            self._cursor.execute("CREATE TABLE IF NOT EXISTS test (id INT)")
+        self.validate_spans()
+
+    def test_executemany(self):
+        """Should create a child span for executemany
+        """
+        with self._tracer.start_as_current_span("rootSpan"):
+            data = ["1", "2", "3"]
+            stmt = "INSERT INTO test (id) VALUES (%s)"
+            self._cursor.executemany(stmt, data)
+        self.validate_spans()
+
+    def test_callproc(self):
+        """Should create a child span for callproc
+        """
+        with self._tracer.start_as_current_span("rootSpan"), self.assertRaises(
+            Exception
+        ):
+            self._cursor.callproc("test", ())
+            self.validate_spans()

tox.ini

@@ -259,6 +259,7 @@ commands =
 deps =
   pytest
   docker-compose >= 1.25.2
+  mysql-connector-python ~=  8.0
   pymongo ~= 3.1
   psycopg2 ~= 2.8.4
 
@@ -269,6 +270,7 @@ commands_pre =
   pip install -e {toxinidir}/opentelemetry-api \
               -e {toxinidir}/opentelemetry-sdk \
               -e {toxinidir}/ext/opentelemetry-ext-dbapi \
+              -e {toxinidir}/ext/opentelemetry-ext-mysql \
               -e {toxinidir}/ext/opentelemetry-ext-psycopg2 \
               -e {toxinidir}/ext/opentelemetry-ext-pymongo
   docker-compose up -d