__init__.py

#!/usr/bin/env python

"""

Copyright (C) 2019-2022 Vanessa Sochat.

This Source Code Form is subject to the terms of the
Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed
with this file, You can obtain one at http://mozilla.org/MPL/2.0/.


"""

import scompose
import argparse
import sys
import os


def get_parser():
    description = "Orchestration for Singularity containers"
    parser = argparse.ArgumentParser(description="Singularity Compose")

    # Verbosity
    parser.add_argument(
        "--debug",
        dest="debug",
        help="use verbose logging to debug.",
        default=False,
        action="store_true",
    )

    parser.add_argument(
        "--version",
        "-v",
        dest="version",
        help="print version and exit.",
        default=False,
        action="store_true",
    )

    parser.add_argument(
        "--log-level",
        default="INFO",
        dest="log_level",
        type=str,
        help="logging level",
        choices=["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"],
    )

    # Global Variables
    parser.add_argument(
        "--file",
        "-f",
        dest="file",
        help="specify compose file (default singularity-compose.yml). It can be used multiple times",
        action="append",
        default=[],
    )

    parser.add_argument(
        "--project-name",
        "-p",
        default=None,
        dest="project_name",
        type=str,
        help="specify project name (defaults to $PWD)",
    )

    parser.add_argument(
        "--project-directory",
        default=None,
        dest="working_dir",
        type=str,
        help="specify project working directory (defaults to compose file location)",
    )

    parser.add_argument(
        "--env-file",
        default=None,
        dest="env_file",
        type=str,
        help="an environment file to source",
    )

    subparsers = parser.add_subparsers(
        help="scompose actions",
        title="actions",
        description=description,
        dest="command",
    )

    # print version and exit
    version = subparsers.add_parser("version", help="show software version")

    # Build

    build = subparsers.add_parser("build", help="Build or rebuild containers")

    # Check

    check = subparsers.add_parser(
        "check", help="check or validate singularity-compose.yml"
    )

    check.add_argument(
        "--preview",
        dest="preview",
        help="print compose file(s) interpolated content",
        default=False,
        action="store_true",
    )

    # Config

    config = subparsers.add_parser("config", help="Validate and view the compose file")

    # Create (assumes built already), Up (will also build, if able)

    create = subparsers.add_parser("create", help="create instances")

    up = subparsers.add_parser("up", help="build and start containers")

    restart = subparsers.add_parser("restart", help="stop and start containers.")

    for sub in [create, up, restart]:
        sub.add_argument(
            "--read_only",
            dest="read_only",
            help="disable the instance from writing to tmp",
            default=False,
            action="store_true",
        )

        sub.add_argument(
            "--no-resolv",
            dest="no_resolv",
            help="do not generate and bind a resolv.conf",
            default=False,
            action="store_true",
        )

        sub.add_argument(
            "--bridge",
            default="10.22.0.0/16",
            dest="bridge",
            type=str,
            help="the address of the bridge to derive others from.",
        )

    # Down or stop

    down = subparsers.add_parser("down", help="stop instances")
    stop = subparsers.add_parser("stop", help="stop instances")

    for command in [down, stop]:
        command.add_argument(
            "--timeout",
            "-t",
            dest="timeout",
            type=int,
            help="force kill non stopped instances after specified seconds",
            default=None,
        )

    execute = subparsers.add_parser("exec", help="execute a command to an instance")

    run = subparsers.add_parser("run", help="run an instance runscript")

    shell = subparsers.add_parser("shell", help="shell into an instance")

    # Logs

    logs = subparsers.add_parser("logs", help="view output from instances")

    logs.add_argument(
        "--tail",
        default=0,
        dest="tail",
        type=int,
        help="clip logs to certain number of lines from end",
    )

    logs.add_argument(
        "--clear",
        dest="clear",
        help="clear existing logs.",
        default=False,
        action="store_true",
    )

    ps = subparsers.add_parser("ps", help="list instances")

    # Add list of names
    for sub in [build, create, down, logs, up, restart, stop]:
        sub.add_argument(
            "names", nargs="*", help="the names of the instances to target"
        )

    # Only one name allowed
    for sub in [shell, execute, run]:
        sub.add_argument("name", nargs=1, help="the name of the instance to target")

    return parser


def start():
    """main is the entrypoint to singularity compose. We figure out the sub
    parser based on the command, and then import and call the appropriate
    main.
    """
    parser = get_parser()

    def show_help(return_code=0):
        """print help, including the software version and exit with return code"""
        version = scompose.__version__

        print("\nSingularity Compose v%s" % version)
        parser.print_help()
        sys.exit(return_code)

    # If the user didn't provide any arguments, show the full help
    if len(sys.argv) == 1:
        show_help()
    try:
        args, extra = parser.parse_known_args()
    except:
        sys.exit(0)

    if args.debug is True:
        os.environ["MESSAGELEVEL"] = "DEBUG"
    else:
        os.environ["MESSAGELEVEL"] = args.log_level

    # Import the logger to grab verbosity level
    from scompose.logger import bot

    # Show the version and exit
    if args.command == "version" or args.version is True:
        print(scompose.__version__)
        sys.exit(0)

    # argparse inherits a funny behaviour that appends default values to the dest value whether you've specified a value
    # or not. The bug/behaviour is documented here: https://bugs.python.org/issue16399
    if len(args.file) == 0:
        args.file = ["singularity-compose.yml"]

    # Does the user want a shell?
    if args.command == "build":
        from scompose.client.build import main
    elif args.command == "check":
        from scompose.client.check import main
    elif args.command == "create":
        from scompose.client.create import main
    elif args.command == "config":
        from scompose.client.config import main
    elif args.command in ["down", "stop"]:
        from scompose.client.down import main
    elif args.command == "exec":
        from scompose.client.exec import main
    elif args.command == "logs":
        from scompose.client.logs import main
    elif args.command == "ps":
        from scompose.client.ps import main
    elif args.command == "restart":
        from scompose.client.restart import main
    elif args.command == "run":
        from scompose.client.run import main
    elif args.command == "shell":
        from scompose.client.shell import main
    elif args.command == "up":
        from scompose.client.up import main

    # Pass on to the correct parser
    return_code = 0
    try:
        main(args=args, parser=parser, extra=extra)
        sys.exit(return_code)
    except KeyboardInterrupt:
        bot.exit("Aborting.")
    except UnboundLocalError:
        return_code = 1

    sys.exit(return_code)


if __name__ == "__main__":
    start()