BUG21492815: Fix callproc when consuming results turned on

We fix the MySQLCursor.callproc() method when consume results is
turned on by temporary disabling the automatic consumption.

We also fix returning raw results after executing stored routines
when a raw cursor such as MySQLCursorRaw is used. This was only a
problem in the pure Python code.

The string representation of call cursor have been improved. It now
will state correctl which cursor class was used.

A test case has been added for BUG#21492815 testing both converted
and raw results. Some test cases have been updated.
(cherry picked from commit c85d89c)

Author: Geert Vanderkelen

cpyint

@@ -1,5 +1,5 @@
 # MySQL Connector/Python - MySQL driver written in Python.
-# Copyright (c) 2014, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2014, 2015, Oracle and/or its affiliates. All rights reserved.
 
 # MySQL Connector/Python is licensed under the terms of the GPLv2
 # <http://www.gnu.org/licenses/old-licenses/gpl-2.0.html>, like most

lib/mysql/connector/authentication.py

@@ -1,5 +1,5 @@
 # MySQL Connector/Python - MySQL driver written in Python.
-# Copyright (c) 2009, 2014, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2009, 2015, Oracle and/or its affiliates. All rights reserved.
 
 # MySQL Connector/Python is licensed under the terms of the GPLv2
 # <http://www.gnu.org/licenses/old-licenses/gpl-2.0.html>, like most

lib/mysql/connector/connection.py

@@ -84,6 +84,8 @@ class CursorBase(MySQLCursorAbstract):
     It's better to inherite from MySQLCursor.
     """
 
+    _raw = False
+
     def __init__(self):
         self._description = None
         self._rowcount = -1
@@ -704,15 +706,24 @@ def callproc(self, procname, args=()):
 
             call = "CALL {0}({1})".format(procname, ','.join(argnames))
 
+            # pylint: disable=W0212
+            # We disable consuming results temporary to make sure we
+            # getting all results
+            can_consume_results = self._connection._consume_results
             for result in self._connection.cmd_query_iter(call):
-                # pylint: disable=W0212
-                tmp = MySQLCursorBuffered(self._connection._get_self())
+                self._connection._consume_results = False
+                if self._raw:
+                    tmp = MySQLCursorBufferedRaw(self._connection._get_self())
+                else:
+                    tmp = MySQLCursorBuffered(self._connection._get_self())
+                tmp._executed = "(a result of {0})".format(call)
                 tmp._handle_result(result)
                 if tmp._warnings is not None:
                     self._warnings = tmp._warnings
-                # pylint: enable=W0212
                 if 'columns' in result:
                     results.append(tmp)
+            self._connection._consume_results = can_consume_results
+            #pylint: enable=W0212
 
             if argnames:
                 select = "SELECT {0}".format(','.join(argtypes))
@@ -888,16 +899,17 @@ def with_rows(self):
         return True
 
     def __str__(self):
-        fmt = "MySQLCursor: %s"
+        fmt = "{class_name}: {stmt}"
         if self._executed:
-            executed = bytearray(self._executed).decode('utf-8')
-            if len(executed) > 30:
-                res = fmt % (executed[:30] + '..')
-            else:
-                res = fmt % (executed)
+            try:
+                executed = self._executed.decode('utf-8')
+            except AttributeError:
+                executed = self._executed
+            if len(executed) > 40:
+                executed = executed[:40] + '..'
         else:
-            res = fmt % '(Nothing executed yet)'
-        return res
+            executed = '(Nothing executed yet)'
+        return fmt.format(class_name=self.__class__.__name__, stmt=executed)
 
 
 class MySQLCursorBuffered(MySQLCursor):
@@ -965,6 +977,9 @@ class MySQLCursorRaw(MySQLCursor):
     """
     Skips conversion from MySQL datatypes to Python types when fetching rows.
     """
+
+    _raw = True
+
     def fetchone(self):
         row = self._fetch_row()
         if row:
@@ -990,6 +1005,9 @@ class MySQLCursorBufferedRaw(MySQLCursorBuffered):
     Cursor which skips conversion from MySQL datatypes to Python types when
     fetching rows and fetches rows within execute().
     """
+
+    _raw = True
+
     def fetchone(self):
         row = self._fetch_row()
         if row:

lib/mysql/connector/cursor.py

@@ -434,6 +434,7 @@ def callproc(self, procname, args=()):
                     cur = CMySQLCursorBufferedRaw(self._cnx._get_self())
                 else:
                     cur = CMySQLCursorBuffered(self._cnx._get_self())
+                cur._executed = "(a result of {0})".format(call)
                 cur._handle_result(result)
                 # pylint: enable=W0212
                 results.append(cur)
@@ -610,15 +611,18 @@ def with_rows(self):
         return False
 
     def __str__(self):
-        fmt = "CMySQLCursor: {0}"
+        fmt = "{class_name}: {stmt}"
         if self._executed:
-            executed = self._executed.decode('utf-8')
-            if len(executed) > 30:
-                executed = executed[:30] + '..'
+            try:
+                executed = self._executed.decode('utf-8')
+            except AttributeError:
+                executed = self._executed
+            if len(executed) > 40:
+                executed = executed[:40] + '..'
         else:
             executed = '(Nothing executed yet)'
 
-        return fmt.format(executed)
+        return fmt.format(class_name=self.__class__.__name__, stmt=executed)
 
 
 class CMySQLCursorBuffered(CMySQLCursor):

lib/mysql/connector/cursor_cext.py

@@ -1,5 +1,5 @@
 # MySQL Connector/Python - MySQL driver written in Python.
-# Copyright (c) 2013, 2014, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2013, 2015, Oracle and/or its affiliates. All rights reserved.
 
 # MySQL Connector/Python is licensed under the terms of the GPLv2
 # <http://www.gnu.org/licenses/old-licenses/gpl-2.0.html>, like most

tests/__init__.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 # MySQL Connector/Python - MySQL driver written in Python.
-# Copyright (c) 2014, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2014, 2015, Oracle and/or its affiliates. All rights reserved.
 
 # MySQL Connector/Python is licensed under the terms of the GPLv2
 # <http://www.gnu.org/licenses/old-licenses/gpl-2.0.html>, like most
@@ -431,7 +431,7 @@ def test__str__(self):
         stmt = "SELECT VERSION(),USER(),CURRENT_TIME(),NOW(),SHA1('myconnpy')"
         cur.execute(stmt)
         cur.fetchone()
-        self.assertEqual("CMySQLCursor: {0}..".format(stmt[:30]),
+        self.assertEqual("CMySQLCursor: {0}..".format(stmt[:40]),
                          cur.__str__())
         cur.close()
 

tests/cext/test_cext_cursor.py

@@ -1,5 +1,5 @@
 # MySQL Connector/Python - MySQL driver written in Python.
-# Copyright (c) 2014, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2014, 2015, Oracle and/or its affiliates. All rights reserved.
 
 # MySQL Connector/Python is licensed under the terms of the GPLv2
 # <http://www.gnu.org/licenses/old-licenses/gpl-2.0.html>, like most

tests/test_abstracts.py

@@ -3856,3 +3856,68 @@ def test_password_with_spaces(self):
                 self.fail('Failed using password with spaces')
             else:
                 cnx.close()
+
+
+class BugOra21492815(tests.MySQLConnectorTests):
+    """BUG#21492815: CALLPROC() HANGS WHEN CONSUME_RESULTS=TRUE
+    """
+    def setUp(self):
+        config = tests.get_mysql_config()
+        cnx = connection.MySQLConnection(**config)
+        cur = cnx.cursor()
+
+        self.proc1 = 'Bug20834643'
+        self.proc2 = 'Bug20834643_1'
+        cur.execute("DROP PROCEDURE IF EXISTS {0}".format(self.proc1))
+
+        create = ("CREATE PROCEDURE {0}() BEGIN SELECT 1234; "
+                  "END".format(self.proc1))
+        cur.execute(create)
+        cur.execute("DROP PROCEDURE IF EXISTS {0}".format(self.proc2))
+
+        create = ("CREATE PROCEDURE {0}() BEGIN SELECT 9876; "
+                  "SELECT CONCAT('','abcd'); END".format(self.proc2))
+        cur.execute(create)
+        cur.close()
+        cnx.close()
+
+    def tearDown(self):
+        config = tests.get_mysql_config()
+        cnx = connection.MySQLConnection(**config)
+        cur = cnx.cursor()
+        cur.execute("DROP PROCEDURE IF EXISTS {0}".format(self.proc1))
+        cur.execute("DROP PROCEDURE IF EXISTS {0}".format(self.proc2))
+        cur.close()
+        cnx.close()
+
+    @cnx_config(consume_results=True, raw=True)
+    @foreach_cnx()
+    def test_set(self):
+        cur = self.cnx.cursor()
+        cur.callproc(self.proc1)
+        self.assertEqual((bytearray(b'1234'),),
+                          next(cur.stored_results()).fetchone())
+
+        cur.callproc(self.proc2)
+        exp = [[(bytearray(b'9876'),)], [(bytearray(b'abcd'),)]]
+        results = []
+        for result in cur.stored_results():
+            results.append(result.fetchall())
+        self.assertEqual(exp, results)
+        cur.close()
+
+    @cnx_config(consume_results=True, raw=False)
+    @foreach_cnx()
+    def test_set(self):
+        cur = self.cnx.cursor()
+        cur.callproc(self.proc1)
+        self.assertEqual((1234,),
+                          next(cur.stored_results()).fetchone())
+
+        cur.callproc(self.proc2)
+        exp = [[(9876,)], [('abcd',)]]
+        results = []
+        for result in cur.stored_results():
+            results.append(result.fetchall())
+        self.assertEqual(exp, results)
+        cur.close()

tests/test_bugs.py

@@ -1,5 +1,5 @@
 # MySQL Connector/Python - MySQL driver written in Python.
-# Copyright (c) 2009, 2014, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2009, 2015, Oracle and/or its affiliates. All rights reserved.
 
 # MySQL Connector/Python is licensed under the terms of the GPLv2
 # <http://www.gnu.org/licenses/old-licenses/gpl-2.0.html>, like most

tests/test_connection.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# Copyright (c) 2009, 2014, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2009, 2015, Oracle and/or its affiliates. All rights reserved.
 
 # MySQL Connector/Python is licensed under the terms of the GPLv2
 # <http://www.gnu.org/licenses/old-licenses/gpl-2.0.html>, like most
@@ -916,7 +916,7 @@ def test__str__(self):
         stmt = "SELECT VERSION(),USER(),CURRENT_TIME(),NOW(),SHA1('myconnpy')"
         self.cur.execute(stmt)
         self.cur.fetchone()
-        self.assertEqual("MySQLCursor: {0}..".format(stmt[:30]),
+        self.assertEqual("MySQLCursor: {0}..".format(stmt[:40]),
                          self.cur.__str__())
         self.cur.close()