WL#15982: Remove use of mysql_shutdown

This worklog removes the usage of mysql_shutdown() C API function and
COM_SHUTDOWN.
The COM_SHUTDOWN is replaced by SQL command SHUTDOWN.
The current API for connection.cmd_shutdown() keeps unchanged.

Change-Id: Ie002c8b325b28fa5b3b353370e9473e841761fa3

Author: nmariz

CHANGES.txt

@@ -8,6 +8,11 @@ Copyright (c) 2009, 2023, Oracle and/or its affiliates.
 Full release notes:
  http://dev.mysql.com/doc/relnotes/connector-python/en/
 
+v8.3.0
+======
+
+- WL#15982: Remove use of mysql_shutdown
+
 v8.2.0
 ======
 

lib/mysql/connector/abstracts.py

@@ -1506,10 +1506,12 @@ def cmd_quit(self) -> Any:
         """Close the current connection with the server"""
         raise NotImplementedError
 
-    def cmd_shutdown(
-        self, shutdown_type: Optional[int] = None
-    ) -> Optional[Mapping[str, Any]]:
-        """Shut down the MySQL Server"""
+    def cmd_shutdown(self, shutdown_type: Optional[int] = None) -> None:
+        """Shut down the MySQL Server
+
+        This method sends the SHUTDOWN command to the MySQL server.
+        The `shutdown_type` is not used, and it's kept for backward compatibility.
+        """
         raise NotImplementedError
 
     def cmd_statistics(self) -> Optional[Mapping[str, Any]]:

lib/mysql/connector/connection.py

@@ -57,14 +57,7 @@
 from . import version
 from .abstracts import MySQLConnectionAbstract
 from .authentication import MySQLAuthenticator, get_auth_plugin
-from .constants import (
-    ClientFlag,
-    FieldType,
-    ServerCmd,
-    ServerFlag,
-    ShutdownType,
-    flag_is_set,
-)
+from .constants import ClientFlag, FieldType, ServerCmd, ServerFlag, flag_is_set
 from .conversion import MySQLConverter
 from .cursor import (
     CursorBase,
@@ -929,24 +922,13 @@ def cmd_quit(self) -> bytes:
         self._socket.send(packet, 0, 0)
         return bytes(packet)
 
-    def cmd_shutdown(self, shutdown_type: Optional[int] = None) -> EofPacketType:
+    def cmd_shutdown(self, shutdown_type: Optional[int] = None) -> None:
         """Shut down the MySQL Server
 
-        This method sends the SHUTDOWN command to the MySQL server and is only
-        possible if the current user has SUPER privileges. The result is a
-        dictionary containing the OK packet information.
-
-        Note: Most applications and scripts do not the SUPER privilege.
-
-        Returns a dict()
+        This method sends the SHUTDOWN command to the MySQL server.
+        The `shutdown_type` is not used, and it's kept for backward compatibility.
         """
-        if shutdown_type:
-            if not ShutdownType.get_info(shutdown_type):
-                raise InterfaceError("Invalid shutdown type")
-            atype = shutdown_type
-        else:
-            atype = ShutdownType.SHUTDOWN_DEFAULT
-        return self._handle_eof(self._send_cmd(ServerCmd.SHUTDOWN, int4store(atype)))
+        self.cmd_query("SHUTDOWN")
 
     def cmd_statistics(self) -> StatsPacketType:
         """Send the statistics command to the MySQL Server

lib/mysql/connector/connection_cext.py

@@ -897,7 +897,11 @@ def cmd_quit(self) -> None:
         self.close()
 
     def cmd_shutdown(self, shutdown_type: Optional[int] = None) -> None:
-        """Shut down the MySQL Server"""
+        """Shut down the MySQL Server
+
+        This method sends the SHUTDOWN command to the MySQL server.
+        The `shutdown_type` is not used, and it's kept for backward compatibility.
+        """
         if not self._cmysql:
             raise OperationalError("MySQL Connection not available")
 

src/mysql_capi.c

@@ -2954,6 +2954,8 @@ MySQL_shutdown(MySQL *self, PyObject *args)
 {
     unsigned int level = 0;
     int res;
+    char *stmt = "SHUTDOWN";
+    Py_ssize_t stmt_length;
 
     CHECK_SESSION(self);
 
@@ -2962,7 +2964,8 @@ MySQL_shutdown(MySQL *self, PyObject *args)
     }
 
     Py_BEGIN_ALLOW_THREADS
-    res = mysql_shutdown(&self->session, level);
+    stmt_length = strlen(stmt);
+    res = mysql_real_query(&self->session, stmt, stmt_length);
     Py_END_ALLOW_THREADS
 
     if (res) {

tests/test_abstracts.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2014, 2022, Oracle and/or its affiliates.
+# Copyright (c) 2014, 2023, 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
@@ -255,12 +255,8 @@ def test_cmd_quit(self):
         "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),
-        "BugOra17422299 not tested with MySQL version 5.6",
+        tests.MYSQL_VERSION < (8, 0, 1),
+        "The SQL command SHUTDOWN is only available as of MySQL 8.0.1",
     )
     @foreach_cnx()
     def test_cmd_shutdown(self):

tests/test_bugs.py

@@ -1947,12 +1947,8 @@ def test_load_csv(self):
     "Test not available for external MySQL servers",
 )
 @unittest.skipIf(
-    tests.MYSQL_VERSION >= (8, 0, 1),
-    "BugOra17422299 not tested with MySQL version >= 8.0.1",
-)
-@unittest.skipIf(
-    tests.MYSQL_VERSION <= (5, 7, 1),
-    "BugOra17422299 not tested with MySQL version 5.6",
+    tests.MYSQL_VERSION < (8, 0, 1),
+    "The SQL command SHUTDOWN is only available as of MySQL 8.0.1",
 )
 class BugOra17422299(tests.MySQLConnectorTests):
     """BUG#17422299: cmd_shutdown fails with malformed connection packet"""