From 8ccf5a38c76c7bd3e63589562839c13e23d71626 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ferenc=20G=C3=A9czi?= Date: Fri, 1 Sep 2023 10:00:00 +0000 Subject: [PATCH] refactor(tests): Clean up old PEP-249 tests MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Use the `unittest` module's `assert` in unit tests. * Drop legacy branching for unsupported 2.7 * Eliminate unused variables * Remove superfluous initializations * Use unpack assignments Signed-off-by: Ferenc Géczi --- tests/clients/test_mysqlclient.py | 51 ++++++++------------------ tests/clients/test_psycopg2.py | 42 ++++++++------------- tests/clients/test_pymysql.py | 61 ++++++++++--------------------- 3 files changed, 51 insertions(+), 103 deletions(-) diff --git a/tests/clients/test_mysqlclient.py b/tests/clients/test_mysqlclient.py index a5d134331..7fdb51698 100644 --- a/tests/clients/test_mysqlclient.py +++ b/tests/clients/test_mysqlclient.py @@ -11,10 +11,7 @@ from instana.singletons import tracer -if sys.version_info[0] > 2: - import MySQLdb -else: - raise SkipTest("mysqlclient supported on Python 3 only") +import MySQLdb logger = logging.getLogger(__name__) @@ -75,24 +72,22 @@ def test_vanilla_query(self): self.assertEqual(0, len(spans)) def test_basic_query(self): - result = None with tracer.start_active_span('test'): result = self.cursor.execute("""SELECT * from users""") self.cursor.fetchone() - assert(result >= 0) + self.assertTrue(result >= 0) spans = self.recorder.queued_spans() self.assertEqual(2, len(spans)) - db_span = spans[0] - test_span = spans[1] + db_span, test_span = spans 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.assertIsNone(db_span.ec) self.assertEqual(db_span.n, "mysql") self.assertEqual(db_span.data["mysql"]["db"], testenv['mysql_db']) @@ -102,7 +97,6 @@ def test_basic_query(self): self.assertEqual(db_span.data["mysql"]["port"], testenv['mysql_port']) def test_basic_insert(self): - result = None with tracer.start_active_span('test'): result = self.cursor.execute( """INSERT INTO users(name, email) VALUES(%s, %s)""", @@ -113,14 +107,13 @@ def test_basic_insert(self): spans = self.recorder.queued_spans() self.assertEqual(2, len(spans)) - db_span = spans[0] - test_span = spans[1] + db_span, test_span = spans 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.assertIsNone(db_span.ec) self.assertEqual(db_span.n, "mysql") self.assertEqual(db_span.data["mysql"]["db"], testenv['mysql_db']) @@ -130,7 +123,6 @@ def test_basic_insert(self): 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', 'beaker@muppets.com'), ('beaker', 'beaker@muppets.com')]) @@ -141,14 +133,13 @@ def test_executemany(self): spans = self.recorder.queued_spans() self.assertEqual(2, len(spans)) - db_span = spans[0] - test_span = spans[1] + db_span, test_span = spans 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.assertIsNone(db_span.ec) self.assertEqual(db_span.n, "mysql") self.assertEqual(db_span.data["mysql"]["db"], testenv['mysql_db']) @@ -158,23 +149,21 @@ def test_executemany(self): 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',)) - assert(result) + self.assertTrue(result) spans = self.recorder.queued_spans() self.assertEqual(2, len(spans)) - db_span = spans[0] - test_span = spans[1] + db_span, test_span = spans 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.assertIsNone(db_span.ec) self.assertEqual(db_span.n, "mysql") self.assertEqual(db_span.data["mysql"]["db"], testenv['mysql_db']) @@ -185,24 +174,19 @@ def test_call_proc(self): def test_error_capture(self): result = None - span = None try: with tracer.start_active_span('test'): result = self.cursor.execute("""SELECT * from blah""") self.cursor.fetchone() except Exception: pass - finally: - if span: - span.finish() - assert(result is None) + self.assertIsNone(result) spans = self.recorder.queued_spans() self.assertEqual(2, len(spans)) - db_span = spans[0] - test_span = spans[1] + db_span, test_span = spans self.assertEqual("test", test_span.data["sdk"]["name"]) self.assertEqual(test_span.t, db_span.t) @@ -227,8 +211,7 @@ def test_connect_cursor_ctx_mgr(self): spans = self.recorder.queued_spans() self.assertEqual(2, len(spans)) - db_span = spans[0] - test_span = spans[1] + db_span, test_span = spans self.assertEqual("test", test_span.data["sdk"]["name"]) self.assertEqual(test_span.t, db_span.t) @@ -253,8 +236,7 @@ def test_connect_ctx_mgr(self): spans = self.recorder.queued_spans() self.assertEqual(2, len(spans)) - db_span = spans[0] - test_span = spans[1] + db_span, test_span = spans self.assertEqual("test", test_span.data["sdk"]["name"]) self.assertEqual(test_span.t, db_span.t) @@ -279,8 +261,7 @@ def test_cursor_ctx_mgr(self): spans = self.recorder.queued_spans() self.assertEqual(2, len(spans)) - db_span = spans[0] - test_span = spans[1] + db_span, test_span = spans self.assertEqual("test", test_span.data["sdk"]["name"]) self.assertEqual(test_span.t, db_span.t) diff --git a/tests/clients/test_psycopg2.py b/tests/clients/test_psycopg2.py index 771241f9b..27adae063 100644 --- a/tests/clients/test_psycopg2.py +++ b/tests/clients/test_psycopg2.py @@ -64,8 +64,8 @@ def tearDown(self): return None def test_vanilla_query(self): - assert psycopg2.extras.register_uuid(None, self.db) - assert psycopg2.extras.register_uuid(None, self.db.cursor()) + self.assertTrue(psycopg2.extras.register_uuid(None, self.db)) + self.assertTrue(psycopg2.extras.register_uuid(None, self.db.cursor())) self.cursor.execute("""SELECT * from users""") result = self.cursor.fetchone() @@ -84,14 +84,13 @@ def test_basic_query(self): spans = self.recorder.queued_spans() self.assertEqual(2, len(spans)) - db_span = spans[0] - test_span = spans[1] + db_span, test_span = spans 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.assertIsNone(db_span.ec) self.assertEqual(db_span.n, "postgres") self.assertEqual(db_span.data["pg"]["db"], testenv['postgresql_db']) @@ -107,14 +106,13 @@ def test_basic_insert(self): spans = self.recorder.queued_spans() self.assertEqual(2, len(spans)) - db_span = spans[0] - test_span = spans[1] + db_span, test_span = spans 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.assertIsNone(db_span.ec) self.assertEqual(db_span.n, "postgres") self.assertEqual(db_span.data["pg"]["db"], testenv['postgresql_db']) @@ -124,7 +122,6 @@ def test_basic_insert(self): self.assertEqual(db_span.data["pg"]["port"], testenv['postgresql_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', 'beaker@muppets.com'), ('beaker', 'beaker@muppets.com')]) @@ -133,14 +130,13 @@ def test_executemany(self): spans = self.recorder.queued_spans() self.assertEqual(2, len(spans)) - db_span = spans[0] - test_span = spans[1] + db_span, test_span = spans 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.assertIsNone(db_span.ec) self.assertEqual(db_span.n, "postgres") self.assertEqual(db_span.data["pg"]["db"], testenv['postgresql_db']) @@ -150,23 +146,21 @@ def test_executemany(self): self.assertEqual(db_span.data["pg"]["port"], testenv['postgresql_port']) def test_call_proc(self): - result = None with tracer.start_active_span('test'): result = self.cursor.callproc('test_proc', ('beaker',)) - assert(type(result) is tuple) + self.assertIsInstance(result, tuple) spans = self.recorder.queued_spans() self.assertEqual(2, len(spans)) - db_span = spans[0] - test_span = spans[1] + db_span, test_span = spans 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.assertIsNone(db_span.ec) self.assertEqual(db_span.n, "postgres") self.assertEqual(db_span.data["pg"]["db"], testenv['postgresql_db']) @@ -184,13 +178,12 @@ def test_error_capture(self): except Exception: pass - assert(result is None) + self.assertIsNone(result) spans = self.recorder.queued_spans() self.assertEqual(2, len(spans)) - db_span = spans[0] - test_span = spans[1] + db_span, test_span = spans self.assertEqual("test", test_span.data["sdk"]["name"]) self.assertEqual(test_span.t, db_span.t) @@ -257,8 +250,7 @@ def test_connect_cursor_ctx_mgr(self): spans = self.recorder.queued_spans() self.assertEqual(2, len(spans)) - db_span = spans[0] - test_span = spans[1] + db_span, test_span = spans self.assertEqual("test", test_span.data["sdk"]["name"]) self.assertEqual(test_span.t, db_span.t) @@ -282,8 +274,7 @@ def test_connect_ctx_mgr(self): spans = self.recorder.queued_spans() self.assertEqual(2, len(spans)) - db_span = spans[0] - test_span = spans[1] + db_span, test_span = spans self.assertEqual("test", test_span.data["sdk"]["name"]) self.assertEqual(test_span.t, db_span.t) @@ -307,8 +298,7 @@ def test_cursor_ctx_mgr(self): spans = self.recorder.queued_spans() self.assertEqual(2, len(spans)) - db_span = spans[0] - test_span = spans[1] + db_span, test_span = spans self.assertEqual("test", test_span.data["sdk"]["name"]) self.assertEqual(test_span.t, db_span.t) diff --git a/tests/clients/test_pymysql.py b/tests/clients/test_pymysql.py index 508d1b647..b88ff0d8d 100644 --- a/tests/clients/test_pymysql.py +++ b/tests/clients/test_pymysql.py @@ -69,24 +69,22 @@ def test_vanilla_query(self): self.assertEqual(0, len(spans)) def test_basic_query(self): - result = None with tracer.start_active_span('test'): result = self.cursor.execute("""SELECT * from users""") self.cursor.fetchone() - assert(result >= 0) + self.assertTrue(result >= 0) spans = self.recorder.queued_spans() self.assertEqual(2, len(spans)) - db_span = spans[0] - test_span = spans[1] + db_span, test_span = spans 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.assertIsNone(db_span.ec) self.assertEqual(db_span.n, "mysql") self.assertEqual(db_span.data["mysql"]["db"], testenv['mysql_db']) @@ -96,24 +94,22 @@ def test_basic_query(self): self.assertEqual(db_span.data["mysql"]["port"], testenv['mysql_port']) def test_query_with_params(self): - result = None with tracer.start_active_span('test'): result = self.cursor.execute("""SELECT * from users where id=1""") self.cursor.fetchone() - assert(result >= 0) + self.assertTrue(result >= 0) spans = self.recorder.queued_spans() self.assertEqual(2, len(spans)) - db_span = spans[0] - test_span = spans[1] + db_span, test_span = spans 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.assertIsNone(db_span.ec) self.assertEqual(db_span.n, "mysql") self.assertEqual(db_span.data["mysql"]["db"], testenv['mysql_db']) @@ -123,7 +119,6 @@ def test_query_with_params(self): self.assertEqual(db_span.data["mysql"]["port"], testenv['mysql_port']) def test_basic_insert(self): - result = None with tracer.start_active_span('test'): result = self.cursor.execute( """INSERT INTO users(name, email) VALUES(%s, %s)""", @@ -134,14 +129,13 @@ def test_basic_insert(self): spans = self.recorder.queued_spans() self.assertEqual(2, len(spans)) - db_span = spans[0] - test_span = spans[1] + db_span, test_span = spans 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.assertIsNone(db_span.ec) self.assertEqual(db_span.n, "mysql") self.assertEqual(db_span.data["mysql"]["db"], testenv['mysql_db']) @@ -151,7 +145,6 @@ def test_basic_insert(self): 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', 'beaker@muppets.com'), ('beaker', 'beaker@muppets.com')]) @@ -162,14 +155,13 @@ def test_executemany(self): spans = self.recorder.queued_spans() self.assertEqual(2, len(spans)) - db_span = spans[0] - test_span = spans[1] + db_span, test_span = spans 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.assertIsNone(db_span.ec) self.assertEqual(db_span.n, "mysql") self.assertEqual(db_span.data["mysql"]["db"], testenv['mysql_db']) @@ -179,23 +171,21 @@ def test_executemany(self): 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',)) - assert(result) + self.assertTrue(result) spans = self.recorder.queued_spans() self.assertEqual(2, len(spans)) - db_span = spans[0] - test_span = spans[1] + db_span, test_span = spans 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.assertIsNone(db_span.ec) self.assertEqual(db_span.n, "mysql") self.assertEqual(db_span.data["mysql"]["db"], testenv['mysql_db']) @@ -206,36 +196,26 @@ def test_call_proc(self): def test_error_capture(self): result = None - span = None try: with tracer.start_active_span('test'): result = self.cursor.execute("""SELECT * from blah""") self.cursor.fetchone() except Exception: pass - finally: - if span: - span.finish() - assert(result is None) + self.assertIsNone(result) spans = self.recorder.queued_spans() self.assertEqual(2, len(spans)) - db_span = spans[0] - test_span = spans[1] + db_span, test_span = spans 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(1, db_span.ec) - if sys.version_info[0] >= 3: - # Python 3 - self.assertEqual(db_span.data["mysql"]["error"], u'(1146, "Table \'%s.blah\' doesn\'t exist")' % testenv['mysql_db']) - else: - # Python 2 - self.assertEqual(db_span.data["mysql"]["error"], u'(1146, u"Table \'%s.blah\' doesn\'t exist")' % testenv['mysql_db']) + self.assertEqual(db_span.data["mysql"]["error"], u'(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']) @@ -253,8 +233,7 @@ def test_connect_cursor_ctx_mgr(self): spans = self.recorder.queued_spans() self.assertEqual(2, len(spans)) - db_span = spans[0] - test_span = spans[1] + db_span, test_span = spans self.assertEqual("test", test_span.data["sdk"]["name"]) self.assertEqual(test_span.t, db_span.t) @@ -278,8 +257,7 @@ def test_connect_ctx_mgr(self): spans = self.recorder.queued_spans() self.assertEqual(2, len(spans)) - db_span = spans[0] - test_span = spans[1] + db_span, test_span = spans self.assertEqual("test", test_span.data["sdk"]["name"]) self.assertEqual(test_span.t, db_span.t) @@ -304,8 +282,7 @@ def test_cursor_ctx_mgr(self): spans = self.recorder.queued_spans() self.assertEqual(2, len(spans)) - db_span = spans[0] - test_span = spans[1] + db_span, test_span = spans self.assertEqual("test", test_span.data["sdk"]["name"]) self.assertEqual(test_span.t, db_span.t)