forked from openwallet-foundation/acapy-plugins
-
Notifications
You must be signed in to change notification settings - Fork 0
/
repo_manager.py
527 lines (445 loc) · 19.6 KB
/
repo_manager.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
import os
import re
import shutil
import subprocess
import sys
from copy import deepcopy
from enum import Enum
from pathlib import Path
from typing import Optional, Tuple
GLOBAL_PLUGIN_DIR = "plugin_globals"
class PluginInfo:
def __init__(
self,
name: str,
version: Optional[str] = None,
description: Optional[str] = None,
):
self.name = name
self.version = version
self.description = description
class ManagedPoetrySections(str, Enum):
META = "[tool.poetry]"
DEPS = "[tool.poetry.dependencies]"
DEV_DEPS = "[tool.poetry.dev-dependencies]"
INT_DEPS = "[tool.poetry.group.integration.dependencies]"
RUFF = "[tool.ruff]"
RUFF_LINT = "[tool.ruff.lint]"
RUFF_FILES = "[tool.ruff.lint.per-file-ignores]"
PYTEST = "[tool.pytest.ini_options]"
COVERAGE = "[tool.coverage.run]"
COVERAGE_REPORT = "[tool.coverage.report]"
COVERAGE_XML = "[tool.coverage.xml]"
BUILD = "[build-system]"
EXTRAS = "[tool.poetry.extras]"
sections = {
"META": [],
"DEPS": [],
"DEV_DEPS": [],
"INT_DEPS": [],
"RUFF": [],
"RUFF_LINT": [],
"RUFF_FILES": [],
"PYTEST": [],
"COVERAGE": [],
"COVERAGE_REPORT": [],
"COVERAGE_XML": [],
"BUILD": [],
"EXTRAS": [],
}
class NEW_PLUGIN_FOLDERS(Enum):
DOCKER = "docker"
INTEGRATION = "integration"
DEVCONTAINER = ".devcontainer"
VSCODE = ".vscode"
class NEW_PLUGIN_FILES(Enum):
PYPROJECT = "pyproject.toml"
README = "README.md"
DEFINITION = "definition.py"
class TAGGED_FILES(Enum):
DOCKER_DEFAULT = "docker/default.yml"
DOCKERFILE = "docker/Dockerfile"
DOCKER_INTEGRATION = "docker/integration.yml"
PYPROJECT = "pyproject.toml"
PYPROJECT_INTEGRATION = "integration/pyproject.toml"
DEVCONTAINER = ".devcontainer/devcontainer.json"
VSCODE = ".vscode/launch.json"
def replace_plugin_tag(path: str, info: PluginInfo):
with open(path, "r") as file:
filedata = file.read()
filedata = filedata.replace(GLOBAL_PLUGIN_DIR, info.name)
with open(path, "w") as file:
file.write(filedata)
def copy_all_common_files_for_new_plugin(info: PluginInfo) -> None:
for folder in list(NEW_PLUGIN_FOLDERS):
shutil.copytree(
f"./{GLOBAL_PLUGIN_DIR}/{folder.value}", f"./{info.name}/{folder.value}"
)
for file in list(NEW_PLUGIN_FILES):
file_location = (
f"./{info.name}/{file.value}"
if not file == NEW_PLUGIN_FILES.DEFINITION
else f"./{info.name}/{info.name}/{file.value}"
)
shutil.copyfile(f"./{GLOBAL_PLUGIN_DIR}/{file.value}", file_location)
for file in list(TAGGED_FILES):
replace_plugin_tag(f"./{info.name}/{file.value}", info)
def combine_dependencies(plugin_dependencies, global_dependencies) -> None:
"""Add the plugin dependencies to the global dependencies if they are plugin specific."""
for p_dep in plugin_dependencies:
if p_dep.split("=")[0].strip() not in [
g_dep.split("=")[0].strip() for g_dep in global_dependencies
]:
global_dependencies.append(p_dep)
def is_end_of_section(line: str, current_section: str) -> bool:
str_line = line.strip()
return (
str_line in [section.value for section in ManagedPoetrySections]
and str_line != current_section
)
def get_section(i: int, filedata: list, arr: list, current_section: str) -> int:
"""Put the section into the array and return the number of lines in the section."""
j = i
while j < len(filedata) and not is_end_of_section(filedata[j], current_section):
arr.append(filedata[j])
j += 1
# Remove the last empty line
if arr[-1] == "":
arr.pop()
return j - i
def extract_common_sections(filedata: str, sections: dict) -> None:
"""Go through the file by line and extract the section into the sections object."""
filedata = filedata.split("\n")
for i in range(len(filedata)):
line = filedata[i]
for section in ManagedPoetrySections:
if line.startswith(section.value):
i += get_section(i + 1, filedata, sections[section.name], section.value)
def get_section_output(
i: int, content: list, output: list, section: list, current_section: str
) -> int:
"""
Get a config section based off of an empty line of length of file.
Args:
i: The current line number
content: The file content
output: The output list
section: The section to process
Returns: The number of lines in the section
"""
j = i
output.append(content[j])
while j < len(content) - 1 and not is_end_of_section(content[j], current_section):
j += 1
while len(section) > 0:
output.append(section.pop(0) + "\n")
output.append("\n")
return j - i
def get_and_combine_main_poetry_sections(name: str) -> Tuple[dict, dict]:
"""Get the global main sections and combine them with the plugin specific sections."""
global_sections = deepcopy(sections)
plugin_sections = deepcopy(sections)
with open(f"./{GLOBAL_PLUGIN_DIR}/{TAGGED_FILES.PYPROJECT.value}", "r") as file:
filedata = file.read()
extract_common_sections(filedata, global_sections)
with open(f"./{name}/{TAGGED_FILES.PYPROJECT.value}", "r") as file:
filedata = file.read()
extract_common_sections(filedata, plugin_sections)
combine_dependencies(plugin_sections["DEPS"], global_sections["DEPS"])
combine_dependencies(plugin_sections["EXTRAS"], global_sections["EXTRAS"])
combine_dependencies(plugin_sections["DEV_DEPS"], global_sections["DEV_DEPS"])
combine_dependencies(plugin_sections["INT_DEPS"], global_sections["INT_DEPS"])
combine_dependencies(plugin_sections["PYTEST"], global_sections["PYTEST"])
return global_sections, plugin_sections
def process_main_config_sections(
name: str, plugin_sections: dict, global_sections: dict
) -> None:
"""Process the main config sections and write them to the plugins pyproject.toml file."""
with open(f"./{GLOBAL_PLUGIN_DIR}/{TAGGED_FILES.PYPROJECT.value}", "r") as in_file:
content = in_file.readlines()
sections = [section.value for section in ManagedPoetrySections]
output = []
with open(f"./{name}/{TAGGED_FILES.PYPROJECT.value}", "w") as out_file:
i = 0
while i < len(content):
if content[i].startswith(ManagedPoetrySections.META.value):
output.append(ManagedPoetrySections.META.value + "\n")
[output.append(line + "\n") for line in plugin_sections["META"]]
output.append("\n")
i += 1
for section in sections:
if content[i].startswith(section):
i += get_section_output(
i,
content,
output,
global_sections[ManagedPoetrySections(content[i].strip()).name],
content[i],
)
else:
i += 1
out_file.writelines(output)
replace_plugin_tag(f"./{name}/{TAGGED_FILES.PYPROJECT.value}", PluginInfo(name))
def get_and_combine_integration_poetry_sections(name: str) -> tuple[dict, dict]:
"""Get the global integration sections and combine them with the plugin specific sections."""
global_sections = deepcopy(sections)
plugin_sections = deepcopy(sections)
with open(
f"./{GLOBAL_PLUGIN_DIR}/{TAGGED_FILES.PYPROJECT_INTEGRATION.value}", "r"
) as file:
filedata = file.read()
extract_common_sections(filedata, global_sections)
with open(f"./{name}/{TAGGED_FILES.PYPROJECT_INTEGRATION.value}", "r") as file:
filedata = file.read()
extract_common_sections(filedata, plugin_sections)
combine_dependencies(plugin_sections["DEPS"], global_sections["DEPS"])
combine_dependencies(plugin_sections["DEV_DEPS"], global_sections["DEV_DEPS"])
combine_dependencies(plugin_sections["PYTEST"], global_sections["PYTEST"])
return global_sections, plugin_sections
def process_integration_config_sections(
name: str, plugin_sections: dict, global_sections: dict
) -> None:
"""Process the integration test config sections and write them to the plugins integration/pyproject.toml file."""
with open(
f"./{GLOBAL_PLUGIN_DIR}/{TAGGED_FILES.PYPROJECT_INTEGRATION.value}", "r"
) as in_file:
content = in_file.readlines()
sections = [section.value for section in ManagedPoetrySections]
output = []
with open(f"./{name}/{TAGGED_FILES.PYPROJECT_INTEGRATION.value}", "w") as out_file:
i = 0
while i < len(content):
if content[i].startswith(ManagedPoetrySections.META.value):
output.append(ManagedPoetrySections.META.value + "\n")
[output.append(line + "\n") for line in plugin_sections["META"]]
i += 1
output.append("\n")
for section in sections:
if content[i].startswith(section):
i += get_section_output(
i,
content,
output,
global_sections[ManagedPoetrySections(content[i].strip()).name],
content[i],
)
else:
i += 1
out_file.writelines(output)
def replace_global_sections(name: str) -> None:
"""
Combine the global sections with the plugin specific sections and write them to the plugins pyproject.toml file
with the global dependencies overriding the plugin dependencies.
"""
global_sections, plugin_sections = get_and_combine_main_poetry_sections(name)
process_main_config_sections(name, plugin_sections, global_sections)
if is_plugin_directory(name, True):
global_sections, plugin_sections = get_and_combine_integration_poetry_sections(
name
)
process_integration_config_sections(name, plugin_sections, global_sections)
def is_plugin_directory(plugin_name: str, exclude_lite_plugins: bool = False) -> bool:
# If there is a directory which is not a plugin it should be ignored here
if exclude_lite_plugins:
lite_plugins = Path("lite_plugins").read_text().splitlines()
return (
os.path.isdir(plugin_name)
and plugin_name != GLOBAL_PLUGIN_DIR
and not plugin_name.startswith(".")
and plugin_name not in lite_plugins
)
return (
os.path.isdir(plugin_name)
and plugin_name != GLOBAL_PLUGIN_DIR
and not plugin_name.startswith(".")
)
def update_all_poetry_locks():
for root, _, files in os.walk("."):
if "poetry.lock" in files:
print(f"Updating poetry.lock in {root}")
subprocess.run(["poetry", "lock"], cwd=root)
def upgrade_library_in_all_plugins(library: str = None):
for root, _, files in os.walk("."):
if "poetry.lock" in files:
with open(f"{root}/poetry.lock", "r") as file:
for line in file:
if f'name = "{library}"' in line:
print(f"Updating poetry.lock in {root}")
subprocess.run(["poetry", "update", library], cwd=root)
break
def main(arg_1=None, arg_2=None):
options = """
What would you like to do?
(1) Create a new plugin
(2) Update all plugin common poetry sections
(3) Upgrade plugin_global dependencies
(4) Update plugins description with supported acapy-agent version
(5) Get the plugins that upgraded since last release
(6) Update all poetry.lock files
(7) Upgrade a specific library in all plugins
(8) Exit \n\nInput: """
if arg_1:
selection = arg_1
else:
selection = input(options)
if selection != "4" and selection != "5":
print("Checking poetry is available...")
response = os.system("which poetry")
if response == "":
print("Poetry is not available. Please install poetry.")
exit(1)
if selection == "1":
# Create a new plugin
msg = """Creating a new plugin: This will create a blank plugin with all the common files and folders needed to get started developing and testing."""
print(msg)
name = input("Enter the plugin name (recommended to use snake_case): ")
if name == "":
print("You must enter a plugin name")
exit(1)
version = str(input("Enter the plugin version (default is 0.1.0): ") or "0.1.0")
description = input("Enter the plugin description (default is ''): ") or ""
plugin_info = PluginInfo(name, version, description)
os.makedirs(f"./{name}/{name}/v1_0")
copy_all_common_files_for_new_plugin(plugin_info)
os.system(f"cd {name} && poetry install --all-extras")
elif selection == "2":
# Update common poetry sections
msg = """Updating all plugin common poetry sections: This will take the global sections from the plugin_globals and combine them with the plugin specific sections, and install and update the lock file \n"""
print(msg)
for plugin_name in os.listdir("./"):
if is_plugin_directory(plugin_name):
print(f"Updating common poetry sections in {plugin_name}\n")
replace_global_sections(plugin_name)
os.system(f"cd {plugin_name} && rm poetry.lock && poetry lock")
# Don't update lite plugin integration files (They don't have any)
if is_plugin_directory(plugin_name, True):
os.system(
f"cd {plugin_name}/integration && rm poetry.lock && poetry lock"
)
elif selection == "3":
# Upgrade plugin globals lock file
msg = """Upgrade plugin_global dependencies \n"""
print(msg)
os.system("cd plugin_globals && poetry lock")
# Update plugins description with supported acapy-agent version
elif selection == "4":
"""
1. Update the description of each plugin with the supported acapy-agent version.
2. Output text for the release notes in markdown form.
"""
# Get the acapy-agent version from the global poetry.lock file
with open("./plugin_globals/poetry.lock", "r") as file:
for line in file:
if 'name = "acapy-agent"' in line:
next_line = next(file, None)
global_version = re.findall(r'"([^"]*)"', next_line)
break
# Create and output the markdown release notes
msg = f"""## ACA-Py Release {global_version[0]}\n"""
print(msg)
# Markdown table header
print("| Plugin Name | Supported ACA-Py Release |")
print("| --- | --- |")
for plugin_name in sorted(os.listdir("./")):
if is_plugin_directory(plugin_name):
# Plugin specific acapy-agent version
with open(f"./{plugin_name}/poetry.lock", "r") as file:
for line in file:
if 'name = "acapy-agent"' in line:
next_line = next(file, None)
version = re.findall(r'"([^"]*)"', next_line)
break
# Extract the description from the pyproject.toml file
with open(f"./{plugin_name}/pyproject.toml", "r") as file:
filedata = file.read()
linedata = filedata.split("\n")
for i in range(len(linedata)):
line = linedata[i]
if "description = " in line:
description = re.findall(r'"([^"]*)"', line)
description_line = line
break
# Replace the description with the supported acapy-agent version at the end
if description[0].find("Supported acapy-agent version") != -1:
description[0] = description[0].split(
" (Supported acapy-agent version"
)[0]
filedata = filedata.replace(
description_line,
f'description = "{description[0]} (Supported acapy-agent version: {version[0]}) "',
)
with open(f"./{plugin_name}/pyproject.toml", "w") as file:
file.write(filedata)
print(f"|{plugin_name} | {version[0]}|")
print("\n")
elif selection == "5":
"""
Extract the plugins from the RELEASES.md and determine which plugins which can be
upgraded or are new based off of the global acapy-agent version.
"""
# All the plugins. Used to determine which plugins are new.
all_plugins = [
plugin for plugin in os.listdir("./") if is_plugin_directory(plugin)
]
# Get the acapy-agent version from the global poetry.lock file
with open("./plugin_globals/poetry.lock", "r") as file:
for line in file:
if 'name = "acapy-agent"' in line:
next_line = next(file, None)
global_version = re.findall(r'"([^"]*)"', next_line)
break
# Extract the plugins and versions from the last release in the RELEASES.md file
with open("RELEASES.md", "r") as file:
last_releases = []
for line in file:
if f"## ACA-Py Release {global_version[0]}" in line:
line = next(file)
line = next(file)
line = next(file)
while "### Plugins Upgraded" not in line:
if (
line != "| Plugin Name | Supported ACA-Py Release |\n"
and line != "| --- | --- |\n"
):
last_releases.append(line.strip())
line = next(file)
break
# All plugins that have been released on the last release. Used to determine which plugins can be upgraded.
plugins_on_old_release = []
# All plugins that have been released. Used to determine which plugins are new.
released_plugins = []
# Get all released plugins and the plugins not on the global version
for item in last_releases:
split_item = item.split("|")
if len(split_item) > 1:
released_plugins.append(split_item[1].strip())
if split_item[2].strip() == global_version[0]:
plugins_on_old_release.append(split_item[1].strip())
# If there is releases in the RELEASES.md file then look for new plugins and add them to plugins on old release
if last_releases:
new_plugins = [
plugin for plugin in all_plugins if plugin not in released_plugins
]
for plugin in new_plugins:
plugins_on_old_release.append(plugin)
output = ""
for plugin in plugins_on_old_release:
output += f"{plugin} "
print(output)
elif selection == "6":
print("Updating all poetry.lock files in nested directories...")
update_all_poetry_locks()
elif selection == "7":
print("Upgrading a specific library in all plugins...")
upgrade_library_in_all_plugins(arg_2)
elif selection == "8":
print("Exiting...")
exit(0)
else:
print("Invalid selection. Please try again.")
main()
if __name__ == "__main__":
try:
main(sys.argv[1], sys.argv[2] if len(sys.argv) > 2 else None)
except Exception:
main()