"""Entry point for buildtest"""
import os
import shutil
import webbrowser
from buildtest.cli import get_parser
from buildtest.cli.build import BuildTest, Tee
from buildtest.cli.buildspec import (
BuildspecCache,
buildspec_find,
buildspec_maintainers,
buildspec_validate,
edit_buildspec_file,
edit_buildspec_test,
show_buildspecs,
show_failed_buildspecs,
summarize_buildspec_cache,
)
from buildtest.cli.cd import change_directory
from buildtest.cli.cdash import upload_test_cdash, view_cdash_project
from buildtest.cli.clean import clean
from buildtest.cli.compilers import compiler_cmd
from buildtest.cli.config import config_cmd
from buildtest.cli.debugreport import print_debug_report
from buildtest.cli.help import buildtest_help
from buildtest.cli.helpcolor import print_available_colors
from buildtest.cli.history import build_history
from buildtest.cli.info import buildtest_info
from buildtest.cli.inspect import inspect_cmd
from buildtest.cli.path import path_cmd
from buildtest.cli.report import report_cmd
from buildtest.cli.schema import schema_cmd
from buildtest.cli.stats import stats_cmd
from buildtest.config import SiteConfiguration
from buildtest.defaults import (
BUILDSPEC_CACHE_FILE,
BUILDTEST_BUILDSPEC_DIR,
BUILDTEST_EXECUTOR_DIR,
BUILDTEST_LOGFILE,
BUILDTEST_USER_HOME,
VAR_DIR,
console,
)
from buildtest.exceptions import BuildTestError
from buildtest.log import init_logfile
from buildtest.system import BuildTestSystem
from buildtest.tools.editor import set_editor
from buildtest.tools.stylecheck import run_style_checks
from buildtest.tools.tutorialexamples import generate_tutorial_examples
from buildtest.tools.unittests import run_unit_tests
from buildtest.utils.file import (
create_dir,
is_file,
read_file,
remove_file,
resolve_path,
)
from buildtest.utils.tools import deep_get
from rich.traceback import install
[docs]def main():
"""Entry point to buildtest."""
parser = get_parser()
args = parser.parse_args()
install(show_locals=True)
no_color = False
# disable color if buildtest --no-color or BUILDTEST_COLOR=False is set
if args.no_color or os.getenv("BUILDTEST_COLOR") == "False":
no_color = True
console.no_color = no_color
report_file = args.report
# print content of BUILDTEST_LOGFILE if buildtest --view-log or buildtest --print-log is specified which should contain output of last log
if args.view_log or args.print_log:
# if logfile is not present we should raise exception since this file is only created upon running 'buildtest build'
if not is_file(BUILDTEST_LOGFILE):
raise BuildTestError(
f"Unable to find logfile: {BUILDTEST_LOGFILE}, please run 'buildtest build'"
)
content = read_file(BUILDTEST_LOGFILE)
if args.view_log:
with console.pager():
console.print(content)
else:
console.print(content)
return
# print the available color options in a table format if buildtest --helpcolor is specified
if args.helpcolor:
print_available_colors()
return
# print full path to the lastlog file if buildtest --logpath is specified
if args.logpath:
console.print(BUILDTEST_LOGFILE)
return
if is_file(BUILDTEST_LOGFILE):
remove_file(BUILDTEST_LOGFILE)
logger = init_logfile(debug=args.debug, loglevel=args.loglevel)
create_dir(BUILDTEST_USER_HOME)
create_dir(BUILDTEST_EXECUTOR_DIR)
create_dir(BUILDTEST_BUILDSPEC_DIR)
# Create a build test system, and check requirements
system = BuildTestSystem()
validate_executors = True
# if buildtest build --disable-executor-check is specified store the value
if hasattr(args, "disable_executor_check"):
validate_executors = args.disable_executor_check
config_file = (
resolve_path(args.configfile) or os.getenv("BUILDTEST_CONFIGFILE") or None
)
configuration = SiteConfiguration(config_file)
configuration.detect_system()
configuration.validate(validate_executors, moduletool=system.system["moduletool"])
buildtest_editor = set_editor(args.editor)
logger.info(f"[red]Processing buildtest configuration file: {configuration.file}")
# build buildspec cache file automatically if it doesn't exist
if not is_file(BUILDSPEC_CACHE_FILE):
root_buildspecs = []
if hasattr(args, "root"):
root_buildspecs = args.root
BuildspecCache(roots=root_buildspecs, configuration=configuration)
# buildtest build command
if args.subcommands in ["build", "bd"]:
fname = os.path.join(VAR_DIR, "output.txt")
with Tee(fname):
cmd = BuildTest(
configuration=configuration,
buildspecs=args.buildspec,
exclude_buildspecs=args.exclude,
executors=args.executor,
tags=args.tags,
filter_buildspecs=args.filter,
rebuild=args.rebuild,
stage=args.stage,
testdir=args.testdir,
buildtest_system=system,
report_file=report_file,
maxpendtime=args.maxpendtime,
poll_interval=args.pollinterval,
remove_stagedir=args.remove_stagedir,
retry=args.retry,
account=args.account,
helpfilter=args.helpfilter,
numprocs=args.procs,
numnodes=args.nodes,
modules=args.modules,
modulepurge=args.module_purge,
unload_modules=args.unload_modules,
rerun=args.rerun,
executor_type=args.executor_type,
timeout=args.timeout,
limit=args.limit,
)
cmd.build()
if cmd.build_success():
build_history_dir = cmd.get_build_history_dir()
shutil.move(fname, os.path.join(build_history_dir, "output.txt"))
# buildtest build history
elif args.subcommands in ["history", "hy"]:
build_history(args)
# implementation for 'buildtest buildspec find'
elif args.subcommands in ["buildspec", "bc"]:
if args.buildspecs_subcommand in ["find", "f"]:
buildspec_find(args=args, configuration=configuration)
elif args.buildspecs_subcommand in ["summary", "sm"]:
summarize_buildspec_cache(
pager=args.pager, configuration=configuration, color=args.color
)
elif args.buildspecs_subcommand in ["show", "s"]:
show_buildspecs(
test_names=args.name, configuration=configuration, theme=args.theme
)
elif args.buildspecs_subcommand in ["show-fail", "sf"]:
show_failed_buildspecs(
configuration=configuration,
test_names=args.name,
report_file=report_file,
theme=args.theme,
)
elif args.buildspecs_subcommand in ["edit-test", "et"]:
edit_buildspec_test(
test_names=args.name,
configuration=configuration,
editor=buildtest_editor,
)
elif args.buildspecs_subcommand in ["edit-file", "ef"]:
edit_buildspec_file(
buildspecs=args.file,
configuration=configuration,
editor=buildtest_editor,
)
elif args.buildspecs_subcommand in ["maintainers", "m"]:
name = None
if hasattr(args, "name"):
name = args.name
buildspec_maintainers(
configuration=configuration,
list_maintainers=args.list,
breakdown=args.breakdown,
terse=args.terse,
header=args.no_header,
color=args.color,
name=name,
)
elif args.buildspecs_subcommand in ["validate", "val"]:
buildspec_validate(
buildspecs=args.buildspec,
excluded_buildspecs=args.exclude,
tags=args.tag,
executors=args.executor,
configuration=configuration,
)
# running buildtest inspect
elif args.subcommands in ["inspect", "it"]:
inspect_cmd(args, report_file=report_file)
elif args.subcommands in ["stats"]:
stats_cmd(name=args.name, report_file=report_file)
# running buildtest config
elif args.subcommands in ["config", "cg"]:
# running buildtest config compilers
if args.config in ["compilers", "co"]:
compiler_cmd(args, configuration)
else:
config_cmd(args, configuration, buildtest_editor, system)
# buildtest report
elif args.subcommands in ["report", "rt"]:
report_cmd(args, report_file)
elif args.subcommands == "path":
path_cmd(
name=args.name,
outfile=args.outfile,
errfile=args.errfile,
testpath=args.testpath,
buildscript=args.buildscript,
stagedir=args.stagedir,
buildenv=args.buildenv,
)
# running bnuildtest schema
elif args.subcommands == "schema":
schema_cmd(args)
# running buildtest cdash
elif args.subcommands == "cdash":
cdash_config = deep_get(configuration.target_config, "cdash")
if not cdash_config:
raise BuildTestError(
f"We found no 'cdash' setting set in configuration file: {configuration.file}. Please specify 'cdash' setting in order to use 'buildtest cdash' command"
)
if args.cdash == "view":
view_cdash_project(
cdash_config=cdash_config,
config_file=configuration.file,
open_browser=True,
)
elif args.cdash == "upload":
upload_test_cdash(
build_name=args.buildname,
configuration=configuration,
site=args.site,
report_file=report_file,
open_browser=args.open,
)
elif args.subcommands in ["help", "h"]:
buildtest_help(command=args.command)
elif args.subcommands == "clean":
clean(configuration=configuration, yes=args.yes)
elif args.subcommands == "cd":
change_directory(args.test)
elif args.subcommands == "docs":
webbrowser.open("https://buildtest.readthedocs.io/")
elif args.subcommands == "schemadocs":
webbrowser.open("https://buildtesters.github.io/buildtest/")
elif args.subcommands == "info":
buildtest_info(configuration, system)
elif args.subcommands in ["debug", "debugreport"]:
print_debug_report(system, configuration)
elif args.subcommands in ["unittests", "test"]:
run_unit_tests(
pytestopts=args.pytestopts,
sourcefiles=args.sourcefiles,
enable_coverage=args.coverage,
)
elif args.subcommands == "tutorial-examples":
generate_tutorial_examples()
elif args.subcommands in ["stylecheck", "style"]:
run_style_checks(
no_black=args.no_black,
no_isort=args.no_isort,
no_pyflakes=args.no_pyflakes,
apply_stylechecks=args.apply,
)
if __name__ == "__main__":
main()