cloud-image-val.py

import os

from pprint import pprint
from argparse import ArgumentParser, RawTextHelpFormatter
from main.cloud_image_validator import CloudImageValidator
from lib.config_lib import CIVConfig
from lib import console_lib

parser = ArgumentParser(formatter_class=RawTextHelpFormatter)

parser.add_argument(
    "-r",
    "--resources-file",
    help="Path to the resources JSON file that contains the Cloud provider and the images to use.\n"
    "See cloud/sample/resources_<cloud>.json to know about the expected file structure.",
    default=None,
)
parser.add_argument(
    "-o",
    "--output-file",
    help="Output file path of the resultant Junit XML test report and others",
    default=None,
)
parser.add_argument(
    "-t",
    "--test-filter",
    help="Use this option to filter tests execution by test name",
    default=None,
)
parser.add_argument(
    "--test-suites",
    help="Use this option to specify which test suites will be use for test run."
    "If no test suite is provided, default test suites will be used (see test_suite/)",
    nargs="+",
    default=None,
)
parser.add_argument(
    "-m",
    "--include-markers",
    help="Use this option to specify which tests to run that match a pytest markers expression.\n"
    'The only marker currently supported is "pub" (see pytest.ini for more details)\n'
    "Example:\n"
    '\t-m "pub" --> run tests marked as "pub", which is for images are already published\n'
    '\t-m "not pub" --> exclude "pub" tests\n'
    "More information about pytest markers:\n"
    "--> https://doc.pytest.org/en/latest/example/markers.html",
    default=None,
)
parser.add_argument(
    "-p",
    "--parallel",
    help="Use this option to enable parallel test execution mode.",
    action="store_true",
    default=None,
)
parser.add_argument(
    "-d",
    "--debug",
    help="Use this option to enable debugging mode.",
    action="store_true",
    default=None,
)
parser.add_argument(
    "-s",
    "--stop-cleanup",
    help="Use this option to enable stop cleanup process until a key is pressed. \n"
    "Helpful when you need to connect through ssh to an instance.",
    action="store_true",
    default=None,
)
parser.add_argument(
    "-e",
    "--environment",
    help="Use this option to set what environment CIV is going to run on.\n"
    'This can change CIV behaviour like how "-s" works. this option can be\n'
    'set to "automated" or "local".',
    default=None,
)
parser.add_argument(
    "-c",
    "--config-file",
    help="Use this option to pass CLI options through a config file.\n"
    "This config should be in yaml format, examples can be found in the README",
    default=None,
)
parser.add_argument(
    "--tags",
    help="Use this option to add tags to created cloud resources and modify CIV behaviour.\n"
    "This tags should be passed in json format as in this example:\n"
    "--tags 'key1:value1, key2:value2'",
    default=None,
)
parser.add_argument(
    "-a",
    "--attach",
    help="Attach to last deployed CIV instances, if still exist.\n"
    "Useful in case CIV abruptedly closed and instances are still running in the cloud.\n"
    "For this feature to work, CIV_INSTANCES_JSON file must still exist, as well as the .tf.json and .tfstate files\n"
    "IMPORTANT NOTE: Make sure to use exactly the same CIV cli arguments as in previous execution,\n"
    "or provide the same civ_config file to avoid unexpected results.",
    action="store_true",
    default=False,
)

if __name__ == "__main__":
    args = parser.parse_args()

    # Add current dir abspath to PYTHONPATH to avoid issues when importing modules
    if "PYTHONPATH" not in os.environ:
        os.environ["PYTHONPATH"] = ""
    os.environ["PYTHONPATH"] = ":".join(
        [f"{os.path.dirname(__file__)}", os.environ["PYTHONPATH"]]
    )

    config_manager = CIVConfig(args.__dict__)

    config_manager.update_config()
    config_manager.validate_config()
    config_manager.export_config_as_env_vars()

    config = config_manager.get_config()

    if config["debug"]:
        console_lib.print_divider("Config")
        pprint(config)

    cloud_image_validator = CloudImageValidator(config=config)
    exit(cloud_image_validator.main(attach=args.attach))