Merge pull request #1417 from OlehPalanskyi/master

Updating the Jira alert for scenarios where we need to create subtask (child issues) within existing tasks.

Author: jertel

CHANGELOG.md

@@ -4,7 +4,7 @@
 - Renamed PR #1193's `fields` common rule option to `include_fields` due to collision with `new_term` rule type's existing `field` parameter - [#1408](https://github.com/jertel/elastalert2/pull/1408) - @jertel
 
 ## New features
-- None
+- [Jira] Add ability to create a subtask, etc of an existing parent - [#1417](https://github.com/jertel/elastalert2/pull/1417) - @olehpalanskyi
 
 ## Other changes
 - [workwechat] add workwechat msgtype - [#1369](https://github.com/jertel/elastalert2/pull/1369) - @bitqiu

docs/source/alerts.rst

@@ -1195,6 +1195,26 @@ This alert requires four additional options:
 
 Optional:
 
+``jira_parent``: Specify an existing ticket that will be used as a parent to create a new subtask in it
+
+  For example, if you have this issue hierarchy:
+    Epic
+    Story, Task, Bug
+    Subtask
+
+  Then:
+    As a parent issue, an epic can have stories, tasks, and bugs as subtask (child issues).
+    As a parent issues, task, stories and bugs can have subtasks as subtask (child issues).
+    A subtask can’t have any subtask (child issues).
+
+  Example usage::
+
+      jira_server: "https://example.atlassian.net/"
+      jira_project: "XXX"
+      jira_assignee: user@example.com
+      jira_issuetype: "Sub-task"
+      jira_parent: "XXX-3164"
+
 ``jira_assignee``: Assigns an issue to a user.
 
 ``jira_component``: The name of the component or components to set the ticket to. This can be a single string or a list of strings. This is provided for backwards compatibility and will eventually be deprecated. It is preferable to use the plural ``jira_components`` instead.

elastalert/alerters/jira.py

@@ -46,6 +46,7 @@ class JiraAlerter(Alerter):
         'jira_server',
         'jira_transition_to',
         'jira_watchers',
+        'jira_parent'
     ]
 
     # Some built-in Jira types that can be used as custom fields require special handling
@@ -66,6 +67,8 @@ def __init__(self, rule):
         self.get_account(self.rule['jira_account_file'])
         self.project = self.rule['jira_project']
         self.issue_type = self.rule['jira_issuetype']
+        # this parameter use to create subtasks
+        self.parent = self.rule.get('jira_parent', None)
 
         # Deferred settings refer to values that can only be resolved when a match
         # is found and as such loading them will be delayed until we find a match
@@ -126,8 +129,13 @@ def set_priority(self):
             elastalert_logger.error("Priority %s not found. Valid priorities are %s" % (self.priority, list(self.priority_ids.keys())))
 
     def reset_jira_args(self):
-        self.jira_args = {'project': {'key': self.project},
-                          'issuetype': {'name': self.issue_type}}
+        if self.parent:
+            self.jira_args = {'project': {'key': self.project},
+                                'parent': {'key': self.parent},
+                                'issuetype': {'name': self.issue_type}}
+        else:
+            self.jira_args = {'project': {'key': self.project},
+                            'issuetype': {'name': self.issue_type}}
 
         if self.components:
             # Support single component or list
@@ -411,4 +419,4 @@ def get_account(self, account_file):
             self.apikey = account_conf['apikey']
         else:
             self.user = account_conf['user']
-            self.password = account_conf['password']
+            self.password = account_conf['password']

tests/alerters/jira_test.py

@@ -429,3 +429,64 @@ def test_jira_auth_token(caplog):
     ]
     # we only want to test authentication via apikey, the rest we don't care of
     assert mock_jira.mock_calls[:1] == expected
+
+
+def test_create_subtask(caplog):
+    caplog.set_level(logging.INFO)
+    description_txt = "Description stuff goes here like a runbook link."
+    rule = {
+        'name': 'test alert',
+        'jira_account_file': 'jirafile',
+        'type': mock_rule(),
+        'jira_project': 'testproject',
+        'jira_priority': 0,
+        'jira_issuetype': 'testtype',
+        'jira_parent': 'PARENT-123',  # ID of the parent issue
+        'jira_server': 'jiraserver',
+        'jira_label': 'testlabel',
+        'jira_component': 'testcomponent',
+        'jira_description': description_txt,
+        'jira_assignee': 'testuser',
+        'jira_watchers': ['testwatcher1', 'testwatcher2'],
+        'timestamp_field': '@timestamp',
+        'alert_subject': 'Issue {0} occurred at {1}',
+        'alert_subject_args': ['test_term', '@timestamp'],
+        'rule_file': '/tmp/foo.yaml',
+    }
+
+    mock_priority = mock.Mock(id='5')
+
+    with mock.patch('elastalert.alerters.jira.JIRA') as mock_jira, \
+            mock.patch('elastalert.alerters.jira.read_yaml') as mock_open:
+        mock_open.return_value = {'user': 'jirauser', 'password': 'jirapassword'}
+        mock_jira.return_value.priorities.return_value = [mock_priority]
+        mock_jira.return_value.fields.return_value = []
+        alert = JiraAlerter(rule)
+        alert.alert([{'test_term': 'test_value', '@timestamp': '2014-10-31T00:00:00'}])
+
+    expected = [
+        mock.call('jiraserver', basic_auth=('jirauser', 'jirapassword')),
+        mock.call().priorities(),
+        mock.call().fields(),
+        mock.call().create_issue(
+            issuetype={'name': 'testtype'},
+            priority={'id': '5'},
+            project={'key': 'testproject'},
+            labels=['testlabel'],
+            components=[{'name': 'testcomponent'}],
+            description=mock.ANY,
+            summary='Issue test_value occurred at 2014-10-31T00:00:00',
+            parent={'key': 'PARENT-123'}  # Asserting that subtask is created with correct parent
+        ),
+        mock.call().assign_issue(mock.ANY, 'testuser'),
+        mock.call().add_watcher(mock.ANY, 'testwatcher1'),
+        mock.call().add_watcher(mock.ANY, 'testwatcher2'),
+    ]
+    # We don't care about additional calls to mock_jira, such as __str__
+    # we only want to test creating subtasks, the rest we don't care of
+    assert mock_jira.mock_calls[:7] == expected
+    assert mock_jira.mock_calls[3][2]['description'].startswith(description_txt)
+    user, level, message = caplog.record_tuples[0]
+    assert 'elastalert' == user
+    assert logging.INFO == level
+    assert 'pened Jira ticket:' in message