BUG27535063: Fix wrong error message when specifying the collation for a non TEXT field

nmariz · nmariz · commit cd3b71b81af9 · 2020-07-17T10:33:27.000+01:00
When creating an index on a collection, if a collation is specified but the
field is not of the type TEXT, then an error message is generated but
with a wrong field type.

This patch fixes the issue by setting the correct field type. Previously
it always raised with "GEOJSON" for all field types.

Tests were added for regression.
diff --git a/lib/mysqlx/statement.py b/lib/mysqlx/statement.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2016, 2020, 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
@@ -1405,25 +1405,23 @@ def execute(self):
                     if not constraint["type"].upper().startswith("TEXT"):
                         raise ProgrammingError(
                             "The 'collation' member can only be used when "
-                            "field  type is set to 'GEOJSON'")
-                    else:
-                        constraint["collation"] = field_desc.pop("collation")
+                            "field type is set to '{}'"
+                            "".format(constraint["type"].upper()))
+                    constraint["collation"] = field_desc.pop("collation")
                 # "options" and "srid" fields in IndexField can be
                 # present only if "type" is set to "GEOJSON"
                 if "options" in field_desc:
                     if constraint["type"].upper() != "GEOJSON":
                         raise ProgrammingError(
                             "The 'options' member can only be used when "
                             "index type is set to 'GEOJSON'")
-                    else:
-                        constraint["options"] = field_desc.pop("options")
+                    constraint["options"] = field_desc.pop("options")
                 if "srid" in field_desc:
                     if constraint["type"].upper() != "GEOJSON":
                         raise ProgrammingError(
                             "The 'srid' member can only be used when index "
                             "type is set to 'GEOJSON'")
-                    else:
-                        constraint["srid"] = field_desc.pop("srid")
+                    constraint["srid"] = field_desc.pop("srid")
                 args["constraint"].append(constraint)
         except KeyError as err:
             raise ProgrammingError("Required inner member {} not found in "
diff --git a/tests/test_mysqlx_crud.py b/tests/test_mysqlx_crud.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-# Copyright (c) 2016, 2020, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2016, 2020, 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
@@ -2152,6 +2152,29 @@ def test_create_index(self):
         create_index = collection.create_index(index_name, index_desc)
         self.assertRaises(TypeError, create_index.execute)
 
+        # check error message for wrong collation
+        err_msg = ("The 'collation' member can only be used when field type "
+                   "is set to '{}'")
+        index_name = "age_idx"
+        index_desc = {"fields": [{"field": "$.age", "type": "INT",
+                                  "collation": "utf8mb4_0900_ai_ci"}],
+                      "type": "INDEX"}
+        create_index = collection.create_index(index_name, index_desc)
+        try:
+            create_index.execute()
+        except mysqlx.ProgrammingError as err:
+            self.assertEqual(err.msg, err_msg.format("INT"))
+
+        index_name = "emails_idx"
+        index_desc = {"fields": [{"field": "$.emails", "type": "CHAR(128)",
+                                  "collation": "utf8mb4_0900_ai_ci"}],
+                      "type": "INDEX"}
+        create_index = collection.create_index(index_name, index_desc)
+        try:
+            create_index.execute()
+        except mysqlx.ProgrammingError as err:
+            self.assertEqual(err.msg, err_msg.format("CHAR(128)"))
+
         self.schema.drop_collection(collection_name)
 
     @unittest.skipIf(tests.MYSQL_VERSION < (8, 0, 4), "Dev API change")
