kiwi-scp/src/kiwi/subcommands/sh.py

# system
import logging
import subprocess

# local
from ._subcommand import ServiceCommand
from .utils.dockercommand import DockerCommand


def _service_has_executable(config, args, compose_cmd, exe_name):
    """
    Test if container (as of compose_cmd array) has an executable exe_name in its PATH.
    Requires /bin/sh and which.
    """

    try:
        # test if desired shell exists
        DockerCommand('docker-compose').run(
            config, args, [*compose_cmd, '/bin/sh', '-c', f"which {exe_name}"],
            check=True, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL
        )
        return True

    except subprocess.CalledProcessError as e:
        # fallback
        return False


def _find_shell(config, args, compose_cmd):
    """find first working shell (provided by config and args) in container (as of compose_cmd array)"""

    # builtin shells: as a last resort, fallback to '/bin/sh' and 'sh'
    shells = ['/bin/sh', 'sh']

    # load favorite shells from config
    if config['runtime:shells']:
        shells = [*config['runtime:shells'], *shells]

    # consider shell from args
    if args.shell:
        shells = [args.shell, *shells]

    logging.debug(f"Shells priority: {shells}")

    # actually try shells
    for i, shell in enumerate(shells):
        if _service_has_executable(config, args, compose_cmd, shell):
            # found working shell
            logging.debug(f"Using shell '{shell}'")
            return shell

        elif i + 1 < len(shells):
            # try next in list
            logging.info(f"Shell '{shell}' not found in container, trying '{shells[i+1]}'")

        elif args.shell:
            # not found, user suggestion provided
            logging.warning(f"Could not find any working shell in this container. "
                            f"Launching provided '{args.shell}' nevertheless. "
                            f"Don't get mad if this fails!")
            return args.shell

        else:
            # not found, search exhausted
            logging.error(f"Could not find any working shell among '{shells}' in this container. "
                          f"Please suggest a shell using the '-s SHELL' command line option!")
            return None


class ShCommand(ServiceCommand):
    """kiwi sh"""

    def __init__(self):
        super().__init__(
            'sh', num_projects=1, num_services=1,
            description="Spawn shell inside a project's service"
        )

        # -s argument: Select shell
        self._sub_parser.add_argument(
            '-s', '--shell', type=str,
            help="shell to spawn"
        )

    def run(self, runner, config, args):
        compose_cmd = ['exec', args.services[0]]
        shell = _find_shell(config, args, compose_cmd)

        if shell is not None:
            # spawn shell
            DockerCommand('docker-compose').run(
                config, args, [*compose_cmd, shell]
            )