mirror of
https://github.com/getsolus/packages.git
synced 2025-05-01 23:31:08 +03:00
77b4ac49c5
Change the output of the `update` subcommand with: - A Markdown format that can be used for publishing. - Multiple authors (one for each commit). - The GitHub author that made the change.
329 lines
9.4 KiB
Python
Executable file
329 lines
9.4 KiB
Python
Executable file
#!/usr/bin/env python3
|
|
import argparse
|
|
import json
|
|
import os.path
|
|
import subprocess
|
|
import sys
|
|
import tempfile
|
|
from dataclasses import dataclass
|
|
from datetime import datetime, timezone
|
|
from typing import Any, Dict, Iterable, List, Optional, Sequence
|
|
from urllib import request
|
|
|
|
|
|
class TTY:
|
|
Reset = '\033[0m'
|
|
Red = '\033[31m'
|
|
Green = '\033[32m'
|
|
Yellow = '\033[33m'
|
|
Blue = '\033[34m'
|
|
White = '\033[97m'
|
|
|
|
@staticmethod
|
|
def url(name: str, ref: str) -> str:
|
|
return f'\033]8;;{ref}\033\\{name}\033]8;;\033\\'
|
|
|
|
|
|
class Listable:
|
|
@property
|
|
def package(self) -> str:
|
|
raise NotImplementedError
|
|
|
|
@property
|
|
def date(self) -> datetime:
|
|
raise NotImplementedError
|
|
|
|
def to_md(self) -> str:
|
|
raise NotImplementedError
|
|
|
|
def to_tty(self) -> str:
|
|
raise NotImplementedError
|
|
|
|
|
|
class GitHubCommit:
|
|
@staticmethod
|
|
def get(ref: str) -> 'GitHubCommit':
|
|
cached = GitHubCommit.__get_cache(ref)
|
|
if cached is not None:
|
|
return cached
|
|
|
|
return GitHubCommit.__get_gh_cli(ref)
|
|
|
|
def __init__(self, data: Dict[str, Any]) -> None:
|
|
self._data = data
|
|
|
|
@property
|
|
def author(self) -> str:
|
|
author = self._data.get('author')
|
|
if author is not None:
|
|
return str(author.get('login', 'Unknown'))
|
|
|
|
return str(self._data['commit']['author']['name'])
|
|
|
|
@staticmethod
|
|
def __tempfile(ref: str) -> str:
|
|
dir = os.path.join(tempfile.gettempdir(), '_solus_worklog')
|
|
os.makedirs(dir, exist_ok=True, mode=0o700)
|
|
|
|
return os.path.join(dir, ref + '.json')
|
|
|
|
@staticmethod
|
|
def __get_cache(ref: str) -> Optional['GitHubCommit']:
|
|
file = GitHubCommit.__tempfile(ref)
|
|
if not os.path.exists(file):
|
|
return None
|
|
|
|
with open(file, 'rb') as f:
|
|
return GitHubCommit(json.loads(f.read()))
|
|
|
|
@staticmethod
|
|
def __store_cache(ref: str, commit: str) -> None:
|
|
with open(os.path.join(GitHubCommit.__tempfile(ref)), 'w') as fh:
|
|
fh.write(commit)
|
|
|
|
@staticmethod
|
|
def __get_gh_cli(ref: str) -> 'GitHubCommit':
|
|
res = subprocess.run(['gh', 'api', f'repos/getsolus/packages/commits/{ref}'],
|
|
capture_output=True, text=True)
|
|
if res.returncode != 0:
|
|
raise ValueError(f'GitHub API returned non-zero exit: {res.stderr}')
|
|
|
|
GitHubCommit.__store_cache(ref, res.stdout)
|
|
|
|
return GitHubCommit(json.loads(res.stdout))
|
|
|
|
|
|
@dataclass
|
|
class Build(Listable):
|
|
id: int
|
|
pkg: str
|
|
version: str
|
|
release: str
|
|
ref: str
|
|
tag: str
|
|
tag_url: str
|
|
log_url: str
|
|
status: str
|
|
builder: str
|
|
finished: Optional[str]
|
|
|
|
@property
|
|
def package(self) -> str:
|
|
return self.pkg
|
|
|
|
@property
|
|
def date(self) -> datetime:
|
|
if self.finished is None:
|
|
return datetime.now(tz=timezone.utc)
|
|
|
|
return datetime.fromisoformat(self.finished).astimezone(timezone.utc)
|
|
|
|
def to_md(self) -> str:
|
|
return f'[{self.pkg} {self.v}]({self.tag_url})'
|
|
|
|
def to_tty(self) -> str:
|
|
return (f'{TTY.Green}{self.pkg}{TTY.Reset} {self.v} ' +
|
|
f'{TTY.Blue}[{self.builder}]{TTY.Reset} ' +
|
|
TTY.url('[🡕]', self.tag_url))
|
|
|
|
@property
|
|
def v(self) -> str:
|
|
return f'{self.version}-{self.release}'
|
|
|
|
def commit(self) -> GitHubCommit:
|
|
return GitHubCommit.get(self.ref)
|
|
|
|
|
|
class Update(Listable):
|
|
"""
|
|
Update represents a package update.
|
|
It includes information from one or more builds.
|
|
"""
|
|
|
|
def __init__(self, *builds: Build):
|
|
self.builds = list(builds)
|
|
|
|
def append(self, build: Build) -> None:
|
|
self.builds.append(build)
|
|
|
|
@property
|
|
def last(self) -> Build:
|
|
return max(self.builds, key=lambda b: b.date)
|
|
|
|
@property
|
|
def date(self) -> datetime:
|
|
return self.last.date
|
|
|
|
@property
|
|
def package(self) -> str:
|
|
return self.last.package
|
|
|
|
@property
|
|
def v(self) -> str:
|
|
return self.last.v
|
|
|
|
@property
|
|
def _successful_builds(self) -> Iterable[Build]:
|
|
return [build for build in self.builds if build.status == "OK"]
|
|
|
|
def to_tty(self) -> str:
|
|
authors = [TTY.url(f'@{build.commit().author}', build.tag_url)
|
|
for build in self._successful_builds]
|
|
|
|
return (f'{TTY.Green}{self.package}{TTY.Reset} {self.v} ' +
|
|
f'{TTY.Blue}[{", ".join(authors)}]{TTY.Reset}')
|
|
|
|
def to_md(self) -> str:
|
|
authors = [f'[@{build.commit().author}]({build.tag_url})'
|
|
for build in self._successful_builds]
|
|
|
|
return f'**{self.package}** was updated to **{self.v}** ({", ".join(authors)})'
|
|
|
|
|
|
class Builds:
|
|
_url = 'https://build.getsol.us/builds.json'
|
|
_builds: Optional[List[Build]] = None
|
|
|
|
@property
|
|
def all(self) -> List[Build]:
|
|
if self._builds is None:
|
|
with request.urlopen(self._url) as data:
|
|
self._builds = json.load(data, object_hook=lambda d: Build(**d))
|
|
|
|
return self._builds
|
|
|
|
@property
|
|
def packages(self) -> List[Build]:
|
|
return list({b.pkg: b for b in self.all}.values())
|
|
|
|
def updates(self, start: datetime, end: datetime) -> List[Update]:
|
|
updates: Dict[str, Update] = {}
|
|
|
|
for build in self._filter(self.all, start, end):
|
|
if build.status != "OK":
|
|
continue
|
|
|
|
if build.package in updates:
|
|
updates[build.package].append(build)
|
|
else:
|
|
updates[build.package] = Update(build)
|
|
|
|
return list(updates.values())
|
|
|
|
def during(self, start: datetime, end: datetime) -> List[Build]:
|
|
return self._filter(self.all, start, end)
|
|
|
|
@staticmethod
|
|
def _filter(builds: List[Build], start: datetime, end: datetime) -> List[Build]:
|
|
return list(filter(lambda b: start <= b.date <= end, builds))
|
|
|
|
|
|
@dataclass
|
|
class Commit(Listable):
|
|
ref: str
|
|
ts: str
|
|
msg: str
|
|
author: str
|
|
|
|
@staticmethod
|
|
def from_line(line: str) -> 'Commit':
|
|
return Commit(*line.split('\x1e'))
|
|
|
|
@property
|
|
def date(self) -> datetime:
|
|
return datetime.fromisoformat(self.ts).astimezone(timezone.utc)
|
|
|
|
@property
|
|
def package(self) -> str:
|
|
if ':' not in self.msg:
|
|
return '<unknown>'
|
|
|
|
return self.msg.split(':', 2)[0].strip()
|
|
|
|
@property
|
|
def change(self) -> str:
|
|
if ':' not in self.msg:
|
|
return self.msg.strip()
|
|
return self.msg.split(':', 2)[1].strip()
|
|
|
|
@property
|
|
def url(self) -> str:
|
|
return f'https://github.com/getsolus/packages/commit/{self.ref}'
|
|
|
|
def to_md(self) -> str:
|
|
return f'[{self.msg}]({self.url})'
|
|
|
|
def to_tty(self) -> str:
|
|
return (f'{TTY.Yellow}{TTY.url(self.ref, self.url)}{TTY.Reset} '
|
|
f'{self.date} '
|
|
f'{TTY.Green}{self.package}: {TTY.Reset}{self.change} '
|
|
f'{TTY.Blue}[{self.author}]{TTY.Reset} ' +
|
|
TTY.url('[🡕]', self.url))
|
|
|
|
|
|
class Git:
|
|
_cmd = ['git', '-c', 'color.ui=always', 'log', '--date=iso-strict', '--no-merges',
|
|
'--reverse', '--pretty=format:%h%x1e%ad%x1e%s%x1e%an']
|
|
|
|
def commits_by_pkg(self, start: datetime, end: datetime) -> Dict[str, List[Commit]]:
|
|
commits: Dict[str, List[Commit]] = {}
|
|
for commit in self.commits(start, end):
|
|
commits[commit.package] = commits.get(commit.package, []) + [commit]
|
|
|
|
return commits
|
|
|
|
def commits(self, start: datetime, end: datetime) -> List[Commit]:
|
|
return [Commit.from_line(line) for line in self._commits(start, end)]
|
|
|
|
def _commits(self, start: datetime, end: datetime) -> List[str]:
|
|
out = subprocess.Popen(self._cmd + [f'--after={start}', f'--before={end}'],
|
|
stdout=subprocess.PIPE, stderr=sys.stderr).stdout
|
|
if out is None:
|
|
return []
|
|
|
|
return out.read().decode('utf8').strip().split("\n")
|
|
|
|
|
|
def parse_date(date: str) -> datetime:
|
|
out = subprocess.Popen(['date', '-u', '--iso-8601=s', '--date=' + date],
|
|
stdout=subprocess.PIPE).stdout
|
|
if out is None:
|
|
raise ValueError(f'invalid date: {repr(date)}')
|
|
|
|
return datetime.fromisoformat(out.read().decode('utf8').strip())
|
|
|
|
|
|
if __name__ == '__main__':
|
|
parser = argparse.ArgumentParser()
|
|
parser.add_argument('command', type=str, choices=['builds', 'updates', 'commits'])
|
|
parser.add_argument('after', type=str, help='Show builds after this date')
|
|
parser.add_argument('before', type=str, help='Show builds before this date')
|
|
parser.add_argument('--format', '-f', type=str, choices=['md', 'tty'], default='tty')
|
|
parser.add_argument('--sort', '-s', action='store_true', help='Sort packages in lexically ascending order')
|
|
|
|
cli_args = parser.parse_args()
|
|
start = parse_date(cli_args.after)
|
|
end = parse_date(cli_args.before)
|
|
builds = Builds()
|
|
git = Git()
|
|
items: Sequence[Listable] = []
|
|
|
|
match cli_args.command:
|
|
case 'builds':
|
|
items = builds.during(start, end)
|
|
case 'updates':
|
|
items = builds.updates(start, end)
|
|
case 'commits':
|
|
items = git.commits(start, end)
|
|
|
|
if cli_args.sort:
|
|
items = sorted(items, key=lambda item: (item.package, item.date))
|
|
|
|
match cli_args.format:
|
|
case 'tty':
|
|
lines = [item.to_tty() for item in items]
|
|
case 'md':
|
|
lines = [f'- {item.to_md()}' for item in items]
|
|
|
|
print(f'{len(lines)} {cli_args.command}:')
|
|
print("\n".join(lines))
|