-
Notifications
You must be signed in to change notification settings - Fork 314
/
git.py
950 lines (862 loc) · 34.3 KB
/
git.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
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
"""
Module for executing git commands, sending results back to the handlers
"""
import os
import re
import subprocess
from subprocess import Popen, PIPE, CalledProcessError
import pexpect
from urllib.parse import unquote
from tornado.web import HTTPError
# Git configuration options exposed through the REST API
ALLOWED_OPTIONS = ['user.name', 'user.email']
# Regex pattern to capture (key, value) of Git configuration options.
# See https://git-scm.com/docs/git-config#_syntax for git var syntax
CONFIG_PATTERN = re.compile(r"(?:^|\n)([\w\-\.]+)\=")
class GitAuthInputWrapper:
"""
Helper class which is meant to replace subprocess.Popen for communicating
with git CLI when also sending username and password for auth
"""
def __init__(self, command, cwd, env, username, password):
self.command = command
self.cwd = cwd
self.env = env
self.username = username
self.password = password
def communicate(self):
try:
p = pexpect.spawn(
self.command,
cwd = self.cwd,
env = self.env
)
# We expect a prompt from git
# In most of cases git will prompt for username and
# then for password
# In some cases (Bitbucket) username is included in
# remote URL, so git will not ask for username
i = p.expect(['Username for .*: ', 'Password for .*:'])
if i==0: #ask for username then password
p.sendline(self.username)
p.expect('Password for .*:')
p.sendline(self.password)
elif i==1: #only ask for password
p.sendline(self.password)
p.expect(pexpect.EOF)
response = p.before
self.returncode = p.wait()
p.close()
return response
except pexpect.exceptions.EOF: #In case of pexpect failure
response = p.before
self.returncode = p.exitstatus
p.close() #close process
return response
class Git:
"""
A single parent class containing all of the individual git methods in it.
"""
def __init__(self, contents_manager):
self.contents_manager = contents_manager
self.root_dir = os.path.expanduser(contents_manager.root_dir)
def config(self, top_repo_path, **kwargs):
"""Get or set Git options.
If no kwargs, all options are returned. Otherwise kwargs are set.
"""
response = {"code": 1}
if len(kwargs):
output = []
for k, v in filter(lambda t: True if t[0] in ALLOWED_OPTIONS else False, kwargs.items()):
cmd = ["git", "config", "--add", k, v]
p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, cwd=top_repo_path)
out, err = p.communicate()
output.append(out.decode("utf-8").strip())
response["code"] = p.returncode
if p.returncode != 0:
response["command"] = " ".join(cmd)
response["message"] = err.decode("utf-8").strip()
return response
response["message"] = "\n".join(output).strip()
else:
cmd = ["git", "config", "--list"]
p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, cwd=top_repo_path)
output, error = p.communicate()
response = {"code": p.returncode}
if p.returncode != 0:
response["command"] = " ".join(cmd)
response["message"] = error.decode("utf-8").strip()
else:
raw = output.decode("utf-8").strip()
s = CONFIG_PATTERN.split(raw)
response["options"] = {k:v for k, v in zip(s[1::2], s[2::2]) if k in ALLOWED_OPTIONS}
return response
def changed_files(self, base=None, remote=None, single_commit=None):
"""Gets the list of changed files between two Git refs, or the files changed in a single commit
There are two reserved "refs" for the base
1. WORKING : Represents the Git working tree
2. INDEX: Represents the Git staging area / index
Keyword Arguments:
single_commit {string} -- The single commit ref
base {string} -- the base Git ref
remote {string} -- the remote Git ref
Returns:
dict -- the response of format {
"code": int, # Command status code
"files": [string, string], # List of files changed.
"message": [string] # Error response
}
"""
if single_commit:
cmd = ['git', 'diff', '{}^!'.format(single_commit), '--name-only']
elif base and remote:
if base == 'WORKING':
cmd = ['git', 'diff', remote, '--name-only']
elif base == 'INDEX':
cmd = ['git', 'diff', '--staged', remote, '--name-only']
else:
cmd = ['git', 'diff', base, remote, '--name-only']
else:
raise HTTPError(400, 'Either single_commit or (base and remote) must be provided')
response = {}
try:
stdout = subprocess.check_output(
cmd,
cwd=self.root_dir,
stderr=subprocess.STDOUT
)
response['files'] = stdout.decode('utf-8').strip().split('\n')
response['code'] = 0
except CalledProcessError as e:
response['message'] = e.output.decode('utf-8')
response['code'] = e.returncode
return response
def clone(self, current_path, repo_url, auth=None):
"""
Execute `git clone`.
When no auth is provided, disables prompts for the password to avoid the terminal hanging.
When auth is provided, await prompts for username/passwords and sends them
:param current_path: the directory where the clone will be performed.
:param repo_url: the URL of the repository to be cloned.
:param auth: OPTIONAL dictionary with 'username' and 'password' fields
:return: response with status code and error message.
"""
env = os.environ.copy()
if (auth):
env["GIT_TERMINAL_PROMPT"] = "1"
p = GitAuthInputWrapper(
command='git clone {} -q'.format(unquote(repo_url)),
cwd=os.path.join(self.root_dir, current_path),
env = env,
username=auth['username'],
password=auth['password'],
)
error = p.communicate()
else:
env["GIT_TERMINAL_PROMPT"] = "0"
p = subprocess.Popen(
['git', 'clone', unquote(repo_url)],
stdout=PIPE,
stderr=PIPE,
env = env,
cwd=os.path.join(self.root_dir, current_path),
)
_, error = p.communicate()
response = {"code": p.returncode}
if p.returncode != 0:
response["message"] = error.decode("utf-8").strip()
return response
def status(self, current_path):
"""
Execute git status command & return the result.
"""
p = Popen(
["git", "status", "--porcelain", "-u"],
stdout=PIPE,
stderr=PIPE,
cwd=os.path.join(self.root_dir, current_path),
)
my_output, my_error = p.communicate()
if p.returncode == 0:
result = []
line_array = my_output.decode("utf-8").splitlines()
for line in line_array:
to1 = None
from_path = line[3:]
if line[0] == "R":
to0 = line[3:].split(" -> ")
to1 = to0[len(to0) - 1]
else:
to1 = line[3:]
if to1.startswith('"'):
to1 = to1[1:]
if to1.endswith('"'):
to1 = to1[:-1]
result.append(
{"x": line[0], "y": line[1], "to": to1, "from": from_path}
)
return {"code": p.returncode, "files": result}
else:
return {
"code": p.returncode,
"command": "git status --porcelain -u",
"message": my_error.decode("utf-8"),
}
def log(self, current_path, history_count=10):
"""
Execute git log command & return the result.
"""
p = Popen(
["git", "log", "--pretty=format:%H%n%an%n%ar%n%s", ("-%d" % history_count)],
stdout=PIPE,
stderr=PIPE,
cwd=os.path.join(self.root_dir, current_path),
)
my_output, my_error = p.communicate()
if p.returncode == 0:
result = []
line_array = my_output.decode("utf-8").splitlines()
i = 0
PREVIOUS_COMMIT_OFFSET = 4
while i < len(line_array):
if i + PREVIOUS_COMMIT_OFFSET < len(line_array):
result.append(
{
"commit": line_array[i],
"author": line_array[i + 1],
"date": line_array[i + 2],
"commit_msg": line_array[i + 3],
"pre_commit": line_array[i + PREVIOUS_COMMIT_OFFSET],
}
)
else:
result.append(
{
"commit": line_array[i],
"author": line_array[i + 1],
"date": line_array[i + 2],
"commit_msg": line_array[i + 3],
"pre_commit": "",
}
)
i += PREVIOUS_COMMIT_OFFSET
return {"code": p.returncode, "commits": result}
else:
return {"code": p.returncode, "message": my_error.decode("utf-8")}
def detailed_log(self, selected_hash, current_path):
"""
Execute git log -1 --stat --numstat --oneline command (used to get
insertions & deletions per file) & return the result.
"""
p = subprocess.Popen(
["git", "log", "-1", "--stat", "--numstat", "--oneline", selected_hash],
stdout=PIPE,
stderr=PIPE,
cwd=os.path.join(self.root_dir, current_path),
)
my_output, my_error = p.communicate()
if p.returncode == 0:
result = []
note = [0] * 3
count = 0
temp = ""
line_array = my_output.decode("utf-8").splitlines()
length = len(line_array)
INSERTION_INDEX = 0
DELETION_INDEX = 1
MODIFIED_FILE_PATH_INDEX = 2
if length > 1:
temp = line_array[length - 1]
words = temp.split()
for i in range(0, len(words)):
if words[i].isdigit():
note[count] = words[i]
count += 1
for num in range(1, int(length / 2)):
line_info = line_array[num].split(maxsplit=2)
words = line_info[2].split("/")
length = len(words)
result.append(
{
"modified_file_path": line_info[MODIFIED_FILE_PATH_INDEX],
"modified_file_name": words[length - 1],
"insertion": line_info[INSERTION_INDEX],
"deletion": line_info[DELETION_INDEX],
}
)
if note[2] == 0 and length > 1:
if "-" in temp:
exchange = note[1]
note[1] = note[2]
note[2] = exchange
return {
"code": p.returncode,
"modified_file_note": temp,
"modified_files_count": note[0],
"number_of_insertions": note[1],
"number_of_deletions": note[2],
"modified_files": result,
}
else:
return {
"code": p.returncode,
"command": "git log_1",
"message": my_error.decode("utf-8"),
}
def diff(self, top_repo_path):
"""
Execute git diff command & return the result.
"""
p = Popen(
["git", "diff", "--numstat"], stdout=PIPE, stderr=PIPE, cwd=top_repo_path
)
my_output, my_error = p.communicate()
if p.returncode == 0:
result = []
line_array = my_output.decode("utf-8").splitlines()
for line in line_array:
linesplit = line.split()
result.append(
{
"insertions": linesplit[0],
"deletions": linesplit[1],
"filename": linesplit[2],
}
)
return {"code": p.returncode, "result": result}
else:
return {"code": p.returncode, "message": my_error.decode("utf-8")}
def branch(self, current_path):
"""
Execute 'git for-each-ref' command & return the result.
"""
heads = self.branch_heads(current_path)
if heads["code"] != 0:
# error; bail
return heads
remotes = self.branch_remotes(current_path)
if remotes["code"] != 0:
# error; bail
return remotes
# all's good; concatenate results and return
return {"code": 0, "branches": heads["branches"] + remotes["branches"], "current_branch": heads["current_branch"]}
def branch_heads(self, current_path):
"""
Execute 'git for-each-ref' command on refs/heads & return the result.
"""
# Format reference: https://git-scm.com/docs/git-for-each-ref#_field_names
formats = ['refname:short', 'objectname', 'upstream:short', 'HEAD']
cmd = ["git", "for-each-ref", "--format=" + "%09".join("%({})".format(f) for f in formats), "refs/heads/"]
p = subprocess.Popen(
cmd,
stdout=PIPE,
stderr=PIPE,
cwd=os.path.join(self.root_dir, current_path),
)
output, error = p.communicate()
if p.returncode == 0:
current_branch = None
results = []
try:
for name,commit_sha,upstream_name,is_current_branch in (line.split('\t') for line in output.decode("utf-8").splitlines()):
is_current_branch = bool(is_current_branch.strip())
branch = {
"is_current_branch": is_current_branch,
"is_remote_branch": False,
"name": name,
"upstream": upstream_name if upstream_name else None,
"top_commit": commit_sha,
"tag": None,
}
results.append(branch)
if is_current_branch:
current_branch = branch
# Above can fail in certain cases, such as an empty repo with
# no commits. In that case, just fall back to determining
# current branch
if not current_branch:
branch = {
"is_current_branch": True,
"is_remote_branch": False,
"name": self.get_current_branch(current_path),
"upstream": None,
"top_commit": None,
"tag": None,
}
results.append(branch)
current_branch = branch
return {"code": p.returncode, "branches": results, "current_branch": current_branch}
except Exception as downstream_error:
return {
"code": -1,
"command": ' '.join(cmd),
"message": str(downstream_error),
}
else:
return {
"code": p.returncode,
"command": ' '.join(cmd),
"message": error.decode("utf-8"),
}
def branch_remotes(self, current_path):
"""
Execute 'git for-each-ref' command on refs/heads & return the result.
"""
# Format reference: https://git-scm.com/docs/git-for-each-ref#_field_names
formats = ['refname:short', 'objectname']
cmd = ["git", "for-each-ref", "--format=" + "%09".join("%({})".format(f) for f in formats), "refs/remotes/"]
p = subprocess.Popen(
cmd,
stdout=PIPE,
stderr=PIPE,
cwd=os.path.join(self.root_dir, current_path),
)
output, error = p.communicate()
if p.returncode == 0:
results = []
try:
for name,commit_sha in (line.split('\t') for line in output.decode("utf-8").splitlines()):
results.append({
"is_current_branch": False,
"is_remote_branch": True,
"name": name,
"upstream": None,
"top_commit": commit_sha,
"tag": None,
})
return {"code": p.returncode, "branches": results}
except Exception as downstream_error:
return {
"code": -1,
"command": ' '.join(cmd),
"message": str(downstream_error),
}
else:
return {
"code": p.returncode,
"command": ' '.join(cmd),
"message": error.decode("utf-8"),
}
def show_top_level(self, current_path):
"""
Execute git --show-toplevel command & return the result.
"""
p = Popen(
["git", "rev-parse", "--show-toplevel"],
stdout=PIPE,
stderr=PIPE,
cwd=os.path.join(self.root_dir, current_path),
)
my_output, my_error = p.communicate()
if p.returncode == 0:
result = {
"code": p.returncode,
"top_repo_path": my_output.decode("utf-8").strip("\n"),
}
return result
else:
return {
"code": p.returncode,
"command": "git rev-parse --show-toplevel",
"message": my_error.decode("utf-8"),
}
def show_prefix(self, current_path):
"""
Execute git --show-prefix command & return the result.
"""
p = Popen(
["git", "rev-parse", "--show-prefix"],
stdout=PIPE,
stderr=PIPE,
cwd=os.path.join(self.root_dir, current_path),
)
my_output, my_error = p.communicate()
if p.returncode == 0:
result = {
"code": p.returncode,
"under_repo_path": my_output.decode("utf-8").strip("\n"),
}
return result
else:
return {
"code": p.returncode,
"command": "git rev-parse --show-prefix",
"message": my_error.decode("utf-8"),
}
def add(self, filename, top_repo_path):
"""
Execute git add<filename> command & return the result.
"""
if not isinstance(filename, str):
# assume filename is a sequence of str
cmd = ["git", "add"] + list(filename)
else:
cmd = ["git", "add", filename]
return subprocess.check_output(cmd, cwd=top_repo_path)
def add_all(self, top_repo_path):
"""
Execute git add all command & return the result.
"""
my_output = subprocess.check_output(["git", "add", "-A"], cwd=top_repo_path)
return my_output
def add_all_unstaged(self, top_repo_path):
"""
Execute git add all unstaged command & return the result.
"""
e = 'git add -u'
my_output = subprocess.call(e, shell=True, cwd=top_repo_path)
return {"result": my_output}
def add_all_untracked(self, top_repo_path):
"""
Execute git add all untracked command & return the result.
"""
e = 'echo "a\n*\nq\n" | git add -i'
my_output = subprocess.call(e, shell=True, cwd=top_repo_path)
return {"result": my_output}
def reset(self, filename, top_repo_path):
"""
Execute git reset <filename> command & return the result.
"""
my_output = subprocess.check_output(
["git", "reset", "--", filename], cwd=top_repo_path
)
return my_output
def reset_all(self, top_repo_path):
"""
Execute git reset command & return the result.
"""
my_output = subprocess.check_output(["git", "reset"], cwd=top_repo_path)
return my_output
def delete_commit(self, commit_id, top_repo_path):
"""
Delete a specified commit from the repository.
"""
my_output = subprocess.check_output(
["git", "revert", "--no-commit", commit_id], cwd=top_repo_path
)
return my_output
def reset_to_commit(self, commit_id, top_repo_path):
"""
Reset the current branch to a specific past commit.
"""
cmd = ["git", "reset", "--hard"]
if commit_id:
cmd.append(commit_id)
my_output = subprocess.check_output(
cmd, cwd=top_repo_path
)
return my_output
def checkout_new_branch(self, branchname, current_path):
"""
Execute git checkout <make-branch> command & return the result.
"""
p = Popen(
["git", "checkout", "-b", branchname],
stdout=PIPE,
stderr=PIPE,
cwd=os.path.join(self.root_dir, current_path),
)
my_output, my_error = p.communicate()
if p.returncode == 0:
return {"code": p.returncode, "message": my_output.decode("utf-8")}
else:
return {
"code": p.returncode,
"command": "git checkout " + "-b" + branchname,
"message": my_error.decode("utf-8"),
}
def _get_branch_reference(self, branchname, current_path):
"""
Execute git rev-parse --symbolic-full-name <branch-name> and return the result (or None).
"""
p = subprocess.Popen(
["git", "rev-parse", "--symbolic-full-name", branchname],
stdout=PIPE,
stderr=PIPE,
cwd=os.path.join(self.root_dir, current_path),
)
my_output, my_error = p.communicate()
if p.returncode == 0:
return my_output.decode("utf-8").strip("\n")
else:
return None
def checkout_branch(self, branchname, current_path):
"""
Execute git checkout <branch-name> command & return the result.
Use the --track parameter for a remote branch.
"""
reference_name = self._get_branch_reference(branchname, current_path)
if reference_name is None:
is_remote_branch = False
else:
is_remote_branch = self._is_remote_branch(reference_name)
if is_remote_branch:
cmd = ["git", "checkout", "--track", branchname]
else:
cmd = ["git", "checkout", branchname]
p = subprocess.Popen(
cmd,
stdout=PIPE,
stderr=PIPE,
cwd=os.path.join(self.root_dir, current_path),
)
my_output, my_error = p.communicate()
if p.returncode == 0:
return { "code": 0, "message": my_output.decode("utf-8") }
else:
return { "code": p.returncode, "message": my_error.decode("utf-8"), "command": " ".join(cmd) }
def checkout(self, filename, top_repo_path):
"""
Execute git checkout command for the filename & return the result.
"""
my_output = subprocess.check_output(
["git", "checkout", "--", filename], cwd=top_repo_path
)
return my_output
def checkout_all(self, top_repo_path):
"""
Execute git checkout command & return the result.
"""
my_output = subprocess.check_output(
["git", "checkout", "--", "."], cwd=top_repo_path
)
return my_output
def commit(self, commit_msg, top_repo_path):
"""
Execute git commit <filename> command & return the result.
"""
my_output = subprocess.check_output(
["git", "commit", "-m", commit_msg], cwd=top_repo_path
)
return my_output
def pull(self, curr_fb_path, auth=None):
"""
Execute git pull --no-commit. Disables prompts for the password to avoid the terminal hanging while waiting
for auth.
"""
env = os.environ.copy()
if (auth):
env["GIT_TERMINAL_PROMPT"] = "1"
p = GitAuthInputWrapper(
command = 'git pull --no-commit',
cwd = os.path.join(self.root_dir, curr_fb_path),
env = env,
username = auth['username'],
password = auth['password']
)
error = p.communicate()
else:
env["GIT_TERMINAL_PROMPT"] = "0"
p = subprocess.Popen(
['git', 'pull', '--no-commit'],
stdout=PIPE,
stderr=PIPE,
env = env,
cwd=os.path.join(self.root_dir, curr_fb_path),
)
_, error = p.communicate()
response = {"code": p.returncode}
if p.returncode != 0:
response["message"] = error.decode("utf-8").strip()
return response
def push(self, remote, branch, curr_fb_path, auth=None):
"""
Execute `git push $UPSTREAM $BRANCH`. The choice of upstream and branch is up to the caller.
"""
env = os.environ.copy()
if (auth):
env["GIT_TERMINAL_PROMPT"] = "1"
p = GitAuthInputWrapper(
command = 'git push {} {}'.format(remote, branch),
cwd = os.path.join(self.root_dir, curr_fb_path),
env = env,
username = auth['username'],
password = auth['password']
)
error = p.communicate()
else:
env["GIT_TERMINAL_PROMPT"] = "0"
p = subprocess.Popen(
['git', 'push', remote, branch],
stdout=PIPE,
stderr=PIPE,
env = env,
cwd=os.path.join(self.root_dir, curr_fb_path),
)
_, error = p.communicate()
response = {"code": p.returncode}
if p.returncode != 0:
response["message"] = error.decode("utf-8").strip()
return response
def init(self, current_path):
"""
Execute git init command & return the result.
"""
my_output = subprocess.check_output(
["git", "init"], cwd=os.path.join(self.root_dir, current_path)
)
return my_output
def _is_remote_branch(self, branch_reference):
"""Check if given branch is remote branch by comparing with 'remotes/',
TODO : Consider a better way to check remote branch
"""
return branch_reference.startswith("refs/remotes/")
def _get_branch_name(self, branch_reference):
"""Get branch name for given branch
"""
if branch_reference.startswith("refs/heads/"):
return branch_reference.split("refs/heads/")[1]
if branch_reference.startswith("refs/remotes/"):
return branch_reference.split("refs/remotes/")[1]
raise ValueError("Reference [{}] is not a valid branch.", branch_reference)
def get_current_branch(self, current_path):
"""Use `symbolic-ref` to get the current branch name. In case of
failure, assume that the HEAD is currently detached, and fall back
to the `branch` command to get the name.
See https://git-blame.blogspot.com/2013/06/checking-current-branch-programatically.html
"""
command = ["git", "symbolic-ref", "HEAD"]
p = subprocess.Popen(
command,
stdout=PIPE,
stderr=PIPE,
cwd=os.path.join(self.root_dir, current_path),
)
output, error = p.communicate()
if p.returncode == 0:
return output.decode("utf-8").split('/')[-1].strip()
elif "not a symbolic ref" in error.decode("utf-8").lower():
return self._get_current_branch_detached(current_path)
else:
raise Exception(
"Error [{}] occurred while executing [{}] command to get current branch.".format(
error.decode("utf-8"), " ".join(command)
)
)
def _get_current_branch_detached(self, current_path):
"""Execute 'git branch -a' to get current branch details in case of detached HEAD
"""
command = ["git", "branch", "-a"]
p = subprocess.Popen(
command,
stdout=PIPE,
stderr=PIPE,
cwd=os.path.join(self.root_dir, current_path),
)
output, error = p.communicate()
if p.returncode == 0:
for branch in output.decode("utf-8").splitlines():
branch = branch.strip()
if branch.startswith("*"):
return branch.lstrip("* ")
else:
raise Exception(
"Error [{}] occurred while executing [{}] command to get detached HEAD name.".format(
error.decode("utf-8"), " ".join(command)
)
)
def get_upstream_branch(self, current_path, branch_name):
"""Execute 'git rev-parse --abbrev-ref branch_name@{upstream}' to get
upstream branch name tracked by given local branch.
Reference : https://git-scm.com/docs/git-rev-parse#git-rev-parse-emltbranchnamegtupstreamemegemmasterupstreamememuem
"""
command = [
"git",
"rev-parse",
"--abbrev-ref",
"{}@{{upstream}}".format(branch_name),
]
p = subprocess.Popen(
command,
stdout=PIPE,
stderr=PIPE,
cwd=os.path.join(self.root_dir, current_path),
)
output, error = p.communicate()
if p.returncode == 0:
return output.decode("utf-8").strip()
elif "fatal: no upstream configured for branch" in error.decode("utf-8").lower():
return None
elif "unknown revision or path not in the working tree" in error.decode("utf-8").lower():
return None
else:
raise Exception(
"Error [{}] occurred while executing [{}] command to get upstream branch.".format(
error.decode("utf-8"), " ".join(command)
)
)
def _get_tag(self, current_path, commit_sha):
"""Execute 'git describe commit_sha' to get
nearest tag associated with lastest commit in branch.
Reference : https://git-scm.com/docs/git-describe#git-describe-ltcommit-ishgt82308203
"""
command = ["git", "describe", "--tags", commit_sha]
p = subprocess.Popen(
command,
stdout=PIPE,
stderr=PIPE,
cwd=os.path.join(self.root_dir, current_path),
)
output, error = p.communicate()
if p.returncode == 0:
return output.decode("utf-8").strip()
elif "fatal: no tags can describe '{}'.".format(commit_sha) in error.decode(
"utf-8"
).lower():
return None
elif "fatal: no names found" in error.decode("utf-8").lower():
return None
else:
raise Exception(
"Error [{}] occurred while executing [{}] command to get nearest tag associated with branch.".format(
error.decode("utf-8"), " ".join(command)
)
)
def show(self, filename, ref, top_repo_path):
"""
Execute git show <ref:filename> command & return the result.
"""
command = ["git", "show", '{}:{}'.format(ref, filename)]
p = subprocess.Popen(
command,
stdout=PIPE,
stderr=PIPE,
cwd=top_repo_path
)
output, error = p.communicate()
error_messages = map(lambda n: n.lower(), [
"fatal: Path '{}' exists on disk, but not in '{}'".format(filename, ref),
"fatal: Path '{}' does not exist (neither on disk nor in the index)".format(filename)
])
lower_error = error.decode('utf-8').lower()
if p.returncode == 0:
return output.decode('utf-8')
elif any([msg in lower_error for msg in error_messages]):
return ""
else:
raise HTTPError(log_message='Error [{}] occurred while executing [{}] command to retrieve plaintext diff.'.format(
error.decode('utf-8'),
' '.join(command)
))
def get_content(self, filename, top_repo_path):
"""
Get the file content of filename.
"""
relative_repo = os.path.relpath(top_repo_path, self.root_dir)
model = self.contents_manager.get(path=os.path.join(relative_repo, filename))
return model['content']
def diff_content(self, filename, prev_ref, curr_ref, top_repo_path):
"""
Collect get content of prev and curr and return.
"""
prev_content = self.show(filename, prev_ref["git"], top_repo_path)
if "special" in curr_ref:
if curr_ref["special"] == "WORKING":
curr_content = self.get_content(filename, top_repo_path)
elif curr_ref["special"] == "INDEX":
curr_content = self.show(filename, "", top_repo_path)
else:
raise HTTPError(log_message="Error while retrieving plaintext diff, unknown special ref '{}'.".format(curr_ref["special"]))
else:
curr_content = self.show(filename, curr_ref["git"], top_repo_path)
return {"prev_content": prev_content, "curr_content": curr_content}