paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-03 05:23:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add support for old Jira API's version to Jira integration.

Browse Source
This commit is contained in:
Tomasz Kolek
2017-01-30 19:26:48 +01:00
committed by Tim Abbott
parent bc20692a91
commit 11a1f1d72b
23 changed files with 1867 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
zerver/webhooks/jira/tests.py
View File

@@ -11,7 +11,14 @@ class JiraHookTests(WebhookTestCase):
url = self.build_webhook_url()
result = self.client_post(url,
self.get_body('unknown'),
self.get_body('unknown_v1'),
stream_name="jira",
content_type="application/json")
self.assert_json_error(result, "Got JIRA event type we don't support: jira:issue_unknown")
result = self.client_post(url,
self.get_body('unknown_v2'),
stream_name="jira",
content_type="application/json")
@@ -23,7 +30,7 @@ class JiraHookTests(WebhookTestCase):
url = "/api/v1/external/jira?api_key=%s&stream=jira_custom" % (api_key,)
msg = self.send_json_payload(self.TEST_USER_EMAIL,
url,
self.get_body('created'),
self.get_body('created_v2'),
stream_name="jira_custom",
content_type="application/json")
self.assertEqual(msg.topic_name(), "BUG-15: New bug with hook")
@@ -37,7 +44,8 @@ class JiraHookTests(WebhookTestCase):
expected_message = """Leo Franchi **created** [BUG-15](http://lfranchi.com:8080/browse/BUG-15) priority Major, assigned to **no one**:
> New bug with hook"""
self.send_and_test_stream_message('created', expected_subject, expected_message)
self.send_and_test_stream_message('created_v1', expected_subject, expected_message)
self.send_and_test_stream_message('created_v2', expected_subject, expected_message)
def test_created_assignee(self):
# type: () -> None
@@ -45,7 +53,8 @@ class JiraHookTests(WebhookTestCase):
expected_message = """Leonardo Franchi [Administrator] **created** [TEST-4](https://zulipp.atlassian.net/browse/TEST-4) priority Major, assigned to **Leonardo Franchi [Administrator]**:
> Test Created Assignee"""
self.send_and_test_stream_message('created_assignee', expected_subject, expected_message)
self.send_and_test_stream_message('created_assignee_v1', expected_subject, expected_message)
self.send_and_test_stream_message('created_assignee_v2', expected_subject, expected_message)
def test_commented(self):
# type: () -> None
@@ -55,7 +64,8 @@ class JiraHookTests(WebhookTestCase):
Adding a comment. Oh, what a comment it is!
"""
self.send_and_test_stream_message('commented', expected_subject, expected_message)
self.send_and_test_stream_message('commented_v1', expected_subject, expected_message)
self.send_and_test_stream_message('commented_v2', expected_subject, expected_message)
def test_comment_edited(self):
# type: () -> None
@@ -65,34 +75,37 @@ Adding a comment. Oh, what a comment it is!
Adding a comment. Oh, what a comment it is!
"""
self.send_and_test_stream_message('comment_edited', expected_subject, expected_message)
self.send_and_test_stream_message('comment_edited_v2', expected_subject, expected_message)
def test_comment_deleted(self):
# type: () -> None
expected_subject = "TOM-1: New Issue"
expected_message = "Tomasz Kolek **deleted comment from** [TOM-1](https://zuliptomek.atlassian.net/browse/TOM-1) (assigned to **kolaszek@go2.pl**)"
self.send_and_test_stream_message('comment_deleted', expected_subject, expected_message)
self.send_and_test_stream_message('comment_deleted_v2', expected_subject, expected_message)
def test_commented_markup(self):
# type: () -> None
expected_subject = "TEST-7: Testing of rich text"
expected_message = """Leonardo Franchi [Administrator] **added comment to** [TEST-7](https://zulipp.atlassian.net/browse/TEST-7):\n\n\nThis is a comment that likes to **exercise** a lot of _different_ `conventions` that `jira uses`.\r\n\r\n~~~\n\r\nthis code is not highlighted, but monospaced\r\n\n~~~\r\n\r\n~~~\n\r\ndef python():\r\n print "likes to be formatted"\r\n\n~~~\r\n\r\n[http://www.google.com](http://www.google.com) is a bare link, and [Google](http://www.google.com) is given a title.\r\n\r\nThanks!\r\n\r\n~~~ quote\n\r\nSomeone said somewhere\r\n\n~~~\n"""
self.send_and_test_stream_message('commented_markup', expected_subject, expected_message)
self.send_and_test_stream_message('commented_markup_v1', expected_subject, expected_message)
self.send_and_test_stream_message('commented_markup_v2', expected_subject, expected_message)
def test_deleted(self):
# type: () -> None
expected_subject = "BUG-15: New bug with hook"
expected_message = "Leo Franchi **deleted** [BUG-15](http://lfranchi.com:8080/browse/BUG-15)!"
self.send_and_test_stream_message('deleted', expected_subject, expected_message)
self.send_and_test_stream_message('deleted_v1', expected_subject, expected_message)
self.send_and_test_stream_message('deleted_v2', expected_subject, expected_message)
def test_reassigned(self):
# type: () -> None
expected_subject = "BUG-15: New bug with hook"
expected_message = """Leo Franchi **updated** [BUG-15](http://lfranchi.com:8080/browse/BUG-15) (assigned to **Othello, the Moor of Venice**):
* Changed assignee from **None** to **Othello, the Moor of Venice**
* Changed assignee to **Othello, the Moor of Venice**
"""
self.send_and_test_stream_message('reassigned', expected_subject, expected_message)
self.send_and_test_stream_message('reassigned_v1', expected_subject, expected_message)
self.send_and_test_stream_message('reassigned_v2', expected_subject, expected_message)
def test_priority_updated(self):
# type: () -> None
@@ -101,7 +114,18 @@ Adding a comment. Oh, what a comment it is!
* Changed priority from **Critical** to **Major**
"""
self.send_and_test_stream_message('updated_priority', expected_subject, expected_message)
self.send_and_test_stream_message('updated_priority_v1', expected_subject, expected_message)
self.send_and_test_stream_message('updated_priority_v2', expected_subject, expected_message)
def test_status_changed(self):
# type: () -> None
expected_subject = "TEST-1: Fix That"
expected_message = """Leonardo Franchi [Administrator] **updated** [TEST-1](https://zulipp.atlassian.net/browse/TEST-1):
* Changed status from **To Do** to **In Progress**
"""
self.send_and_test_stream_message('change_status_v1', expected_subject, expected_message)
self.send_and_test_stream_message('change_status_v2', expected_subject, expected_message)
def get_body(self, fixture_name):
# type: (Text) -> Text

44
zerver/webhooks/jira/view.py
View File

@@ -140,6 +140,32 @@ def get_issue_subject(payload):
# type: (Dict[str, Any]) -> Text
return "{}: {}".format(get_issue_id(payload), get_issue_title(payload))
def get_sub_event_for_update_issue(payload):
# type: (Dict[str, Any]) -> Text
sub_event = payload.get('issue_event_type_name', '')
if sub_event == '':
if payload.get('comment'):
return 'issue_commented'
elif payload.get('transition'):
return 'issue_transited'
return sub_event
def get_event_type(payload):
# type: (Dict[str, Any]) -> Text
event = payload.get('webhookEvent')
if event is None and payload.get('transition'):
event = 'jira:issue_updated'
return event
def add_change_info(content, field, from_field, to_field):
# type: (Text, Text, Text, Text) -> Text
content += "* Changed {}".format(field)
if from_field:
content += " from **{}**".format(from_field)
if to_field:
content += " to {}\n".format(to_field)
return content
def handle_updated_issue_event(payload, user_profile):
# Reassigned, commented, reopened, and resolved events are all bundled
# into this one 'updated' event type, so we try to extract the meaningful
@@ -156,7 +182,7 @@ def handle_updated_issue_event(payload, user_profile):
else:
assignee_blurb = ''
sub_event = payload.get('issue_event_type_name')
sub_event = get_sub_event_for_update_issue(payload)
if 'comment' in sub_event:
if sub_event == 'issue_commented':
verb = 'added comment to'
@@ -164,13 +190,13 @@ def handle_updated_issue_event(payload, user_profile):
verb = 'edited comment on'
else:
verb = 'deleted comment from'
content = "{} **{}** {}{}".format(get_issue_author(payload), verb, issue, assignee_blurb)
content = u"{} **{}** {}{}".format(get_issue_author(payload), verb, issue, assignee_blurb)
comment = get_in(payload, ['comment', 'body'])
if comment:
comment = convert_jira_markup(comment, user_profile.realm)
content = "{}:\n\n\n{}\n".format(content, comment)
content = u"{}:\n\n\n{}\n".format(content, comment)
else:
content = "{} **updated** {}{}:\n\n".format(get_issue_author(payload), issue, assignee_blurb)
content = u"{} **updated** {}{}:\n\n".format(get_issue_author(payload), issue, assignee_blurb)
changelog = get_in(payload, ['changelog'])
if changelog != '':
@@ -187,7 +213,13 @@ def handle_updated_issue_event(payload, user_profile):
from_field_string = item.get('fromString')
if target_field_string or from_field_string:
content += "* Changed {} from **{}** to {}\n".format(field, from_field_string, target_field_string)
content = add_change_info(content, field, from_field_string, target_field_string)
elif sub_event == 'issue_transited':
from_field_string = get_in(payload, ['transition', 'from_status'])
target_field_string = '**{}**'.format(get_in(payload, ['transition', 'to_status']))
if target_field_string or from_field_string:
content = add_change_info(content, 'status', from_field_string, target_field_string)
return content
@@ -212,7 +244,7 @@ def api_jira_webhook(request, user_profile, client,
stream=REQ(default='jira')):
# type: (HttpRequest, UserProfile, Client, Dict[str, Any], Text) -> HttpResponse
event = payload.get('webhookEvent')
event = get_event_type(payload)
if event == 'jira:issue_created':
subject = get_issue_subject(payload)
content = handle_created_issue_event(payload)