Logo
devel

Background

  • Summary of buildtest

Getting Started

  • Installing buildtest
  • Quick Start Guide

Tutorial

  • Buildtest 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
  • Buildtest Schemas
  • 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
  • Docs »
  • <no title>
  • Edit on GitHub
Next Previous

  • 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_slurm_executor()
                    • BuilderBase.is_batch_job()
                    • BuilderBase.start()
                    • BuilderBase.stop()
                    • BuilderBase.retry()
                    • BuilderBase.build()
                    • BuilderBase.run()
                    • 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.copy_stage_files()
                    • BuilderBase._build_setup()
                    • BuilderBase._write_build_script()
                    • BuilderBase._write_test()
                    • BuilderBase._emit_command()
                    • BuilderBase._default_test_variables()
                    • BuilderBase.sched_init()
                    • BuilderBase.get_job_directives()
                    • BuilderBase._get_burst_buffer()
                    • BuilderBase._get_data_warp()
                    • BuilderBase._set_execute_perm()
                    • BuilderBase._get_environment()
                    • BuilderBase._get_variables()
                    • BuilderBase.add_metrics()
                    • 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__()
                  • BuilderBase
                    • dependency
                    • shell_detection
                    • _set_metadata_values
                    • get_test_extension
                    • is_local_executor
                    • is_slurm_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
                    • _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
                    • is_valid_metric
                    • check_test_state
                    • _process_compiler_config
                    • __str__
                    • __repr__
            • buildtest.builders.compiler
              • Module Contents
                • Classes
                  • CompilerBuilder
                    • CompilerBuilder.type
                    • CompilerBuilder.lang_ext_table
                    • CompilerBuilder.cc
                    • CompilerBuilder.cxx
                    • CompilerBuilder.fc
                    • CompilerBuilder.ldflags
                    • CompilerBuilder.cflags
                    • CompilerBuilder.cxxflags
                    • CompilerBuilder.fflags
                    • CompilerBuilder.cppflags
                    • CompilerBuilder.setup()
                    • CompilerBuilder.generate_script()
                    • CompilerBuilder._resolve_source()
                    • CompilerBuilder._detect_lang()
                    • CompilerBuilder._compile_cmd()
                    • CompilerBuilder._run_cmd()
                    • CompilerBuilder._process_compiler_config()
                    • CompilerBuilder.set_cc()
                    • CompilerBuilder.set_cxx()
                    • CompilerBuilder.set_fc()
                    • CompilerBuilder.set_cflags()
                    • CompilerBuilder.set_fflags()
                    • CompilerBuilder.set_cxxflags()
                    • CompilerBuilder.set_cppflags()
                    • CompilerBuilder.set_ldflags()
                    • CompilerBuilder.get_cc()
                    • CompilerBuilder.get_cxx()
                    • CompilerBuilder.get_fc()
                    • CompilerBuilder.get_cflags()
                    • CompilerBuilder.get_cxxflags()
                    • CompilerBuilder.get_fflags()
                    • CompilerBuilder.get_cppfilags()
                    • CompilerBuilder.get_ldflags()
                    • CompilerBuilder.get_path()
                  • 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
                    • ScriptBuilder.type
                    • ScriptBuilder.resolve_compilers()
                    • ScriptBuilder.write_python_script()
                    • ScriptBuilder.generate_script()
                  • ScriptBuilder
                    • type
                    • resolve_compilers
                    • write_python_script
                    • generate_script
            • buildtest.builders.spack
              • Module Contents
                • Classes
                  • SpackBuilder
                    • SpackBuilder.type
                    • SpackBuilder.generate_script()
                    • SpackBuilder._spack_test()
                    • SpackBuilder._resolve_spack_root()
                    • SpackBuilder._spack_environment()
                  • SpackBuilder
                    • type
                    • generate_script
                    • _spack_test
                    • _resolve_spack_root
                    • _spack_environment
        • buildtest.buildsystem
          • Submodules
            • buildtest.buildsystem.builders
              • Module Contents
                • Classes
                  • Builder
                    • Builder.filter_by_executor_type()
                    • Builder.create_script_builders()
                    • Builder.create_compiler_builders()
                    • Builder.create_spack_builders()
                    • Builder.generate_builders()
                    • Builder.build()
                    • Builder._skip_tests_by_tags()
                    • Builder._skip_tests_by_type()
                    • Builder.get_builders()
                    • Builder.get_filtered_buildspec()
                  • Builder
                    • filter_by_executor_type
                    • create_script_builders
                    • create_compiler_builders
                    • create_spack_builders
                    • generate_builders
                    • build
                    • _skip_tests_by_tags
                    • _skip_tests_by_type
                    • get_builders
                    • get_filtered_buildspec
            • buildtest.buildsystem.checks
              • Module Contents
                • Functions
                • Attributes
                  • logger
                  • is_metrics_defined()
                  • returncode_check()
                  • runtime_check()
                  • regex_check()
                  • exists_check()
                  • is_file_check()
                  • is_dir_check()
                  • convert_metrics()
                  • assert_ge_check()
                  • assert_le_check()
                  • assert_gt_check()
                  • assert_eq_check()
                  • assert_ne_check()
                  • contains_check()
                  • notcontains_check()
                  • assert_range_check()
                  • logger
                  • is_metrics_defined
                  • returncode_check
                  • runtime_check
                  • regex_check
                  • exists_check
                  • is_file_check
                  • is_dir_check
                  • convert_metrics
                  • assert_ge_check
                  • assert_le_check
                  • assert_gt_check
                  • assert_eq_check
                  • assert_ne_check
                  • contains_check
                  • notcontains_check
                  • assert_range_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()
                  • 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
                    • Tee.__enter__()
                    • Tee.__exit__()
                    • Tee.write()
                    • Tee.flush()
                  • resolve_testdirectory()
                  • discover_buildspecs()
                  • print_discovered_buildspecs()
                  • discover_buildspecs_by_tags()
                  • discover_buildspecs_by_executor()
                  • discover_by_buildspecs()
                  • print_filters()
                  • BuildTest
                    • BuildTest.load_rerun_file()
                    • BuildTest.save_rerun_file()
                    • BuildTest._validate_filters()
                    • BuildTest.discovered_buildspecs()
                    • 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()
                  • 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_by_type
                    • print_batch_builders
                    • 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()
                  • show_buildspecs()
                  • show_failed_buildspecs()
                  • buildspec_validate()
                  • summarize_buildspec_cache()
                  • summary_print()
                  • buildspec_maintainers()
                  • buildspec_find()
                  • logger
                  • BuildspecCache
                    • table
                    • filter_fields
                    • default_format_fields
                    • format_fields
                    • get_cache
                    • load_paths
                    • build
                    • _discover_buildspecs
                    • _write_buildspec_cache
                    • _validate_buildspecs
                    • get_names
                    • get_random_tests
                    • 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_find
                    • print_maintainers_by_buildspecs
                    • print_invalid_buildspecs
                    • print_filter_fields
                    • print_format_fields
                    • print_raw_filter_fields
                    • print_raw_format_fields
                    • print_paths
                  • edit_buildspec_test
                  • edit_buildspec_file
                  • show_buildspecs
                  • show_failed_buildspecs
                  • buildspec_validate
                  • summarize_buildspec_cache
                  • summary_print
                  • buildspec_maintainers
                  • buildspec_find
            • buildtest.cli.cd
              • Module Contents
                • Functions
                  • change_directory()
                  • change_directory
            • buildtest.cli.cdash
              • Module Contents
                • Functions
                  • cdash_cmd()
                  • view_cdash_project()
                  • upload_test_cdash()
                  • cdash_cmd
                  • view_cdash_project
                  • upload_test_cdash
            • buildtest.cli.clean
              • Module Contents
                • Functions
                  • clean()
                  • clean
            • buildtest.cli.compilers
              • Module Contents
                • Classes
                • Functions
                  • compiler_cmd()
                  • 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()
                  • compiler_cmd
                  • compiler_test
                  • 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_path()
                  • view_configuration()
                  • view_executors()
                  • config_cmd
                  • edit_configuration
                  • view_system
                  • validate_config
                  • view_path
                  • view_configuration
                  • view_executors
            • buildtest.cli.debugreport
              • Module Contents
                • Functions
                  • print_debug_report()
                  • 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()
                  • 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.helpcolor
              • Module Contents
                • Functions
                  • print_available_colors()
                  • print_available_colors
            • buildtest.cli.history
              • Module Contents
                • Functions
                • Attributes
                  • logger
                  • build_history()
                  • sorted_alphanumeric()
                  • list_build_history()
                  • query_builds()
                  • logger
                  • build_history
                  • sorted_alphanumeric
                  • list_build_history
                  • query_builds
            • buildtest.cli.info
              • Module Contents
                • Functions
                  • buildtest_info()
                  • buildtest_info
            • buildtest.cli.inspect
              • Module Contents
                • Functions
                  • inspect_cmd()
                  • fetch_test_names()
                  • inspect_list()
                  • inspect_query()
                  • inspect_buildspec()
                  • inspect_by_name()
                  • inspect_cmd
                  • fetch_test_names
                  • inspect_list
                  • inspect_query
                  • inspect_buildspec
                  • inspect_by_name
            • buildtest.cli.path
              • Module Contents
                • Functions
                  • path_cmd()
                  • path_cmd
            • buildtest.cli.report
              • Module Contents
                • Classes
                • Functions
                • Attributes
                  • logger
                  • is_int()
                  • Report
                    • Report.format_field_description
                    • Report.filter_field_description
                    • Report.format_fields
                    • Report.filter_fields
                    • Report.display_table
                    • Report.reportfile()
                    • Report.get()
                    • Report._check_filter_fields()
                    • Report._check_format_fields()
                    • Report._check_start_and_end_fields()
                    • Report.load()
                    • 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.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_cmd()
                  • report_summary()
                  • print_report_summary_output()
                  • logger
                  • is_int
                  • Report
                    • format_field_description
                    • filter_field_description
                    • format_fields
                    • filter_fields
                    • display_table
                    • reportfile
                    • get
                    • _check_filter_fields
                    • _check_format_fields
                    • _check_start_and_end_fields
                    • load
                    • filter_buildspecs_from_report
                    • filter_by_start_end
                    • _filter_by_names
                    • _filter_by_tags
                    • _filter_by_executor
                    • _filter_by_state
                    • _filter_by_returncode
                    • process_report
                    • print_format_fields
                    • print_filter_fields
                    • print_raw_filter_fields
                    • print_raw_format_fields
                    • print_report
                    • latest_testid_by_name
                    • get_names
                    • get_random_tests
                    • get_buildspecs
                    • get_test_by_state
                    • get_testids
                    • _testid_lookup
                    • lookup
                    • builder_names
                    • get_random_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()
                  • schema_cmd
            • buildtest.cli.stats
              • Module Contents
                • Functions
                  • stats_cmd()
                  • stats_cmd
          • Package Contents
            • Functions
            • Attributes
              • BUILDTEST_COPYRIGHT
              • BUILDTEST_VERSION
              • console
              • schema_table
              • handle_kv_string()
              • positive_number()
              • supported_color()
              • valid_time()
              • get_parser()
              • misc_menu()
              • stylecheck_menu()
              • unittest_menu()
              • tutorial_examples_menu()
              • path_menu()
              • history_menu()
              • build_menu()
              • buildspec_menu()
              • config_menu()
              • report_menu()
              • inspect_menu()
              • schema_menu()
              • cdash_menu()
              • BUILDTEST_COPYRIGHT
              • BUILDTEST_VERSION
              • console
              • schema_table
              • handle_kv_string
              • positive_number
              • supported_color
              • valid_time
              • get_parser
              • misc_menu
              • stylecheck_menu
              • unittest_menu
              • tutorial_examples_menu
              • path_menu
              • 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
                    • BaseExecutor.type
                    • BaseExecutor.add_builder()
                    • BaseExecutor.get_builder()
                    • BaseExecutor.load()
                    • BaseExecutor.run()
                    • BaseExecutor.__str__()
                    • BaseExecutor.__repr__()
                  • BaseExecutor
                    • type
                    • add_builder
                    • get_builder
                    • load
                    • run
                    • __str__
                    • __repr__
            • buildtest.executors.cobalt
              • Module Contents
                • Classes
                • Attributes
                  • logger
                  • CobaltExecutor
                    • CobaltExecutor.type
                    • CobaltExecutor.launcher_command()
                    • CobaltExecutor.run()
                    • CobaltExecutor.poll()
                    • CobaltExecutor.gather()
                  • logger
                  • CobaltExecutor
                    • type
                    • launcher_command
                    • run
                    • poll
                    • gather
            • buildtest.executors.local
              • Module Contents
                • Classes
                  • LocalExecutor
                    • LocalExecutor.type
                    • LocalExecutor.load()
                    • LocalExecutor.run()
                  • LocalExecutor
                    • type
                    • load
                    • run
            • buildtest.executors.lsf
              • Module Contents
                • Classes
                • Attributes
                  • logger
                  • LSFExecutor
                    • LSFExecutor.type
                    • LSFExecutor.launcher_command()
                    • LSFExecutor.run()
                    • LSFExecutor.poll()
                    • LSFExecutor.gather()
                  • logger
                  • LSFExecutor
                    • type
                    • launcher_command
                    • run
                    • poll
                    • gather
            • buildtest.executors.pbs
              • Module Contents
                • Classes
                • Attributes
                  • logger
                  • PBSExecutor
                    • PBSExecutor.type
                    • PBSExecutor.launcher_command()
                    • PBSExecutor.run()
                    • PBSExecutor.poll()
                    • PBSExecutor.gather()
                  • logger
                  • PBSExecutor
                    • type
                    • launcher_command
                    • run
                    • poll
                    • gather
            • 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.run()
                    • BuildExecutor.poll()
                    • BuildExecutor.print_job_details()
                  • 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
                    • SlurmExecutor.type
                    • SlurmExecutor.launcher_command()
                    • SlurmExecutor.run()
                    • SlurmExecutor.poll()
                    • SlurmExecutor.gather()
                  • logger
                  • SlurmExecutor
                    • type
                    • launcher_command
                    • run
                    • poll
                    • gather
        • buildtest.scheduler
          • Submodules
            • buildtest.scheduler.cobalt
              • Module Contents
                • Classes
                • Attributes
                  • logger
                  • CobaltJob
                    • CobaltJob.is_pending()
                    • CobaltJob.is_running()
                    • CobaltJob.is_complete()
                    • CobaltJob.is_suspended()
                    • CobaltJob.is_cancelled()
                    • CobaltJob.cobalt_log()
                    • CobaltJob.output_file()
                    • CobaltJob.error_file()
                    • CobaltJob.exitcode()
                    • CobaltJob.poll()
                    • CobaltJob.gather()
                    • CobaltJob.cancel()
                  • 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
                    • Job.state()
                    • Job.get()
                    • Job.is_pending()
                    • Job.is_running()
                    • Job.is_suspended()
                    • Job.cancel()
                    • Job.poll()
                  • Job
                    • state
                    • get
                    • is_pending
                    • is_running
                    • is_suspended
                    • cancel
                    • poll
            • 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.output_file()
                    • LSFJob.error_file()
                    • LSFJob.exitcode()
                    • LSFJob.poll()
                    • LSFJob.gather()
                    • LSFJob.cancel()
                  • 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
                    • PBSJob.is_pending()
                    • PBSJob.is_running()
                    • PBSJob.is_complete()
                    • PBSJob.is_suspended()
                    • PBSJob.output_file()
                    • PBSJob.error_file()
                    • PBSJob.exitcode()
                    • PBSJob.success()
                    • PBSJob.fail()
                    • PBSJob.poll()
                    • PBSJob.gather()
                    • PBSJob.cancel()
                  • 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
                    • 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.exitcode()
                    • SlurmJob.cancel()
                    • SlurmJob.poll()
                    • SlurmJob.gather()
                  • 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()
                  • here
                  • schema_table
                  • schema_store
                  • resolver
                  • custom_validator
            • buildtest.schemas.utils
              • Module Contents
                • Functions
                • Attributes
                  • here
                  • load_schema()
                  • load_recipe()
                  • here
                  • load_schema
                  • load_recipe
        • buildtest.tools
          • Submodules
            • buildtest.tools.docs
              • Module Contents
                • Functions
                  • run()
                  • write_example()
                  • build_spack_examples()
                  • build_compiler_examples()
                  • run
                  • write_example
                  • build_spack_examples
                  • build_compiler_examples
            • buildtest.tools.editor
              • Module Contents
                • Functions
                  • set_editor()
                  • set_editor
            • buildtest.tools.modules
              • Module Contents
                • Functions
                  • get_module_commands()
                  • get_module_commands
            • buildtest.tools.stylecheck
              • Module Contents
                • Functions
                  • run_black()
                  • run_isort()
                  • run_pyflakes()
                  • run_style_checks()
                  • run_black
                  • run_isort
                  • run_pyflakes
                  • run_style_checks
            • buildtest.tools.tutorialexamples
              • Module Contents
                • Functions
                  • generate_tutorial_examples()
                  • generate_tutorial_examples
            • buildtest.tools.unittests
              • Module Contents
                • Functions
                • Attributes
                  • here
                  • run_unit_tests()
                  • parser
                  • here
                  • run_unit_tests
                  • parser
        • buildtest.utils
          • Submodules
            • buildtest.utils.command
              • Module Contents
                • Classes
                  • Capturing
                    • Capturing.out
                    • Capturing.err
                    • Capturing.__enter__()
                    • Capturing.set_stdout()
                    • Capturing.set_stderr()
                    • Capturing.__exit__()
                    • Capturing.cleanup()
                  • BuildTestCommand
                    • BuildTestCommand.execute()
                    • BuildTestCommand.returncode()
                    • BuildTestCommand.decode()
                    • BuildTestCommand.get_output()
                    • BuildTestCommand.get_error()
                    • BuildTestCommand.get_command()
                  • Capturing
                    • out
                    • err
                    • __enter__
                    • set_stdout
                    • set_stderr
                    • __exit__
                    • cleanup
                  • BuildTestCommand
                    • 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()
                  • 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
                    • Shell.opts
                    • Shell.path
                    • Shell.__str__()
                    • Shell.__repr__()
                    • Shell.get()
                  • 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
                    • Timer.start()
                    • Timer.stop()
                    • Timer.duration()
                  • TimerError
                  • Timer
                    • start
                    • stop
                    • duration
            • buildtest.utils.tools
              • Module Contents
                • Functions
                  • deep_get()
                  • checkColor()
                  • deep_get
                  • checkColor
      • 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.is_executor_disabled()
                • SiteConfiguration._validate_local_executors()
                • SiteConfiguration._validate_lsf_executors()
                • SiteConfiguration._validate_slurm_executors()
                • SiteConfiguration._validate_cobalt_executors()
                • SiteConfiguration._validate_pbs_executors()
              • logger
              • SiteConfiguration
                • file
                • load
                • 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
            • 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
              • BuildTestError.__str__()
            • BuildspecError
              • BuildspecError.get_exception()
            • InvalidBuildspec
            • InvalidBuildspecSchemaType
            • InvalidBuildspecExecutor
            • ExecutorError
            • RuntimeFailure
            • ConfigurationError
              • ConfigurationError.__str__()
            • BuildTestError
              • __str__
            • BuildspecError
              • get_exception
            • InvalidBuildspec
            • InvalidBuildspecSchemaType
            • InvalidBuildspecExecutor
            • ExecutorError
            • RuntimeFailure
            • ConfigurationError
              • __str__
        • buildtest.log
          • Module Contents
            • Functions
              • init_logfile()
              • init_logfile
        • buildtest.main
          • Module Contents
            • Functions
              • main()
              • main
        • buildtest.system
          • Module Contents
            • Classes
              • BuildTestSystem
                • BuildTestSystem.system
                • BuildTestSystem.supported_platforms
                • BuildTestSystem.get()
                • BuildTestSystem.check()
                • BuildTestSystem.check_scheduler()
                • BuildTestSystem.detect_module_tool()
              • Scheduler
                • Scheduler.logger
                • Scheduler.check_binaries()
                • Scheduler.active()
              • Slurm
                • Slurm.binaries
                • Slurm.active()
                • Slurm._get_partitions()
                • Slurm._get_clusters()
                • Slurm._get_qos()
              • LSF
                • LSF.binaries
                • LSF._get_queues()
              • Cobalt
                • Cobalt.binaries
                • Cobalt._get_queues()
              • PBS
                • PBS.binaries
                • PBS.check()
                • PBS._get_queues()
              • 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
        • BUILDTEST_VERSION
        • __version__
        • BUILDTEST_COPYRIGHT
Next Previous

© Copyright Copyright (c) 2021-2023, 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. Revision 87cbe8c0.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: devel
Versions
latest
stable
v1.1
v1.0
v0.15.0
v0.14.0
v0.13.0
v0.12.0
v0.11.0
v0.10.2
v0.10.0
v0.9.6
v0.9.0
v0.8.0
devel
Downloads
pdf
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.