forked from koansys/github-migrate-trac-tickets
/
trac-tickets-to-gh.py
executable file
·174 lines (148 loc) · 6.68 KB
/
trac-tickets-to-gh.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
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# Migrate trac tickets from DB into GitHub using v3 API.
# Transform milestones to milestones, components to labels.
# The code merges milestones and labels does NOT attempt to prevent
# duplicating tickets so you'll get multiples if you run repeatedly.
# See API docs: http://developer.github.com/v3/issues/
# TODO:
# - it's not getting ticket *changes* from 'comments', like milestone changed.
# - should I be migrating Trac 'keywords' to Issue 'labels'?
# - list Trac users, get GitHub collaborators, define a mapping for issue assignee.
# - the Trac style ticket refs like 'see #37' will ref wrong GitHub issue since numbers change
import datetime
# TODO: conditionalize and use 'json'
import logging
from optparse import OptionParser
import sqlite3
from github import GitHub
class Trac(object):
# We don't have a way to close (potentially nested) cursors
def __init__(self, trac_db_path):
self.trac_db_path = trac_db_path
try:
self.conn = sqlite3.connect(self.trac_db_path)
except sqlite3.OperationalError, e:
raise RuntimeError("Could not open trac db=%s e=%s" % (
self.trac_db_path, e))
def sql(self, sql_query):
"""Create a new connection, send the SQL query, return response.
We need unique cursors so queries in context of others work.
"""
cursor = self.conn.cursor()
cursor.execute(sql_query)
return cursor
def close(self):
self.conn.close()
# Warning: optparse is deprecated in python-2.7 in favor of argparse
usage = """
%prog [options] trac_db_path github_username github_password github_repo
The path might be something like "/tmp/trac.db"
The github_repo combines user or organization and specific repo like "myorg/myapp"
"""
parser = OptionParser(usage=usage)
parser.add_option('-q', '--quiet', action="store_true", default=False,
help='Decrease logging of activity')
(options, args) = parser.parse_args()
try:
[trac_db_path, github_username, github_password, github_repo] = args
except ValueError:
parser.error('Wrong number of arguments')
if not '/' in github_repo:
parser.error('Repo must be specified like "organization/project"')
if options.quiet:
logging.basicConfig(level=logging.INFO)
else:
logging.basicConfig(level=logging.DEBUG)
trac = Trac(trac_db_path)
github = GitHub(github_username, github_password, github_repo)
# Show the Trac usernames assigned to tickets as an FYI
logging.info("Getting Trac ticket owners (will NOT be mapped to GitHub username)...")
for (username,) in trac.sql('SELECT DISTINCT owner FROM ticket'):
if username:
username = username.strip() # username returned is tuple like: ('phred',)
logging.debug("Trac ticket owner: %s" % username)
# Get GitHub labels; we'll merge Trac components into them
logging.info("Getting existing GitHub labels...")
labels = {}
for label in github.labels():
labels[label['name']] = label['url'] # ignoring 'color'
logging.debug("label name=%s" % label['name'])
# Get any existing GitHub milestones so we can merge Trac into them.
# We need to reference them by numeric ID in tickets.
# API returns only 'open' issues by default, have to ask for closed like:
# curl -u 'USER:PASS' https://api.github.com/repos/USERNAME/REPONAME/milestones?state=closed
logging.info("Getting existing GitHub milestones...")
milestone_id = {}
for m in github.milestones():
milestone_id[m['title']] = m['number']
logging.debug("milestone (open) title=%s" % m['title'])
for m in github.milestones(query='state=closed'):
milestone_id[m['title']] = m['number']
logging.debug("milestone (closed) title=%s" % m['title'])
# We have no way to set the milestone closed date in GH.
# The 'due' and 'completed' are long ints representing datetimes.
logging.info("Migrating Trac milestones to GitHub...")
milestones = trac.sql('SELECT name, description, due, completed FROM milestone')
for name, description, due, completed in milestones:
name = name.strip()
logging.debug("milestone name=%s due=%s completed=%s" % (name, due, completed))
if name and name not in milestone_id:
if completed:
state = 'closed'
else:
state = 'open'
milestone = {'title': name,
'state': state,
'description': description,
}
if due:
milestone['due_on'] = datetime.datetime.fromtimestamp(
due / 1000 / 1000).isoformat()
logging.debug("milestone: %s" % milestone)
gh_milestone = github.milestones(data=milestone)
milestone_id['name'] = gh_milestone['number']
# Copy Trac tickets to GitHub issues, keyed to milestones above
tickets = trac.sql('SELECT id, summary, description , owner, milestone, component, status FROM ticket ORDER BY id') # LIMIT 5
for tid, summary, description, owner, milestone, component, status in tickets:
logging.info("Ticket %d: %s" % (tid, summary))
if description:
description = description.strip()
if milestone:
milestone = milestone.strip()
issue = {'title': summary}
if description:
issue['body'] = description
if milestone:
m = milestone_id.get(milestone)
if m:
issue['milestone'] = m
if component:
if component not in labels:
# GitHub creates the 'url' and 'color' fields for us
github.labels(data={'name': component})
labels[component] = 'CREATED' # keep track of it so we don't re-create it
logging.debug("adding component as new label=%s" % component)
issue['labels'] = [component]
# We have to create/map Trac users to GitHub usernames before we can assign
# them to tickets; don't see how to do that conveniently now.
# if owner.strip():
# ticket['assignee'] = owner.strip()
gh_issue = github.issues(data=issue)
# Add comments
comments = trac.sql('SELECT author, newvalue AS body FROM ticket_change WHERE field="comment" AND ticket=%s' % tid)
for author, body in comments:
body = body.strip()
if body:
# prefix comment with author as git doesn't keep them separate
if author:
body = "[%s] %s" % (author, body)
logging.debug('issue comment: %s' % body[:40]) # TODO: escape newlines
github.issue_comments(gh_issue['number'], data={'body': body})
# Close tickets if they need it.
# The v3 API says we should use PATCH, but
# http://developer.github.com/v3/ says POST is supported.
if status == 'closed':
github.issues(id_=gh_issue['number'], data={'state': 'closed'})
logging.debug("close")
trac.close()