WL14634: Running unit tests against external server

Currently, unit tests are written so that the testing framework starts
servers required by the tests.

This worklog aims to modify existing unit tests so that they can also
run against an external server not controlled by the testing framework.

The following command line arguments can be used:

  --use-external-server  Sets to use an external server.
                         (Default: False)
  --host                 Hostname or IP address for TCP/IP connections
                         to use with an external server.
                         (Default: 127.0.0.1)
  --port                 TCP/IP port to use with an external server.
                         (Default: 8806)
  --mysqlx-port          MySQL X TCP/IP port to use with an external
                         server.
                         (Default: 88060)
  --user                 User to use with an external server.
                         (Default: root)
  --password             Password to with an external server.
                         (Default: "")

Example:

  python unittest.py --use-external-server --host=10.0.0.32

As an alternative to command line arguments, environment variables can
be used instead:

  host:        $MYSQL_HOST
  port:        $MYSQL_PORT
  mysqlx port: $MYSQLX_PORT
  user:        $MYSQL_USER
  password:    $MYSQL_PASSWORD

The testing system will use the command line arguments, but if they are
not set, the system will try to use the environment variables. Finally,
if no arguments or environment are set, the MySQL defaults will be used.

Author: nmariz

CHANGES.txt

@@ -11,6 +11,7 @@ Full release notes:
 v8.0.26
 =======
 
+- WL#14634: Running unit tests against external server
 - WL#14542: Deprecate TLS 1.0 and 1.1
 - WL#14440: Support for authentication_kerberos_client authentication plugin
 - WL#14237: Support query attributes

examples/inserts.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
-# Copyright (c) 2009, 2017, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2009, 2021, Oracle and/or its affiliates. All rights reserved.
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License, version 2.0, as
@@ -53,7 +53,7 @@ def main(config):
         "CREATE TABLE names ("
         "    id TINYINT UNSIGNED NOT NULL AUTO_INCREMENT, "
         "    name VARCHAR(30) DEFAULT '' NOT NULL, "
-        "    info TEXT DEFAULT '', "
+        "    info TEXT, "
         "    age TINYINT UNSIGNED DEFAULT '30', "
         "PRIMARY KEY (id))"
     )

examples/multi_resultsets.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
-# Copyright (c) 2009, 2017, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2009, 2021, Oracle and/or its affiliates. All rights reserved.
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License, version 2.0, as
@@ -52,7 +52,7 @@ def main(config):
         "CREATE TABLE names ("
         "    id TINYINT UNSIGNED NOT NULL AUTO_INCREMENT, "
         "    name VARCHAR(30) DEFAULT '' NOT NULL, "
-        "    info TEXT DEFAULT '', "
+        "    info TEXT, "
         "    age TINYINT UNSIGNED DEFAULT '30', "
         "    PRIMARY KEY (id))"
     )

tests/__init__.py

@@ -136,6 +136,7 @@ def load_source(name, path):
 
 OPTIONS_INIT = False
 
+MYSQL_EXTERNAL_SERVER = False
 MYSQL_SERVERS_NEEDED = 1
 MYSQL_SERVERS = []
 MYSQL_VERSION = ()
@@ -1000,8 +1001,20 @@ def is_plugin_available(plugin_name, config_vars=None, in_server=None):
 
     Returns True if plugin an success else False.
     """
-    available = False
     server = in_server if in_server else MYSQL_SERVERS[0]
+    if MYSQL_EXTERNAL_SERVER:
+        from mysql.connector import MySQLConnection
+        config = server.client_config.copy()
+        del config["database"]
+        with MySQLConnection(**config) as cnx:
+            cnx.cmd_query("SHOW PLUGINS")
+            res = cnx.get_rows()
+            for row in res[0]:
+                if row[0] == plugin_name and row[1] == "ACTIVE":
+                    return True
+        return False
+
+    available = False
     plugin_config_vars = config_vars if config_vars else []
     server_cnf = server._cnf
     server_cnf_bkp = server._cnf

tests/cext/test_cext_api.py

@@ -463,6 +463,10 @@ def test_commit(self):
 
         cmy1.query("DROP TABLE IF EXISTS {0}".format(table))
 
+    @unittest.skipIf(
+        tests.MYSQL_EXTERNAL_SERVER,
+        "Test not available for external MySQL servers",
+    )
     def test_change_user(self):
         connect_kwargs = self.connect_kwargs.copy()
         cnx = CMySQLConnection(**connect_kwargs)
@@ -737,7 +741,7 @@ def test_get_host_info(self):
 
         cmy.connect(**config)
 
-        if os.name == 'posix':
+        if os.name == 'posix' and not tests.MYSQL_EXTERNAL_SERVER:
             # On POSIX systems we would be connected by UNIX socket
             self.assertTrue('via UNIX socket' in cmy.get_host_info())
 

tests/issues/test_bug21449207.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved.
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License, version 2.0, as
@@ -31,6 +31,7 @@
 import mysql.connector
 from tests import foreach_cnx, cnx_config
 import tests
+import unittest
 
 
 class Bug21449207(tests.MySQLConnectorTests):
@@ -41,7 +42,7 @@ def setUp(self):
 
         create_table = (
             "CREATE TABLE {0} ("
-            "id INT PRIMARY KEY, "
+            "id INT PRIMARY KEY AUTO_INCREMENT, "
             "a LONGTEXT "
             ") ENGINE=Innodb DEFAULT CHARSET utf8".format(self.tbl))
         cnx.cmd_query(create_table)
@@ -74,6 +75,10 @@ def test_50k_compressed(self):
         self.assertEqual(exp, row[0])
         self.assertEqual(row[0][-20:], exp[-20:])
 
+    @unittest.skipIf(
+        tests.MYSQL_EXTERNAL_SERVER,
+        "Test not available for external MySQL servers",
+    )
     @foreach_cnx()
     def test_16M_compressed(self):
         cur = self.cnx.cursor()

tests/issues/test_bug21449996.py

@@ -31,10 +31,16 @@
 import mysql.connector
 from tests import foreach_cnx
 import tests
+import unittest
 
 # using "/" (slash) to avoid windows scape characters
 DATA_FILE = "/".join(['tests', 'data', 'random_big_bin.csv'])
 
+
+@unittest.skipIf(
+    tests.MYSQL_EXTERNAL_SERVER,
+    "Test not available for external MySQL servers",
+)
 class Bug21449996(tests.MySQLConnectorTests):
 
     def setUp(self):

tests/issues/test_bug22545879.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved.
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License, version 2.0, as
@@ -52,6 +52,11 @@
 
 OPTION_FILE = os.path.join('tests', 'data', 'option_files', 'my.cnf')
 
+
+@unittest.skipIf(
+    tests.MYSQL_EXTERNAL_SERVER,
+    "Test not available for external MySQL servers",
+)
 class Bug21449996(tests.MySQLConnectorTests):
 
     @cnx_config(ssl_ca=TEST_SSL['ca'], ssl_cert=TEST_SSL['cert'], ssl_key=TEST_SSL['key'],

tests/mysqld.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2009, 2020, Oracle and/or its affiliates.
+# Copyright (c) 2009, 2021, Oracle and/or its affiliates.
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License, version 2.0, as
@@ -834,6 +834,7 @@ def handle(self):
         self._server_replies = self._server_replies[bufsize:]
         return res
 
+
 class DummyMySQLServer(ThreadingMixIn, TCPServer):
     """Class accepting connections for testing MySQL connections"""
 
@@ -863,3 +864,53 @@ def reset(self):
 
     def get_address(self):
         return 'dummy'
+
+
+class MySQLExternalServer:
+    """Class for managing an external MySQL Server."""
+
+    def __init__(self, cnf, name):
+        self.cnf = cnf
+        self.name = name
+        self.version = None
+        self.license = None
+
+        self.bind_address = None
+        self.unix_socket = None
+        self.mysqlx_unix_socket = None
+        self.pid_file = None
+        self.client_config = {}
+        self.xplugin_config = {}
+
+    def _exit_with_unsupported_operation(self):
+        LOGGER.error(
+            "Operation not supported when using an external MySQL server"
+        )
+        sys.exit(1)
+
+    def bootstrap(self):
+        self._exit_with_unsupported_operation()
+
+    def check_running(self, pid=None):
+        self._exit_with_unsupported_operation()
+
+    def start(self, **kwargs):
+        self._exit_with_unsupported_operation()
+
+    def stop(self):
+        self._exit_with_unsupported_operation()
+
+    def remove(self):
+        self._exit_with_unsupported_operation()
+
+    def get_exec(self, exec_name):
+        self._exit_with_unsupported_operation()
+
+    def update_config(self, **kwargs):
+        self._exit_with_unsupported_operation()
+
+    def wait_up(self, tries=10, delay=1):
+        self._exit_with_unsupported_operation()
+
+    def wait_down(self, tries=10, delay=1):
+        self._exit_with_unsupported_operation()

tests/test_abstracts.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2014, 2020, Oracle and/or its affiliates.
+# Copyright (c) 2014, 2021, Oracle and/or its affiliates.
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License, version 2.0, as
@@ -225,6 +225,10 @@ def test_cmd_quit(self):
         self.cnx.cmd_quit()
         self.assertFalse(self.cnx.is_connected())
 
+    @unittest.skipIf(
+        tests.MYSQL_EXTERNAL_SERVER,
+        "Test not available for external MySQL servers",
+    )
     @unittest.skipIf(tests.MYSQL_VERSION >= (8, 0, 1),
                      "As of MySQL 8.0.1, CMD_SHUTDOWN is not recognized.")
     @unittest.skipIf(tests.MYSQL_VERSION <= (5, 7, 1),