forked from VerifiableRobotics/LTLMoP
-
Notifications
You must be signed in to change notification settings - Fork 0
/
LTLMoP_GitHub_Setup.py
401 lines (320 loc) · 13.7 KB
/
LTLMoP_GitHub_Setup.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
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
#!/usr/bin/python
"""
A moderately labyrinthine script to help LTLMoP developers
set their computer up for working with LTLMoP on GitHub.
Written by Cameron Finucane <cpf37@cornell.edu>
"""
import textwrap, getpass
import sys, math, os, time
import urllib2, json
import subprocess, socket
import base64
def patrickSays(msg):
# Wrap to an appropriate width between 10 and 60 characters
# This is super inefficient... but we are using modern computers!
for wrap_width in xrange(10,60):
wrapped_msg = textwrap.wrap(msg, wrap_width)
if len(wrapped_msg) <= 2:
break
# Fill to at least 2 lines
while (len(wrapped_msg) < 2):
wrapped_msg.append("")
# This ASCII cat is by 'Hilary'; taken without permission from http://www.doghause.com/ascii.asp
plain_cat = r"""
/\___/\**
/ / . . \*
\ \ ^ /*
\ / \**
\ /______ \***
*******************""".replace("*"," ").split("\n")
plain_bubble = r"""
__{0}_
/ %-{1}s \
< %-{1}s |
| %-{1}s |
\_{0}_/
""".format("_"*wrap_width, wrap_width).split("\n")
# Make the bubble the right size
extra_height = len(wrapped_msg) - 2
plain_bubble = plain_bubble[0:4] + [plain_bubble[4]]*max(0,extra_height) + plain_bubble[5:]
if extra_height <= 0:
plain_bubble[4] = plain_bubble[4].replace(r" \_", r"\__") # Tweaking
cat_index, bubble_index, msg_index = (0,0,0)
while bubble_index < len(plain_bubble):
if "%" in plain_bubble[bubble_index]:
print plain_cat[cat_index] + plain_bubble[bubble_index] % (wrapped_msg[msg_index])
msg_index += 1
else:
print plain_cat[cat_index] + plain_bubble[bubble_index]
cat_index = min(cat_index+1, len(plain_cat)-1)
bubble_index += 1
def openInBrowser(url):
if sys.platform in ['win32', 'cygwin']:
cmd = "start"
shell = True
elif sys.platform.startswith('linux'):
cmd = "xdg-open"
shell = False
elif sys.platform == 'darwin':
cmd = "open"
shell = True
else:
print "Sorry, I don't know how to open the default browser on your computer."
print "You'll need to visit %s on your own :(" % url
return
subprocess.Popen([cmd, url], shell=shell)
def runGitCommand(cmd):
global ssh_env
if ssh_env is None:
os.system(cmd)
else:
cmd = subprocess.Popen(["bash", "-c", "%s %s" % (ssh_env, cmd)], shell=True)
# Wait for subprocess to finish
while cmd.returncode is None:
cmd.poll()
time.sleep(0.1)
def githubAPICall(path, data=None, method=None):
"""
Relies on GitHub API v3
"""
headers = {}
if data is not None:
data = json.dumps(data)
headers.update({'Content-Type': 'application/json'})
# Most likely you want to be POSTing
if method is None:
method = "POST"
else:
data = ""
# Most likely you want to be GETing
if method is None:
method = "GET"
if method == "POST":
req = urllib2.Request("https://api.github.com"+path, data, headers)
elif method == "PATCH":
req = urllib2.Request("https://api.github.com"+path, data, headers)
req.get_method = lambda: "PATCH"
elif method == "GET":
req = urllib2.Request("https://api.github.com"+path)
else:
print "ERROR: Unknown HTTP method %s!" % method
return None
# Force sending of authentication headers
# From http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/267197
global github_username, github_password
base64string = base64.encodestring('%s:%s' % (github_username, github_password))[:-1]
authheader = "Basic %s" % base64string
req.add_header("Authorization", authheader)
f = urllib2.urlopen(req)
response = json.load(f)
f.close()
return response
if __name__ == "__main__":
# If on Windows, use Git Bash for the shell
if sys.platform in ['win32', 'cygwin']:
# TODO: Is there a better way to determine whether we're in bash or not?
cmd = subprocess.Popen(["ls"],stdout=subprocess.PIPE,stderr=subprocess.PIPE,shell=True)
# Wait for subprocess to finish
while cmd.returncode is None:
cmd.poll()
time.sleep(0.01)
if cmd.returncode != 0:
print "Trying to use Git Bash..."
bash_path = None
for ev in ["ProgramFiles", "ProgramFiles(x86)", "ProgramW6432"]:
if ev not in os.environ: continue
bp = os.path.join(os.environ[ev], 'Git', 'bin', 'bash.exe')
if os.path.exists(bp):
bash_path = bp
break
if bash_path is None:
print "Couldn't find Git Bash. Please install Git for Windows."
print "(See http://code.google.com/p/msysgit/)"
print
print "Press [Enter] to quit..."
raw_input()
sys.exit(1)
print "Found Git Bash at %s" % bash_path
cmd = subprocess.Popen([bash_path, "--login", "-i", "-c", 'python "%s"' % (os.path.abspath(__file__))])
# Wait for subprocess to finish
try:
while cmd.returncode is None:
cmd.poll()
time.sleep(0.01)
except KeyboardInterrupt:
cmd.kill()
sys.exit(0)
patrickSays("Hi! I'm a harmless cat who's going to help you out with Git.")
print
print "Hey there, let's get you set up to work with LTLMoP on GitHub."
print "(Tip: If you mess up and want to restart this process, press Ctrl-C at any time to quit.)"
print
have_account = ''
while have_account.lower() not in ['y','n']:
have_account = raw_input("First off, do you already have an account on GitHub? (y/n): ")
print
if have_account.lower() == 'n':
print "No problem, let's send you over to the GitHub user registration website."
print "Please sign up for a new account and then come back here when you're done."
print
raw_input("Press [Enter] to open up the browser...")
openInBrowser("https://github.com/signup/free")
print
print "OK, awesome. Welcome back."
else:
print "Fantastic. That will save us some time."
print
print "Now you're going to need to give me the login information for your GitHub account."
print "I promise I won't do anything rude. Remember, I'm just a harmless cat."
print
authenticated = False
while not authenticated:
github_username=""
github_password=""
while github_username == "":
github_username = raw_input("Please enter your GitHub username: ")
while github_password == "":
print "Please enter your GitHub password"
github_password = getpass.getpass("(note: the characters will not show up as you type): ")
authenticated = True
# Set up authentication to the GitHub website
auth_handler = urllib2.HTTPBasicAuthHandler()
auth_handler.add_password(realm='GitHub',
uri='https://api.github.com',
user=github_username,
passwd=github_password)
opener = urllib2.build_opener(auth_handler)
urllib2.install_opener(opener)
try:
user_data = githubAPICall("/user")
email_data = githubAPICall("/user/emails")
except urllib2.HTTPError as e:
if e.code in [401, 403]:
print
print "Invalid login! Let's try this again."
print
authenticated = False
else:
print "HTTP Error Code %d. :( Aborting." % e.code
sys.exit(1)
github_fullname = ""
if 'name' in user_data:
github_fullname = user_data['name']
if github_fullname.strip() == "":
print
print "It looks like you didn't give GitHub your full name."
print "As a paranoid cat myself, I respect your decision, but would urge you to"
print "consider changing your mind. You should be proud of your work on LTLMoP!"
print
print "Please enter your full name (i.e. Firstname Lastname), or"
github_fullname = raw_input("just press [Enter] to use your username (%s): " % github_username).strip()
if github_fullname == "":
github_fullname = github_username
# Update the GitHub profile
githubAPICall("/user", {'name': github_fullname}, method="PATCH")
github_email = email_data[0]
patrickSays("Nice to meet you, %s! ... My name's Patrick, by the way." % github_fullname.split(" ")[0])
print
pubkey_path = os.path.expanduser("~/.ssh/id_rsa.pub")
if os.path.exists(pubkey_path):
print "Looks like you already have an SSH key. We're just going to use that."
print "(If this isn't what you were expecting, consider deleting ~/.ssh/id_rsa.pub and coming back.)"
print
raw_input("Press [Enter] to continue...")
else:
print "Next, we need to generate an SSH key to authenticate this computer to GitHub."
print "Come up with a password that you can remember; you'll need to use it"
print "when committing code to GitHub."
print
# Make the ~/.ssh directory if necessary
if not os.path.exists(os.path.dirname(pubkey_path)):
os.mkdir(os.path.dirname(pubkey_path))
cmd = subprocess.Popen(["ssh-keygen", "-t", "rsa", "-C", github_email, "-f", os.path.splitext(pubkey_path)[0]], shell=True)
# Wait for subprocess to finish
while cmd.returncode is None:
cmd.poll()
time.sleep(0.1)
print
# On windows, we want to use ssh-agent to keep the user from having to
# type in their ssh password multiple times
if sys.platform in ['win32', 'cygwin']:
print "Now just authenticate once for the rest of this session."
print "Please type in your SSH password one last time."
cmd = subprocess.Popen(["ssh-agent"], stdout=subprocess.PIPE, shell=True)
ssh_env = cmd.communicate()[0].replace("\n", " ")
cmd = subprocess.Popen(["bash", "-c", "%s ssh-add" % ssh_env], shell=True)
# Wait for subprocess to finish
while cmd.returncode is None:
cmd.poll()
time.sleep(0.1)
else:
ssh_env = None
print
print "Great, thanks. The rest I can do by myself, so sit back and relax."
time.sleep(1)
print
print "Adding this SSH key to GitHub..."
print
hostname = socket.gethostname().split(".")[0]
keyfile = open(pubkey_path, 'r')
pubkey = keyfile.read().strip()
keyfile.close()
try:
githubAPICall("/user/keys", {"title": "%s (%s)" % (github_email, hostname), "key": pubkey})
except urllib2.HTTPError as e:
if e.code == 422:
print "It looks like you probably already have this key enabled. Skipping this step."
else:
print "HTTP Error Code %d. :( Aborting." % e.code
sys.exit(1)
print
repo_data = githubAPICall("/user/repos")
if any([(r['name'] == "LTLMoP") for r in repo_data]):
print "Looks like you already have a fork of LTLMoP on GitHub. Good on you!"
fresh_fork = False
else:
print "Creating a fork of LTLMoP on GitHub for you. This may take a few minutes..."
response = githubAPICall("/repos/LTLMoP/LTLMoP/forks", method="POST")
print "Creation started at URL: " + response['html_url']
patrickSays("Please wait!")
print
sys.stdout.write("Waiting for fork to complete...")
repo_data = None
while repo_data is None or not any([(r['name'] == "LTLMoP") for r in repo_data]):
repo_data = githubAPICall("/user/repos")
time.sleep(2)
sys.stdout.write(".")
fresh_fork = True
print "\nOkay, looks good!"
print
print "Making sure your commits are made under your name..."
os.system("git config --global --replace-all user.name \"%s\"" % github_fullname)
os.system("git config --global --replace-all user.email \"%s\"" % github_email)
if os.path.exists(os.path.expanduser("~/LTLMoP")):
print "It looks like you already have a LTLMoP folder in your home directory."
print "If you actually want to clone a new copy, please delete or rename it first and come back."
else:
print
print "Cloning a copy of LTLMoP into your home directory..."
print "(Tip: If it asks you if you want to continue connecting, type 'yes' and press [Enter])"
runGitCommand("git clone git@github.com:%s/LTLMoP.git %s" % (github_username, os.path.expanduser("~/LTLMoP")))
print
os.chdir(os.path.expanduser("~/LTLMoP"))
if fresh_fork:
branch_data = githubAPICall("/repos/%s/LTLMoP/branches" % (github_username))
print "Deleting extraneous branches to make your life simpler..."
# Delete all remote branches
for b in branch_data:
if b['name'] == "development": continue
runGitCommand("git push origin :%s" % b['name'])
print "Adding official repository as `upstream` remote..."
runGitCommand("git remote add upstream https://github.com/LTLMoP/LTLMoP.git")
runGitCommand("git fetch upstream development")
patrickSays("Hooray! All done! See you around.")
print
print "Your copy of LTLMoP is checked out into %s." % os.path.expanduser("~/LTLMoP")
print "Feel free to move the folder to anywhere you'd like."
print "If you want more guidance, please look at the companion tutorial."
# TODO: kill ssh-agent?
print "Press [Enter] to quit..."
raw_input()