/
jira.py
271 lines (206 loc) · 9.54 KB
/
jira.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
#!/usr/bin/python
# encoding: utf-8
import argparse
import sys
from workflow import Workflow
from lib.jira import JIRA
log = None
jira = None
board_id = None
wf = None
def list_sprints():
sprints = wf.cached_data('sprints', get_sprints, max_age=360)
if sprints:
for sprint in sprints:
log.info("Sprint: %s" % sprint.name)
log.info("Sprint Id: %s" % sprint.id)
wf.add_item(title=sprint.name, valid=True)
else:
wf.add_item(title=u'No sprints found', subtitle=u'try later')
def list_incomplete_stories(query):
# incompleted_stories = wf.cached_data('stories', get_incompleted_stories, max_age=60)
incompleted_stories = get_incompleted_stories()
if not incompleted_stories:
wf.add_item(title=u'No sprint found!', subtitle=u'Create a new sprint or select another Board')
else:
if query:
incompleted_stories = wf.filter(query, incompleted_stories, key=search_key_for_issue)
for story in incompleted_stories:
if story.key:
log.info(story.key)
full_story = get_issue(story.key)
title = ' - '.join([story.key, story.fields.summary])
subtitle = ' - '.join([story.fields.priority.name, story.fields.status.name])
wf.add_item(title=title, subtitle=subtitle, arg=story.permalink(),
autocomplete='--story ' + story.key + ' ',
largetext=full_story.fields.description, copytext=story.key)
wf.store_data('key', story.key)
def get_sprints(latest_first=True):
log.info('Retrieving the sprints from JIRA')
sprints = jira.sprints(board_id)
sprints = sorted((sprint for sprint in sprints if sprint.name.startswith("Sprint ")),
key=lambda x: int(x.name.split(' ')[1]), reverse=latest_first)
return sprints
def get_current_sprint():
sprints = get_sprints()
if sprints and len(sprints) > 0:
return sprints[0]
return None
def get_incompleted_stories():
current_sprint = get_current_sprint()
if current_sprint:
log.info('Getting the incompleted stories for Sprint: ' + current_sprint.name)
return [jira.issue(x.key) for x in jira.incompleted_issues(board_id, current_sprint.id)]
return None
def setup():
username = wf.settings.get('user', None)
keychain = wf.settings.get('keychain', None)
server = wf.settings.get('server', None)
if username and keychain and server:
password = wf.get_password(account=username, service=keychain)
auth = (username, password)
return JIRA(server=server, basic_auth=auth)
else:
if board_id and int(board_id):
wf.add_item(title=u'Error connecting to the Jira Server', subtitle=u'Please check the connections details')
else:
wf.add_item(title=u'Please setup a valid Board')
wf.send_feedback()
return None
def list_subtasks(story_key):
issue = get_issue(story_key)
subtasks = issue.fields.subtasks
# wf.add_item(title='Create a new subtask', autocomplete='--add_subtask ' + story_key)
if subtasks:
for subtask in subtasks:
title = ' - '.join([subtask.key, subtask.fields.summary])
subtitle = ' - '.join([subtask.fields.priority.name, subtask.fields.status.name])
wf.add_item(title=title, subtitle=subtitle, arg=subtask.permalink(),
largetext=subtask.fields.summary, copytext=subtask.key,
autocomplete=u'--subtask ' + subtask.key)
else:
wf.add_item(title=u'The story has no subtasks', subtitle=u'Click to create one (not yet)', valid=False)
wf.add_item(title=u'Go back', autocomplete=u'--story ' + story_key)
def _load_issue():
story_key = wf.cached_data('story-key')
return jira.issue(story_key)
def get_issue(story_key):
wf.cache_data('story-key', story_key)
# story = wf.cached_data('story', _load_issue, max_age=30)
# return story
return _load_issue()
def show_story_options(story_key, is_subtask=False):
issue = get_issue(story_key)
wf.add_item(title=u'Open in Browser', subtitle=u'opens in your default browser',
largetext=issue.fields.description,
copytext=story_key,
arg=issue.permalink(), valid=True)
if not is_subtask:
wf.add_item(title=u'Browse Subtasks', subtitle=u'Show all the tasks of the story',
autocomplete='--subtasks ' + story_key + ' ')
wf.add_item(title=u'Status: ' + issue.fields.status.name, subtitle=issue.fields.status.description,
largetext=issue.fields.status.name)
if issue.fields.assignee:
wf.add_item(title=u'Assignee: ' + issue.fields.assignee.displayName, subtitle=issue.fields.assignee.name)
wf.add_item(title=u'Assign to me', subtitle=u'Replace {0} with yourself'.format(issue.fields.assignee.name),
autocomplete=u'--assign ' + story_key, valid=True)
else:
wf.add_item(title=u'Assign to me', subtitle=u'No person assigned yet',
autocomplete=u'--assign ' + story_key + ' ', valid=True)
if issue.fields.comment and issue.fields.comment.total > 0:
wf.add_item(title=u'Browse comments ', subtitle=u'Total Comments: ' + str(issue.fields.comment.total),
autocomplete=u'--comments ' + story_key + ' ')
if not is_subtask:
wf.add_item(title=u'Go back', autocomplete=u'')
else:
wf.add_item(title=u'Go back', autocomplete=u'--subtasks ' + issue.fields.parent.key)
def show_subtask_options(story_key, title):
wf.add_item(title=u'Creating Subtask For: ' + story_key, subtitle=title)
wf.store_data('subtask_title', title)
wf.add_item(title=u'Save it!', subtitle=title, autocomplete=u'--save')
def create_subtask(parent_key, description):
log.info(' '.join('Creating subtask', description, u'for story', parent_key))
parent_story = get_issue(parent_key)
subtask_fields = {
'project': {'key': parent_story.fields.project.key},
'summary': 'Test child auto created issue',
'description': description,
'issuetype': {'name': 'Sub-task'},
'parent': {'id': parent_story.key},
}
jira.create_issue(fields=subtask_fields)
def list_story_comments(story_key, is_subtask=False):
issue = get_issue(story_key)
for comment in issue.fields.comment.comments:
wf.add_item(title=comment.body,
largetext=comment.body, copytext=comment.body,
subtitle=comment.author.name, valid=True, arg=comment.self)
if is_subtask:
wf.add_item(title=u'Go back', autocomplete=u'--subtasks ' + story_key)
else:
wf.add_item(title=u'Go back', autocomplete=u'--story ' + story_key)
def search_key_for_issue(issue):
"""Generate a string search key for a story or subtasks"""
elements = [issue.key]
if issue.fields.summary:
elements.append(issue.fields.summary)
if issue.fields.description:
elements.append(issue.fields.description) # description
return u' '.join(elements)
def search_key_for_board(board):
"""Generate a string search key for a story or subtasks"""
elements = [str(board.id)]
if board.name:
elements.append(board.name)
return u' '.join(elements)
def list_boards(query=None):
boards = jira.boards()
for board in wf.filter(query, boards, max_results=7, key=search_key_for_board):
wf.add_item(title=board.name, subtitle=u'Board Id: {0}'.format(board.id), valid=True,
arg=unicode(board.id))
# wf.add_item(title='More', autocomplete=u'--boards '+ str(initial + 1))
def assign_to_me(issue):
username = wf.settings.get('user', None)
jira.assign_issue(issue, username)
def main(wf):
log.info(wf.args)
parser = argparse.ArgumentParser()
parser.add_argument('--story', dest='story', nargs='?', default=None)
parser.add_argument('--subtasks', dest='subtasks', nargs='?', default=None)
parser.add_argument('--subtask', dest='subtask', nargs='?', default=None)
parser.add_argument('--comments', dest='comments', nargs='?', default=None)
parser.add_argument('--comments_sub', dest='comments_sub', nargs='?', default=None)
parser.add_argument('--add_subtasks', dest='add_subtask', nargs='?', default=None)
parser.add_argument('--boards', dest='boards', nargs='?', default=None)
parser.add_argument('--assign', dest='assign', nargs='?', default=None)
# parser.add_argument('--save', dest='save_subtask', nargs='?', default=None)
parser.add_argument('query', nargs='?', default=None)
args = parser.parse_args(wf.args)
if args.story:
show_story_options(args.story)
elif args.subtask:
show_story_options(args.subtask, is_subtask=True)
elif args.subtasks:
list_subtasks(args.subtasks)
elif args.comments:
list_story_comments(args.comments)
elif args.comments_sub:
list_story_comments(args.comments, is_subtask=True)
elif args.add_subtask:
show_subtask_options(args.add_subtask, args.title)
elif args.boards:
list_boards(args.boards)
elif args.assign:
assign_to_me(args.assign)
# elif args.save_subtask:
# create_subtask(wf.stored_data('key'), wf.stored_data('subtask_title'))
else:
list_incomplete_stories(args.query)
wf.send_feedback()
if __name__ == '__main__':
wf = Workflow()
# wf.cache_serializer = 'cpickle'
log = wf.logger
board_id = wf.settings.get('sprint_board', None)
jira = setup()
sys.exit(wf.run(main))