ansible/test/lib/ansible_test/_internal/ci/local.py

"""Support code for working without a supported CI provider."""

from __future__ import annotations

import abc
import inspect
import platform
import random
import re
import pathlib
import typing as t

from ..config import (
    CommonConfig,
    TestConfig,
)

from ..io import (
    read_text_file,
)

from ..git import (
    Git,
)

from ..util import (
    ApplicationError,
    display,
    get_subclasses,
    is_binary_file,
    SubprocessError,
)

from . import (
    AuthContext,
    AuthHelper,
    CIProvider,
)

CODE = ''  # not really a CI provider, so use an empty string for the code


class Local(CIProvider):
    """CI provider implementation when not using CI."""

    priority = 1000

    @staticmethod
    def is_supported() -> bool:
        """Return True if this provider is supported in the current running environment."""
        return True

    @property
    def code(self) -> str:
        """Return a unique code representing this provider."""
        return CODE

    @property
    def name(self) -> str:
        """Return descriptive name for this provider."""
        return 'Local'

    def generate_resource_prefix(self) -> str:
        """Return a resource prefix specific to this CI provider."""
        prefix = 'ansible-test-%d-%s' % (
            random.randint(10000000, 99999999),
            platform.node().split('.')[0],
        )

        return prefix

    def get_base_commit(self, args: CommonConfig) -> str:
        """Return the base commit or an empty string."""
        return ''

    def detect_changes(self, args: TestConfig) -> t.Optional[list[str]]:
        """Initialize change detection."""
        result = LocalChanges(args)

        display.info('Detected branch %s forked from %s at commit %s' % (
            result.current_branch, result.fork_branch, result.fork_point))

        if result.untracked and not args.untracked:
            display.warning('Ignored %s untracked file(s). Use --untracked to include them.' %
                            len(result.untracked))

        if result.committed and not args.committed:
            display.warning('Ignored %s committed change(s). Omit --ignore-committed to include them.' %
                            len(result.committed))

        if result.staged and not args.staged:
            display.warning('Ignored %s staged change(s). Omit --ignore-staged to include them.' %
                            len(result.staged))

        if result.unstaged and not args.unstaged:
            display.warning('Ignored %s unstaged change(s). Omit --ignore-unstaged to include them.' %
                            len(result.unstaged))

        names = set()

        if args.tracked:
            names |= set(result.tracked)
        if args.untracked:
            names |= set(result.untracked)
        if args.committed:
            names |= set(result.committed)
        if args.staged:
            names |= set(result.staged)
        if args.unstaged:
            names |= set(result.unstaged)

        if not args.metadata.changes:
            args.metadata.populate_changes(result.diff)

            for path in result.untracked:
                if is_binary_file(path):
                    args.metadata.changes[path] = ((0, 0),)
                    continue

                line_count = len(read_text_file(path).splitlines())

                args.metadata.changes[path] = ((1, line_count),)

        return sorted(names)

    def supports_core_ci_auth(self) -> bool:
        """Return True if Ansible Core CI is supported."""
        return Authenticator.available()

    def prepare_core_ci_request(self, config: dict[str, object], context: AuthContext) -> dict[str, object]:
        if not (authenticator := Authenticator.load()):
            raise ApplicationError('Ansible Core CI authentication has not been configured.')

        display.info(f'Using {authenticator} for Ansible Core CI.', verbosity=1)

        return authenticator.prepare_auth_request(config, context)

    def get_git_details(self, args: CommonConfig) -> t.Optional[dict[str, t.Any]]:
        """Return details about git in the current environment."""
        return None  # not yet implemented for local


class InvalidBranch(ApplicationError):
    """Exception for invalid branch specification."""

    def __init__(self, branch: str, reason: str) -> None:
        message = 'Invalid branch: %s\n%s' % (branch, reason)

        super().__init__(message)

        self.branch = branch


class LocalChanges:
    """Change information for local work."""

    def __init__(self, args: TestConfig) -> None:
        self.args = args
        self.git = Git()

        self.current_branch = self.git.get_branch()

        if self.is_official_branch(self.current_branch):
            raise InvalidBranch(branch=self.current_branch,
                                reason='Current branch is not a feature branch.')

        self.fork_branch = None
        self.fork_point = None

        self.local_branches = sorted(self.git.get_branches())
        self.official_branches = sorted([b for b in self.local_branches if self.is_official_branch(b)])

        for self.fork_branch in self.official_branches:
            try:
                self.fork_point = self.git.get_branch_fork_point(self.fork_branch)
                break
            except SubprocessError:
                pass

        if self.fork_point is None:
            raise ApplicationError('Unable to auto-detect fork branch and fork point.')

        # tracked files (including unchanged)
        self.tracked = sorted(self.git.get_file_names(['--cached']))
        # untracked files (except ignored)
        self.untracked = sorted(self.git.get_file_names(['--others', '--exclude-standard']))
        # tracked changes (including deletions) committed since the branch was forked
        self.committed = sorted(self.git.get_diff_names([self.fork_point, 'HEAD']))
        # tracked changes (including deletions) which are staged
        self.staged = sorted(self.git.get_diff_names(['--cached']))
        # tracked changes (including deletions) which are not staged
        self.unstaged = sorted(self.git.get_diff_names([]))
        # diff of all tracked files from fork point to working copy
        self.diff = self.git.get_diff([self.fork_point])

    def is_official_branch(self, name: str) -> bool:
        """Return True if the given branch name an official branch for development or releases."""
        if self.args.base_branch:
            return name == self.args.base_branch

        if name == 'devel':
            return True

        if re.match(r'^stable-[0-9]+\.[0-9]+$', name):
            return True

        return False


class Authenticator(metaclass=abc.ABCMeta):
    """Base class for authenticators."""

    @staticmethod
    def list() -> list[type[Authenticator]]:
        """List all authenticators in priority order."""
        return sorted((sc for sc in get_subclasses(Authenticator) if not inspect.isabstract(sc)), key=lambda obj: obj.priority())

    @staticmethod
    def load() -> Authenticator | None:
        """Load an authenticator instance, returning None if not configured."""
        for implementation in Authenticator.list():
            if implementation.config_file().exists():
                return implementation()

        return None

    @staticmethod
    def available() -> bool:
        """Return True if an authenticator is available, otherwise False."""
        return bool(Authenticator.load())

    @classmethod
    @abc.abstractmethod
    def priority(cls) -> int:
        """Priority used to determine which authenticator is tried first, from lowest to highest."""

    @classmethod
    @abc.abstractmethod
    def config_file(cls) -> pathlib.Path:
        """Path to the config file for this authenticator."""

    @abc.abstractmethod
    def prepare_auth_request(self, config: dict[str, object], context: AuthContext) -> dict[str, object]:
        """Prepare an authenticated Ansible Core CI request using the given config and context."""

    def __str__(self) -> str:
        return self.__class__.__name__


class PasswordAuthenticator(Authenticator):
    """Authenticate using a password."""

    @classmethod
    def priority(cls) -> int:
        return 200

    @classmethod
    def config_file(cls) -> pathlib.Path:
        return pathlib.Path('~/.ansible-core-ci.key').expanduser()

    def prepare_auth_request(self, config: dict[str, object], context: AuthContext) -> dict[str, object]:
        parts = self.config_file().read_text().strip().split(maxsplit=1)

        if len(parts) == 1:  # temporary backward compatibility for legacy API keys
            request = dict(
                config=config,
                auth=dict(
                    remote=dict(
                        key=parts[0],
                    ),
                ),
            )

            return request

        username, password = parts

        request = dict(
            type="remote:password",
            config=config,
            username=username,
            password=password,
        )

        return request


class SshAuthenticator(Authenticator):
    """Authenticate using an SSH key."""

    @classmethod
    def priority(cls) -> int:
        return 100

    @classmethod
    def config_file(cls) -> pathlib.Path:
        return pathlib.Path('~/.ansible-core-ci.auth').expanduser()

    def prepare_auth_request(self, config: dict[str, object], context: AuthContext) -> dict[str, object]:
        parts = self.config_file().read_text().strip().split(maxsplit=1)
        username, key_file = parts

        request: dict[str, object] = dict(
            type="remote:ssh",
            config=config,
            username=username,
        )

        auth_helper = AuthHelper(pathlib.Path(key_file).expanduser())
        auth_helper.sign_request(request, context)

        return request