-
Notifications
You must be signed in to change notification settings - Fork 0
/
main.py
executable file
·231 lines (191 loc) · 7.4 KB
/
main.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
#!/usr/bin/env python3
# Copyright (C) 2023 Maxwell G <maxwell@gtmx.me>
# SPDX-License-Identifier: GPL-3.0-or-later
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or
# https://www.gnu.org/licenses/gpl-3.0.txt)
from __future__ import annotations
import dataclasses
import webbrowser
from collections import Counter
from collections.abc import Iterable, Iterator
from functools import cached_property
from pathlib import Path
from typing import TypedDict, cast
import jinja2
import pyperclip # type: ignore[import]
import typer
from antsibull.from_source.verify import FileError, FileErrorOutput
from antsibull.sanity_tests import CollectionOutput, IgnoreEntry
from antsibull.sanity_tests import Output as SanityTestsOutput
from antsibull.tagging import CollectionTagData
from antsibull.types import CollectionName, make_collection_mapping
from antsibull_core.yaml import load_yaml_file, store_yaml_stream
from yarl import URL
app = typer.Typer()
env = jinja2.Environment(
autoescape=jinja2.select_autoescape(default_for_string=False),
trim_blocks=True,
undefined=jinja2.StrictUndefined,
loader=jinja2.FileSystemLoader(Path(__file__).resolve().parent / "templates"),
)
def get_all_errors(outputs: Iterable[FileErrorOutput], /) -> Counter[FileError]:
return Counter(output["error"] for output in outputs)
class UpstreamsTestOutput(TypedDict):
collections: dict[CollectionName, list[FileErrorOutput]]
@dataclasses.dataclass()
class Args:
data_path: Path
tag_data_path: Path
upstreams_data_path: Path
@cached_property
def data(self) -> SanityTestsOutput:
data = load_yaml_file(self.data_path)
data["collections"] = make_collection_mapping(data["collections"])
return data
@cached_property
def tags_data(self) -> dict[CollectionName, CollectionTagData]:
data = load_yaml_file(self.tag_data_path)
data = make_collection_mapping(data)
return data
@cached_property
def upstreams_data(self) -> UpstreamsTestOutput:
data = load_yaml_file(self.upstreams_data_path)
data["collections"] = make_collection_mapping(data["collections"])
return data
@app.callback()
def callback(
ctx: typer.Context,
data_path: Path = typer.Option(..., "-i", "--data", "--sanity-data"),
tag_data: Path = typer.Option(..., "-t", "--tag-data"),
upstreams_data_path: Path = typer.Option(..., "-u", "--upstreams-data"),
):
ctx.obj = Args(data_path, tag_data, upstreams_data_path)
def get_test_name(path: str) -> str:
return path.removeprefix("ansible-test-sanity-").removesuffix(".json")
def get_issue_title(collection: CollectionName, sargs: Args) -> str:
has_sanity_errors = sargs.data["collections"][collection]["failed"]
has_file_errors = collection in sargs.upstreams_data["collections"]
title = "Community package requirements: "
found: list[str] = []
if has_sanity_errors:
found.append("sanity tests")
if has_file_errors:
found.append("repository management")
if not found:
raise ValueError("No errors found")
title += " and ".join(found)
return title
@app.command()
def render(
ctx: typer.Context,
collection_: str,
add_title: bool = typer.Option(False, "-T", "--add-title"),
output: typer.FileTextWrite = typer.Option("-", "-o", "--output"),
) -> None:
sargs = ctx.ensure_object(Args)
collection = CollectionName(collection_)
rendered = render_issue(collection, sargs)
if add_title:
title = get_issue_title(collection, sargs)
rendered = f"# {title}\n\n" + rendered.lstrip("\n")
print(rendered, file=output)
output.close()
@app.command()
def render_all(
ctx: typer.Context,
output_dir: Path = typer.Option(..., "-O", "--output-dir"),
add_title: bool = typer.Option(False, "-T", "--add-title"),
) -> None:
sargs = ctx.ensure_object(Args)
output_dir.mkdir(exist_ok=True)
for collection, data in sargs.data["collections"].items():
# fmt: off
if (
not data["failed"]
and not sargs.upstreams_data["collections"].get(collection)
):
# fmt: on
continue
render(
ctx,
collection,
add_title,
cast(typer.FileTextWrite, (output_dir / f"{collection}.md").open("w")),
)
@app.command()
def sanity_data(
ctx: typer.Context,
collection_: str,
output: typer.FileTextWrite = typer.Option("-", "-o", "--output"),
) -> None:
sargs = ctx.ensure_object(Args)
collection = CollectionName(collection_)
data = sargs.data["collections"][collection]
store_yaml_stream(output, data)
output.close()
@app.command()
def issue(ctx: typer.Context, collection_: str) -> None:
sargs = ctx.ensure_object(Args)
collection = CollectionName(collection_)
title = get_issue_title(collection, sargs)
body = render_issue(collection, sargs)
# `repository` shouldn't be None, mypy.
assert (u := sargs.tags_data[collection]["repository"])
# Guess issue tracker URL. This won't always be correct, but close enough
issue_url = URL(u) / "issues/new"
issue_url = issue_url.with_query(title=title)
# Clipboard managers will save both
pyperclip.copy(title)
pyperclip.copy(body)
webbrowser.open(str(issue_url))
def render_issue(collection: CollectionName, sargs: Args) -> str:
sanity_data = sargs.data["collections"][collection]
sanity = sanity_data["sanity"]
test_json = sanity["test_json"]
tags_data = sargs.tags_data[collection]
file_errors = sargs.upstreams_data["collections"].get(collection) or []
invalid_ignores = [
IgnoreEntry(**data) for data in cast(dict, sanity["banned_ignore_entries"])
]
tvars = {
"collection_name": collection,
"test_json": test_json,
"invalid_ignores": invalid_ignores,
"tag_output": tags_data,
"file_errors": file_errors,
"env_details": sargs.data["env_details"],
"ignores_file": sanity.get("ignores_file"),
}
return env.get_template("issue.md").render(**tvars)
def get_error_tuples(
sanity: CollectionOutput, upstreams: list[FileErrorOutput] | None
) -> Iterator[tuple[str | FileError, int]]:
for file, test_json in sanity["sanity"]["test_json"].items():
yield get_test_name(file), sum(
len(r["output"].splitlines()) for r in test_json["results"]
)
if banned := sanity["sanity"].get("banned_ignore_entries"):
yield "BANNED_SANITY", len(banned)
if upstreams:
yield from get_all_errors(upstreams).items()
@app.command()
def failures(ctx: typer.Context, bullet: str = "*", reverse: bool = False) -> None:
sargs = ctx.ensure_object(Args)
sanity = sargs.data["collections"]
upstreams = sargs.upstreams_data["collections"]
failed_collectiions: dict[CollectionName, dict[str | FileError, int]] = {
collection: out
for collection, sanity_out in sanity.items()
if (out := dict(get_error_tuples(sanity_out, upstreams.get(collection))))
}
for collection, test_data in sorted(
failed_collectiions.items(), key=(lambda x: sum(x[1].values())), reverse=reverse
):
print(bullet, collection)
for name, output_count in sorted(
test_data.items(), key=lambda x: x[1], reverse=True
):
print(f" {output_count} {name}")
print(f"Total: {len(failed_collectiions)}")
if __name__ == "__main__":
app()