rose_stem_extract_source.py

#!/usr/bin/env python3
# -----------------------------------------------------------------------------
# (C) Crown copyright Met Office. All rights reserved.
# The file LICENCE, distributed with this code, contains details of the terms
# under which the code may be used.
# -----------------------------------------------------------------------------

"""
Clone sources for a rose-stem run for use with git bdiff module in scripts
Only intended for use with rose-stem suites that have provided appropriate
environment variables
"""

import os
from pathlib import Path
from ast import literal_eval
from get_git_sources import clone_and_merge, set_https, validate_dependencies
import logging


def main() -> None:
    """
    1. Read environment variables for:
        SOURCE_DIRECTORY - location to clone sources,
        DEPENDENCIES - dictionary of dependencies,
        USE_TOKENS - whether to use tokens for https URLs,
        USE_MIRRORS - whether to use local git mirrors,
        GIT_MIRROR_LOC - location of local git mirrors
    2. For each dependency in DEPENDENCIES, clone or sync the source
    3. If USE_TOKENS is True, modify the source URLs to use https
    4. If USE_MIRRORS is True, clone from local mirrors at GIT_MIRROR_LOC
    """

    logging.basicConfig(level=logging.INFO)

    clone_loc = Path(os.environ["SOURCE_DIRECTORY"])
    dependencies: dict = literal_eval(os.environ["DEPENDENCIES"])
    validate_dependencies(dependencies)

    if os.environ.get("USE_TOKENS", "false").lower() == "true":
        dependencies = set_https(dependencies)

    use_mirrors = os.environ.get("USE_MIRRORS", "false").lower() == "true"
    mirror_loc = Path(os.getenv("GIT_MIRROR_LOC", ""))

    for dependency, sources in dependencies.items():
        loc = clone_loc / dependency
        clone_and_merge(sources, loc, use_mirrors, mirror_loc)


if __name__ == "__main__":
    main()