301 lines
9.1 KiB
Python
301 lines
9.1 KiB
Python
import json
|
|
import os
|
|
import signal
|
|
from collections.abc import Generator
|
|
from dataclasses import dataclass
|
|
from pathlib import Path
|
|
from tempfile import NamedTemporaryFile
|
|
from typing import Any
|
|
|
|
from buildbot.config.builder import BuilderConfig
|
|
from buildbot.plugins import util
|
|
from buildbot.process.buildstep import BuildStep
|
|
from buildbot.process.properties import Interpolate
|
|
from buildbot.reporters.base import ReporterBase
|
|
from buildbot.www.auth import AuthBase
|
|
from buildbot.www.avatar import AvatarBase
|
|
from buildbot_gitea.auth import GiteaAuth # type: ignore[import]
|
|
from buildbot_gitea.reporter import GiteaStatusPush # type: ignore[import]
|
|
from twisted.internet import defer, threads
|
|
from twisted.python import log
|
|
from twisted.python.failure import Failure
|
|
|
|
from .common import (
|
|
http_request,
|
|
paginated_github_request,
|
|
slugify_project_name,
|
|
)
|
|
from .projects import GitBackend, GitProject
|
|
from .secrets import read_secret_file
|
|
|
|
|
|
@dataclass
|
|
class GiteaConfig:
|
|
instance_url: str
|
|
oauth_id: str | None
|
|
|
|
oauth_secret_name: str = "gitea-oauth-secret"
|
|
token_secret_name: str = "gitea-token"
|
|
webhook_secret_name: str = "gitea-webhook-secret"
|
|
project_cache_file: Path = Path("gitea-project-cache.json")
|
|
topic: str | None = "build-with-buildbot"
|
|
|
|
def oauth_secret(self) -> str:
|
|
return read_secret_file(self.oauth_secret_name)
|
|
|
|
def token(self) -> str:
|
|
return read_secret_file(self.token_secret_name)
|
|
|
|
|
|
class GiteaProject(GitProject):
|
|
config: GiteaConfig
|
|
webhook_secret: str
|
|
data: dict[str, Any]
|
|
|
|
def __init__(
|
|
self, config: GiteaConfig, webhook_secret: str, data: dict[str, Any]
|
|
) -> None:
|
|
self.config = config
|
|
self.webhook_secret = webhook_secret
|
|
self.data = data
|
|
|
|
def create_project_hook(
|
|
self,
|
|
owner: str,
|
|
repo: str,
|
|
webhook_url: str,
|
|
) -> None:
|
|
hooks = paginated_github_request(
|
|
f"https://{self.config.instance_url}/api/v1/repos/{owner}/{repo}/hooks?limit=100",
|
|
self.config.token(),
|
|
)
|
|
config = dict(
|
|
url=webhook_url + "change_hook/gitea",
|
|
content_type="json",
|
|
insecure_ssl="0",
|
|
secret=self.webhook_secret,
|
|
)
|
|
data = dict(
|
|
name="web",
|
|
active=True,
|
|
events=["push", "pull_request"],
|
|
config=config,
|
|
type="gitea",
|
|
)
|
|
headers = {
|
|
"Authorization": f"token {self.config.token()}",
|
|
"Accept": "application/json",
|
|
"Content-Type": "application/json",
|
|
}
|
|
for hook in hooks:
|
|
if hook["config"]["url"] == webhook_url + "change_hook/gitea":
|
|
log.msg(f"hook for {owner}/{repo} already exists")
|
|
return
|
|
|
|
http_request(
|
|
f"https://{self.config.instance_url}/api/v1/repos/{owner}/{repo}/hooks",
|
|
method="POST",
|
|
headers=headers,
|
|
data=data,
|
|
)
|
|
|
|
def get_project_url(self) -> str:
|
|
return f"https://git:%(secret:{self.config.token_secret_name})s@{self.config.instance_url}/{self.name}"
|
|
|
|
@property
|
|
def pretty_type(self) -> str:
|
|
return "Gitea"
|
|
|
|
@property
|
|
def type(self) -> str:
|
|
return "gitea"
|
|
|
|
@property
|
|
def repo(self) -> str:
|
|
return self.data["name"]
|
|
|
|
@property
|
|
def owner(self) -> str:
|
|
return self.data["owner"]["login"]
|
|
|
|
@property
|
|
def name(self) -> str:
|
|
return self.data["full_name"]
|
|
|
|
@property
|
|
def url(self) -> str:
|
|
# not `html_url` because https://github.com/lab132/buildbot-gitea/blob/f569a2294ea8501ef3bcc5d5b8c777dfdbf26dcc/buildbot_gitea/webhook.py#L34
|
|
return self.data["ssh_url"]
|
|
|
|
@property
|
|
def project_id(self) -> str:
|
|
return slugify_project_name(self.data["full_name"])
|
|
|
|
@property
|
|
def default_branch(self) -> str:
|
|
return self.data["default_branch"]
|
|
|
|
@property
|
|
def topics(self) -> list[str]:
|
|
# note that Gitea doesn't by default put this data here, we splice it in, in `refresh_projects`
|
|
return self.data["topics"]
|
|
|
|
@property
|
|
def belongs_to_org(self) -> bool:
|
|
# TODO Gitea doesn't include this information
|
|
return False # self.data["owner"]["type"] == "Organization"
|
|
|
|
|
|
class GiteaBackend(GitBackend):
|
|
config: GiteaConfig
|
|
|
|
def __init__(self, config: GiteaConfig) -> None:
|
|
self.config = config
|
|
self.webhook_secret = read_secret_file(self.config.webhook_secret_name)
|
|
|
|
def create_reload_builder(self, worker_names: list[str]) -> BuilderConfig:
|
|
"""Updates the flake an opens a PR for it."""
|
|
factory = util.BuildFactory()
|
|
factory.addStep(
|
|
ReloadGiteaProjects(self.config, self.config.project_cache_file),
|
|
)
|
|
return util.BuilderConfig(
|
|
name=self.reload_builder_name,
|
|
workernames=worker_names,
|
|
factory=factory,
|
|
)
|
|
|
|
def create_reporter(self) -> ReporterBase:
|
|
return GiteaStatusPush(
|
|
"https://" + self.config.instance_url,
|
|
Interpolate(self.config.token()),
|
|
context=Interpolate("buildbot/%(prop:status_name)s"),
|
|
context_pr=Interpolate("buildbot/%(prop:status_name)s"),
|
|
)
|
|
|
|
def create_change_hook(self) -> dict[str, Any]:
|
|
return {
|
|
"secret": self.webhook_secret,
|
|
}
|
|
|
|
def create_avatar_method(self) -> AvatarBase | None:
|
|
return None
|
|
|
|
def create_auth(self) -> AuthBase:
|
|
assert self.config.oauth_id is not None, "Gitea requires an OAuth ID to be set"
|
|
return GiteaAuth(
|
|
"https://" + self.config.instance_url,
|
|
self.config.oauth_id,
|
|
self.config.oauth_secret(),
|
|
)
|
|
|
|
def load_projects(self) -> list["GitProject"]:
|
|
if not self.config.project_cache_file.exists():
|
|
return []
|
|
|
|
repos: list[dict[str, Any]] = sorted(
|
|
json.loads(self.config.project_cache_file.read_text()),
|
|
key=lambda x: x["full_name"],
|
|
)
|
|
return list(
|
|
filter(
|
|
lambda project: self.config.topic is not None
|
|
and self.config.topic in project.topics,
|
|
[
|
|
GiteaProject(self.config, self.webhook_secret, repo)
|
|
for repo in repos
|
|
],
|
|
)
|
|
)
|
|
|
|
def are_projects_cached(self) -> bool:
|
|
return self.config.project_cache_file.exists()
|
|
|
|
@property
|
|
def type(self) -> str:
|
|
return "gitea"
|
|
|
|
@property
|
|
def pretty_type(self) -> str:
|
|
return "Gitea"
|
|
|
|
@property
|
|
def reload_builder_name(self) -> str:
|
|
return "reload-gitea-projects"
|
|
|
|
@property
|
|
def change_hook_name(self) -> str:
|
|
return "gitea"
|
|
|
|
|
|
class ReloadGiteaProjects(BuildStep):
|
|
name = "reload_gitea_projects"
|
|
config: GiteaConfig
|
|
|
|
def __init__(
|
|
self, config: GiteaConfig, project_cache_file: Path, **kwargs: Any
|
|
) -> None:
|
|
self.config = config
|
|
self.project_cache_file = project_cache_file
|
|
super().__init__(**kwargs)
|
|
|
|
def reload_projects(self) -> None:
|
|
refresh_projects(self.config, self.project_cache_file)
|
|
|
|
@defer.inlineCallbacks
|
|
def run(self) -> Generator[Any, object, Any]:
|
|
d = threads.deferToThread(self.reload_projects) # type: ignore[no-untyped-call]
|
|
|
|
self.error_msg = ""
|
|
|
|
def error_cb(failure: Failure) -> int:
|
|
self.error_msg += failure.getTraceback()
|
|
return util.FAILURE
|
|
|
|
d.addCallbacks(lambda _: util.SUCCESS, error_cb)
|
|
res = yield d
|
|
if res == util.SUCCESS:
|
|
# reload the buildbot config
|
|
os.kill(os.getpid(), signal.SIGHUP)
|
|
return util.SUCCESS
|
|
else:
|
|
yield self.addLog("log").addStderr(
|
|
f"Failed to reload project list: {self.error_msg}"
|
|
)
|
|
return util.FAILURE
|
|
|
|
|
|
def refresh_projects(config: GiteaConfig, repo_cache_file: Path) -> None:
|
|
repos = []
|
|
|
|
for repo in paginated_github_request(
|
|
f"https://{config.instance_url}/api/v1/user/repos?limit=100",
|
|
config.token(),
|
|
):
|
|
if not repo["permissions"]["admin"]:
|
|
name = repo["full_name"]
|
|
log.msg(
|
|
f"skipping {name} because we do not have admin privileges, needed for hook management",
|
|
)
|
|
else:
|
|
try:
|
|
# Gitea doesn't include topics in the default repo listing, unlike GitHub
|
|
topics: list[str] = http_request(
|
|
f"https://{config.instance_url}/api/v1/repos/{repo['owner']['login']}/{repo['name']}/topics",
|
|
headers={"Authorization": f"token {config.token}"},
|
|
).json()["topics"]
|
|
repo["topics"] = topics
|
|
repos.append(repo)
|
|
except OSError:
|
|
pass
|
|
|
|
with NamedTemporaryFile("w", delete=False, dir=repo_cache_file.parent) as f:
|
|
path = Path(f.name)
|
|
try:
|
|
f.write(json.dumps(repos))
|
|
f.flush()
|
|
path.rename(repo_cache_file)
|
|
except OSError:
|
|
path.unlink()
|
|
raise
|