libvirt/ci/util.py

import json
import pathlib
import urllib.request
import urllib.parse

from typing import Dict, List


def get_registry_uri(namespace: str,
                     gitlab_uri: str = "https://gitlab.com") -> str:
    """
    Construct a v4 API URI pointing the namespaced project's image registry.

    :param namespace: GitLab project namespace, e.g. "libvirt/libvirt"
    :param gitlab_uri: GitLab base URI, can be a private deployment
    :param api_version: GitLab REST API version number
    :return: URI pointing to a namespaced project's image registry
    """

    # this converts something like "libvirt/libvirt" to "libvirt%2Flibvirt"
    namespace_urlenc = urllib.parse.quote_plus(namespace)

    project_uri = f"{gitlab_uri}/api/v4/projects/{namespace_urlenc}"

    uri = project_uri + "/registry/repositories"
    return uri


def get_registry_images(uri: str) -> List[Dict]:
    """
    List all container images that are currently available in the given GitLab
    project.

    :param uri: URI pointing to a GitLab instance's image registry
    :return: list of container image names
    """

    r = urllib.request.urlopen(uri + "?per_page=100")

    # read the HTTP response and load the JSON part of it
    return json.loads(r.read().decode())


def get_dockerfiles(base_dir) -> List:
    """
    List all container dockerfiles in the local directory.

    :return: list of dockerfile names
    """

    dkrs = []
    d = pathlib.Path(base_dir, "containers")
    for f in d.iterdir():
        if f.suffix == ".Dockerfile":
            dkrs.append(f.stem)
    return dkrs


def get_registry_stale_images(registry_uri: str, base_dir: str) -> Dict[str, int]:
    """
    Check the GitLab image registry for images that we no longer support and
    which should be deleted.

    :param uri: URI pointing to a GitLab instance's image registry
    :param base_dir: local repository base directory
    :return: dictionary formatted as: {<gitlab_image_name>: <gitlab_image_id>}
    """

    dockerfiles = get_dockerfiles(base_dir)
    images = get_registry_images(registry_uri)

    stale_images = {}
    for img in images:
        if img["name"][3:] not in dockerfiles:
            stale_images[img["name"]] = img["id"]

    return stale_images