-
Notifications
You must be signed in to change notification settings - Fork 12
Expand file tree
/
Copy pathengine.py
More file actions
392 lines (322 loc) · 12.7 KB
/
engine.py
File metadata and controls
392 lines (322 loc) · 12.7 KB
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
from __future__ import annotations
import json
from dataclasses import dataclass
from pathlib import Path
import base_cli
from base_setup.artifacts import reconcile_artifact, resolve_artifact_definitions
from base_setup.errors import ArtifactError
from base_setup.manifest import ArtifactRequest, BaseManifest, ManifestError, read_manifest
from base_setup.process import command_exists, run_check
from base_setup.registry import ArtifactDefinition
app = base_cli.App(name="base_dev")
SUPPORTED_PROFILES = ("dev", "sre")
@dataclass(frozen=True)
class DevCheck:
name: str
ok: bool
message: str
fix: str
status: str = ""
finding_id: str = "BASE-D100"
@dataclass(frozen=True)
class ProfileManifest:
name: str
manifest: BaseManifest
definitions: tuple[ArtifactDefinition, ...]
class ProfileError(ValueError):
pass
def main(argv: list[str] | None = None) -> int:
result = app.click_command.main(args=argv, standalone_mode=False)
return int(result or 0)
@app.command(context_settings={"help_option_names": ["-h", "--help"]})
@base_cli.argument("action", required=True)
@base_cli.option("--dry-run", is_flag=True, help="Log planned setup changes without making them.")
@base_cli.option("--format", "output_format", default="text", help="Output format for check/doctor: text or json.")
@base_cli.option(
"--profile",
"profiles",
multiple=True,
help="Comma-separated prerequisite profiles to include. Defaults to dev.",
)
def run(ctx: base_cli.Context, action: str, dry_run: bool, output_format: str, profiles: tuple[str, ...]) -> int:
try:
profile_manifests = read_profile_manifests(ctx, normalize_profiles(profiles))
except (ManifestError, ArtifactError) as exc:
ctx.log.error(str(exc))
return 1
except ProfileError as exc:
ctx.log.error(str(exc))
return 2
if action == "setup":
return setup_profile_manifests(ctx, profile_manifests, dry_run=dry_run)
if action == "check":
return check_profile_manifests(ctx, profile_manifests, output_format=output_format)
if action == "doctor":
return doctor_profile_manifests(profile_manifests, output_format=output_format)
ctx.log.error("Unsupported base_dev action '%s'. Expected setup, check, or doctor.", action)
return 2
def normalize_profiles(profiles: tuple[str, ...]) -> tuple[str, ...]:
if not profiles:
return ("dev",)
normalized: list[str] = []
for profile_list in profiles:
for raw_profile in profile_list.split(","):
profile = raw_profile.strip().lower()
if not profile:
raise ProfileError("Profile list must not contain empty entries.")
if profile not in SUPPORTED_PROFILES:
display_profile = raw_profile.strip() or raw_profile
raise ProfileError(
f"Unsupported profile '{display_profile}'. Expected one of: {', '.join(SUPPORTED_PROFILES)}."
)
if profile not in normalized:
normalized.append(profile)
return tuple(normalized)
def read_profile_manifests(ctx: base_cli.Context, profiles: tuple[str, ...]) -> tuple[ProfileManifest, ...]:
profile_manifests: list[ProfileManifest] = []
for profile in profiles:
manifest = read_profile_manifest(ctx, profile)
definitions = resolve_artifact_definitions(manifest.artifacts)
profile_manifests.append(ProfileManifest(profile, manifest, definitions))
return tuple(profile_manifests)
def read_profile_manifest(ctx: base_cli.Context, profile: str) -> BaseManifest:
if ctx.base_home is None:
raise ManifestError("BASE_HOME is required to load Base's prerequisite profile manifests.")
return read_manifest(profile_manifest_path(ctx.base_home, profile))
def read_dev_manifest(ctx: base_cli.Context) -> BaseManifest:
if ctx.base_home is None:
raise ManifestError("BASE_HOME is required to load Base's developer prerequisite manifest.")
return read_profile_manifest(ctx, "dev")
def dev_manifest_path(base_home: Path) -> Path:
return base_home / "lib" / "base" / "dev_manifest.yaml"
def profile_manifest_path(base_home: Path, profile: str) -> Path:
if profile == "dev":
return dev_manifest_path(base_home)
return base_home / "lib" / "base" / f"{profile}_manifest.yaml"
def setup_profile_manifests(
ctx: base_cli.Context,
profile_manifests: tuple[ProfileManifest, ...],
dry_run: bool,
) -> int:
for profile_manifest in profile_manifests:
status = setup_profile_artifacts(
ctx,
profile_manifest.name,
profile_manifest.manifest,
profile_manifest.definitions,
dry_run=dry_run,
)
if status != 0:
return status
return 0
def setup_dev_artifacts(
ctx: base_cli.Context,
manifest: BaseManifest,
definitions: tuple[ArtifactDefinition, ...],
dry_run: bool,
) -> int:
return setup_profile_artifacts(ctx, "dev", manifest, definitions, dry_run=dry_run)
def setup_profile_artifacts(
ctx: base_cli.Context,
profile: str,
manifest: BaseManifest,
definitions: tuple[ArtifactDefinition, ...],
dry_run: bool,
) -> int:
if profile == "dev":
ctx.log.info("Reading Base developer prerequisite manifest at '%s'.", manifest.path)
ctx.log.info("Setting up Base developer prerequisites.")
else:
ctx.log.info("Reading Base '%s' prerequisite manifest at '%s'.", profile, manifest.path)
ctx.log.info("Setting up Base '%s' prerequisites.", profile)
try:
for artifact, definition in zip(manifest.artifacts, definitions, strict=True):
reconcile_artifact(ctx, definition, artifact.version, manifest.project_name, dry_run=dry_run)
except ArtifactError as exc:
ctx.log.error(str(exc))
return 1
if profile == "dev":
ctx.log.info("Base developer prerequisite setup is complete.")
else:
ctx.log.info("Base '%s' prerequisite setup is complete.", profile)
return 0
def check_profile_manifests(
ctx: base_cli.Context,
profile_manifests: tuple[ProfileManifest, ...],
output_format: str,
) -> int:
checks = tuple(
check
for profile_manifest in profile_manifests
for check in dev_checks(
profile_manifest.manifest.artifacts,
profile_manifest.definitions,
profile=profile_manifest.name,
)
)
return print_check_results(ctx, checks, output_format=output_format)
def check_dev_artifacts(
ctx: base_cli.Context,
artifacts: tuple[ArtifactRequest, ...],
definitions: tuple[ArtifactDefinition, ...],
output_format: str,
) -> int:
checks = dev_checks(artifacts, definitions, profile="dev")
return print_check_results(ctx, checks, output_format=output_format)
def print_check_results(ctx: base_cli.Context, checks: tuple[DevCheck, ...], output_format: str) -> int:
if output_format == "json":
print(json.dumps([check_to_json(check) for check in checks], indent=2))
elif output_format == "text":
for check in checks:
if check.ok:
ctx.log.info(check.message)
else:
ctx.log.warning(check.message)
else:
ctx.log.error("Unsupported check output format '%s'. Expected text or json.", output_format)
return 2
return 0 if all(check.ok for check in checks) else 1
def doctor_profile_manifests(
profile_manifests: tuple[ProfileManifest, ...],
output_format: str,
) -> int:
checks = tuple(
check
for profile_manifest in profile_manifests
for check in dev_checks(
profile_manifest.manifest.artifacts,
profile_manifest.definitions,
profile=profile_manifest.name,
)
)
return print_doctor_results(checks, output_format=output_format)
def doctor_dev_artifacts(
artifacts: tuple[ArtifactRequest, ...],
definitions: tuple[ArtifactDefinition, ...],
output_format: str,
) -> int:
checks = dev_checks(artifacts, definitions, profile="dev")
return print_doctor_results(checks, output_format=output_format)
def print_doctor_results(checks: tuple[DevCheck, ...], output_format: str) -> int:
if output_format == "json":
print(json.dumps([check_to_doctor_json(check) for check in checks], indent=2))
return min(sum(1 for check in checks if doctor_status(check) == "error"), 125)
if output_format != "text":
print(f"Unsupported doctor output format '{output_format}'. Expected text or json.")
return 2
error_count = 0
for check in checks:
status = doctor_status(check)
if status == "error":
print_doctor_finding("error", check.finding_id, check.name, check.message, check.fix)
error_count += 1
else:
print_doctor_finding(status, check.finding_id, check.name, check.message, check.fix)
return min(error_count, 125)
def dev_checks(
artifacts: tuple[ArtifactRequest, ...],
definitions: tuple[ArtifactDefinition, ...],
profile: str = "dev",
) -> tuple[DevCheck, ...]:
checks: list[DevCheck] = []
for artifact, definition in zip(artifacts, definitions):
check = check_homebrew_artifact(artifact, definition, profile=profile)
checks.append(check)
if artifact.name == "gh" and check.ok:
checks.append(check_github_cli_auth())
return tuple(checks)
def profile_setup_fix(profile: str) -> str:
return f"basectl setup --profile {profile}"
def check_homebrew_artifact(
artifact: ArtifactRequest,
definition: ArtifactDefinition,
profile: str = "dev",
) -> DevCheck:
if definition.manager != "homebrew":
return DevCheck(
name=artifact.name,
ok=False,
message=(
f"Artifact '{artifact.name}' uses unsupported developer prerequisite manager '{definition.manager}'."
),
fix=f"Update {profile_manifest_path(Path('lib/base'), profile).name} to use a Homebrew-managed tool.",
finding_id="BASE-D101",
)
if artifact.version != "latest":
return DevCheck(
name=artifact.name,
ok=False,
message=f"Artifact '{artifact.name}' uses unsupported developer prerequisite version '{artifact.version}'.",
fix="Use version 'latest' for Homebrew-managed developer prerequisites.",
finding_id="BASE-D102",
)
if not command_exists("brew"):
return DevCheck(
name=artifact.name,
ok=False,
message=f"Homebrew is required to check developer prerequisite '{artifact.name}'.",
fix="basectl setup",
finding_id="BASE-D103",
)
ok = run_check(["brew", "list", definition.package])
if ok:
return DevCheck(
name=artifact.name,
ok=True,
message=f"Artifact '{artifact.name}' is installed via Homebrew package '{definition.package}'.",
fix="",
finding_id="BASE-D104",
)
return DevCheck(
name=artifact.name,
ok=False,
message=f"Artifact '{artifact.name}' is not installed via Homebrew package '{definition.package}'.",
fix=profile_setup_fix(profile),
finding_id="BASE-D104",
)
def check_github_cli_auth() -> DevCheck:
if not command_exists("gh"):
return DevCheck(
name="gh-auth",
ok=False,
message="GitHub CLI 'gh' was not found.",
fix="basectl setup --profile dev",
finding_id="BASE-D105",
)
ok = run_check(["gh", "auth", "status"])
if ok:
return DevCheck(
name="gh-auth",
ok=True,
message="GitHub CLI authentication is ready.",
fix="",
finding_id="BASE-D106",
)
return DevCheck(
name="gh-auth",
ok=False,
message="GitHub CLI authentication is not ready.",
fix="gh auth login -h github.com",
finding_id="BASE-D106",
)
def check_to_json(check: DevCheck) -> dict[str, str | bool]:
return {
"name": check.name,
"ok": check.ok,
"message": check.message,
"fix": check.fix,
}
def check_to_doctor_json(check: DevCheck) -> dict[str, str]:
return {
"id": check.finding_id,
"status": doctor_status(check),
"name": check.name,
"message": check.message,
"fix": check.fix,
}
def doctor_status(check: DevCheck) -> str:
return check.status or ("ok" if check.ok else "error")
def print_doctor_finding(status: str, finding_id: str, name: str, message: str, fix: str = "") -> None:
print(f"{status:<5} {finding_id:<9} {name:<26} {message}")
if fix:
print(f" Fix: {fix}")