diff --git a/.github/scripts/cleanup-tags.py b/.github/scripts/cleanup-tags.py new file mode 100644 index 000000000..a77b5fad0 --- /dev/null +++ b/.github/scripts/cleanup-tags.py @@ -0,0 +1,268 @@ +import logging +import os +from argparse import ArgumentParser +from typing import Final +from typing import List +from urllib.parse import quote + +import requests +from common import get_log_level + +logger = logging.getLogger("cleanup-tags") + + +class GithubContainerRegistry: + def __init__( + self, + session: requests.Session, + token: str, + owner_or_org: str, + ): + self._session: requests.Session = session + self._token = token + self._owner_or_org = owner_or_org + self._BRANCHES_ENDPOINT = "https://api.github.com/repos/{OWNER}/{REPO}/branches" + if self._owner_or_org == "paperless-ngx": + self._PACKAGES_VERSIONS_ENDPOINT = "https://api.github.com/orgs/{ORG}/packages/{PACKAGE_TYPE}/{PACKAGE_NAME}/versions" + self._PACKAGE_VERSION_DELETE_ENDPOINT = "https://api.github.com/orgs/{ORG}/packages/{PACKAGE_TYPE}/{PACKAGE_NAME}/versions/{PACKAGE_VERSION_ID}" + else: + self._PACKAGES_VERSIONS_ENDPOINT = "https://api.github.com/user/packages/{PACKAGE_TYPE}/{PACKAGE_NAME}/versions" + self._PACKAGE_VERSION_DELETE_ENDPOINT = "https://api.github.com/user/packages/{PACKAGE_TYPE}/{PACKAGE_NAME}/versions/{PACKAGE_VERSION_ID}" + + def __enter__(self): + self._session.headers.update( + { + "Accept": "application/vnd.github.v3+json", + "Authorization": f"token {self._token}", + }, + ) + return self + + def __exit__(self, exc_type, exc_val, exc_tb): + if "Accept" in self._session.headers: + del self._session.headers["Accept"] + if "Authorization" in self._session.headers: + del self._session.headers["Authorization"] + + def _read_all_pages(self, endpoint): + internal_data = [] + + while True: + resp = self._session.get(endpoint) + if resp.status_code == 200: + internal_data += resp.json() + if "next" in resp.links: + endpoint = resp.links["next"]["url"] + else: + logger.debug("Exiting pagination loop") + break + else: + logger.warning(f"Request to {endpoint} return HTTP {resp.status_code}") + break + + return internal_data + + def get_branches(self, repo: str): + endpoint = self._BRANCHES_ENDPOINT.format(OWNER=self._owner_or_org, REPO=repo) + internal_data = self._read_all_pages(endpoint) + return internal_data + + def filter_branches_by_name_pattern(self, branch_data, pattern: str): + matches = {} + + for branch in branch_data: + if branch["name"].startswith(pattern): + matches[branch["name"]] = branch + + return matches + + def get_package_versions( + self, + package_name: str, + package_type: str = "container", + ) -> List: + package_name = quote(package_name, safe="") + endpoint = self._PACKAGES_VERSIONS_ENDPOINT.format( + ORG=self._owner_or_org, + PACKAGE_TYPE=package_type, + PACKAGE_NAME=package_name, + ) + + internal_data = self._read_all_pages(endpoint) + + return internal_data + + def filter_packages_by_tag_pattern(self, package_data, pattern: str): + matches = {} + + for package in package_data: + if "metadata" in package and "container" in package["metadata"]: + container_metadata = package["metadata"]["container"] + if "tags" in container_metadata: + container_tags = container_metadata["tags"] + for tag in container_tags: + if tag.startswith(pattern): + matches[tag] = package + break + + return matches + + def filter_packages_untagged(self, package_data): + matches = {} + + for package in package_data: + if "metadata" in package and "container" in package["metadata"]: + container_metadata = package["metadata"]["container"] + if "tags" in container_metadata: + container_tags = container_metadata["tags"] + if not len(container_tags): + matches[package["name"]] = package + + return matches + + def delete_package_version(self, package_name, package_data): + package_name = quote(package_name, safe="") + endpoint = self._PACKAGE_VERSION_DELETE_ENDPOINT.format( + ORG=self._owner_or_org, + PACKAGE_TYPE=package_data["metadata"]["package_type"], + PACKAGE_NAME=package_name, + PACKAGE_VERSION_ID=package_data["id"], + ) + resp = self._session.delete(endpoint) + if resp.status_code != 204: + logger.warning( + f"Request to delete {endpoint} returned HTTP {resp.status_code}", + ) + + +class DockerHubContainerRegistery: + def __init__(self): + pass + + def __enter__(self): + return self + + def __exit__(self, exc_type, exc_val, exc_tb): + pass + + def get_image_versions(self) -> List: + return [] + + def delete_image_version(self): + pass + + +def _main(): + parser = ArgumentParser( + description="Using the GitHub API locate and optionally delete container" + " tags which no longer have an associated feature branch", + ) + + parser.add_argument( + "--delete", + action="store_true", + default=False, + help="If provided, actually delete the container tags", + ) + + # TODO There's a lot of untagged images, do those need to stay for anything? + parser.add_argument( + "--untagged", + action="store_true", + default=False, + help="If provided, delete untagged containers as well", + ) + + parser.add_argument( + "--loglevel", + default="info", + help="Configures the logging level", + ) + + args = parser.parse_args() + + logging.basicConfig( + level=get_log_level(args), + datefmt="%Y-%m-%d %H:%M:%S", + format="%(asctime)s %(levelname)-8s %(message)s", + ) + + repo_owner: Final[str] = os.environ["GITHUB_REPOSITORY_OWNER"] + repo: Final[str] = os.environ["GITHUB_REPOSITORY"] + gh_token: Final[str] = os.environ["GITHUB_TOKEN"] + + with requests.session() as sess: + with GithubContainerRegistry(sess, gh_token, repo_owner) as gh_api: + all_branches = gh_api.get_branches("paperless-ngx") + logger.info(f"Located {len(all_branches)} branches of {repo_owner}/{repo} ") + + feature_branches = gh_api.filter_branches_by_name_pattern( + all_branches, + "feature-", + ) + logger.info(f"Located {len(feature_branches)} feature branches") + + for package_name in ["paperless-ngx", "paperless-ngx/builder/cache/app"]: + + all_package_versions = gh_api.get_package_versions(package_name) + logger.info( + f"Located {len(all_package_versions)} versions of package {package_name}", + ) + + packages_tagged_feature = gh_api.filter_packages_by_tag_pattern( + all_package_versions, + "feature-", + ) + logger.info( + f'Located {len(packages_tagged_feature)} versions of package {package_name} tagged "feature-"', + ) + + untagged_packages = gh_api.filter_packages_untagged( + all_package_versions, + ) + logger.info( + f"Located {len(untagged_packages)} untagged versions of package {package_name}", + ) + + to_delete = list( + set(packages_tagged_feature.keys()) - set(feature_branches.keys()), + ) + logger.info( + f"Located {len(to_delete)} versions of package {package_name} to delete", + ) + + for tag_to_delete in to_delete: + package_version_info = packages_tagged_feature[tag_to_delete] + + logger.info( + f"Deleting {tag_to_delete} (id {package_version_info['id']})", + ) + if args.delete: + gh_api.delete_package_version( + package_name, + package_version_info, + ) + + if args.untagged: + logger.info(f"Deleting untagged packages of {package_name}") + for to_delete_name in untagged_packages: + to_delete_version = untagged_packages[to_delete_name] + logger.info(f"Deleting id {to_delete_version['id']}") + if args.delete: + gh_api.delete_package_version( + package_name, + to_delete_version, + ) + + with DockerHubContainerRegistery() as dh_api: + docker_hub_image_version = dh_api.get_image_versions() + + # TODO + docker_hub_to_delete = [] + + for x in docker_hub_to_delete: + dh_api.delete_image_version() + + +if __name__ == "__main__": + _main() diff --git a/.github/scripts/common.py b/.github/scripts/common.py index 3913c91cd..f0302e79a 100644 --- a/.github/scripts/common.py +++ b/.github/scripts/common.py @@ -1,4 +1,6 @@ #!/usr/bin/env python3 +import logging +from argparse import ArgumentError def get_image_tag( @@ -25,3 +27,18 @@ def get_cache_image_tag( rebuilds, generally almost instant for the same version """ return f"ghcr.io/{repo_name}/builder/cache/{pkg_name}:{pkg_version}" + + +def get_log_level(args) -> int: + levels = { + "critical": logging.CRITICAL, + "error": logging.ERROR, + "warn": logging.WARNING, + "warning": logging.WARNING, + "info": logging.INFO, + "debug": logging.DEBUG, + } + level = levels.get(args.loglevel.lower()) + if level is None: + level = logging.INFO + return level diff --git a/.github/workflows/cleanup-tags.yml b/.github/workflows/cleanup-tags.yml new file mode 100644 index 000000000..5342d040a --- /dev/null +++ b/.github/workflows/cleanup-tags.yml @@ -0,0 +1,48 @@ +name: Cleanup Image Tags + +on: + schedule: + - cron: '0 0 * * SAT' + delete: + pull_request: + types: + - closed + push: + paths: + - ".github/workflows/cleanup-tags.yml" + - ".github/scripts/cleanup-tags.py" + - ".github/scripts/common.py" + +env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + +jobs: + cleanup: + name: Cleanup Image Tags + runs-on: ubuntu-20.04 + permissions: + packages: write + steps: + - + name: Checkout + uses: actions/checkout@v3 + - + name: Login to Github Container Registry + uses: docker/login-action@v1 + with: + registry: ghcr.io + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + - + name: Set up Python + uses: actions/setup-python@v3 + with: + python-version: "3.9" + - + name: Install requests + run: | + python -m pip install requests + - + name: Cleanup feature tags + run: | + python ${GITHUB_WORKSPACE}/.github/scripts/cleanup-tags.py --loglevel info