-
Notifications
You must be signed in to change notification settings - Fork 0
/
ZeroHour.py
350 lines (289 loc) · 14.7 KB
/
ZeroHour.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
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
import sys
import requests, trello, pyral #NOTE: pyral Doesn't support Python 3 and bug #40 is an issue
import csv
import getpass
import datetime
import re
import html2text
import urllib
from pyral import Rally, rallyWorkset
"""
ZeroHour Package v0.2
[Package for linking Rally and Trello]
**** Requires a custom version of pyral ****
TODO : Deal with command line arguments better.
Perhaps a ZeroHourProperties class that
holds all the values and move the global
vars in there as well.
: Extend to sync Rally and Trello
- Deal with the difference in comments (HTML (fancy Rally type) > Markdown > HTML (no fancy Rally type))
- Figure out a strategy to deal with duplicates in Trello
- What to do about comments (Rally only has a comments box, not seperate comments)
- Optimise this script, it's run time is not fast enough for constant synching
- If there are changes, what side of the change is new?
"""
UNDER_DEVELOPMENT = True
DEBUG_OUTPUT = True
RALLY_PREFIX = re.compile(r'^[A-Z]*[^[0-9]]*')
RALLY_ID_FROM_TRELLO= re.compile(r'^[.]*[^-]*')
def parseCommandLineOptions(cmdLineOptions):
"""Parse arguments (a list) into a dictionary
No idea why the argument order gets messed up
>>> parseCommandLineOptions(['--testa=a','--testb=b','--testc=c'])
{'testa': 'a', 'testc': 'c', 'testb': 'b'}"""
optionsDictionary = dict()
for option in cmdLineOptions:
parts = option[2:].split('=')
optionsDictionary[parts[0]] = parts[1]
return optionsDictionary
def initTrello(cmdLineOptions):
"""Return a trelloApi that has the token set. If no token provided, output token URL. Also check required arguments are present"""
requiredOptions = {'trelloUser', 'trelloBoard', 'trelloList'}
print 'Setting up Trello (trello v(0.9.1))...'
if 'trelloID' in cmdLineOptions:
trelloApi = trello.TrelloApi(cmdLineOptions['trelloID'])
else:
print "ERROR: No trelloID specified"
sys.exit()
if 'trelloToken' not in cmdLineOptions:
url = trelloApi.get_token_url("Rally Integration")
print "ERROR: trelloToken required: Token URL: '{}'".format(url)
sys.exit()
if not requiredOptions.issubset(cmdLineOptions):
print "ERROR: One of more of the required Trello options ({}) missing.".format(requiredOptions)
sys.exit()
trelloApi.set_token(cmdLineOptions['trelloToken'])
return trelloApi
def getTrelloBoardsForUser(trelloID, trelloToken, trelloUserName):
boards = trello.Members(trelloID, trelloToken).get_board(trelloUserName)
return boards
def getTrelloBoard(trelloID, trelloToken, trelloUserName, boardName):
"""Return a Trello Board object from Trello server"""
boards = getTrelloBoardsForUser(trelloID, trelloToken, trelloUserName)
tBoards = [board for board in boards if board['name'] == boardName]
if len(tBoards) < 1:
print "ERROR: Trello board '{}' not found.".format(boardName)
sys.exit()
return tBoards[0]
def getTrelloListsForBoard(trelloID, trelloToken, trelloBoard):
"""Return all lists for the given Trello board"""
lists = trello.Boards(trelloID, trelloToken).get_list(trelloBoard['id'])
return lists
def getAllTrelloTicketsForBoard(trelloID, trelloToken, trelloBoard):
"""Return a list of all Trello tickets from all lists for the given board"""
lists = getTrelloListsForBoard(trelloID, trelloToken, trelloBoard)
cardsInBoard = []
for list in lists:
cardsInList = trello.Lists(trelloID, trelloToken).get_card(list['id'])
print "Adding {} cards for {}".format(len(cardsInList), list['name'])
cardsInBoard += cardsInList
return cardsInBoard
def getTrelloList(trelloID, trelloToken, trelloBoard, trelloListName):
"""Return a Trello List object from Trello server"""
allTrelloLists = getTrelloListsForBoard(trelloID, trelloToken, trelloBoard)
tLists = [list for list in allTrelloLists if list['name'] == trelloListName]
if len(tLists) < 1:
print "ERROR: Trello list '{}' not found.".format(cmdLineOptions['trelloList'])
sys.exit()
return tLists[0]
def getRallyArtifactTypeFromID(FullFormattedID):
"""Returns Rally.ARTIFACT_TYPE given a FormattedID by extracting the prefix and looking it up in pyral
e.g. DE7410 = [DE]7410 = 'Defect'
>>> getRallyArtifactTypeFromID('DE7410')
'Defect'
>>> getRallyArtifactTypeFromID('S1234')
'Story'
>>> getRallyArtifactTypeFromID('US1234')
'Story'
"""
return Rally.ARTIFACT_TYPE[re.search(RALLY_PREFIX, FullFormattedID).group(0)]
def extractRallyIDFromTrelloTitle(trelloTitle):
"""Return the Rally ID at the start of trelloTitle of the form '[ID] - [...]' or None if not title is not of the correct form"""
result = re.search(RALLY_ID_FROM_TRELLO, trelloTitle)
if result:
return result.group(0).strip()
else:
return None
def initRally(cmdLineOptions):
requiredOptions = {'rallyServer','rallyUser','rallyPassword'}
print 'Setting up Rally (pyral v{version})...'.format(version = pyral.__version__)
if not requiredOptions.issubset(cmdLineOptions):
print "ERROR: One of more of the required Rally options ({}) missing.".format(requiredOptions)
sys.exit()
return Rally(cmdLineOptions['rallyServer'], cmdLineOptions['rallyUser'], cmdLineOptions['rallyPassword'])
def getUserAndEmailList(rally, trelloID, trelloToken, trelloBoard):
"""Return a dict of Trello usernames to Rally/Trello e-mails using full name to link them
[Username (trello) <-- Full Name (Both) --> E-mail (rally)]
This is necessary because Trello users can only view their own e-mail addresses"""
emailList = dict()
all_users = rally.getAllUsers() #XXX This call crashes pyral 1.1.1 - Custom pyral changes are needed
for user in all_users:
rallyName = ("{} {}".format(user.FirstName, user.LastName)).lower()
emailList[rallyName] = user.EmailAddress
boardMembers = trello.Boards(trelloID, trelloToken).get_member(trelloBoard['id'])
emailToUserName = dict()
for member in boardMembers:
trelloName = ("{}".format(member['fullName'])).lower()
emailToUserName[member['username']] = emailList[trelloName]
return emailToUserName
def getRallyUserNameQueryString(nameDictionary):
"""Return query string which includes all users listen in nameDictionary such that:-
((((
(Owner.UserName = "a@evogi.com") OR (Owner.UserName = "b@evogi.com")
) OR (Owner.UserName = "c@evogi.com")
) OR (Owner.UserName = "d@evogi.com")
) OR (Owner.UserName = "e@evogi.com")
)
- First condition is standard ((name = a) OR (name = b))
- For every extra condition, prepend with '(' then add 'OR (new condition)' and finish with ')''
>>> getRallyUserNameQueryString({'steve' : 'steve@evogi.com'})
'AND (Owner.UserName = "steve@evogi.com")'
>>> getRallyUserNameQueryString({'steve' : 'steve@evogi.com', 'bob' : 'bob@evogi.com'})
'AND ((Owner.UserName = "steve@evogi.com") OR (Owner.UserName = "bob@evogi.com"))'
"""
usersQuery = ""
i = 1
for user in nameDictionary:
userQuery = "(Owner.UserName = \"{}\")".format(nameDictionary[user])
if i > 1:
usersQuery = "({} OR {})".format(usersQuery, userQuery)
else:
usersQuery = userQuery
i+=1
return "AND {}".format(usersQuery)
def buildRallyArtifactInclusionQuery(rally, trelloID, trelloToken, trelloBoard):
users_rallyToTrello = getUserAndEmailList(rally, trelloID, trelloToken, trelloBoard)
users_query = getRallyUserNameQueryString(users_rallyToTrello)
inclusionQuery = "(State != Completed) {}".format(users_query)
if DEBUG_OUTPUT: print "Getting Rally tasks in the criteria '{}'".format(inclusionQuery)
return inclusionQuery
def getRallyRallyArtifactList(rally, inclusionQuery, migrationFile=""):
"""Get all Rally artifacts that match required criteria"""
print "Retrieving list of Rally artifacts to migrate..."
backupMigrationListToFile = len(migrationFile) > 0
if backupMigrationListToFile: migrationList = open(migrationFile, 'w')
openTasks = []
response = rally.get('Task', fetch="FormattedID", query=inclusionQuery, order='DragAndDropRank')
print "\t{} Tasks found".format(response.resultCount)
for story in response:
openTasks.append(story.FormattedID)
if backupMigrationListToFile: migrationList.write("{}\n".format(story.FormattedID))
if DEBUG_OUTPUT: print "Added {} to Rally tasks...".format(story.FormattedID)
print "...{} artifacts collected.".format(len(openTasks))
if backupMigrationListToFile: migrationList.close()
return openTasks
class TrelloCard:
"""Representation of a card on Trello, essentially a 'Defect' or 'UserStory' containing multiple 'Task's"""
def __init__(self, cardID):
self.cardID = cardID
self.tasks = []
self.orderValue = 0
def setOrderValue(self, val):
self.orderValue = val
def addTask(self, task):
self.tasks.append(task)
def printtrelloCardsFromRally(trelloCardsFromRally):
"""Output heirachical list provided trello cards"""
print "\n****** WorkProducts and Children ******"
for cardID in trelloCardsFromRally:
print "{} : {}".format(trelloCardsFromRally[cardID].cardID, getRallyArtifactTypeFromID(cardID))
for task in trelloCardsFromRally[cardID].tasks:
print "\t{} : {}".format(task.FormattedID, getRallyArtifactTypeFromID(task.FormattedID))
print "***************************************\n"
def sortArtifactsIntoTrelloTasks(rally, cardList = []):
"""Return a list of top level TrelloCard objects with associated Trello Tasks sorted into them
Requires a Rally object to make requests on object to figure out WorkItem (parent)"""
print "Sorting Trello Tasks into parent Artifacts/Cards"
trelloCardsFromRally = dict()
for id in cardList:
items = rally.get('Task', fetch=True, query="({})".format("FormattedID = {}".format(id)))
if items.resultCount is 1:
rallyItem = items.next()
parentFormattedID = getattr(rallyItem.WorkProduct, 'FormattedID')
if parentFormattedID not in trelloCardsFromRally:
if DEBUG_OUTPUT: print "Creating card {}".format(parentFormattedID)
trelloCard = TrelloCard(parentFormattedID)
trelloCardsFromRally[parentFormattedID] = trelloCard
if DEBUG_OUTPUT: print "\tAdding {} to card {}".format(rallyItem.FormattedID, parentFormattedID)
trelloCardsFromRally[parentFormattedID].addTask(rallyItem)
if DEBUG_OUTPUT: printtrelloCardsFromRally(trelloCardsFromRally)
return trelloCardsFromRally
def orderCards(rally, cards):
"""Return a DragAndDropRank ordered array of TrelloCard (cards) ID"""
print "Calculating DragAndDropRank order..."
orderedParentCards = [] ##get a list of all cards
countDone = 0
for cardID in cards:
cardArtifactType = getRallyArtifactTypeFromID(cardID)
items = rally.get(cardArtifactType, fetch=True, query="({})".format("FormattedID = {}".format(cardID)), order='DragAndDropRank')
orderedParentCards.extend(items)
#Order parent cards by DragAndDropRank
orderedParentCards.sort(key=lambda c: c.DragAndDropRank, reverse=True)
return orderedParentCards
def addTrelloTasklist(trelloCard, tasks, trelloID, trelloToken):
remotetrelloCardsFromRally = trello.Cards(trelloID, trelloToken)
trelloChecklists = trello.Checklists(trelloID, trelloToken)
taskList = remotetrelloCardsFromRally.new_checklist(trelloCard['id'], None)
trelloChecklists.update_name(taskList['id'], "Tasks")
for task in tasks:
trelloChecklists.new_checkItem(taskList['id'], task.Name)
def addTrelloCard(cardTitle, description, trelloID, trelloToken, trelloList):
remotetrelloCardsFromRally = trello.Cards(trelloID, trelloToken)
cardOnTrello = remotetrelloCardsFromRally.new(cardTitle, trelloList['id'], description)
return cardOnTrello
def addTrelloCardWithTasks(card, tasks, trelloID, trelloToken, trelloList, changeLog):
"""Add 'card' to LIVE Trello with 'tasks'"""
cardArtifactType = getRallyArtifactTypeFromID(card.FormattedID)
print "Adding {} ({})...".format(cardArtifactType, card.FormattedID)
descriptionAsMarkdown = html2text.html2text(card.Description)
cardTitle = "{} - {}".format(card.FormattedID, card.Name)
try:
cardOnTrello = addTrelloCard(cardTitle, descriptionAsMarkdown, trelloID, trelloToken, trelloList)
addTrelloTasklist(cardOnTrello, tasks, trelloID, trelloToken)
changeLog.write("{} Added Trello card with {} tasks, for {}\n".format(datetime.datetime.now(), len(tasks), card.FormattedID))
except Exception as ex: #TODO More info - Should only catch ConnectionError and HTTPError
template = "An exception of type {0} occured. \nArguments:{1!r}"
message = template.format(type(ex).__name__, ex.args)
print message
changeLog.write("{} ERROR adding trello card {}: {}\n\t{}\n".format(datetime.datetime.now(), card.FormattedID, type(ex).__name__, ex.args))
def addtrelloCardsFromRally(orderedParentCards, trelloCardsFromRally, trelloID, trelloToken, trelloList, changeLog):
for card in orderedParentCards:
addTrelloCardWithTasks(card, trelloCardsFromRally[card.FormattedID].tasks, trelloID, trelloToken, trelloList, changeLog)
def migrateRallyArtifactsToTrello(rally, trelloID, trelloToken, trelloBoard):
"""Migrate non-closed Rally artifacts to Trello as Cards (Artifacts) and Checklists (Tasks) if they have a matching user on the given trelloBoard"""
artifactQuery = buildRallyArtifactInclusionQuery(rally, trelloID, trelloToken, trelloBoard)
tasksForMigration = getRallyRallyArtifactList(rally, artifactQuery, 'migration.list')
trelloCardsFromRally = sortArtifactsIntoTrelloTasks(rally, tasksForMigration)
orderedParentCards = orderCards(rally, trelloCardsFromRally)
zerohour.addtrelloCardsFromRally(orderedParentCards, trelloCardsFromRally, trelloID, trelloToken, tList, changeLog)
def syncRallyAndPython(rally, trelloID, trelloToken, trelloBoard):
print "Synching Rally to Trello board {}".format(trelloBoard['name'])
#get all Rally tickets
artifactQuery = buildRallyArtifactInclusionQuery(rally, trelloID, trelloToken, trelloBoard)
rallyTasks = getRallyRallyArtifactList(rally, artifactQuery, 'rallyArtifact.list')
trelloCardsFromRally = sortArtifactsIntoTrelloTasks(rally, rallyTasks)
#get all Trello tickets (that's every ticket on a given board, in every list)
lists = getTrelloListsForBoard(trelloID, trelloToken, trelloBoard)
tickets = getAllTrelloTicketsForBoard(trelloID, trelloToken, trelloBoard)
#Compare all details from tickets and trelloCardsFromRally
synchFile = open("synch.list", "w")
trelloTicketIDs = []
for ticket in tickets:
rallyID = extractRallyIDFromTrelloTitle(ticket['name'])
if rallyID:
trelloTicketIDs += rallyID #if it doesn't have a rally ID, there's no point synching it
if rallyID in trelloCardsFromRally:
synchFile.write("{}\n".format(rallyID))
print "{} Found! with {} Tasks".format(rallyID, len(trelloCardsFromRally[rallyID].tasks))
else:
synchFile.write(">>>{}\n".format(rallyID))
print "{} NOT Found!".format(rallyID)
else:
print "No Rally ID found for Trello card '{}'".format(ticket['name'])
for rallyArtifact in trelloCardsFromRally:
if rallyArtifact not in trelloTicketIDs:
synchFile.write("<<<{}\n".format(rallyArtifact))
synchFile.close()
# TODO Add non-existing Artifacts/Cardss
# TODO "Merge" changes...HOW!?!?
#TODO Add Rally Artifacts that dont exist in Trello