-
Notifications
You must be signed in to change notification settings - Fork 0
/
fetch-dependencies.py
executable file
·253 lines (198 loc) · 8.53 KB
/
fetch-dependencies.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
#!/usr/bin/env python3
import contextlib
import dataclasses
import functools as fn
from pathlib import Path
import os
import subprocess as sp
import sys
from typing import Iterator, NamedTuple
import textwrap
####################################################################################################
# HELPER CLASSES AND FUNCTIONS
#
# \/ \/ \/ scroll down for start of the script \/ \/ \/
####################################################################################################
class Colors:
"""A few ANSI color codes that are used in logging."""
reset = "\033[0m"
bold = "\033[1m"
blue = "\033[34m"
# We add extra logs if the `FETCH_DEPENDENCIES_DEBUG` environment variable
# is set to 1
debug_enabled=os.environ.get('FETCH_DEPENDENCIES_DEBUG', '0') == '1'
def debug(*args):
"""Only print `*args` in debug mode."""
if debug_enabled:
print(f"{Colors.blue}>>", *args, file=sys.stderr, end=f"{Colors.reset}\n")
def info(*args):
"""Print a message that needs to stand out in bold."""
print(f"{Colors.bold}::", *args, end=f"{Colors.reset}\n")
@contextlib.contextmanager
def pushd(path: Path):
"""Context manager that changes the current directory to `path` and changes it back to the
previous directory when going out of scope."""
old_cwd = Path.cwd()
os.chdir(path)
debug('PUSHD', path)
try:
yield
finally:
os.chdir(old_cwd)
debug('POPD')
def run(command: list, **kwargs) -> sp.CompletedProcess:
"""Wrapper around `subprocess.run` that logs the command that will be executed in debug
mode."""
debug('RUN', command)
return sp.run(command, **kwargs)
# Convenience function for commands that are run internally by this script
# (and whose output should be not shown to the user)
run_internal = fn.partial(run, capture_output=True, text=True)
def short_commit_info(commit_ish: str):
"""Returns a one-line informtation string on `commit_ish`."""
result = run_internal(['git', 'show', '--date=human', '--no-patch',
'--format=format:%cd [%cN] %s', commit_ish])
return result.stdout.strip()
def yes_no_question(*args):
response = input(' '.join([*args, '[y/N] ']))
return response in ['y', 'Y']
# The following classes are just helper classes to transfer data beteween the different steps of
# script.
@dataclasses.dataclass
class Dependency:
path: Path
repo: str
ref: str
class CheckoutStatus(NamedTuple):
path: Path
commit: str
should_fetch: bool
def parse_dependencies(f) -> Iterator[Dependency]:
"""Parses a set of dependency lines. Lines starting with `#` are ignored."""
for i, d in enumerate(map(str.split, f), 1):
match d:
case [] | ['#', *_]:
pass
case [path, repo, ref]:
yield Dependency(Path(path), repo, ref)
case _:
print(f'Error in dependencies file. I do not understand line {i}.', file=sys.stderr)
sys.exit(1)
####################################################################################################
# SCRIPT STARTS HERE
####################################################################################################
if __name__ == '__main__':
# We will probably have to switch to argparse at some point, but this does the job for now.
match sys.argv:
case [cmd, *args] if (set(args) & {'-h', '--help', '-help', '/?'}):
print(f"usage: {cmd} <dependencies-file>")
print(textwrap.dedent("""
Downloads dependencies listed in <dependencies-file>. The paths listed in the
dependencies file are relative to the current working directory.
"""))
sys.exit(0)
case [_, deps_spec]:
deps_spec_path = Path(deps_spec)
case [cmd, *_]:
sys.exit(2)
# Use current working directory as the root for relative paths in the dependencies
projects_dir = Path.cwd()
with open(deps_spec_path) as f:
deps = list(parse_dependencies(f))
# All the dependencies are checked and added to the following lists depending on what to do with
# them.
clone = []
checkout = []
do_nothing = []
error = []
for d in deps:
dep_wc = (projects_dir / d.path).absolute()
# If the dependency working copy does not exist yet, we can just clone it.
if not dep_wc.exists():
clone.append(d)
continue
# If a file with the same path as the working copy already exists, check if it is the root
# of a git working copy. If something does not look right, do not try anything that we
# might regret.
if not dep_wc.is_dir():
error.append((d.path, 'This path exists but is not a directory.'))
continue
with pushd(dep_wc):
rev_parse_result = run_internal(['git', 'rev-parse', '--show-toplevel'])
if rev_parse_result.returncode != 0:
error.append((d.path, 'git rev-parse failed. Is this a git working copy?'))
continue
if not dep_wc.samefile(Path(rev_parse_result.stdout.strip())):
error.append((d.path, 'This path is inside a subdirectory of an existing git working copy.'))
continue
# If the working copy looks like a directory, we will try and checkout the right revision,
# and fetch commits from the default remote if needed.
with pushd(dep_wc):
rev_parse_result = run_internal(['git', 'rev-parse', 'HEAD'])
if rev_parse_result.stdout.strip() == d.ref:
do_nothing.append(d.path)
continue
status_result = run_internal(['git', 'status', '--porcelain=v1'], check=True)
if status_result.stdout:
error.append((d.path, 'This git working copy is not clean. I will not switch it.'))
else:
cat_file_result = run_internal(['git', 'cat-file', '-e', f'{d.ref}^0'])
checkout.append(CheckoutStatus(path=d.path,
commit=d.ref,
should_fetch=(cat_file_result.returncode != 0)))
# Describe the changes that will be made, and ask if the script should proceed.
if clone:
info("I will clone these dependencies:")
print()
for d in clone:
print(f" {d.path} - {d.repo} ({d.ref})")
print()
if checkout:
info("These dependencies are already cloned but I will switch their working copy:")
print()
for path, ref, fetch in checkout:
with pushd(path):
# [2024-04-27 thibaut] yes, the formatting is intentional...
print( f" {path} - {ref}")
if fetch:
print( " [commit not found locally]")
else:
print(f" {short_commit_info('HEAD')}")
print(f" -> {short_commit_info(ref)}")
print()
if error:
info("These dependencies confuse me. I will not do anything:")
print()
for path, err_msg in error:
print(f" {path} - {err_msg}")
print()
if do_nothing:
info("These dependencies are already checked out at the right revision:")
print()
for path in do_nothing:
print(f" {path}")
print()
if not(clone or checkout):
# nothing to do, exit
sys.exit(0)
if not yes_no_question('Should I continue?'):
sys.exit(0)
print()
# Do the actual work.
for d in clone:
info('Dependency', f"'{d.path}'", '[clone]')
run(['git', 'clone', '--recurse-submodules', d.repo, d.path])
with pushd(d.path):
run(['git', 'checkout', '--recurse-submodules', '--detach', d.ref])
print()
for path, ref, fetch in checkout:
info('Dependency', f"'{d.path}'", '[switch]')
with pushd(path):
if fetch:
run(['git', 'fetch'])
run(['git', 'checkout', '--recurse-submodules', '--detach', ref])
####################################################################################################
# SCRIPT ENDS HERE
#
# (in case you did not notice)
####################################################################################################