Logo
2.1

Background

  • Summary of buildtest

Getting Started

  • Installing buildtest
  • Quick Start Guide

Tutorial

  • Command Line Tutorial
  • Buildspec Tutorial
  • Buildtest Tutorial on Perlmutter

How-to-guides

  • How to configure buildtest
  • Batch Scheduler Support
  • Troubleshooting Buildtest

Explanation

  • Build and Test Process
  • Using buildtest at HPC sites

Reference

  • Buildtest Command Line Reference
  • Writing Buildspecs
  • Additional Features
  • Facility Test Examples
  • buildtest API Reference
  • Buildtest Command Reference
  • Conference and Publications

Development Guide

  • Contributing Guide

Useful Links

  • Buildtest Github repo
  • Buildtest Slack
  • buildtest at NERSC
buildtest
  • <no title>
  • View page source
Previous Next
  • buildtest API Reference
    • buildtest
      • Subpackages
        • buildtest.builders
          • Submodules
            • buildtest.builders.base
              • Module Contents
                • Classes
                  • BuilderBase
                    • BuilderBase.dependency
                    • BuilderBase.shell_detection()
                    • BuilderBase._set_metadata_values()
                    • BuilderBase.get_test_extension()
                    • BuilderBase.is_local_executor()
                    • BuilderBase.is_container_executor()
                    • BuilderBase.is_batch_job()
                    • BuilderBase.start()
                    • BuilderBase.stop()
                    • BuilderBase.retry()
                    • BuilderBase.build()
                    • BuilderBase.run()
                    • BuilderBase.prepare_run()
                    • BuilderBase.execute_run()
                    • BuilderBase.execute_post_run_script()
                    • BuilderBase._display_output_content()
                    • BuilderBase._display_test_content()
                    • BuilderBase.handle_run_result()
                    • BuilderBase.record_starttime()
                    • BuilderBase.record_endtime()
                    • BuilderBase.runtime()
                    • BuilderBase.get_runtime()
                    • BuilderBase.state()
                    • BuilderBase.failed()
                    • BuilderBase.complete()
                    • BuilderBase.running()
                    • BuilderBase.is_pending()
                    • BuilderBase.is_complete()
                    • BuilderBase.is_failed()
                    • BuilderBase.is_running()
                    • BuilderBase._build_setup()
                    • BuilderBase._create_directories()
                    • BuilderBase._resolve_paths()
                    • BuilderBase._copy_files_to_stage()
                    • BuilderBase._write_build_script()
                    • BuilderBase._generate_build_script_lines()
                    • BuilderBase._generate_trap_message()
                    • BuilderBase._get_execution_command()
                    • BuilderBase._copy_build_script_to_test_root()
                    • BuilderBase._write_post_run_script()
                    • BuilderBase._write_test()
                    • BuilderBase.get_container_invocation()
                    • BuilderBase._emit_command()
                    • BuilderBase._emit_set_command()
                    • BuilderBase._set_default_test_variables()
                    • BuilderBase.set_scheduler_settings()
                    • BuilderBase.get_job_directives()
                    • BuilderBase._get_burst_buffer()
                    • BuilderBase._get_data_warp()
                    • BuilderBase._set_execute_perm()
                    • BuilderBase._get_environment()
                    • BuilderBase._get_variables()
                    • BuilderBase._extract_line()
                    • BuilderBase.add_metrics()
                    • BuilderBase.handle_regex_metric()
                    • BuilderBase.handle_file_regex_metric()
                    • BuilderBase.get_match()
                    • BuilderBase.output()
                    • BuilderBase.error()
                    • BuilderBase.generate_script()
                    • BuilderBase.post_run_steps()
                    • BuilderBase.is_valid_metric()
                    • BuilderBase.check_test_state()
                    • BuilderBase._process_compiler_config()
                    • BuilderBase.__str__()
                    • BuilderBase.__repr__()
            • buildtest.builders.script
              • Module Contents
                • Classes
                  • ScriptBuilder
                    • ScriptBuilder.type
                    • ScriptBuilder.resolve_compilers()
                    • ScriptBuilder.write_python_script()
                    • ScriptBuilder._get_compiler_variables()
                    • ScriptBuilder.generate_script()
                    • ScriptBuilder._get_container_command()
            • buildtest.builders.spack
              • Module Contents
                • Classes
                  • SpackBuilder
                    • SpackBuilder.type
                    • SpackBuilder.generate_script()
                    • SpackBuilder._spack_test()
                    • SpackBuilder._resolve_spack_root()
                    • SpackBuilder._spack_environment()
        • buildtest.buildsystem
          • Submodules
            • buildtest.buildsystem.builders
              • Module Contents
                • Classes
                  • Builder
                    • Builder.filter_by_executor_type()
                    • Builder.create_script_builders()
                    • Builder.create_spack_builders()
                    • Builder.generate_builders()
                    • Builder.build()
                    • Builder._skip_tests_by_exclude_tags()
                    • Builder._skip_tests_by_tags()
                    • Builder._skip_tests_by_type()
                    • Builder.get_builders()
                    • Builder.get_filtered_buildspec()
            • buildtest.buildsystem.checks
              • Module Contents
                • Functions
                • Attributes
                  • logger
                  • is_metrics_defined()
                  • returncode_check()
                  • runtime_check()
                  • file_regex_check()
                  • regex_check()
                  • is_symlink_check()
                  • exists_check()
                  • is_file_check()
                  • is_dir_check()
                  • convert_metrics()
                  • comparison_check()
                  • contains_check()
                  • assert_range_check()
                  • file_count_check()
                  • linecount_check()
                  • file_linecount_check()
            • buildtest.buildsystem.parser
              • Module Contents
                • Classes
                  • BuildspecParser
                    • BuildspecParser.__str__()
                    • BuildspecParser.__repr__()
                    • BuildspecParser._check_schema_type()
                    • BuildspecParser._check_executor()
                    • BuildspecParser.validate()
                    • BuildspecParser.get_test_names()
        • buildtest.cli
          • Submodules
            • buildtest.cli.build
              • Module Contents
                • Classes
                • Functions
                • Attributes
                  • logger
                  • Tee
                    • Tee.__enter__()
                    • Tee.__exit__()
                    • Tee.write()
                    • Tee.flush()
                  • resolve_testdirectory()
                  • discover_buildspecs()
                  • print_discovered_buildspecs()
                  • discover_buildspecs_by_tags()
                  • discover_buildspecs_by_name()
                  • discover_buildspecs_by_executor()
                  • discover_by_buildspecs()
                  • print_filters()
                  • BuildTest
                    • BuildTest.buildexecutor
                    • BuildTest.load_rerun_file()
                    • BuildTest.save_rerun_file()
                    • BuildTest.save_profile_to_configuration()
                    • BuildTest.load_profile()
                    • BuildTest._validate_filters()
                    • BuildTest.build()
                    • BuildTest.parse_buildspecs()
                    • BuildTest.build_phase()
                    • BuildTest.run_phase()
                    • BuildTest.build_success()
                    • BuildTest.print_test_summary()
                    • BuildTest._update_build_history()
                    • BuildTest.get_build_history_dir()
                    • BuildTest.print_builders_by_type()
                    • BuildTest.print_batch_builders()
                    • BuildTest.print_builders()
                  • update_report()
            • buildtest.cli.buildspec
              • Module Contents
                • Classes
                • Functions
                • Attributes
                  • logger
                  • BuildspecCache
                    • BuildspecCache.table
                    • BuildspecCache.filter_fields
                    • BuildspecCache.default_format_fields
                    • BuildspecCache.format_fields
                    • BuildspecCache.get_cache()
                    • BuildspecCache.load_paths()
                    • BuildspecCache.build()
                    • BuildspecCache._discover_buildspecs()
                    • BuildspecCache._write_buildspec_cache()
                    • BuildspecCache._validate_buildspecs()
                    • BuildspecCache.get_names()
                    • BuildspecCache.get_random_tests()
                    • BuildspecCache.lookup_buildspec_by_name()
                    • BuildspecCache.build_cache()
                    • BuildspecCache._check_filter_fields()
                    • BuildspecCache._check_format_fields()
                    • BuildspecCache._filter_buildspecs()
                    • BuildspecCache.find_buildspecs()
                    • BuildspecCache.get_valid_buildspecs()
                    • BuildspecCache.get_invalid_buildspecs()
                    • BuildspecCache.get_unique_tags()
                    • BuildspecCache.get_unique_executors()
                    • BuildspecCache.get_maintainers()
                    • BuildspecCache.get_paths()
                    • BuildspecCache.tag_breakdown()
                    • BuildspecCache.executor_breakdown()
                    • BuildspecCache.test_breakdown_by_buildspec()
                    • BuildspecCache.print_buildspecfiles()
                    • BuildspecCache.print_tags()
                    • BuildspecCache.print_executors()
                    • BuildspecCache.print_by_executors()
                    • BuildspecCache.print_by_tags()
                    • BuildspecCache.print_buildspecs()
                    • BuildspecCache.list_maintainers()
                    • BuildspecCache.print_maintainer()
                    • BuildspecCache.print_maintainers_find()
                    • BuildspecCache.print_maintainers_by_buildspecs()
                    • BuildspecCache.print_invalid_buildspecs()
                    • BuildspecCache.print_filter_fields()
                    • BuildspecCache.print_format_fields()
                    • BuildspecCache.print_raw_filter_fields()
                    • BuildspecCache.print_raw_format_fields()
                    • BuildspecCache.print_paths()
                  • edit_buildspec_test()
                  • edit_buildspec_file()
                  • is_test_name_in_cache()
                  • show_buildspecs()
                  • show_tests_by_status()
                  • show_failed_buildspecs()
                  • handle_exception()
                  • buildspec_validate_command()
                  • summarize_buildspec_cache()
                  • summary_print()
                  • buildspec_maintainers()
                  • buildspec_find()
                  • open_buildspec_in_editor()
                  • validate_buildspec()
            • buildtest.cli.cd
              • Module Contents
                • Functions
                  • change_directory()
            • buildtest.cli.cdash
              • Module Contents
                • Functions
                  • cdash_cmd()
                  • view_cdash_project()
                  • upload_test_cdash()
            • buildtest.cli.clean
              • Module Contents
                • Functions
                  • clean()
            • buildtest.cli.commands
              • Module Contents
                • Functions
                  • list_buildtest_commands()
            • buildtest.cli.compilers
              • Module Contents
                • Classes
                • Functions
                  • compiler_cmd()
                  • remove_compilers()
                  • list_compilers()
                  • compiler_test()
                  • compiler_find()
                  • BuildtestCompilers
                    • BuildtestCompilers.compiler_table
                    • BuildtestCompilers.find_compilers()
                    • BuildtestCompilers._validate_modules()
                    • BuildtestCompilers._update_compiler_section()
                    • BuildtestCompilers.print_json()
                    • BuildtestCompilers.print_yaml()
                    • BuildtestCompilers.names()
                    • BuildtestCompilers.print_compilers()
            • buildtest.cli.config
              • Module Contents
                • Functions
                  • config_cmd()
                  • handle_view_command()
                  • handle_profiles_command()
                  • handle_executors_command()
                  • handle_validate_command()
                  • handle_systems_command()
                  • handle_edit_command()
                  • handle_path_command()
                  • edit_configuration()
                  • view_system()
                  • validate_config()
                  • view_path()
                  • view_configuration()
                  • remove_profiles()
                  • list_profiles()
                  • display_executors_in_json_format()
                  • display_executors_in_yaml_format()
                  • display_disabled_executors()
                  • display_invalid_executors()
                  • display_all_executors()
                  • view_executors()
                  • remove_executors()
            • buildtest.cli.debugreport
              • Module Contents
                • Functions
                  • print_debug_report()
            • buildtest.cli.helpcolor
              • Module Contents
                • Functions
                  • print_available_colors()
            • buildtest.cli.history
              • Module Contents
                • Functions
                • Attributes
                  • logger
                  • build_history()
                  • sorted_alphanumeric()
                  • query_builds()
                  • list_build_history()
                  • process_history_data()
            • buildtest.cli.info
              • Module Contents
                • Functions
                  • buildtest_info()
                  • print_version_info()
            • buildtest.cli.inspect
              • Module Contents
                • Functions
                  • print_by_query()
                  • fetch_test_names()
                  • print_builders()
                  • inspect_list()
                  • inspect_query()
                  • inspect_buildspec()
                  • print_by_name()
                  • inspect_by_name()
            • buildtest.cli.path
              • Module Contents
                • Functions
                  • path_cmd()
            • buildtest.cli.report
              • Module Contents
                • Classes
                • Functions
                • Attributes
                  • logger
                  • PASS
                  • FAIL
                  • is_int()
                  • Report
                    • Report.default_row_count
                    • Report.format_field_description
                    • Report.filter_field_description
                    • Report.format_fields
                    • Report.filter_fields
                    • Report.display_table
                    • Report.format_fields_detailed
                    • Report.set_report_parameters()
                    • Report.reportfile()
                    • Report.get()
                    • Report.validate_filter_and_format_fields()
                    • Report._check_filter_fields()
                    • Report._check_format_fields()
                    • Report._check_start_and_end_fields()
                    • Report.load_report()
                    • Report.validate_buildspec_filter()
                    • Report.validate_state_filter()
                    • Report.filter_buildspecs_from_report()
                    • Report.filter_by_start_end()
                    • Report._filter_by_names()
                    • Report._filter_by_tags()
                    • Report._filter_by_executor()
                    • Report._filter_by_state()
                    • Report._filter_by_returncode()
                    • Report.process_report()
                    • Report.filter_tests()
                    • Report.add_tests_to_display_table()
                    • Report.print_format_fields()
                    • Report.print_filter_fields()
                    • Report.print_raw_filter_fields()
                    • Report.print_raw_format_fields()
                    • Report.print_report()
                    • Report.latest_testid_by_name()
                    • Report.get_names()
                    • Report.get_random_tests()
                    • Report.get_buildspecs()
                    • Report.get_test_by_state()
                    • Report.get_testids()
                    • Report._testid_lookup()
                    • Report.lookup()
                    • Report.builder_names()
                    • Report.get_random_builder_names()
                    • Report.breakdown_by_test_names()
                    • Report.fetch_records_by_ids()
                    • Report.get_buildspec_by_test()
                  • list_report()
                  • clear_report()
                  • report_cmd()
                  • report_summary()
                  • print_report_summary_output()
            • buildtest.cli.show
              • Module Contents
                • Functions
                  • print_build_show()
                  • print_buildspec_show()
                  • print_config_show()
                  • print_inspect_show()
                  • print_report_show()
                  • print_history_show()
                  • print_cdash_show()
                  • print_stylecheck_show()
                  • print_unittests_show()
                  • print_path_show()
                  • buildtest_show()
            • buildtest.cli.stats
              • Module Contents
                • Functions
                  • stats_cmd()
          • Package Contents
            • Classes
            • Functions
            • Attributes
              • BUILDTEST_COPYRIGHT
              • BUILDTEST_VERSION
              • console
              • build_filters_format()
              • handle_kv_string()
              • positive_number()
              • supported_color()
              • valid_time()
              • get_parser()
              • BuildTestParser
                • BuildTestParser._github
                • BuildTestParser._docs
                • BuildTestParser._slack
                • BuildTestParser._issues
                • BuildTestParser._progname
                • BuildTestParser._description
                • BuildTestParser.epilog_str
                • BuildTestParser._buildtest_show_commands
                • BuildTestParser.parse()
                • BuildTestParser.get_subparsers()
                • BuildTestParser.retrieve_main_options()
                • BuildTestParser._build_subparsers()
                • BuildTestParser._build_options()
                • BuildTestParser.get_subcommands()
                • BuildTestParser.get_parent_parser()
                • BuildTestParser.misc_menu()
                • BuildTestParser.stylecheck_menu()
                • BuildTestParser.tutorial_menu()
                • BuildTestParser.unittest_menu()
                • BuildTestParser.path_menu()
                • BuildTestParser.history_menu()
                • BuildTestParser.build_menu()
                • BuildTestParser.buildspec_menu()
                • BuildTestParser.buildspec_find_menu()
                • BuildTestParser.config_menu()
                • BuildTestParser.report_menu()
                • BuildTestParser.inspect_menu()
                • BuildTestParser.cdash_menu()
        • buildtest.executors
          • Submodules
            • buildtest.executors.base
              • Module Contents
                • Classes
                  • BaseExecutor
                    • BaseExecutor.type
                    • BaseExecutor.default_maxpendtime
                    • BaseExecutor.add_builder()
                    • BaseExecutor.get_builder()
                    • BaseExecutor.load()
                    • BaseExecutor.run()
                    • BaseExecutor.poll()
                    • BaseExecutor.gather()
                    • BaseExecutor._cancel_job_if_elapsedtime_exceeds_timeout()
                    • BaseExecutor._cancel_job_if_pendtime_exceeds_maxpendtime()
                    • BaseExecutor.__str__()
                    • BaseExecutor.__repr__()
            • buildtest.executors.container
              • Module Contents
                • Classes
                  • ContainerExecutor
                    • ContainerExecutor.type
            • buildtest.executors.local
              • Module Contents
                • Classes
                  • LocalExecutor
                    • LocalExecutor.type
                    • LocalExecutor.run()
            • buildtest.executors.lsf
              • Module Contents
                • Classes
                • Attributes
                  • logger
                  • LSFExecutor
                    • LSFExecutor.type
                    • LSFExecutor.launcher_command()
                    • LSFExecutor.run()
            • buildtest.executors.pbs
              • Module Contents
                • Classes
                • Attributes
                  • logger
                  • PBSExecutor
                    • PBSExecutor.type
                    • PBSExecutor.launcher_command()
                    • PBSExecutor.run()
                  • TorqueExecutor
            • buildtest.executors.setup
              • Module Contents
                • Classes
                • Attributes
                  • logger
                  • BuildExecutor
                    • BuildExecutor.__str__()
                    • BuildExecutor.__repr__()
                    • BuildExecutor.names()
                    • BuildExecutor.get()
                    • BuildExecutor.get_validbuilders()
                    • BuildExecutor._choose_executor()
                    • BuildExecutor.setup()
                    • BuildExecutor.select_builders_to_run()
                    • BuildExecutor.check_state()
                    • BuildExecutor.check_returncode()
                    • BuildExecutor.run()
                    • BuildExecutor.poll()
                    • BuildExecutor._print_job_details()
                    • BuildExecutor._cleanup_when_exception()
            • buildtest.executors.slurm
              • Module Contents
                • Classes
                • Attributes
                  • logger
                  • SlurmExecutor
                    • SlurmExecutor.type
                    • SlurmExecutor.launcher_command()
                    • SlurmExecutor.run()
                    • SlurmExecutor.gather()
        • buildtest.scheduler
          • Submodules
            • buildtest.scheduler.detection
              • Module Contents
                • Classes
                  • Scheduler
                    • Scheduler.logger
                    • Scheduler.binaries
                    • Scheduler.queues()
                    • Scheduler.active()
                    • Scheduler.get_queues()
                  • Slurm
                    • Slurm.binaries
                    • Slurm.partitions()
                    • Slurm.clusters()
                    • Slurm.qos()
                    • Slurm.run_command()
                    • Slurm._get_partitions()
                    • Slurm._get_clusters()
                    • Slurm._get_qos()
                    • Slurm.validate_partition()
                    • Slurm.validate_cluster()
                    • Slurm.validate_qos()
                  • LSF
                    • LSF.binaries
                    • LSF.get_queues()
                    • LSF.validate_queue()
                  • PBS
                    • PBS.binaries
                    • PBS.active()
                    • PBS.check()
                    • PBS.get_queues()
                    • PBS.validate_queue()
                  • Torque
                    • Torque.binaries
                    • Torque.active()
                    • Torque.check()
                    • Torque.get_queues()
                    • Torque.validate_queue()
            • buildtest.scheduler.job
              • Module Contents
                • Classes
                  • Job
                    • Job.state()
                    • Job.get()
                    • Job.is_pending()
                    • Job.is_running()
                    • Job.is_suspended()
                    • Job.cancel()
                    • Job.poll()
                    • Job.get_output_and_error_files()
                    • Job.output_file()
                    • Job.error_file()
                    • Job.exitcode()
                    • Job.retrieve_jobdata()
                    • Job.jobdata()
            • buildtest.scheduler.lsf
              • Module Contents
                • Classes
                • Attributes
                  • logger
                  • LSFJob
                    • LSFJob.is_pending()
                    • LSFJob.is_running()
                    • LSFJob.is_complete()
                    • LSFJob.is_suspended()
                    • LSFJob.is_failed()
                    • LSFJob.poll()
                    • LSFJob.get_output_and_error_files()
                    • LSFJob.retrieve_jobdata()
                    • LSFJob.cancel()
            • buildtest.scheduler.pbs
              • Module Contents
                • Classes
                • Attributes
                  • logger
                  • PBSJob
                    • PBSJob.is_pending()
                    • PBSJob.is_running()
                    • PBSJob.is_complete()
                    • PBSJob.is_suspended()
                    • PBSJob.success()
                    • PBSJob.fail()
                    • PBSJob.get_output_error_files()
                    • PBSJob.is_output_ready()
                    • PBSJob.poll()
                    • PBSJob.retrieve_jobdata()
                    • PBSJob.cancel()
                  • TorqueJob
                    • TorqueJob.retrieve_jobdata()
            • buildtest.scheduler.slurm
              • Module Contents
                • Classes
                • Attributes
                  • logger
                  • SlurmJob
                    • SlurmJob.is_pending()
                    • SlurmJob.is_running()
                    • SlurmJob.is_suspended()
                    • SlurmJob.is_cancelled()
                    • SlurmJob.is_complete()
                    • SlurmJob.is_failed()
                    • SlurmJob.is_out_of_memory()
                    • SlurmJob.is_timeout()
                    • SlurmJob.complete()
                    • SlurmJob.state()
                    • SlurmJob.workdir()
                    • SlurmJob.cancel()
                    • SlurmJob.poll()
                    • SlurmJob.get_output_and_error_files()
                    • SlurmJob.retrieve_jobdata()
        • buildtest.schemas
          • Submodules
            • buildtest.schemas.defaults
              • Module Contents
                • Functions
                • Attributes
                  • here
                  • schema_table
                  • schema_store
                  • registry
                  • custom_validator()
            • buildtest.schemas.utils
              • Module Contents
                • Functions
                • Attributes
                  • here
                  • load_schema()
                  • load_recipe()
        • buildtest.tools
          • Submodules
            • buildtest.tools.cpu
              • Module Contents
                • Functions
                  • _bits_from_str()
                  • _str_from_bits()
                  • _sysfs_topo()
                  • _sysctl_topo()
                  • cpuinfo()
            • buildtest.tools.editor
              • Module Contents
                • Functions
                  • set_editor()
            • buildtest.tools.modules
              • Module Contents
                • Functions
                  • get_module_commands()
            • buildtest.tools.stylecheck
              • Module Contents
                • Functions
                  • run_command()
                  • run_black()
                  • run_isort()
                  • run_pyflakes()
                  • run_style_checks()
            • buildtest.tools.tutorialexamples
              • Module Contents
                • Functions
                  • generate_tutorial_examples()
                  • run()
                  • write_example()
                  • build_aws_examples()
                  • build_spack_examples()
                  • execute_commands()
            • buildtest.tools.unittests
              • Module Contents
                • Functions
                • Attributes
                  • here
                  • run_unit_tests()
                  • parser
        • buildtest.utils
          • Submodules
            • buildtest.utils.command
              • Module Contents
                • Classes
                • Attributes
                  • logger
                  • Capturing
                    • Capturing.out
                    • Capturing.err
                    • Capturing.__enter__()
                    • Capturing.set_stdout()
                    • Capturing.set_stderr()
                    • Capturing.__exit__()
                    • Capturing.cleanup()
                  • BuildTestCommand
                    • BuildTestCommand.execute()
                    • BuildTestCommand.reset_output()
                    • BuildTestCommand.find_executable()
                    • BuildTestCommand.decode_output()
                    • BuildTestCommand.returncode()
                    • BuildTestCommand.decode()
                    • BuildTestCommand.get_output()
                    • BuildTestCommand.get_error()
                    • BuildTestCommand.get_command()
            • buildtest.utils.file
              • Module Contents
                • Functions
                • Attributes
                  • max_files_traversed
                  • is_file()
                  • is_dir()
                  • is_symlink()
                  • search_files()
                  • walk_tree()
                  • create_dir()
                  • resolve_path()
                  • read_file()
                  • create_file()
                  • write_file()
                  • remove_file()
                  • load_json()
            • buildtest.utils.print
              • Module Contents
                • Functions
                  • print_file_content()
                  • print_content()
            • buildtest.utils.shell
              • Module Contents
                • Classes
                • Functions
                • Attributes
                  • get_shells()
                  • get_python_shells()
                  • shell_lookup()
                  • is_bash_shell()
                  • is_sh_shell()
                  • is_csh_shell()
                  • is_zsh_shell()
                  • python_shells
                  • system_shells
                  • shell_dict
                  • Shell
                    • Shell.opts
                    • Shell.path
                    • Shell.__str__()
                    • Shell.__repr__()
                    • Shell.get()
            • buildtest.utils.table
              • Module Contents
                • Functions
                  • create_table()
                  • print_table()
                  • print_terse_format()
            • buildtest.utils.timer
              • Module Contents
                • Classes
                  • TimerError
                  • Timer
                    • Timer.start()
                    • Timer.stop()
                    • Timer.duration()
            • buildtest.utils.tools
              • Module Contents
                • Functions
                • Attributes
                  • logger
                  • deep_get()
                  • checkColor()
                  • check_binaries()
                  • check_container_runtime()
      • Submodules
        • buildtest.config
          • Module Contents
            • Classes
            • Attributes
              • logger
              • SiteConfiguration
                • SiteConfiguration.file
                • SiteConfiguration.load()
                • SiteConfiguration.resolve()
                • SiteConfiguration.name()
                • SiteConfiguration.detect_system()
                • SiteConfiguration.validate()
                • SiteConfiguration._executor_check()
                • SiteConfiguration.get_all_executors()
                • SiteConfiguration.is_executor_disabled()
                • SiteConfiguration._validate_container_executors()
                • SiteConfiguration._validate_local_executors()
                • SiteConfiguration._validate_lsf_executors()
                • SiteConfiguration._validate_slurm_executors()
                • SiteConfiguration._validate_pbs_executors()
                • SiteConfiguration._validate_torque_executors()
                • SiteConfiguration.get_profile()
        • buildtest.defaults
          • Module Contents
            • console
            • userhome
            • BUILDTEST_ROOT
            • SCHEMA_ROOT
            • BUILDTEST_UNITTEST_ROOT
            • BUILDTEST_USER_HOME
            • USER_SETTINGS_FILE
            • ci_dir
            • VAR_DIR
            • BUILDTEST_LOGFILE
            • DEFAULT_LOGDIR
            • BUILD_HISTORY_DIR
            • BUILDTEST_RERUN_FILE
            • BUILDTEST_DEFAULT_TESTDIR
            • BUILDTEST_EXECUTOR_DIR
            • BUILDTEST_BUILDSPEC_DIR
            • BUILDSPEC_CACHE_FILE
            • BUILD_REPORT
            • BUILDTEST_REPORTS
            • BUILDSPEC_DEFAULT_PATH
            • TUTORIALS_SETTINGS_FILE
            • DEFAULT_SETTINGS_SCHEMA
        • buildtest.exceptions
          • Module Contents
            • BuildTestError
              • BuildTestError.__str__()
            • BuildspecError
              • BuildspecError.get_exception()
            • InvalidBuildspec
            • InvalidBuildspecSchemaType
            • InvalidBuildspecExecutor
            • ExecutorError
            • RuntimeFailure
            • ConfigurationError
              • ConfigurationError.__str__()
            • JobSchedulerError
        • buildtest.log
          • Module Contents
            • Functions
              • init_logfile()
        • buildtest.main
          • Module Contents
            • Functions
              • main()
              • setup()
              • handle_log_viewing()
              • handle_build_command()
              • handle_buildspec_command()
              • handle_inspect_command()
              • handle_cdash_command()
        • buildtest.system
          • Module Contents
            • Classes
            • Attributes
              • SUPPORTED_PLATFORMS
              • BuildTestSystem
                • BuildTestSystem.system
                • BuildTestSystem.get()
                • BuildTestSystem.check()
                • BuildTestSystem.detect_module_tool()
      • Package Contents
        • __version__
        • BUILDTEST_VERSION
        • BUILDTEST_COPYRIGHT
Previous Next

© Copyright Copyright (c) 2021-2024, The Regents of the University of California, through Lawrence Berkeley National Laboratory (subject to receipt of any required approvals from the U.S. Dept. of Energy), Shahzeb Siddiqui, and Vanessa Sochat. All rights reserved..

Built with Sphinx using a theme provided by Read the Docs.