eive-obsw/cmake/scripts/cmake-build-cfg.py

#!/usr/bin/env python3
"""
@brief  CMake configuration helper
@details
This script was written to have a portable way to perform the CMake configuration with various parameters on
different OSes. It was first written for the FSFW Example, but could be adapted to be more generic
in the future.

Run cmake_build_config.py --help to get more information.
"""
import os
import sys
import argparse
import shutil
import stat


def main():
    print("-- Python CMake build configurator utility --")

    print("Parsing command line arguments..")
    parser = argparse.ArgumentParser(
        description="Processing arguments for CMake build configuration."
    )
    parser.add_argument(
        "-o",
        "--osal",
        type=str,
        choices=["freertos", "linux", "rtems", "host"],
        help="FSFW OSAL. Valid arguments: host, linux, rtems, freertos",
    )
    parser.add_argument(
        "-b",
        "--buildtype",
        type=str,
        choices=["debug", "release", "size", "reldeb"],
        help="CMake build type. Valid arguments: debug, release, size, reldeb (Release with Debug "
        "Information)",
        default="debug",
    )
    parser.add_argument("-l", "--builddir", type=str, help="Specify build directory.")
    parser.add_argument(
        "-g", "--generator", type=str, help="CMake Generator", choices=["make", "ninja"]
    )
    parser.add_argument(
        "-d",
        "--defines",
        help="Additional custom defines passed to CMake (supply without -D prefix!)",
        nargs="*",
        type=str,
    )
    parser.add_argument(
        "-t",
        "--target-bsp",
        type=str,
        help="Target BSP, combination of architecture and machine",
    )

    args = parser.parse_args()

    print("Determining source location..")
    source_location = determine_source_location()
    print(f"Determined source location: {source_location}")

    print("Building cmake configuration command..")

    if args.osal is None:
        print("No FSFW OSAL specified, setting to default (host)..")
        osal = "host"
    else:
        osal = args.osal

    if args.generator is None:
        generator_cmake_arg = ""
    else:
        if args.generator == "make":
            if os.name == "nt":
                generator_cmake_arg = '-G "MinGW Makefiles"'
            else:
                generator_cmake_arg = '-G "Unix Makefiles"'
        elif args.generator == "ninja":
            generator_cmake_arg = "-G Ninja"
        else:
            generator_cmake_arg = args.generator

    if args.buildtype == "debug":
        cmake_build_type = "Debug"
    elif args.buildtype == "release":
        cmake_build_type = "Release"
    elif args.buildtype == "size":
        cmake_build_type = "MinSizeRel"
    else:
        cmake_build_type = "RelWithDebInfo"

    if args.target_bsp is not None:
        cmake_target_cfg_cmd = f'-DTGT_BSP="{args.target_bsp}"'
    else:
        cmake_target_cfg_cmd = ""

    define_string = ""
    if args.defines is not None:
        define_list = args.defines[0].split()
        for define in define_list:
            define_string += f"-D{define} "

    build_folder = cmake_build_type
    if args.builddir is not None:
        build_folder = args.builddir

    build_path = source_location + os.path.sep + build_folder
    if os.path.isdir(build_path):
        remove_old_dir = input(
            f"{build_folder} folder already exists. Remove old directory? [y/n]: "
        )
        if str(remove_old_dir).lower() in ["yes", "y", 1]:
            remove_old_dir = True
        else:
            build_folder = determine_new_folder()
            build_path = source_location + os.path.sep + build_folder
            remove_old_dir = False
        if remove_old_dir:
            rm_build_dir(build_path)
    os.chdir(source_location)
    os.mkdir(build_folder)
    print(f"Navigating into build directory: {build_path}")
    os.chdir(build_folder)

    cmake_command = (
        f'cmake {generator_cmake_arg} -DFSFW_OSAL="{osal}" '
        f'-DCMAKE_BUILD_TYPE="{cmake_build_type}" {cmake_target_cfg_cmd} '
        f"{define_string} {source_location}"
    )
    # Remove redundant spaces
    cmake_command = " ".join(cmake_command.split())
    print("Running CMake command: ")
    print(f'" {cmake_command} "')
    os.system(cmake_command)
    print("-- CMake configuration done. --")


def rm_build_dir(path: str):
    # On windows the permissions of the build directory may have been set to read-only. If this
    # is the case the permissions are changed before trying to delete the directory.
    if not os.access(path, os.W_OK):
        os.chmod(path, stat.S_IWUSR)
    shutil.rmtree(path)


def determine_source_location() -> str:
    index = 0
    while not os.path.isdir("fsfw"):
        index += 1
        os.chdir("..")
        if index >= 5:
            print(
                "Error: Could not find source directory (determined by looking for fsfw folder!)"
            )
            sys.exit(1)
    return os.getcwd()


def determine_new_folder() -> str:
    new_folder = input(f"Use different folder name? [y/n]: ")
    if str(new_folder).lower() in ["yes", "y", 1]:
        new_folder_name = input("New folder name: ")
        return new_folder_name
    else:
        print("Aborting configuration.")
        sys.exit(0)


if __name__ == "__main__":
    main()