Change (add|update)_field_value actions to return issue dict. (#59)

Fix update_field_value when field is 'labels'

Signed-off-by: Jeremiah Millay <[email protected]>

CHANGES.md

@@ -1,5 +1,17 @@
 # Change Log
 
+## 2.4.0
+
+- `add_field_value` and `update_field_value` actions now return a dictionary representation of the issue being modified. Previously these actions would return
+only the `labels` field if it exists as an attribute. This addresses [#53](https://github.com/StackStorm-Exchange/stackstorm-jira/issues/53) but is also beneficial for displaying other field values (inclusive of `labels`) that may have been updated.
+
+- Fix for [#54](https://github.com/StackStorm-Exchange/stackstorm-jira/issues/54) which prevents callers of the `update_field_value` action from updating `labels` which must be passed as a list via the api. As labels cannot contain spaces we split
+the `value` field of this action on whitespace in the case where `field` == `"labels"`. Example invocation:
+
+```
+st2 action execute jira.update_field_value issue_key=NETOPS-1 field=labels value='Label1 Label2'
+```
+
 ## 2.3.1
 
 - Update `README.md` to include `api_token` as an auth method

actions/add_field_value.py

@@ -1,4 +1,5 @@
 from lib.base import BaseJiraAction
+from lib.formatters import to_issue_dict
 
 __all__ = [
     'AddFieldValue'
@@ -9,5 +10,4 @@ class AddFieldValue(BaseJiraAction):
     def run(self, issue_key, field, value):
         issue = self._client.issue(issue_key)
         issue.add_field_value(field, value)
-        result = issue.fields.labels
-        return result
+        return to_issue_dict(issue)

actions/lib/formatters.py

@@ -35,7 +35,7 @@ def to_issue_dict(issue, include_comments=False, include_attachments=False,
         'description': issue.fields.description,
         'status': issue.fields.status.name,
         'resolution': resolution,
-        'labels': issue.fields.labels,
+        'labels': issue.fields.labels if hasattr(issue.fields, 'labels') else [],
         'reporter': reporter,
         'assignee': assignee,
         'created_at': issue.fields.created,

actions/update_field_value.py

@@ -1,4 +1,5 @@
 from lib.base import BaseJiraAction
+from lib.formatters import to_issue_dict
 
 __all__ = [
     'UpdateFieldValue'
@@ -8,6 +9,7 @@
 class UpdateFieldValue(BaseJiraAction):
     def run(self, issue_key, field, value, notify):
         issue = self._client.issue(issue_key)
+        if field == "labels":
+            value = value.split()
         issue.update(fields={field: value}, notify=notify)
-        result = issue.fields.labels
-        return result
+        return to_issue_dict(issue)

pack.yaml

@@ -6,7 +6,7 @@ keywords:
   - issues
   - ticket management
   - project management
-version: 2.3.1
+version: 2.4.0
 python_versions:
   - "3"
 author : StackStorm, Inc.