fsfw/scripts/helper.py

216 lines
6.4 KiB
Python
Raw Normal View History

#!/usr/bin/env python3
# -*- coding: utf-8 -*
"""Small portable helper script to generate test or doc configuration for the
flight software framework
"""
import os
import argparse
import webbrowser
import shutil
import sys
2021-12-03 14:55:00 +01:00
import time
2022-02-02 09:56:12 +01:00
from shutil import which
from typing import List
2022-02-02 09:56:12 +01:00
UNITTEST_FOLDER_NAME = "build-tests"
DOCS_FOLDER_NAME = "build-docs"
def main():
parser = argparse.ArgumentParser(description="FSFW helper script")
2022-02-02 09:56:12 +01:00
choices = ("docs", "tests")
parser.add_argument(
2022-02-02 09:56:12 +01:00
"type", metavar="type", choices=choices, help=f"Target type. Choices: {choices}"
)
parser.add_argument(
2022-02-02 09:56:12 +01:00
"-a", "--all", action="store_true", help="Create, build and open specified type"
)
parser.add_argument(
2022-02-02 09:56:12 +01:00
"-c",
"--create",
action="store_true",
help="Create docs or test build configuration",
)
parser.add_argument(
2022-02-02 09:56:12 +01:00
"-b", "--build", action="store_true", help="Build the specified type"
)
parser.add_argument(
2022-02-02 09:56:12 +01:00
"-o",
"--open",
action="store_true",
help="Open test or documentation data in webbrowser",
)
parser.add_argument(
"-v",
"--valgrind",
action="store_true",
help="Run valgrind on generated test binary",
)
args = parser.parse_args()
if args.all:
args.build = True
args.create = True
args.open = True
2022-02-02 09:56:12 +01:00
elif not args.build and not args.create and not args.open and not args.valgrind:
print(
2022-02-02 09:56:12 +01:00
"Please select at least one operation to perform. "
"Use helper.py -h for more information"
)
sys.exit(1)
# This script can be called from root and from script folder
2022-02-02 09:56:12 +01:00
if not os.path.isfile("README.md"):
os.chdir("..")
build_dir_list = []
if not args.create:
build_dir_list = build_build_dir_list()
2022-02-02 09:56:12 +01:00
if args.type == "tests":
handle_tests_type(args, build_dir_list)
2022-02-02 09:56:12 +01:00
elif args.type == "docs":
handle_docs_type(args, build_dir_list)
else:
2022-02-02 09:56:12 +01:00
print("Invalid or unknown type")
sys.exit(1)
def handle_docs_type(args, build_dir_list: list):
if args.create:
2021-12-03 14:55:00 +01:00
if os.path.exists(DOCS_FOLDER_NAME):
shutil.rmtree(DOCS_FOLDER_NAME)
create_docs_build_cfg()
build_directory = DOCS_FOLDER_NAME
elif len(build_dir_list) == 0:
2022-02-02 09:56:12 +01:00
print(
"No valid CMake docs build directory found. Trying to set up docs build system"
)
shutil.rmtree(DOCS_FOLDER_NAME)
create_docs_build_cfg()
build_directory = DOCS_FOLDER_NAME
elif len(build_dir_list) == 1:
build_directory = build_dir_list[0]
else:
print("Multiple build directories found!")
build_directory = determine_build_dir(build_dir_list)
os.chdir(build_directory)
if args.build:
2022-02-22 14:00:34 +01:00
cmd_runner("cmake --build . -j")
if args.open:
2022-02-02 09:56:12 +01:00
if not os.path.isfile("docs/sphinx/index.html"):
2021-12-03 14:55:00 +01:00
# try again..
2022-02-22 14:00:34 +01:00
cmd_runner("cmake --build . -j")
2022-02-02 09:56:12 +01:00
if not os.path.isfile("docs/sphinx/index.html"):
2021-12-03 14:55:00 +01:00
print(
"No Sphinx documentation file detected. "
"Try to build it first with the -b argument"
)
sys.exit(1)
2022-02-02 09:56:12 +01:00
webbrowser.open("docs/sphinx/index.html")
def handle_tests_type(args, build_dir_list: list):
if args.create:
2021-12-03 14:55:00 +01:00
if os.path.exists(UNITTEST_FOLDER_NAME):
shutil.rmtree(UNITTEST_FOLDER_NAME)
create_tests_build_cfg()
build_directory = UNITTEST_FOLDER_NAME
elif len(build_dir_list) == 0:
print(
2022-02-02 09:56:12 +01:00
"No valid CMake tests build directory found. "
"Trying to set up test build system"
)
create_tests_build_cfg()
build_directory = UNITTEST_FOLDER_NAME
elif len(build_dir_list) == 1:
build_directory = build_dir_list[0]
else:
print("Multiple build directories found!")
build_directory = determine_build_dir(build_dir_list)
os.chdir(build_directory)
if args.build:
2021-12-06 14:46:31 +01:00
perform_lcov_operation(build_directory, False)
if args.open:
2022-02-02 09:56:12 +01:00
if not os.path.isdir("fsfw-tests_coverage"):
print(
"No Unittest folder detected. Try to build them first with the -b argument"
)
sys.exit(1)
webbrowser.open("fsfw-tests_coverage/index.html")
if args.valgrind:
if which("valgrind") is None:
print("Please install valgrind first")
sys.exit(1)
2022-02-14 15:19:47 +01:00
if os.path.split(os.getcwd())[1] != UNITTEST_FOLDER_NAME:
# If we are in a different directory we try to switch into it but
# this might fail
os.chdir(UNITTEST_FOLDER_NAME)
2022-02-22 14:00:34 +01:00
cmd_runner("valgrind --leak-check=full ./fsfw-tests")
2022-02-02 09:56:12 +01:00
os.chdir("..")
def create_tests_build_cfg():
os.mkdir(UNITTEST_FOLDER_NAME)
os.chdir(UNITTEST_FOLDER_NAME)
2022-02-22 14:00:34 +01:00
cmd_runner("cmake -DFSFW_OSAL=host -DFSFW_BUILD_UNITTESTS=ON ..")
2022-02-02 09:56:12 +01:00
os.chdir("..")
def create_docs_build_cfg():
os.mkdir(DOCS_FOLDER_NAME)
os.chdir(DOCS_FOLDER_NAME)
2022-02-22 14:00:34 +01:00
cmd_runner("cmake -DFSFW_OSAL=host -DFSFW_BUILD_DOCS=ON ..")
2022-02-02 09:56:12 +01:00
os.chdir("..")
def build_build_dir_list() -> list:
build_dir_list = []
for directory in os.listdir("."):
if os.path.isdir(directory):
os.chdir(directory)
build_dir_list = check_for_cmake_build_dir(build_dir_list)
os.chdir("..")
return build_dir_list
def check_for_cmake_build_dir(build_dir_list: list) -> list:
if os.path.isfile("CMakeCache.txt"):
build_dir_list.append(os.getcwd())
return build_dir_list
2021-12-06 14:46:31 +01:00
def perform_lcov_operation(directory: str, chdir: bool):
if chdir:
os.chdir(directory)
2022-02-22 14:00:34 +01:00
cmd_runner("cmake --build . -- fsfw-tests_coverage -j")
def determine_build_dir(build_dir_list: List[str]):
build_directory = ""
for idx, directory in enumerate(build_dir_list):
print(f"{idx + 1}: {directory}")
while True:
idx = input("Pick the directory: ")
if not idx.isdigit():
print("Invalid input!")
continue
idx = int(idx)
if idx > len(build_dir_list) or idx < 1:
print("Invalid input!")
continue
build_directory = build_dir_list[idx - 1]
break
return build_directory
2022-02-22 14:00:34 +01:00
def cmd_runner(cmd: str):
print(f"Executing command: {cmd}")
os.system(cmd)
if __name__ == "__main__":
main()