Skip to content
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

Add context manager tests to db modules that conform to PEP-249 #449

Closed
wants to merge 3 commits into from
Closed

Add context manager tests to db modules that conform to PEP-249 #449

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
665827b
add ctx manager tests for pep249 based db modules
GSVarsha Aug 31, 2023
aadb409
remove commit for select statement
GSVarsha Aug 31, 2023
21ad5f3
Revert "remove commit for select statement"
GSVarsha Aug 31, 2023
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
205 changes: 156 additions & 49 deletions tests/clients/test_mysqlclient.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@

logger = logging.getLogger(__name__)

create_table_query = 'CREATE TABLE IF NOT EXISTS users(id serial primary key, \
name varchar(40) NOT NULL, email varchar(40) NOT NULL)'
create_table_query = "CREATE TABLE IF NOT EXISTS users(id serial primary key, \
name varchar(40) NOT NULL, email varchar(40) NOT NULL)"

create_proc_query = """
CREATE PROCEDURE test_proc(IN t VARCHAR(255))
Expand All @@ -28,17 +28,21 @@
END
"""

db = MySQLdb.connect(host=testenv['mysql_host'], port=testenv['mysql_port'],
user=testenv['mysql_user'], passwd=testenv['mysql_pw'],
db=testenv['mysql_db'])
db = MySQLdb.connect(
host=testenv["mysql_host"],
port=testenv["mysql_port"],
user=testenv["mysql_user"],
passwd=testenv["mysql_pw"],
db=testenv["mysql_db"],
)

cursor = db.cursor()
cursor.execute(create_table_query)

while cursor.nextset() is not None:
pass

cursor.execute('DROP PROCEDURE IF EXISTS test_proc')
cursor.execute("DROP PROCEDURE IF EXISTS test_proc")

while cursor.nextset() is not None:
pass
Expand All @@ -54,16 +58,20 @@

class TestMySQLPython(unittest.TestCase):
def setUp(self):
self.db = MySQLdb.connect(host=testenv['mysql_host'], port=testenv['mysql_port'],
user=testenv['mysql_user'], passwd=testenv['mysql_pw'],
db=testenv['mysql_db'])
self.db = MySQLdb.connect(
host=testenv["mysql_host"],
port=testenv["mysql_port"],
user=testenv["mysql_user"],
passwd=testenv["mysql_pw"],
db=testenv["mysql_db"],
)
self.cursor = self.db.cursor()
self.recorder = tracer.recorder
self.recorder.clear_spans()
tracer.cur_ctx = None

def tearDown(self):
""" Do nothing for now """
"""Do nothing for now"""
return None

def test_vanilla_query(self):
Expand All @@ -76,11 +84,11 @@ def test_vanilla_query(self):

def test_basic_query(self):
result = None
with tracer.start_active_span('test'):
with tracer.start_active_span("test"):
result = self.cursor.execute("""SELECT * from users""")
self.cursor.fetchone()

assert(result >= 0)
assert result >= 0

spans = self.recorder.queued_spans()
self.assertEqual(2, len(spans))
Expand All @@ -95,18 +103,19 @@ def test_basic_query(self):
self.assertEqual(None, db_span.ec)

self.assertEqual(db_span.n, "mysql")
self.assertEqual(db_span.data["mysql"]["db"], testenv['mysql_db'])
self.assertEqual(db_span.data["mysql"]["user"], testenv['mysql_user'])
self.assertEqual(db_span.data["mysql"]["stmt"], 'SELECT * from users')
self.assertEqual(db_span.data["mysql"]["host"], testenv['mysql_host'])
self.assertEqual(db_span.data["mysql"]["port"], testenv['mysql_port'])
self.assertEqual(db_span.data["mysql"]["db"], testenv["mysql_db"])
self.assertEqual(db_span.data["mysql"]["user"], testenv["mysql_user"])
self.assertEqual(db_span.data["mysql"]["stmt"], "SELECT * from users")
self.assertEqual(db_span.data["mysql"]["host"], testenv["mysql_host"])
self.assertEqual(db_span.data["mysql"]["port"], testenv["mysql_port"])

def test_basic_insert(self):
result = None
with tracer.start_active_span('test'):
with tracer.start_active_span("test"):
result = self.cursor.execute(
"""INSERT INTO users(name, email) VALUES(%s, %s)""",
('beaker', '[email protected]'))
"""INSERT INTO users(name, email) VALUES(%s, %s)""",
("beaker", "[email protected]"),
)

self.assertEqual(1, result)

Expand All @@ -123,17 +132,22 @@ def test_basic_insert(self):
self.assertEqual(None, db_span.ec)

self.assertEqual(db_span.n, "mysql")
self.assertEqual(db_span.data["mysql"]["db"], testenv['mysql_db'])
self.assertEqual(db_span.data["mysql"]["user"], testenv['mysql_user'])
self.assertEqual(db_span.data["mysql"]["stmt"], 'INSERT INTO users(name, email) VALUES(%s, %s)')
self.assertEqual(db_span.data["mysql"]["host"], testenv['mysql_host'])
self.assertEqual(db_span.data["mysql"]["port"], testenv['mysql_port'])
self.assertEqual(db_span.data["mysql"]["db"], testenv["mysql_db"])
self.assertEqual(db_span.data["mysql"]["user"], testenv["mysql_user"])
self.assertEqual(
db_span.data["mysql"]["stmt"],
"INSERT INTO users(name, email) VALUES(%s, %s)",
)
self.assertEqual(db_span.data["mysql"]["host"], testenv["mysql_host"])
self.assertEqual(db_span.data["mysql"]["port"], testenv["mysql_port"])

def test_executemany(self):
result = None
with tracer.start_active_span('test'):
result = self.cursor.executemany("INSERT INTO users(name, email) VALUES(%s, %s)",
[('beaker', '[email protected]'), ('beaker', '[email protected]')])
with tracer.start_active_span("test"):
result = self.cursor.executemany(
"INSERT INTO users(name, email) VALUES(%s, %s)",
[("beaker", "[email protected]"), ("beaker", "[email protected]")],
)
self.db.commit()

self.assertEqual(2, result)
Expand All @@ -151,18 +165,21 @@ def test_executemany(self):
self.assertEqual(None, db_span.ec)

self.assertEqual(db_span.n, "mysql")
self.assertEqual(db_span.data["mysql"]["db"], testenv['mysql_db'])
self.assertEqual(db_span.data["mysql"]["user"], testenv['mysql_user'])
self.assertEqual(db_span.data["mysql"]["stmt"], 'INSERT INTO users(name, email) VALUES(%s, %s)')
self.assertEqual(db_span.data["mysql"]["host"], testenv['mysql_host'])
self.assertEqual(db_span.data["mysql"]["port"], testenv['mysql_port'])
self.assertEqual(db_span.data["mysql"]["db"], testenv["mysql_db"])
self.assertEqual(db_span.data["mysql"]["user"], testenv["mysql_user"])
self.assertEqual(
db_span.data["mysql"]["stmt"],
"INSERT INTO users(name, email) VALUES(%s, %s)",
)
self.assertEqual(db_span.data["mysql"]["host"], testenv["mysql_host"])
self.assertEqual(db_span.data["mysql"]["port"], testenv["mysql_port"])

def test_call_proc(self):
result = None
with tracer.start_active_span('test'):
result = self.cursor.callproc('test_proc', ('beaker',))
with tracer.start_active_span("test"):
result = self.cursor.callproc("test_proc", ("beaker",))

assert(result)
assert result

spans = self.recorder.queued_spans()
self.assertEqual(2, len(spans))
Expand All @@ -177,17 +194,17 @@ def test_call_proc(self):
self.assertEqual(None, db_span.ec)

self.assertEqual(db_span.n, "mysql")
self.assertEqual(db_span.data["mysql"]["db"], testenv['mysql_db'])
self.assertEqual(db_span.data["mysql"]["user"], testenv['mysql_user'])
self.assertEqual(db_span.data["mysql"]["stmt"], 'test_proc')
self.assertEqual(db_span.data["mysql"]["host"], testenv['mysql_host'])
self.assertEqual(db_span.data["mysql"]["port"], testenv['mysql_port'])
self.assertEqual(db_span.data["mysql"]["db"], testenv["mysql_db"])
self.assertEqual(db_span.data["mysql"]["user"], testenv["mysql_user"])
self.assertEqual(db_span.data["mysql"]["stmt"], "test_proc")
self.assertEqual(db_span.data["mysql"]["host"], testenv["mysql_host"])
self.assertEqual(db_span.data["mysql"]["port"], testenv["mysql_port"])

def test_error_capture(self):
result = None
span = None
try:
with tracer.start_active_span('test'):
with tracer.start_active_span("test"):
result = self.cursor.execute("""SELECT * from blah""")
self.cursor.fetchone()
except Exception:
Expand All @@ -196,7 +213,7 @@ def test_error_capture(self):
if span:
span.finish()

assert(result is None)
assert result is None

spans = self.recorder.queued_spans()
self.assertEqual(2, len(spans))
Expand All @@ -209,11 +226,101 @@ def test_error_capture(self):
self.assertEqual(db_span.p, test_span.s)

self.assertEqual(1, db_span.ec)
self.assertEqual(db_span.data["mysql"]["error"], '(1146, "Table \'%s.blah\' doesn\'t exist")' % testenv['mysql_db'])
self.assertEqual(
db_span.data["mysql"]["error"],
"(1146, \"Table '%s.blah' doesn't exist\")" % testenv["mysql_db"],
)

self.assertEqual(db_span.n, "mysql")
self.assertEqual(db_span.data["mysql"]["db"], testenv['mysql_db'])
self.assertEqual(db_span.data["mysql"]["user"], testenv['mysql_user'])
self.assertEqual(db_span.data["mysql"]["stmt"], 'SELECT * from blah')
self.assertEqual(db_span.data["mysql"]["host"], testenv['mysql_host'])
self.assertEqual(db_span.data["mysql"]["port"], testenv['mysql_port'])
self.assertEqual(db_span.data["mysql"]["db"], testenv["mysql_db"])
self.assertEqual(db_span.data["mysql"]["user"], testenv["mysql_user"])
self.assertEqual(db_span.data["mysql"]["stmt"], "SELECT * from blah")
self.assertEqual(db_span.data["mysql"]["host"], testenv["mysql_host"])
self.assertEqual(db_span.data["mysql"]["port"], testenv["mysql_port"])

def test_connect_cursor_ctx_mgr(self):
result = None
with tracer.start_active_span("test"):
with self.db as connection:
with connection.cursor() as cursor:
result = cursor.execute("""SELECT * from users""")
cursor.fetchone()

assert result >= 0

spans = self.recorder.queued_spans()
self.assertEqual(2, len(spans))

db_span = spans[0]
test_span = spans[1]

self.assertEqual("test", test_span.data["sdk"]["name"])
self.assertEqual(test_span.t, db_span.t)
self.assertEqual(db_span.p, test_span.s)

self.assertEqual(None, db_span.ec)

self.assertEqual(db_span.n, "mysql")
self.assertEqual(db_span.data["mysql"]["db"], testenv["mysql_db"])
self.assertEqual(db_span.data["mysql"]["user"], testenv["mysql_user"])
self.assertEqual(db_span.data["mysql"]["stmt"], "SELECT * from users")
self.assertEqual(db_span.data["mysql"]["host"], testenv["mysql_host"])
self.assertEqual(db_span.data["mysql"]["port"], testenv["mysql_port"])

def test_connect_ctx_mgr(self):
result = None
with tracer.start_active_span("test"):
with self.db as connection:
cursor = connection.cursor()
result = cursor.execute("""SELECT * from users""")
cursor.fetchone()

assert result >= 0

spans = self.recorder.queued_spans()
self.assertEqual(2, len(spans))

db_span = spans[0]
test_span = spans[1]

self.assertEqual("test", test_span.data["sdk"]["name"])
self.assertEqual(test_span.t, db_span.t)
self.assertEqual(db_span.p, test_span.s)

self.assertEqual(None, db_span.ec)

self.assertEqual(db_span.n, "mysql")
self.assertEqual(db_span.data["mysql"]["db"], testenv["mysql_db"])
self.assertEqual(db_span.data["mysql"]["user"], testenv["mysql_user"])
self.assertEqual(db_span.data["mysql"]["stmt"], "SELECT * from users")
self.assertEqual(db_span.data["mysql"]["host"], testenv["mysql_host"])
self.assertEqual(db_span.data["mysql"]["port"], testenv["mysql_port"])

def test_cursor_ctx_mgr(self):
result = None
with tracer.start_active_span("test"):
connection = self.db
with connection.cursor() as cursor:
result = cursor.execute("""SELECT * from users""")
cursor.fetchone()

assert result >= 0

spans = self.recorder.queued_spans()
self.assertEqual(2, len(spans))

db_span = spans[0]
test_span = spans[1]

self.assertEqual("test", test_span.data["sdk"]["name"])
self.assertEqual(test_span.t, db_span.t)
self.assertEqual(db_span.p, test_span.s)

self.assertEqual(None, db_span.ec)

self.assertEqual(db_span.n, "mysql")
self.assertEqual(db_span.data["mysql"]["db"], testenv["mysql_db"])
self.assertEqual(db_span.data["mysql"]["user"], testenv["mysql_user"])
self.assertEqual(db_span.data["mysql"]["stmt"], "SELECT * from users")
self.assertEqual(db_span.data["mysql"]["host"], testenv["mysql_host"])
self.assertEqual(db_span.data["mysql"]["port"], testenv["mysql_port"])
Loading