Add an append action for entry array properties

plus fix a few typos

Signed-off-by: Jacob Floyd <cognifloyd@gmail.com>

Author: cognifloyd

README.md

@@ -50,6 +50,10 @@ You can also use dynamic values from the datastore. See the
   of a JSON serialized object. Then, serialize and store the updated object.
   The property's value may be any json-serializable type.
   Fails if the datastore key does not exist. A coordination backend is recommended.
+* ``kv.append_entry_property`` - Add the value to the end of an array property
+  in the named entry of a JSON serialized object. Then, serialize and store the
+  updated object. The property must be an array. The value to append can be anything.
+  Fails if the datastore key does not exist. A coordination backend is recommended.
 * ``kv.delete_entry_property`` - Delete a property from a named entry of a JSON
   serialized object in the datastore. If the entry is empty, delete it as well.
   Fails if the datastore key does not exist. A coordination backend is recommended.

actions/kv_append_entry_property.py

@@ -0,0 +1,55 @@
+import json
+
+from st2common.services import coordination as coordination_service
+
+from lib.action import St2BaseAction
+
+__all__ = [
+    'St2KVPAppendEntryPropertyAction'
+]
+
+
+class St2KVPAppendEntryPropertyAction(St2BaseAction):
+    # noinspection PyShadowingBuiltins
+    def run(self, key, entry, property, value):
+        with coordination_service.get_coordinator().get_lock('st2.kv_entry.' + key):
+            # get and deserialize object or fail.
+            _key = self.client.keys.get_by_name(key, decrypt=False)
+
+            if not _key:
+                raise Exception("Key does not exist in datastore")
+
+            # optimistically try to decode a json value
+            try:
+                value = json.loads(value)
+            except (TypeError, ValueError):
+                # assume it is either already decoded (TypeError)
+                # or it is a plain string (ValueError)
+                # (malformed JSON objects/arrays will be strings)
+                pass
+
+            deserialized = json.loads(_key.value)
+
+            # update or insert object.entry.property
+            _entry = deserialized.get(entry, {})
+            _property = _entry.get(property, [])
+            try:
+                _property.append(value)
+            except AttributeError:
+                raise Exception("Cannot append. Property {}.{}.{} is not an array!".format(key, entry, property))
+
+            _entry[property] = _property
+            deserialized[entry] = _entry
+
+            # re-serialize and save
+            serialized = json.dumps(deserialized)
+            kvp = self._kvp(name=key, value=serialized)
+            kvp.id = key
+
+            self.client.keys.update(kvp)
+            response = {
+                'key': key,
+                'entry_name': entry,
+                'entry': _entry,
+            }
+            return response

actions/kv_append_entry_property.yaml

@@ -0,0 +1,29 @@
+---
+name: 'kv.append_entry_property'
+enabled: true
+description: |
+  Add a value to the end of an array property under a named entry (sub-object)
+  of a serialized object in kv datastore.
+  Fails if the key does not exist in the datastore, as a property inside it can't be appended to yet.
+  The kv object uses this structure: { entry: { property: [value, value], ...}, ...}
+  This action does not support encrypted datastore objects.
+
+runner_type: python-script
+entry_point: kv_append_entry_property.py
+parameters:
+  key:
+    required: true
+    type: string
+  entry:
+    description: name of the key's entry
+    required: false
+    type: string
+    default: default
+  property:
+    description: name of the entry's property to append to (property should have an array value)
+    required: true
+    type: string
+  value:
+    description: the value may be any json-serializable type (string, number, array, object)
+    required: true
+    # type: any

actions/kv_delete_entry_property.yaml

@@ -2,7 +2,7 @@
 name: 'kv.delete_entry_property'
 enabled: true
 description: |
-  Delete a property (if it exists) under an named entry (sub-object) of a
+  Delete a property (if it exists) under a named entry (sub-object) of a
   serialized object in kv datastore. If the entry is empty after deleting
   the property, this deletes the entry as well.
   Fails if the key does not exist in the datastore.

actions/kv_upsert_entry_property.yaml

@@ -2,7 +2,7 @@
 name: 'kv.upsert_entry_property'
 enabled: true
 description: |
-  Insert or update a property under an named entry (sub-object) of a serialized object in kv datastore.
+  Insert or update a property under a named entry (sub-object) of a serialized object in kv datastore.
   Fails if the key does not exist in the datastore, as a property inside it can't be upserted yet.
   The kv object uses this structure: { entry: { property: value, ... }, entry: {}, ...}
   This action does not support encrypted datastore objects.
@@ -23,6 +23,6 @@ parameters:
     required: true
     type: string
   value:
-    description: the property value may be any json-serialible type (string, number, array, object)
+    description: the property value may be any json-serializable type (string, number, array, object)
     required: true
     # type: any