• buildtest API Reference
  • buildtest
    • Subpackages
      • buildtest.builders
        • Submodules
          • buildtest.builders.base
            • Module Contents
              • Classes
                • BuilderBase
                  • dependency
                  • shell_detection
                  • _set_metadata_values
                  • get_test_extension
                  • is_local_executor
                  • is_batch_job
                  • start
                  • stop
                  • retry
                  • build
                  • run
                  • record_starttime
                  • record_endtime
                  • runtime
                  • get_runtime
                  • state
                  • failed
                  • complete
                  • running
                  • is_pending
                  • is_complete
                  • is_failed
                  • is_running
                  • copy_stage_files
                  • _build_setup
                  • _write_build_script
                  • _write_test
                  • save_artifacts
                  • _emit_command
                  • _default_test_variables
                  • sched_init
                  • get_job_directives
                  • _get_burst_buffer
                  • _get_data_warp
                  • _set_execute_perm
                  • _get_environment
                  • _get_variables
                  • add_metrics
                  • output
                  • error
                  • generate_script
                  • post_run_steps
                  • _check_regex
                  • _returncode_check
                  • _check_runtime
                  • check_test_state
                  • _process_compiler_config
                  • __str__
                  • __repr__
          • buildtest.builders.compiler
            • Module Contents
              • Classes
                • CompilerBuilder
                  • type
                  • lang_ext_table
                  • cc
                  • cxx
                  • fc
                  • ldflags
                  • cflags
                  • cxxflags
                  • fflags
                  • cppflags
                  • setup
                  • generate_script
                  • _resolve_source
                  • _detect_lang
                  • _compile_cmd
                  • _run_cmd
                  • _process_compiler_config
                  • set_cc
                  • set_cxx
                  • set_fc
                  • set_cflags
                  • set_fflags
                  • set_cxxflags
                  • set_cppflags
                  • set_ldflags
                  • get_cc
                  • get_cxx
                  • get_fc
                  • get_cflags
                  • get_cxxflags
                  • get_fflags
                  • get_cppfilags
                  • get_ldflags
                  • get_path
          • buildtest.builders.script
            • Module Contents
              • Classes
                • ScriptBuilder
                  • type
                  • resolve_compilers
                  • write_python_script
                  • generate_script
          • buildtest.builders.spack
            • Module Contents
              • Classes
                • SpackBuilder
                  • type
                  • generate_script
                  • _spack_test
                  • _resolve_spack_root
                  • _spack_environment
      • buildtest.buildsystem
        • Submodules
          • buildtest.buildsystem.builders
            • Module Contents
              • Classes
                • Builder
                  • filter_by_executor_type
                  • _create_builders_procs
                  • _generate_builders
                  • _build_compilers
                  • _skip_tests_by_tags
                  • _skip_tests_by_type
                  • get_builders
                  • get_filtered_buildspec
          • buildtest.buildsystem.parser
            • Module Contents
              • Classes
                • BuildspecParser
                  • __str__
                  • __repr__
                  • _check_schema_type
                  • _check_executor
                  • validate
                  • get_test_names
      • buildtest.cli
        • Submodules
          • buildtest.cli.build
            • Module Contents
              • Classes
              • Functions
              • Attributes
                • logger
                • Tee
                  • __enter__
                  • __exit__
                  • write
                  • flush
                • resolve_testdirectory
                • discover_buildspecs
                • print_discovered_buildspecs
                • discover_buildspecs_by_tags
                • discover_buildspecs_by_executor
                • discover_by_buildspecs
                • print_filters
                • BuildTest
                  • load_rerun_file
                  • save_rerun_file
                  • _validate_filters
                  • discovered_buildspecs
                  • build
                  • parse_buildspecs
                  • build_phase
                  • run_phase
                  • build_success
                  • _print_test_summary
                  • _update_build_history
                  • get_build_history_dir
                  • print_builders
                • update_report
          • buildtest.cli.buildspec
            • Module Contents
              • Classes
              • Functions
              • Attributes
                • logger
                • BuildspecCache
                  • table
                  • filter_fields
                  • default_format_fields
                  • format_fields
                  • get_cache
                  • load_paths
                  • build
                  • _discover_buildspecs
                  • _write_buildspec_cache
                  • _validate_buildspecs
                  • get_names
                  • lookup_buildspec_by_name
                  • build_cache
                  • _check_filter_fields
                  • _check_format_fields
                  • _filter_buildspecs
                  • find_buildspecs
                  • get_valid_buildspecs
                  • get_invalid_buildspecs
                  • get_unique_tags
                  • get_unique_executors
                  • get_maintainers
                  • get_paths
                  • tag_breakdown
                  • executor_breakdown
                  • test_breakdown_by_buildspec
                  • print_buildspecfiles
                  • print_tags
                  • print_executors
                  • print_by_executors
                  • print_by_tags
                  • print_buildspecs
                  • list_maintainers
                  • print_maintainer
                  • print_maintainers_by_buildspecs
                  • print_invalid_buildspecs
                  • print_filter_fields
                  • print_format_fields
                  • print_paths
                • edit_buildspec_test
                • edit_buildspec_file
                • show_buildspecs
                • buildspec_validate
                • summarize_buildspec_cache
                • buildspec_find
          • buildtest.cli.cd
            • Module Contents
              • Functions
                • change_directory
          • buildtest.cli.cdash
            • Module Contents
              • Functions
                • cdash_cmd
                • upload_test_cdash
          • buildtest.cli.clean
            • Module Contents
              • Functions
                • clean
          • buildtest.cli.compilers
            • Module Contents
              • Classes
              • Functions
                • compiler_cmd
                • compiler_find
                • BuildtestCompilers
                  • compiler_table
                  • find_compilers
                  • _validate_modules
                  • _update_compiler_section
                  • print_json
                  • print_yaml
                  • names
                  • print_compilers
          • buildtest.cli.config
            • Module Contents
              • Functions
                • config_cmd
                • edit_configuration
                • view_system
                • validate_config
                • view_configuration
                • view_executors
          • buildtest.cli.debugreport
            • Module Contents
              • Functions
                • print_debug_report
          • buildtest.cli.help
            • Module Contents
              • Functions
                • print_build_help
                • print_buildspec_help
                • print_config_help
                • print_inspect_help
                • print_report_help
                • print_history_help
                • print_cdash_help
                • print_schema_help
                • print_stylecheck_help
                • print_unittests_help
                • print_path_help
                • buildtest_help
          • buildtest.cli.history
            • Module Contents
              • Functions
              • Attributes
                • logger
                • build_history
                • sorted_alphanumeric
                • list_build_history
                • query_builds
          • buildtest.cli.inspect
            • Module Contents
              • Functions
                • inspect_cmd
                • fetch_test_names
                • inspect_list
                • inspect_query
                • inspect_buildspec
                • inspect_by_name
          • buildtest.cli.path
            • Module Contents
              • Functions
                • path_cmd
          • buildtest.cli.report
            • Module Contents
              • Classes
              • Functions
              • Attributes
                • logger
                • is_int
                • Report
                  • format_field_description
                  • filter_field_description
                  • format_fields
                  • filter_fields
                  • display_table
                  • reportfile
                  • get
                  • _check_filter_fields
                  • _check_format_fields
                  • load
                  • filter_buildspecs_from_report
                  • _filter_by_names
                  • _filter_by_tags
                  • _filter_by_executor
                  • _filter_by_state
                  • _filter_by_returncode
                  • process_report
                  • print_format_fields
                  • print_filter_fields
                  • print_report
                  • latest_testid_by_name
                  • get_names
                  • get_buildspecs
                  • get_testids
                  • _testid_lookup
                  • lookup
                  • builder_names
                  • breakdown_by_test_names
                  • fetch_records_by_ids
                • report_cmd
                • report_summary
                • print_report_summary_output
          • buildtest.cli.schema
            • Module Contents
              • Functions
                • schema_cmd
        • Package Contents
          • Functions
          • Attributes
            • BUILDTEST_COPYRIGHT
            • BUILDTEST_VERSION
            • console
            • schema_table
            • handle_kv_string
            • positive_number
            • get_parser
            • history_menu
            • build_menu
            • buildspec_menu
            • config_menu
            • report_menu
            • inspect_menu
            • schema_menu
            • cdash_menu
      • buildtest.executors
        • Submodules
          • buildtest.executors.base
            • Module Contents
              • Classes
                • BaseExecutor
                  • type
                  • add_builder
                  • get_builder
                  • load
                  • run
                  • __str__
                  • __repr__
          • buildtest.executors.cobalt
            • Module Contents
              • Classes
              • Attributes
                • logger
                • CobaltExecutor
                  • type
                  • launcher_command
                  • run
                  • poll
                  • gather
          • buildtest.executors.local
            • Module Contents
              • Classes
                • LocalExecutor
                  • type
                  • load
                  • run
          • buildtest.executors.lsf
            • Module Contents
              • Classes
              • Attributes
                • logger
                • LSFExecutor
                  • type
                  • launcher_command
                  • run
                  • poll
                  • gather
          • buildtest.executors.pbs
            • Module Contents
              • Classes
              • Attributes
                • logger
                • PBSExecutor
                  • type
                  • launcher_command
                  • run
                  • poll
                  • gather
          • buildtest.executors.setup
            • Module Contents
              • Classes
              • Attributes
                • logger
                • BuildExecutor
                  • __str__
                  • __repr__
                  • names
                  • get
                  • get_validbuilders
                  • _choose_executor
                  • setup
                  • select_builders_to_run
                  • run
                  • poll
                  • print_job_details
          • buildtest.executors.slurm
            • Module Contents
              • Classes
              • Attributes
                • logger
                • SlurmExecutor
                  • type
                  • launcher_command
                  • run
                  • poll
                  • gather
      • buildtest.scheduler
        • Submodules
          • buildtest.scheduler.cobalt
            • Module Contents
              • Classes
              • Attributes
                • logger
                • CobaltJob
                  • is_pending
                  • is_running
                  • is_complete
                  • is_suspended
                  • is_cancelled
                  • cobalt_log
                  • output_file
                  • error_file
                  • exitcode
                  • poll
                  • gather
                  • cancel
          • buildtest.scheduler.job
            • Module Contents
              • Classes
                • Job
                  • state
                  • get
                  • is_pending
                  • is_running
                  • is_suspended
                  • cancel
                  • poll
          • buildtest.scheduler.lsf
            • Module Contents
              • Classes
              • Attributes
                • logger
                • LSFJob
                  • is_pending
                  • is_running
                  • is_complete
                  • is_suspended
                  • is_failed
                  • output_file
                  • error_file
                  • exitcode
                  • poll
                  • gather
                  • cancel
          • buildtest.scheduler.pbs
            • Module Contents
              • Classes
              • Attributes
                • logger
                • PBSJob
                  • is_pending
                  • is_running
                  • is_complete
                  • is_suspended
                  • output_file
                  • error_file
                  • exitcode
                  • success
                  • fail
                  • poll
                  • gather
                  • cancel
          • buildtest.scheduler.slurm
            • Module Contents
              • Classes
              • Attributes
                • logger
                • SlurmJob
                  • is_pending
                  • is_running
                  • is_suspended
                  • is_cancelled
                  • is_complete
                  • is_failed
                  • is_out_of_memory
                  • is_timeout
                  • complete
                  • state
                  • workdir
                  • exitcode
                  • cancel
                  • poll
                  • gather
      • buildtest.schemas
        • Submodules
          • buildtest.schemas.defaults
            • Module Contents
              • Functions
              • Attributes
                • here
                • schema_table
                • schema_store
                • resolver
                • custom_validator
          • buildtest.schemas.utils
            • Module Contents
              • Functions
              • Attributes
                • here
                • load_schema
                • load_recipe
      • buildtest.tools
        • Submodules
          • buildtest.tools.docs
            • Module Contents
              • Functions
                • run
                • write_example
                • build_spack_examples
                • build_compiler_examples
          • buildtest.tools.modules
            • Module Contents
              • Functions
                • get_module_commands
          • buildtest.tools.stylecheck
            • Module Contents
              • Functions
                • run_black
                • run_isort
                • run_pyflakes
                • run_style_checks
          • buildtest.tools.unittests
            • Module Contents
              • Functions
              • Attributes
                • run_unit_tests
                • parser
      • buildtest.utils
        • Submodules
          • buildtest.utils.command
            • Module Contents
              • Classes
                • Capturing
                  • __enter__
                  • set_stdout
                  • set_stderr
                  • __exit__
                  • out
                  • err
                  • cleanup
                • BuildTestCommand
                  • set_command
                  • execute
                  • returncode
                  • decode
                  • get_output
                  • get_error
                  • get_command
          • buildtest.utils.file
            • Module Contents
              • Functions
                • is_file
                • is_dir
                • walk_tree
                • create_dir
                • resolve_path
                • read_file
                • write_file
                • remove_file
                • load_json
          • 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
                  • opts
                  • path
                  • __str__
                  • __repr__
                  • get
          • buildtest.utils.timer
            • Module Contents
              • Classes
                • TimerError
                • Timer
                  • start
                  • stop
                  • duration
          • buildtest.utils.tools
            • Module Contents
              • Functions
                • deep_get
    • Submodules
      • buildtest.config
        • Module Contents
          • Classes
          • Attributes
            • logger
            • SiteConfiguration
              • load
              • file
              • resolve
              • name
              • detect_system
              • validate
              • _executor_check
              • is_executor_disabled
              • _validate_local_executors
              • _validate_lsf_executors
              • _validate_slurm_executors
              • _validate_cobalt_executors
              • _validate_pbs_executors
      • buildtest.defaults
        • Module Contents
          • console
          • userhome
          • BUILDTEST_ROOT
          • SCHEMA_ROOT
          • BUILDTEST_UNITTEST_ROOT
          • BUILDTEST_USER_HOME
          • USER_SETTINGS_FILE
          • 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
          • DEFAULT_SETTINGS_FILE
          • TUTORIALS_SETTINGS_FILE
          • DEFAULT_SETTINGS_SCHEMA
      • buildtest.exceptions
        • Module Contents
          • BuildTestError
            • __str__
          • BuildspecError
            • __str__
          • ExecutorError
          • RuntimeFailure
          • ConfigurationError
            • __str__
      • buildtest.log
        • Module Contents
          • Functions
            • init_logfile
      • buildtest.main
        • Module Contents
          • Functions
            • main
      • buildtest.system
        • Module Contents
          • Classes
            • BuildTestSystem
              • system
              • supported_platforms
              • get
              • check
              • check_scheduler
              • detect_module_tool
            • Scheduler
              • logger
              • check_binaries
              • active
            • Slurm
              • binaries
              • active
              • _get_partitions
              • _get_clusters
              • _get_qos
            • LSF
              • binaries
              • _get_queues
            • Cobalt
              • binaries
              • _get_queues
            • PBS
              • binaries
              • check
              • _get_queues
    • Package Contents
      • BUILDTEST_VERSION
      • __version__
      • BUILDTEST_COPYRIGHT