DevAPI: Define action on adding empty list of documents

amitab · amitab · commit 771c70edc479 · 2016-08-18T14:13:21.000+05:30
Adding an empty list of documents is treated as no-operation and never throws
any errors. This behaviour is enforced even with no connection to MySQLx Server
and non-existent collections.

Added tests in mysqlx_crud.
diff --git a/lib/mysqlx/connection.py b/lib/mysqlx/connection.py
@@ -80,6 +80,11 @@ def __init__(self, settings):
         self.reader_writer = None
         self.protocol = None
 
+    def fetch_active_result(self):
+        if self._active_result is not None:
+            self._active_result.fetch_all()
+            self._active_result = None
+
     def connect(self):
         self.stream.connect(self._host, self._port)
         self.reader_writer = MessageReaderWriter(self.stream)
diff --git a/lib/mysqlx/result.py b/lib/mysqlx/result.py
@@ -574,14 +574,16 @@ class BaseResult(object):
     """
     def __init__(self, connection):
         self._connection = connection
-        self._protocol = self._connection.protocol
         self._closed = False
         self._rows_affected = 0
         self._generated_id = -1
         self._warnings = []
-        if connection._active_result is not None:
-            connection._active_result.fetch_all()
-            connection._active_result = None
+
+        if connection is None:
+            self._protocol = None
+        else:
+            self._protocol = connection.protocol
+            connection.fetch_active_result()
 
     def get_warnings(self):
         """Returns the warnings.
@@ -608,10 +610,12 @@ class Result(BaseResult):
         connection (mysqlx.connection.Connection): The Connection object.
         ids (list): A list of IDs.
     """
-    def __init__(self, connection, ids=None):
+    def __init__(self, connection=None, ids=None):
         super(Result, self).__init__(connection)
         self._ids = ids
-        self._protocol.close_result(self)
+
+        if connection is not None:
+            self._protocol.close_result(self)
 
     def get_affected_items_count(self):
         """Returns the number of affected items for the last operation.
diff --git a/lib/mysqlx/statement.py b/lib/mysqlx/statement.py
@@ -30,7 +30,7 @@
 from .compat import STRING_TYPES
 from .dbdoc import DbDoc
 from .protobuf import mysqlx_crud_pb2 as MySQLxCrud
-from .result import SqlResult
+from .result import SqlResult, Result
 
 
 class Statement(object):
@@ -238,6 +238,9 @@ def execute(self):
         Returns:
             mysqlx.Result: Result object.
         """
+        if len(self._values) == 0:
+            return Result()
+
         for doc in self._values:
             self._ids.append(doc.ensure_id())
 
diff --git a/tests/test_mysqlx_crud.py b/tests/test_mysqlx_crud.py
@@ -187,6 +187,33 @@ def test_add(self):
         self.assertEqual(result.get_affected_items_count(), 2)
         self.assertEqual(5, collection.count())
 
+        # add an array of dictionaries (flexible params)
+        result = collection.add([{"name": "Wilma", "age": 33},
+                                {"name": "Barney", "age": 42}]).execute()
+        self.assertEqual(result.get_affected_items_count(), 2)
+        self.assertEqual(7, collection.count())
+
+        # add empty documents
+        session = mysqlx.get_session(self.connect_kwargs)
+        schema = session.get_schema(self.schema_name)
+        valid_col = schema.get_collection(collection_name)
+        invalid_col = schema.get_collection('invalid_col')
+
+        result = valid_col.add().execute()
+        self.assertEqual(0, result.get_affected_items_count())
+
+        result = invalid_col.add().execute()
+        self.assertEqual(0, result.get_affected_items_count())
+
+        # can add empty documents even with no connection
+        session.close()
+        result = valid_col.add().execute()
+        self.assertEqual(0, result.get_affected_items_count())
+
+        result = invalid_col.add().execute()
+        self.assertEqual(0, result.get_affected_items_count())
+
+>>>>>>> 0bc7d3b... DevAPI: Define action on adding empty list of documents
     def test_get_document_ids(self):
         collection_name = "collection_test"
         collection = self.schema.create_collection(collection_name)
