-
Notifications
You must be signed in to change notification settings - Fork 97
Expand file tree
/
Copy pathpkg_in_pipe.py
More file actions
executable file
·462 lines (421 loc) · 18.4 KB
/
Copy pathpkg_in_pipe.py
File metadata and controls
executable file
·462 lines (421 loc) · 18.4 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
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
#!/usr/bin/env python
import argparse
import io
import json
import os
import re
from collections import defaultdict
from datetime import datetime
from textwrap import dedent
from typing import cast
from urllib.request import urlopen
import diskcache
import github
import koji
import requests
from github.Commit import Commit
from github.GithubException import BadCredentialsException
from github.PullRequest import PullRequest
def print_header(out):
print(dedent('''
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>XCP-ng Package Update</title>
<style>
.tooltip{
visibility: hidden;
position: absolute;
}
.has-tooltip:hover .tooltip {
visibility: visible;
z-index: 100;
}
</style>
<script src="https://cdn.tailwindcss.com"></script>
</head>
<body class="bg-gray-400 text-center">
'''), file=out)
def print_plane_warning(out):
print(dedent('''
<div class="px-3 py-3">
<div class="bg-orange-100 border-l-4 border-orange-500 text-orange-700 p-4" role="alert">
<p class="font-bold">Plane malfunction</p>
<p>The issues could not be retrieved from plane.</p>
</div>
</div>'''), file=out)
def print_github_warning(out):
print(dedent('''
<div class="px-3 py-3">
<div class="bg-orange-100 border-l-4 border-orange-500 text-orange-700 p-4" role="alert">
<p class="font-bold">Github access problem</p>
<p>The pull requests come from the cache and may not be up to date.</p>
</div>
</div>'''), file=out)
def print_koji_error(out):
print(dedent('''
<div class="px-3 py-3">
<div class="bg-red-100 border border-red-400 text-red-700 px-4 py-3 rounded relative" role="alert">
<strong class="font-bold">Koji error!</strong>
<span class="block sm:inline">The report can't be generated.</span>
</div>
</div>'''), file=out)
def print_generic_error(out):
print(dedent('''
<div class="px-3 py-3">
<div class="bg-red-100 border border-red-400 text-red-700 px-4 py-3 rounded relative" role="alert">
<strong class="font-bold">Unknown error!</strong>
<span class="block sm:inline">The report can't be generated.</span>
</div>
</div>'''), file=out)
def print_footer(out, started_at, generated_info):
now = datetime.now()
duration = now - started_at
print(dedent(f'''
Generated on {now.date()} at {now.time().strftime("%H:%M:%S")} (took {duration.seconds} seconds).
{generated_info or ''}
</body>
</html>
'''), file=out)
def print_table_header(out, tag):
print(dedent(f'''
<div class="px-3 py-2">
<div class="relative overflow-x-auto shadow-md sm:rounded-lg">
<table class="table-fixed w-full text-sm text-left rtl:text-right text-gray-500 dark:text-gray-400">
<caption class="px-5 py-3 text-lg font-semibold text-left rtl:text-right text-gray-900 bg-white dark:text-white dark:bg-gray-800">
<a name="{tag}" href="#{tag}">{tag}</a>
</caption>
<thead class="text-xs text-gray-700 uppercase bg-gray-50 dark:bg-gray-700 dark:text-gray-400">
<tr>
<th scope="col" class="px-6 py-2 w-[25.5%]">
Build
</th>
<th scope="col" class="px-6 py-2 w-[37.5%]">
Pull Requests
</th>
<th scope="col" class="px-6 py-2 w-[12.5%]">
Cards
</th>
<th scope="col" class="px-6 py-2 w-[12.5%]">
Milestones
</th>
<th scope="col" class="px-6 py-2 w-[12.5%]">
Built by
</th>
<th scope="col" class="px-6 py-2 w-[12.5%]">
Maintained by
</th>
</tr>
</thead>
<tbody>
'''), file=out) # nopep8
def print_table_footer(out):
print(dedent('''
</tbody>
</table>
</div>
</div>
'''), file=out)
def issue_has_link(issue, url):
url = url.strip('/')
return f'href="{url}"' in issue['description_html'] or f'href="{url}/"' in issue['description_html']
def issues_have_link(issues, url):
return any([issue_has_link(issue, url) for issue in issues])
def print_table_line(out, build, link, issues, built_by, prs: list[PullRequest], maintained_by):
issues_content = '\n'.join([
f'''<li>
<a target="_blank" class="font-medium text-blue-600 dark:text-blue-500 hover:underline {'italic' if issue_has_link(i, link) else ''}"
href="https://project.vates.tech/vates-global/browse/XCPNG-{i['sequence_id']}/">XCPNG-{i['sequence_id']}
</a>
</li>''' # noqa
for i in issues
])
warn_pr = "<span class='has-tooltip'><span class='tooltip p-1 rounded bg-blue-500 text-gray-900'>Pull request not listed in any of the related cards</span>⚠️</span>" # noqa
prs_content = '\n'.join([
f'''<li>
<a target="_blank" class="font-medium text-blue-600 dark:text-blue-500 hover:underline"
href="{pr.html_url}">{pr.title} #{pr.number}
</a> {"" if issues_have_link(issues, pr.html_url) else warn_pr}
</li>'''
for pr in prs
])
warn_build = "<span class='has-tooltip'><span class='tooltip p-1 rounded bg-blue-500 text-gray-900'>Build not listed in any of the related cards</span>⚠️</span>" # noqa
warn_maintainer = "<span class='has-tooltip'><span class='tooltip p-1 rounded bg-blue-500 text-gray-900'>Maintainer information missing</span>⚠️</span>" # noqa
milestones_content = ", ".join(sorted(set(milestone for issue in issues for milestone in issue['milestones'])))
print(f'''
<tr class="odd:bg-white odd:dark:bg-gray-900 even:bg-gray-50 even:dark:bg-gray-800 border-b dark:border-gray-700 border-gray-200">
<th scope="row" class="px-6 py-2 font-medium text-gray-900 whitespace-nowrap dark:text-white truncate">
<a target="_blank" class="font-medium text-blue-600 dark:text-blue-500 hover:underline" href="{link}">{build}</a> {"" if issues_have_link(issues, link) else warn_build}
</th>
<td class="px-6 py-2">
<ul>
{prs_content}
</ul>
</td>
<td class="px-6 py-2">
<ul>
{issues_content}
</ul>
</td>
<td class="px-6 py-2">
{milestones_content}
</td>
<td class="px-6 py-2">
{built_by}
</td>
<td class="px-6 py-2">
{maintained_by if maintained_by is not None else warn_maintainer}
</td>
</tr>
''', file=out) # nopep8
def parse_source(source: str) -> tuple[str, str]:
groups = re.match(r'git\+https://github\.com/([\w-]+/[\w.-]+?)(|\.git)#([0-9a-f]{40})', source)
assert groups is not None, "can't match the source to the expected github url"
return (groups[1], groups[3])
def filter_issues(issues, urls):
res = []
for issue in issues:
for url in urls:
if issue_has_link(issue, url):
res.append(issue)
break
return res
TAG_ORDER = ['incoming', 'ci', 'testing', 'candidates', 'updates', 'base', 'lab', 'linstor']
def tag_priority(tag):
# drop the version in the tag — v8.3-incoming -> incoming
tag = tag.split('-')[-1]
if tag in TAG_ORDER:
return TAG_ORDER.index(tag)
else:
return -1
def find_previous_build_commit(build_tag, build):
"""Find the previous build in an higher priority koji tag and return its commit."""
tagged = KOJI.listTagged(build_tag, package=build['package_name'], inherit=True)
tagged = sorted(tagged, key=lambda t: (tag_priority(t['tag_name']), -t['build_id']))
build_tag_priority = tag_priority(build_tag)
tagged = [
t for t in tagged if tag_priority(t['tag_name']) >= build_tag_priority and t['build_id'] < build['build_id']
]
if not tagged:
return None
previous_build = get_koji_build(tagged[0]['build_id'])
if not previous_build.get('source'):
return None
return parse_source(previous_build['source'])[1]
def find_commits(gh, repo, start_sha, end_sha) -> list[Commit]:
"""
List the commits in the range [start_sha,end_sha[.
Note: these are the commits listed by Github starting from start_sha up to end_sha excluded.
A commit older that the end_sha commit and added by a merge commit won't appear in this list.
"""
cache_key = f'commits-2-{start_sha}-{end_sha}'
if not args.re_cache and cache_key in CACHE:
return cast(list[Commit], CACHE[cache_key])
commits = []
if gh:
for commit in gh.get_repo(repo).get_commits(start_sha):
if commit.sha == end_sha:
break
commits.append(commit)
CACHE.set(cache_key, commits, expire=RETENTION_TIME)
return commits
def find_pull_requests(repo, start_sha, end_sha):
"""Find the pull requests for the commits in the [start_sha,end_sha[ range."""
prs = set()
for commit in find_commits(GITHUB, repo, start_sha, end_sha):
cache_key = f'commit-prs-6-{commit.sha}'
if not args.re_cache and cache_key in CACHE:
prs.update(cast(list[PullRequest], CACHE[cache_key]))
elif GITHUB:
commit_prs = list(commit.get_pulls())
if not commit_prs:
# github is not properly reporting some PRs. Try to workaround that problem by getting
# the PR number from the commit message
group = re.match(r'Merge pull request #(\d+) from ', commit.commit.message)
if group:
pr = GITHUB.get_repo(repo).get_pull(int(group[1]))
prs.add(pr)
# github sometimes returns a PR which is only related to the commit through its branch
# history, e.g. a PR whose branch was created from this commit, so we check that the
# commit is actually part of the PR: it must be one of its commits, or its merge
# commit. The latter is needed for the PRs merged by rebase or squash, whose merge
# commit on the base branch is not one of the PR commits.
commit_prs = [pr for pr in commit_prs if commit in pr.get_commits() or commit.sha == pr.merge_commit_sha]
CACHE.set(cache_key, commit_prs, expire=RETENTION_TIME)
prs.update(commit_prs)
return sorted(prs, key=lambda p: p.number, reverse=True)
def get_koji_build(build_id) -> dict:
cache_key = f'koji-build-{build_id}'
if not args.re_cache and cache_key in CACHE:
return cast(dict, CACHE[cache_key])
else:
build = KOJI.getBuild(build_id)
CACHE.set(cache_key, build, expire=RETENTION_TIME)
return build
def get_plane_issues(plane_token):
"""Fetch all issues from Plane API with cursor-based pagination."""
all_results = []
cursor = None
base_url = (
'https://project.vates.tech/api/v1/workspaces/vates-global/projects/'
'43438eec-1335-4fc2-8804-5a4c32f4932d/issues/'
)
while True:
resp = requests.get(
base_url,
headers={'x-api-key': plane_token},
params={'cursor': cursor} if cursor else {},
)
data = resp.json()
all_results.extend(data.get('results', []))
cursor = data.get('next_cursor')
if not data.get('next_page_results', False) or not cursor:
break
return all_results
def get_plane_milestones(plane_token):
"""Fetch all milestones from Plane API with cursor-based pagination."""
all_results = []
cursor = None
base_url = (
'https://project.vates.tech/api/v1/workspaces/vates-global/projects/'
'43438eec-1335-4fc2-8804-5a4c32f4932d/milestones/'
)
while True:
resp = requests.get(
base_url,
headers={'x-api-key': plane_token},
params={'cursor': cursor} if cursor else {},
)
data = resp.json()
all_results.extend(data.get('results', []))
cursor = data.get('next_cursor')
if not data.get('next_page_results', False) or not cursor:
break
return all_results
def get_plane_milestone_issues(plane_token, milestone: str):
"""Fetch all issues for a milestone from Plane API with cursor-based pagination."""
all_results = []
cursor = None
base_url = (
'https://project.vates.tech/api/v1/workspaces/vates-global/projects/'
f'43438eec-1335-4fc2-8804-5a4c32f4932d/milestones/{milestone}/work-items/'
)
while True:
resp = requests.get(
base_url,
headers={'x-api-key': plane_token},
params={'cursor': cursor} if cursor else {},
)
data = resp.json()
all_results.extend(data.get('results', []))
cursor = data.get('next_cursor')
if not data.get('next_page_results', False) or not cursor:
break
return all_results
def get_plane_issues_with_milestones(plane_token):
issues = get_plane_issues(plane_token)
milestones = get_plane_milestones(plane_token)
issue_milestones = defaultdict(list)
for milestone in milestones:
milestone_issues = get_plane_milestone_issues(plane_token, milestone['id'])
for mi in milestone_issues:
issue_milestones[mi['issue']].append(milestone['title'])
for issue in issues:
issue['milestones'] = issue_milestones[issue['id']]
return issues
started_at = datetime.now()
parser = argparse.ArgumentParser(description='Generate a report of the packages in the pipe')
parser.add_argument('output', nargs='?', help='Report output path', default='report.html')
parser.add_argument('--generated-info', help="Add this message about the generation in the report")
parser.add_argument(
'--plane-token', help="The token used to access the plane api", default=os.environ.get('PLANE_TOKEN')
)
parser.add_argument(
'--github-token', help="The token used to access the Github api", default=os.environ.get('GITHUB_TOKEN')
)
parser.add_argument('--cache', help="The cache path", default="/tmp/pkg_in_pipe.cache")
parser.add_argument(
'--tag', '-t', dest='tags', help="The koji tags to include in the report", action='append', default=[]
)
parser.add_argument(
'--package', '-p', dest='packages', help="The packages to include in the report", action='append', default=[]
)
parser.add_argument('--re-cache', help="Refresh the cache", action='store_true')
args = parser.parse_args()
CACHE = diskcache.Cache(args.cache)
RETENTION_TIME = 24 * 60 * 60 # 24 hours
DEFAULT_TAGS = [
f'v{v}-{p}'
for v in ['8.3']
for p in ['incoming', 'ci', 'testing', 'candidates', 'lab', 'v-linstor-testing']
]
# 9.0 does not yet have all the 9.0-* variants. Just list the one already there for now
DEFAULT_TAGS += ['v9.0-incoming']
tags = args.tags or DEFAULT_TAGS
# load the issues from plane, so we can search for the plane card related to a build
try:
issues = get_plane_issues_with_milestones(args.plane_token)
except Exception:
issues = []
raise
# connect to github
GITHUB = None
if args.github_token:
GITHUB = github.Github(auth=github.Auth.Token(args.github_token))
try:
GITHUB.get_repo('xcp-ng/xcp') # check that the token is valid
except BadCredentialsException:
GITHUB = None
# load the packages maintainers
with urlopen('https://github.com/xcp-ng/xcp/raw/refs/heads/master/scripts/rpm_owners/packages.json') as f:
PACKAGES = json.load(f)
with io.StringIO() as out:
print_header(out)
if not issues:
print_plane_warning(out)
if not GITHUB:
print_github_warning(out)
with io.StringIO() as temp_out:
try:
# open koji session
config = koji.read_config("koji")
KOJI = koji.ClientSession('https://kojihub.xcp-ng.org', config)
KOJI.ssl_login(config['cert'], None, config['serverca'])
for tag in tags:
tag_history = dict(
(tl['build_id'], tl['create_ts'])
for tl in KOJI.queryHistory(tag=tag, active=True)['tag_listing']
)
print_table_header(temp_out, tag)
taggeds = KOJI.listTagged(tag)
taggeds = (t for t in taggeds if t['package_name'] in args.packages or args.packages == [])
taggeds = sorted(taggeds, key=lambda t: (tag_history[t['build_id']], t['build_id']), reverse=True)
for tagged in taggeds:
build = get_koji_build(tagged['build_id'])
prs: list[PullRequest] = []
maintained_by = None
previous_build_sha = find_previous_build_commit(tag, build)
if build['source'] is not None:
(repo, sha) = parse_source(build['source'])
prs = find_pull_requests(repo, sha, previous_build_sha)
maintained_by = PACKAGES.get(tagged['package_name'], {}).get('maintainer')
build_url = f'https://koji.xcp-ng.org/buildinfo?buildID={tagged["build_id"]}'
build_issues = filter_issues(issues, [build_url] + [pr.html_url for pr in prs])
print_table_line(
temp_out, tagged['nvr'], build_url, build_issues, tagged['owner_name'], prs, maintained_by
)
print_table_footer(temp_out)
out.write(temp_out.getvalue())
except koji.GenericError:
print_koji_error(out)
raise
except Exception:
print_generic_error(out)
raise
finally:
print_footer(out, started_at, args.generated_info)
# write the actual output at once, in order to avoid a blank page during the processing
with open(args.output, 'w') as f:
f.write(out.getvalue())