forked from nus-apr/auto-code-rover
-
Notifications
You must be signed in to change notification settings - Fork 0
/
utils.py
312 lines (260 loc) · 10.5 KB
/
utils.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
import ast
import contextlib
import glob
import os
import subprocess
from os.path import dirname as pdirname
from os.path import join as pjoin
from pathlib import Path
from subprocess import CalledProcessError
from app.log import log_and_print
@contextlib.contextmanager
def cd(newdir):
"""
Context manager for changing the current working directory
:param newdir: path to the new directory
:return: None
"""
prevdir = os.getcwd()
os.chdir(os.path.expanduser(newdir))
try:
yield
finally:
os.chdir(prevdir)
def run_command(cmd: list[str], **kwargs) -> subprocess.CompletedProcess:
"""
Run a command in the shell.
Args:
- cmd: command to run
"""
try:
cp = subprocess.run(cmd, check=True, **kwargs)
except subprocess.CalledProcessError as e:
log_and_print(f"Error running command: {cmd}, {e}")
raise e
return cp
def is_git_repo() -> bool:
"""
Check if the current directory is a git repo.
"""
git_dir = ".git"
return os.path.isdir(git_dir)
def initialize_git_repo_and_commit(logger=None):
"""
Initialize the current directory as a git repository and make an initial commit.
"""
init_cmd = ["git", "init"]
add_all_cmd = ["git", "add", "."]
commit_cmd = ["git", "commit", "-m", "Temp commit made by ACR."]
run_command(init_cmd, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
run_command(add_all_cmd, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
run_command(commit_cmd, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
def get_current_commit_hash() -> str:
command = ["git", "rev-parse", "HEAD"]
cp = subprocess.run(command, text=True, capture_output=True)
try:
cp.check_returncode()
return cp.stdout.strip()
except CalledProcessError as e:
raise RuntimeError(f"Failed to get SHA-1 of HEAD: {cp.stderr}") from e
def repo_commit_current_changes():
"""
Commit the current active changes so that it's safer to do git reset later on.
Use case: for storing the changes made in pre_install and test_patch in a commit.
"""
add_all_cmd = ["git", "add", "."]
commit_cmd = ["git", "commit", "-m", "Temporary commit for storing changes"]
run_command(add_all_cmd, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
run_command(commit_cmd, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
def clone_repo(clone_link: str, dest_dir: str, cloned_name: str):
"""
Clone a repo to dest_dir.
Returns:
- path to the newly cloned directory.
"""
clone_cmd = ["git", "clone", clone_link, cloned_name]
create_dir_if_not_exists(dest_dir)
with cd(dest_dir):
run_command(clone_cmd)
cloned_dir = pjoin(dest_dir, cloned_name)
return cloned_dir
def clone_repo_and_checkout(
clone_link: str, commit_hash: str, dest_dir: str, cloned_name: str
):
"""
Clone a repo to dest_dir, and checkout to commit `commit_hash`.
Returns:
- path to the newly cloned directory.
"""
cloned_dir = clone_repo(clone_link, dest_dir, cloned_name)
checkout_cmd = ["git", "checkout", commit_hash]
with cd(cloned_dir):
run_command(checkout_cmd)
return cloned_dir
def repo_clean_changes() -> None:
"""
Reset repo to HEAD. Basically clean active changes and untracked files on top of HEAD.
A lightweight version of `repo_reset_and_clean_checkout`. This is also used in different scenarios.
"""
reset_cmd = ["git", "reset", "--hard"]
clean_cmd = ["git", "clean", "-fd"]
run_command(reset_cmd, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
run_command(clean_cmd, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
def repo_reset_and_clean_checkout(commit_hash: str) -> None:
"""
Run commands to reset repo to the original commit state.
Cleans both the uncommited changes and the untracked files, and submodule changes.
Assumption: The current directory is the git repository.
"""
# NOTE: do these before `git reset`. This is because some of the removed files below
# may actually be in version control. So even if we deleted such files here, they
# will be brought back by `git reset`.
# Clean files that might be in .gitignore, but could have been created by previous runs
if os.path.exists(".coverage"):
os.remove(".coverage")
if os.path.exists("tests/.coveragerc"):
os.remove("tests/.coveragerc")
other_cov_files = glob.glob(".coverage.TSS.*", recursive=True)
for f in other_cov_files:
os.remove(f)
reset_cmd = ["git", "reset", "--hard", commit_hash]
clean_cmd = ["git", "clean", "-fd"]
checkout_cmd = ["git", "checkout", commit_hash]
run_command(reset_cmd, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
run_command(clean_cmd, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
# need to checkout before submodule init. Otherwise submodule may init to another version
run_command(checkout_cmd, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
# this is a fail-safe combo to reset any changes to the submodule: first unbind all submodules
# and then make a fresh checkout of them.
# Reference: https://stackoverflow.com/questions/10906554/how-do-i-revert-my-changes-to-a-git-submodule
submodule_unbind_cmd = ["git", "submodule", "deinit", "-f", "."]
submodule_init_cmd = ["git", "submodule", "update", "--init"]
run_command(
submodule_unbind_cmd, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL
)
run_command(
submodule_init_cmd, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL
)
def run_script_in_conda(
args: list[str], env_name: str, **kwargs
) -> subprocess.CompletedProcess:
"""
Run a python command in a given conda environment.
"""
cmd = ["conda", "run", "-n", env_name, "python", *args]
return subprocess.run(cmd, **kwargs)
def run_string_cmd_in_conda(
command: str, env_name: str, **kwargs
) -> subprocess.CompletedProcess:
"""
Run a complete command in a given conda environment, where the command is a string.
This is useful when the command to be run contains &&, etc.
NOTE: use `conda activate` instead of `conda run` in this verison, so that we can
run commands that contain `&&`, etc.
"""
conda_bin_path = os.getenv("CONDA_EXE") # for calling conda
if conda_bin_path is None:
raise RuntimeError("Env variable CONDA_EXE is not set")
conda_root_dir = pdirname(pdirname(conda_bin_path))
conda_script_path = pjoin(conda_root_dir, "etc", "profile.d", "conda.sh")
conda_cmd = f"source {conda_script_path} ; conda activate {env_name} ; {command} ; conda deactivate"
log_and_print(f"Running command: {conda_cmd}")
return subprocess.run(conda_cmd, shell=True, **kwargs)
def create_dir_if_not_exists(dir_path: str):
"""
Create a directory if it does not exist.
Args:
dir_path (str): Path to the directory.
"""
if not os.path.exists(dir_path):
os.makedirs(dir_path)
def to_relative_path(file_path: str, project_root: str) -> str:
"""Convert an absolute path to a path relative to the project root.
Args:
- file_path (str): The absolute path.
- project_root (str): Absolute path of the project root dir.
Returns:
The relative path.
"""
if Path(file_path).is_absolute():
return str(Path(file_path).relative_to(project_root))
else:
return file_path
def to_absolute_path(file_path: str, project_root: str) -> str:
"""Convert a relative path to an absolute path.
Args:
- file_path (str): The relative path.
- project_root (str): Absolute path of a root dir.
"""
return pjoin(project_root, file_path)
def find_file(directory, filename) -> str | None:
"""
Find a file in a directory. filename can be short name, relative path to the
directory, or an incomplete relative path to the directory.
Returns:
- the relative path to the file if found; None otherwise.
"""
# Helper method one
def find_file_exact_relative(directory, filename) -> str | None:
if os.path.isfile(os.path.join(directory, filename)):
return filename
return None
# Helper method two
def find_file_shortname(directory, filename) -> str | None:
for root, dirs, files in os.walk(directory):
for file in files:
if file == filename:
return os.path.relpath(os.path.join(root, file), directory)
return None
# if the filename is exactly the relative path.
found = find_file_exact_relative(directory, filename)
if found is not None:
return found
# if the filename is a short name without any directory
found = find_file_shortname(directory, filename)
if found is not None:
return found
# if the filename has some directory, but is not a relative path to
# the directory
parts = filename.split(os.path.sep)
shortname = parts[-1]
found = find_file_shortname(directory, shortname)
if found is None:
# really cannot find this file
return None
# can find this shortname, but we also need to check whether the intermediate
# directories match
if filename in found:
return found
else:
return None
def parse_function_invocation(
invocation_str: str,
) -> tuple[str, list[str]]:
try:
tree = ast.parse(invocation_str)
expr = tree.body[0]
assert isinstance(expr, ast.Expr)
call = expr.value
assert isinstance(call, ast.Call)
func = call.func
assert isinstance(func, ast.Name)
function_name = func.id
raw_arguments = [ast.unparse(arg) for arg in call.args]
# clean up spaces or quotes, just in case
arguments = [arg.strip().strip("'").strip('"') for arg in raw_arguments]
try:
new_arguments = [ast.literal_eval(x) for x in raw_arguments]
if new_arguments != arguments:
log_and_print(
f"Refactored invocation argument parsing gives different result on "
f"{invocation_str!r}: old result is {arguments!r}, new result "
f" is {new_arguments!r}"
)
except Exception as e:
log_and_print(
f"Refactored invocation argument parsing failed on {invocation_str!r}: {e!s}"
)
except Exception as e:
raise ValueError(f"Invalid function invocation: {invocation_str}") from e
return function_name, arguments