xlab-si/xopera-opera

View on GitHub
src/opera/commands/package.py

Summary

Maintainability
A
55 mins
Test Coverage
import argparse
from pathlib import Path, PurePath
from typing import Optional

import shtab
from opera_tosca_parser.parser import tosca

from opera.error import DataError, ParseError
from opera.utils import generate_random_pathname


def add_parser(subparsers):
    parser = subparsers.add_parser(
        "package",
        help="Package service template and all accompanying files into a CSAR (zip file)"
    )
    parser.add_argument(
        "--service-template", "-t",
        help="Name or path to the TOSCA service template file from the root of the input folder",
    )
    parser.add_argument(
        "--output", "-o",
        help="Output CSAR file path",
    )
    parser.add_argument(
        "--verbose", "-v", action="store_true",
        help="Turns on verbose mode",
    )
    parser.add_argument(
        "service_template_folder",
        help="Path to the root of the service template or folder you want to create the TOSCA CSAR from"
    ).complete = shtab.FILE
    parser.set_defaults(func=_parser_callback)


def _parser_callback(args):
    if not Path(args.service_template_folder).is_dir():
        raise argparse.ArgumentTypeError(f"Directory {args.service_template_folder} is not a valid path!")

    # this variable sets the default CLI packaging format, user can still change it (for example to tar) when using
    # opera as Python library but this is not recommended since TOSCA CSAR is typically a compressed (zipped) file
    csar_package_format = "zip"

    # if the output is set use it, if not create a random file name with UUID
    if args.output:
        # remove file extension if needed (e.g., ".zip", ".tar")
        # because shutil.make_archive already adds the extension
        if args.output.endswith("." + csar_package_format):
            csar_output = str(Path(args.output).with_suffix(""))
        else:
            csar_output = str(Path(args.output))

    else:
        # generate a create a unique random file name
        csar_output = generate_random_pathname("opera-package-")

    try:
        service_template_path = None
        if args.service_template:
            service_template_path = PurePath(args.service_template)

        output_package = package(PurePath(args.service_template_folder), csar_output, service_template_path,
                                 csar_package_format)
        print(f"CSAR was created and packed to '{output_package}'.")
    except ParseError as e:
        print(f"{e.loc}: {e}")
        return 1
    except DataError as e:
        print(str(e))
        return 1

    return 0


def package(input_dir: PurePath, csar_output: str, service_template_path: Optional[PurePath],
            csar_format: str = "zip") -> str:
    csar = tosca.load_csar(input_dir, False)
    result: str = csar.package_csar(csar_output, service_template_path, csar_format)
    return result