ramble.test package

Subpackages

• ramble.test.cmd namespace
  • Submodules
  • ramble.test.cmd.attributes module
    • maintained_apps()
    • maintained_mods()
    • mock_maintainers()
    • mock_tags()
    • tagged_apps()
    • tagged_mods()
    • test_attributes_runs()
    • test_mock_attributes_list()
    • unmaintained_apps()
    • unmaintained_mods()
    • untagged_apps()
    • untagged_mods()
  • ramble.test.cmd.clean module
    • mock_calls_for_clean()
    • test_function_calls()
  • ramble.test.cmd.config module
    • check_config_updated()
    • config_yaml_v015()
    • mock_editor()
    • section_args()
    • test_command_alias()
    • test_config_add()
    • test_config_add_from_file()
    • test_config_add_from_file_multiple()
    • test_config_add_invalid_file_fails()
    • test_config_add_list()
    • test_config_add_ordered_dict()
    • test_config_add_override()
    • test_config_add_override_from_file()
    • test_config_add_override_leaf()
    • test_config_add_override_leaf_from_file()
    • test_config_add_to_workspace()
    • test_config_add_to_workspace_preserve_comments()
    • test_config_add_to_workspace_preserve_multiline_str()
    • test_config_add_update_dict()
    • test_config_edit()
    • test_config_edit_edits_ramble_yaml()
    • test_config_edit_fails_correctly_with_no_workspace()
    • test_config_edit_file()
    • test_config_get_fails_correctly_with_no_workspace()
    • test_config_get_gets_ramble_yaml()
    • test_config_list()
    • test_config_remove_alias_rm()
    • test_config_remove_dict()
    • test_config_remove_from_workspace()
    • test_config_remove_value()
    • test_config_revert()
    • test_config_update_not_needed()
    • test_config_with_c_argument()
    • test_get_config_scope()
    • test_get_config_scope_merged()
    • test_merged_applications_section()
    • test_merged_env_vars_section()
    • test_merged_software_section()
    • test_merged_success_criteria_section()
    • test_merged_variables_section()
    • test_remove_from_list()
    • test_remove_list()
  • ramble.test.cmd.debug module
    • test_debug_report()
  • ramble.test.cmd.deployment module
    • check_deployment_files()
    • test_local_deployment()
    • test_tar_deployment()
  • ramble.test.cmd.docs module
    • test_docs_opens_browser()
  • ramble.test.cmd.edit module
    • mock_editor()
    • test_edit_application()
    • test_edit_command()
    • test_edit_docs()
    • test_edit_file_not_found()
    • test_edit_modifier()
    • test_edit_module()
    • test_edit_test()
  • ramble.test.cmd.help module
    • test_help_default()
  • ramble.test.cmd.info module
    • info_lines()
    • mock_print()
    • parser()
    • test_info_conflicts_pattern()
    • test_info_directives()
    • test_info_fields()
    • test_info_object_name_formats()
    • test_it_just_runs()
    • test_mock_spack_info_software()
    • test_non_app_object_info_common_fields()
    • test_spack_info_software()
  • ramble.test.cmd.license module
    • test_verify_empty()
    • test_verify_with_error()
  • ramble.test.cmd.list module
    • test_list()
    • test_list_base_html()
    • test_list_filter()
    • test_list_format_html()
    • test_list_format_name_only()
    • test_list_format_version_json()
    • test_list_search_description()
    • test_list_tags()
    • test_list_update()
  • ramble.test.cmd.main module
    • test_command_argument_before_command_is_rejected()
    • test_unknown_global_argument_is_rejected()
  • ramble.test.cmd.mirror module
    • test_mirror_add()
    • test_mirror_destroy()
    • test_mirror_name_collision()
    • test_mirror_nonexisting()
    • test_mirror_remove()
    • test_mirror_set_push_url()
    • test_mirror_set_url()
    • tmp_scope()
    • url_check()
  • ramble.test.cmd.on module
    • test_execute_pipeline()
    • test_on_command()
    • test_on_executor()
    • test_on_executor_in_run_dir()
    • test_on_where()
  • ramble.test.cmd.python module
    • test_python()
    • test_python_interpreter_path()
    • test_python_raises()
    • test_python_version()
    • test_python_with_module()
  • ramble.test.cmd.repo module
    • test_add_behavior()
    • test_add_non_existent_repo()
    • test_add_repo_missing_config_file()
    • test_add_with_any_type_registers_all_types()
    • test_create_add_list_remove()
    • test_create_add_list_remove_flags()
    • test_help_option()
    • test_remove_from_any_scope()
  • ramble.test.cmd.results module
    • test_file_import_rejects_invalid_files()
  • ramble.test.cmd.software_definitions module
    • test_software_definitions_conflicts_output()
    • test_software_definitions_conflicts_runs()
    • test_software_definitions_error_on_conflicts()
    • test_software_definitions_runs()
    • test_software_definitions_summary()
    • test_software_definitions_unused_compilers_output()
  • ramble.test.cmd.style module
    • test_black_version_mismatch()
    • test_changed_files_all()
    • test_changed_files_git_failure()
    • test_skip_tools()
    • test_style()
    • test_style_invalid_repo()
    • test_style_tool_args()
    • test_style_tool_args_invalid_format()
    • test_style_tool_args_invalid_tool()
    • test_style_tool_args_multiple()
    • test_style_valid_repo()
    • test_style_with_error()
  • ramble.test.cmd.unit_test module
    • test_external_repo_invalid()
    • test_external_repo_valid()
    • test_failed_import()
    • test_flags_accepted()
    • test_full_list()
    • test_list_only_lib()
    • test_list_only_objects()
    • test_long_list()
    • test_pytest_help()
    • test_slow_flag()
    • test_unit_test_list()
  • ramble.test.cmd.workspace module
    • add_basic()
    • check_basic()
    • check_info_basic()
    • check_no_basic()
    • check_results()
    • remove_basic()
    • test_analyze_nothing()
    • test_anlyze_command()
    • test_concretize_command()
    • test_concretize_concrete_config()
    • test_concretize_nothing()
    • test_custom_executables_info()
    • test_custom_executables_order_info()
    • test_dryrun_noexpvars_setup()
    • test_dryrun_setup()
    • test_edit_edits_correct_paths()
    • test_edit_fails_without_workspace()
    • test_edit_override_gets_correct_path()
    • test_edit_with_faulty_config()
    • test_force_concretize()
    • test_invalid_size_matrices_workspace()
    • test_invalid_template_name_errors()
    • test_invalid_vector_workspace()
    • test_manage_modifier_add_invalid_scope_errors()
    • test_manage_modifier_index_remove()
    • test_manage_modifier_name_globs()
    • test_manage_modifier_no_modifier_errors()
    • test_manage_modifier_no_modifiers()
    • test_manage_modifier_remove_invalid_scope_errors()
    • test_manage_modifier_remove_scope_globs()
    • test_manage_single_modifiers()
    • test_matrix_vector_workspace_full()
    • test_multi_use_vector_var_matrices_workspace()
    • test_no_inherit_active_workspace_variants()
    • test_no_workspace_flag()
    • test_non_vector_var_matrices_workspace()
    • test_reconcretize_in_configs_dir()
    • test_remove_workspace()
    • test_setup_command()
    • test_setup_command_with_missing_log_dir()
    • test_setup_nothing()
    • test_undefined_var_matrices_workspace()
    • test_workspace_activate_by_dir()
    • test_workspace_activate_by_name()
    • test_workspace_activate_fails()
    • test_workspace_activate_no_args()
    • test_workspace_activate_non_existent()
    • test_workspace_activate_parent_dir()
    • test_workspace_activate_prompt()
    • test_workspace_activate_temp()
    • test_workspace_archive()
    • test_workspace_archive_include_secrets()
    • test_workspace_archive_includes_exec_logs()
    • test_workspace_config_precedence()
    • test_workspace_config_simplify_includes()
    • test_workspace_config_squash()
    • test_workspace_create_links()
    • test_workspace_create_parent_dir()
    • test_workspace_deactivate()
    • test_workspace_dir()
    • test_workspace_dirs()
    • test_workspace_experiment_logs()
    • test_workspace_flag_anon()
    • test_workspace_flag_named()
    • test_workspace_from_template()
    • test_workspace_include()
    • test_workspace_info()
    • test_workspace_info_complete()
    • test_workspace_info_prints_all_levels()
    • test_workspace_info_software()
    • test_workspace_info_with_experiment_chain()
    • test_workspace_info_with_where_filter()
    • test_workspace_list()
    • test_workspace_list_parent_dir()
    • test_workspace_no_empty_workloads()
    • test_workspace_simplify()
    • test_workspace_tar_archive()
    • test_workspace_tar_upload_archive()
    • test_workspace_tar_upload_archive_config_url()
    • write_variables_config_file()
  • ramble.test.cmd.workspace_concretize module
    • test_workspace_concretize_additive()
    • test_workspace_multispec_concretize()
  • ramble.test.cmd.workspace_deprecation module
    • test_manage_experiments_package_manager_deprecation()
    • test_manage_experiments_workflow_manager_deprecation()
  • ramble.test.cmd.workspace_manage module
    • test_manage_experiments_no_overwrite_wm_vars()
    • test_manage_variable_multiple_equals()
• ramble.test.definitions namespace
  • Submodules
  • ramble.test.definitions.test_versions module
    • TestObjectVersion
      • TestObjectVersion.test_copy()
      • TestObjectVersion.test_init()
      • TestObjectVersion.test_init_invalid_version()
      • TestObjectVersion.test_satisfies()
      • TestObjectVersion.test_str()
      • TestObjectVersion.test_version_properties()
• ramble.test.end_to_end namespace
  • Subpackages
    • ramble.test.end_to_end.perf_tests namespace
      • Submodules
      • ramble.test.end_to_end.perf_tests.analyze_perf module
      • ramble.test.end_to_end.perf_tests.large_template module
      • ramble.test.end_to_end.perf_tests.many_experiments module
      • ramble.test.end_to_end.perf_tests.many_objects_defaults module
      • ramble.test.end_to_end.perf_tests.matrix_filter_perf module
  • Submodules
  • ramble.test.end_to_end.analyze_fom_output module
    • test_analyze_fail_with_no_fom_detected()
    • test_analyze_fom_origin_types_filter()
    • test_analyze_fom_output()
    • test_analyze_garbage_output()
    • test_analyze_print()
    • test_analyze_success_with_no_fom_defined()
  • ramble.test.end_to_end.analyze_upload module
    • test_analyze_upload()
  • ramble.test.end_to_end.chained_experiment_var_inheritance module
    • test_chained_experiment_variable_inheritance()
  • ramble.test.end_to_end.chained_experiment_variant_propagation module
    • test_chained_experiment_variant_propagation()
  • ramble.test.end_to_end.cleanup_directive module
    • test_cleanup_directive()
  • ramble.test.end_to_end.concretize_with_different_package_managers module
    • test_concretize_with_different_package_managers()
  • ramble.test.end_to_end.config_section_env_vars module
    • test_config_section_env_vars()
  • ramble.test.end_to_end.configvar_dry_run module
    • test_configvar_dry_run()
  • ramble.test.end_to_end.custom_executables module
    • test_custom_executables()
    • test_executable_already_defined()
    • test_executable_override_with_force()
  • ramble.test.end_to_end.define_package_paths module
    • test_define_package_paths()
    • test_package_path_variables()
  • ramble.test.end_to_end.dryrun_chained_experiments module
    • test_dryrun_chained_experiments()
  • ramble.test.end_to_end.dryrun_copies_external_env module
    • test_dryrun_copies_external_env()
  • ramble.test.end_to_end.dryrun_series_contains_package_paths module
    • test_dryrun_series_contains_package_paths()
  • ramble.test.end_to_end.env_var_builtin module
    • test_auto_env_vars()
    • test_env_var_builtin()
    • test_env_var_from_app_only()
    • test_object_env_var_definitions()
    • test_object_env_var_methods()
  • ramble.test.end_to_end.env_var_leakage module
    • test_env_vars_do_not_leak()
  • ramble.test.end_to_end.exclusive_filtered_vector_workloads module
    • test_exclusive_filtered_vector_workloads()
  • ramble.test.end_to_end.expanded_fom_dry_run module
    • test_expanded_foms_dry_run()
  • ramble.test.end_to_end.experiment_excludes module
    • test_wrfv4_exclusions()
  • ramble.test.end_to_end.experiment_hashes module
    • test_experiment_hashes()
  • ramble.test.end_to_end.experiment_repeats module
    • test_gromacs_repeats()
    • test_repeat_info()
    • test_repeat_stats()
  • ramble.test.end_to_end.experiment_templates module
    • test_experiment_templates()
  • ramble.test.end_to_end.explicit_zips module
    • test_wrfv4_explicit_zips()
  • ramble.test.end_to_end.fom_log_file_path module
    • test_relative_fom_log_works()
  • ramble.test.end_to_end.formatted_executables module
    • test_formatted_executables()
    • test_formatted_executables_escaped_braces()
    • test_nested_formatted_executables_are_properly_formatted()
    • test_nested_formatted_executables_dependencies_are_evaluated_correctly()
    • test_object_formatted_executables()
    • test_redefined_executable_errors()
  • ramble.test.end_to_end.globbing_patterns module
    • test_globbing_patterns()
  • ramble.test.end_to_end.gromacs_size_expansion module
    • test_gromacs_size_expansion()
  • ramble.test.end_to_end.included_configuration_files module
    • test_included_configuration_files()
  • ramble.test.end_to_end.inclusive_filtered_vector_workloads module
    • test_inclusive_filtered_vector_workloads()
  • ramble.test.end_to_end.known_applications module
    • test_known_applications()
    • test_known_workflow_managers()
  • ramble.test.end_to_end.license_name module
    • license_param_core()
    • test_license_name_parent()
    • test_license_name_self_explicit()
    • test_license_name_self_implicit()
  • ramble.test.end_to_end.malformed_config module
    • test_missing_config_keys()
  • ramble.test.end_to_end.manage_software module
    • test_manage_software()
  • ramble.test.end_to_end.merge_config_files module
    • test_merge_config_files()
  • ramble.test.end_to_end.missing_required_dry_run module
    • test_missing_required_dry_run()
  • ramble.test.end_to_end.nested_compilers_are_installed module
    • test_nested_compilers_are_installed()
  • ramble.test.end_to_end.nested_config_templates module
    • test_nested_config_templates()
  • ramble.test.end_to_end.object_import module
    • test_object_import_separate_python_source()
  • ramble.test.end_to_end.object_precedence module
    • test_object_precedence_ordering()
    • test_object_precedence_variables()
  • ramble.test.end_to_end.object_validation module
    • test_object_validation()
    • test_object_variable_validation()
    • test_variable_validation_workload()
    • test_variable_validation_workload_defaults()
    • test_variable_validation_workload_group()
  • ramble.test.end_to_end.package_manager_config module
    • test_package_manager_config_zlib()
  • ramble.test.end_to_end.package_manager_provenance module
    • test_spack_package_manager_provenance_zlib()
    • test_usermanged_package_manager_provenance_zlib()
  • ramble.test.end_to_end.package_manager_requirements module
    • test_package_manager_requirements_error()
    • test_package_manager_requirements_zlib()
  • ramble.test.end_to_end.package_manager_unique_env_dirs module
    • test_env_dirs_do_not_collide()
  • ramble.test.end_to_end.passthrough_variables module
    • test_disable_passthrough()
    • test_passthrough_variables()
  • ramble.test.end_to_end.phase_profiling module
    • test_workspace_setup_phase_profiling()
  • ramble.test.end_to_end.phase_selection module
    • enable_verbose()
    • test_workspace_phase_selection()
  • ramble.test.end_to_end.phase_selection_with_dependencies module
    • enable_verbose()
    • test_workspace_phase_selection_with_dependencies()
  • ramble.test.end_to_end.registered_builtin_order module
    • test_registered_builtin_order()
  • ramble.test.end_to_end.setup_analyze module
    • test_setup_analyze()
  • ramble.test.end_to_end.shared_context module
    • test_shared_contexts()
  • ramble.test.end_to_end.shell_wrappers module
    • test_shell_wrapper_workspace_activate_missing()
    • test_shell_wrapper_workspace_lifecycle()
  • ramble.test.end_to_end.short_builtin_dep_name module
    • test_short_builtin_dep_name()
  • ramble.test.end_to_end.software_spec_injection module
    • test_existing_software_spec_does_not_inject()
    • test_software_spec_compiler_injection_works()
    • test_software_spec_injection_missing_compiler_errors()
    • test_software_spec_injection_works()
  • ramble.test.end_to_end.spack_env_cache module
    • test_spack_env_cache()
  • ramble.test.end_to_end.tag_filtering module
    • check_output()
    • test_workspace_tag_filtering()
  • ramble.test.end_to_end.target_shells module
    • test_target_shells_directive()
  • ramble.test.end_to_end.template module
    • test_executable_templates_no_trailing_spaces()
    • test_template()
    • test_template_inherited()
    • test_template_wrong_extension()
  • ramble.test.end_to_end.test_fast_tables module
    • test_tables_output()
  • ramble.test.end_to_end.unused_compilers_are_skipped module
    • test_unused_compilers_are_skipped()
  • ramble.test.end_to_end.variant_propagation module
    • test_variant_propagation_in_new_workspace()
  • ramble.test.end_to_end.vector_workloads module
    • test_vector_workloads()
  • ramble.test.end_to_end.warn_mirror_support module
    • assert_text_in_mirror_logs()
    • test_warn_mirror_support()
  • ramble.test.end_to_end.workspace_includes module
    • test_workspace_add_includes()
    • test_workspace_remove_includes_index()
    • test_workspace_remove_includes_pattern()
  • ramble.test.end_to_end.workspace_path_replacements module
    • test_workspace_dollar_paths()
  • ramble.test.end_to_end.wrfv4_dry_run module
    • test_wrfv4_no_pkg_man_dry_run()
    • test_wrfv4_spack_dry_run()
• ramble.test.modifier_functionality namespace
  • Submodules
  • ramble.test.modifier_functionality.executable_modifier_usage_filters module
    • test_executable_modifier_usage_filters()
    • test_executable_modifier_usage_filters_broken_errors()
  • ramble.test.modifier_functionality.experiment_modification module
    • test_experiment_modification()
  • ramble.test.modifier_functionality.mock_env_var_modifiers module
    • test_gromacs_dry_run_mock_env_vars_mod()
  • ramble.test.modifier_functionality.mock_layered_modifications module
    • test_layered_variable_modifications()
  • ramble.test.modifier_functionality.mock_modifier_dry_run module
    • test_gromacs_dry_run_mock_mods()
  • ramble.test.modifier_functionality.mock_modifier_phases module
    • test_gromacs_dry_run_mock_mod_phase()
  • ramble.test.modifier_functionality.mock_modifier_spack_configs module
    • test_gromacs_mock_spack_config_mod()
  • ramble.test.modifier_functionality.mock_repeated_modifications module
    • test_repeated_variable_modifications()
  • ramble.test.modifier_functionality.mock_spack_modifier module
    • test_gromacs_dry_run_mock_spack_mod()
  • ramble.test.modifier_functionality.modeless_variables module
    • test_modeless_modifier_variables()
  • ramble.test.modifier_functionality.modifier_conflicts module
    • define_experiments()
    • test_name_executables_modifier_conflict()
    • test_name_mode_executables_modifier_conflict()
    • test_name_mode_modifier_conflict()
    • test_name_modifier_conflict()
  • ramble.test.modifier_functionality.modifier_helpers module
    • check_execute_script()
    • check_software_env()
    • env_var_append_paths_modifier()
    • env_var_append_paths_modifier_answer()
    • env_var_append_vars_modifier()
    • env_var_append_vars_modifier_answer()
    • env_var_prepend_paths_modifier()
    • env_var_prepend_paths_modifier_answer()
    • env_var_set_modifier()
    • env_var_set_modifier_answer()
    • env_var_unset_modifier()
    • env_var_unset_modifier_answer()
    • intel_aps_answer()
    • intel_aps_modifier()
    • lscpu_answer()
    • lscpu_modifier()
    • named_modifier()
  • ramble.test.modifier_functionality.modifier_nested_var_dry_run module
    • test_nested_modifier_var()
  • ramble.test.modifier_functionality.modifier_prepare_analysis module
    • test_basic_dry_run_mock_prepare_analysis_mod()
  • ramble.test.modifier_functionality.multi_modifier_dry_run module
    • test_gromacs_multi_modifier_dry_run()
  • ramble.test.modifier_functionality.repeat_env_var module
    • test_modifier_repeat_env_var()
  • ramble.test.modifier_functionality.required_variables module
    • test_required_variables()
  • ramble.test.modifier_functionality.single_modifier_dry_run module
    • test_gromacs_single_full_modifier_dry_run()
    • test_gromacs_single_stub_modifier_dry_run()
• ramble.test.package_manager_functionality namespace
  • Submodules
  • ramble.test.package_manager_functionality.package_manager_general module
    • test_package_manager_names()
    • test_software_info_string()
• ramble.test.success_criteria_functionality namespace
  • Submodules
  • ramble.test.success_criteria_functionality.always_print_foms module
    • test_always_print_foms()
  • ramble.test.success_criteria_functionality.anti_match module
    • test_anti_match_criteria()
  • ramble.test.success_criteria_functionality.repeat_success_strict module
    • test_repeat_success_strict()
  • ramble.test.success_criteria_functionality.success_fom_comparison module
    • test_success_fom_comparison()
  • ramble.test.success_criteria_functionality.success_fom_globbing module
    • test_success_fom_globbing()
  • ramble.test.success_criteria_functionality.success_functions module
    • test_success_function()
  • ramble.test.success_criteria_functionality.success_modifiers module
    • test_success_criteria_with_multiple_experiments()
    • test_success_modifier()
  • ramble.test.success_criteria_functionality.success_scoping module
    • test_disconnected_success()
  • ramble.test.success_criteria_functionality.success_summary module
    • test_success_criteria_summary()
  • ramble.test.success_criteria_functionality.success_variable_fom_comparison module
    • test_success_variable_fom_comparison()
• ramble.test.systems_and_platforms namespace
  • Submodules
  • ramble.test.systems_and_platforms.system_platform_general module
    • test_platform_validator_accelerators_per_node()
    • test_platform_validator_threads_per_core()
    • test_skipping_platform_validator_threads_per_core()
    • test_system_platform_works()
    • test_system_validator_n_nodes()
    • test_system_validator_n_ranks()
• ramble.test.util namespace
  • Submodules
  • ramble.test.util.colors module
    • test_auto_escape()
    • test_auto_escape_unsupported_color()
  • ramble.test.util.conversions module
    • test_canonical_none()
    • test_convert_to_number()
    • test_list_str_to_list()
  • ramble.test.util.editor module
    • bad_exe()
    • good_exe()
    • nosuch_exe()
    • test_editor_both_bad()
    • test_editor_no_visual()
    • test_editor_no_visual_with_args()
    • test_editor_visual()
    • test_editor_visual_bad()
    • test_find_exe_from_env_var()
    • test_find_exe_from_env_var_bad_path()
    • test_find_exe_from_env_var_no_editor()
    • test_find_exe_from_env_var_with_args()
    • vim_exe()
  • ramble.test.util.env module
    • test_env_var_append_command_gen()
    • test_env_var_prepend_command_gen()
    • test_env_var_set_command_gen()
    • test_env_var_unset_command_gen()
  • ramble.test.util.file_cache module
    • cache()
    • test_cache_path()
    • test_destroy()
    • test_init()
    • test_init_entry_dir_no_access()
    • test_init_entry_existing_file()
    • test_init_entry_file_no_access()
    • test_init_entry_hierarchical()
    • test_init_entry_is_dir_error()
    • test_init_entry_new()
    • test_lock_path()
    • test_mtime()
    • test_read_non_existent()
    • test_remove()
    • test_write_and_read_transaction()
    • test_write_transaction_exception()
    • test_write_transaction_overwrite()
  • ramble.test.util.foms module
    • test_get_literal_from_regex_functionality()
    • test_get_literal_from_regex_missing_sre_parse()
  • ramble.test.util.format module
    • test_format_doc()
  • ramble.test.util.logger module
    • logger()
    • test_add_log_context()
    • test_add_log_context_exception()
    • test_add_log_context_unbalanced_nested()
    • test_aggregate_warnings()
    • test_print_aggregated_warnings()
    • test_print_warnings_immediately()
    • test_suppress_warnings()
  • ramble.test.util.module_utils module
    • TestModuleUtils
      • TestModuleUtils.test_import_non_existent_module()
  • ramble.test.util.naming module
    • test_match_pattern()
    • test_mod_to_class()
    • test_possible_ramble_module_names()
    • test_ramble_module_to_python_module()
    • test_simplify_name()
    • test_validate_fully_qualified_module_name()
    • test_validate_module_name()
  • ramble.test.util.object_utils module
    • test_filter_by_name()
  • ramble.test.util.output_capture module
    • test_output_capture()
  • ramble.test.util.path module
    • test_normalize_path_or_url()
  • ramble.test.util.shell_utils module
    • test_cmd_sub_str()
    • test_gen_dict_definition()
    • test_gen_dict_definition_error()
    • test_shell_specializations()
  • ramble.test.util.spec_utils module
    • test_specs_conflict_different_keys_no_conflict()
    • test_specs_conflict_no_conflict()
    • test_specs_conflict_none_values_ignored()
    • test_specs_conflict_simple_conflict()
    • test_specs_conflict_skip_when_different()
    • test_specs_conflict_skip_when_same()
    • test_specs_conflict_with_prefix()
  • ramble.test.util.stats module
    • test_calculate_margin_of_error()
    • test_stats_for_repeat_foms()
  • ramble.test.util.web module
    • MockGcsClient
      • MockGcsClient.bucket()
    • MockGcsClientError
    • MockUrlOpenResponse
      • MockUrlOpenResponse.geturl()
      • MockUrlOpenResponse.read()
    • test_gcs_url_exists()
    • test_get_header()
    • test_list_url_file()
    • test_push_to_url_file()
    • test_remove_url_file()
    • test_spider()
    • test_url_exists_file()
    • test_uses_ssl()
  • ramble.test.util.yaml_generation module
    • test_all_config_options()
    • test_apply_default_config_values()
    • test_get_config_value()
    • test_read_config_file()
    • test_remove_config_value()
    • test_set_config_value()
    • yaml_config()
• ramble.test.workflow_manager_functionality namespace
  • Submodules
  • ramble.test.workflow_manager_functionality.workflow_manager module
    • test_default_workflow_manager_banner()
  • ramble.test.workflow_manager_functionality.workflow_manager_foms module
    • test_workflow_manager_foms()
• ramble.test.workspace_hashing namespace
  • Submodules
  • ramble.test.workspace_hashing.unsetup_workspace_cannot_analyze module
    • test_unsetup_workspace_cannot_analyze()
  • ramble.test.workspace_hashing.workspace_name_does_not_change_hash module
    • test_workspace_name_does_not_change_hash()
  • ramble.test.workspace_hashing.workspace_setup_creates_inventory module
    • test_deterministic_workspace_hash()
    • test_workspace_setup_creates_inventory()

Submodules

ramble.test.application module

Perform tests of the Application class

class ramble.test.application.TestApplicationBase(methodName='runTest')

Bases: TestCase

test_non_reserved_variables()

ramble.test.application.basic_exp_dict()

To set expander consistently with test_wl2 of builtin.mock/applications/basic

ramble.test.application.test_app_features(mutable_mock_apps_repo, app)

ramble.test.application.test_application_copy_is_deep(app_name, wl_name, mutable_mock_apps_repo)

ramble.test.application.test_application_methods_with_default_workspace(mutable_mock_apps_repo, workspace_name)

Verify ApplicationBase methods fallback to self.workspace when workspace=None

ramble.test.application.test_basic_app(mutable_mock_apps_repo)

ramble.test.application.test_class_attributes(mutable_mock_apps_repo)

ramble.test.application.test_define_commands(mutable_mock_apps_repo)

test _define_commands

ramble.test.application.test_define_variables_for_template_path(mutable_mock_apps_repo, workspace_name)

_set_default_variables_for_template_path

ramble.test.application.test_get_executable_graph_custom_executables(mutable_mock_apps_repo)

_get_executable_graph, test3, custom executables

ramble.test.application.test_get_executable_graph_initial(mutable_mock_apps_repo)

_get_executable_graph, test1, workload executables

ramble.test.application.test_get_executable_graph_yaml_defined(mutable_mock_apps_repo)

_get_executable_graph, test2, yaml-defined order

ramble.test.application.test_register_builtin_app(mutable_mock_apps_repo)

ramble.test.application.test_required_builtins(mutable_mock_apps_repo, app)

ramble.test.application.test_set_input_path(mutable_mock_apps_repo)

_set_input_path

ramble.test.application.test_set_input_path_multi_input(mutable_mock_apps_repo)

Tests set_input_path with multiple inputs in a given workload

ramble.test.application.test_set_variables_and_variants(mutable_mock_apps_repo)

Test that set_variables defines workload variables

ramble.test.application.test_short_print(mutable_mock_apps_repo, app)

ramble.test.application.test_undefined_executable_dies(mutable_mock_apps_repo, capsys)

Test that an undefined executable causes a fatal error.

ramble.test.application.test_workload_groups(mutable_mock_apps_repo)

ramble.test.application.test_workload_groups_inherited(mutable_mock_apps_repo)

ramble.test.application_inheritance module

ramble.test.application_inheritance.test_basic_inheritance(mutable_mock_apps_repo)

ramble.test.application_language module

Perform tests of the Application class

ramble.test.application_language.add_compiler(app_inst, spec_num=1)

ramble.test.application_language.add_executable(app_inst, exe_num=1)

ramble.test.application_language.add_figure_of_merit(app_inst, fom_num=1)

ramble.test.application_language.add_input_file(app_inst, input_num=1)

ramble.test.application_language.add_software_spec(app_inst, spec_num=1)

ramble.test.application_language.add_workload(app_inst, wl_num=1)

ramble.test.application_language.test_application_type_features(app_class)

ramble.test.application_language.test_define_compiler_directive(app_class)

ramble.test.application_language.test_executable_directive(app_class)

ramble.test.application_language.test_figure_of_merit_directive(app_class)

ramble.test.application_language.test_figure_of_merit_directive_required_args()

ramble.test.application_language.test_input_file_directive(app_class)

ramble.test.application_language.test_license_name_directive(app_class)

ramble.test.application_language.test_non_reserved_variables(app_class)

ramble.test.application_language.test_software_spec_directive(app_class)

ramble.test.application_language.test_stage_files_directive_invalid_method()

ramble.test.application_language.test_stage_files_directive_method(stage_method, template_contents)

ramble.test.application_language.test_stage_files_directive_no_dst()

ramble.test.application_language.test_stage_files_directive_overwrite()

ramble.test.application_language.test_stage_files_directive_stages()

ramble.test.application_language.test_stage_files_directive_user_defined()

ramble.test.application_language.test_workload_directive(app_class)

ramble.test.application_language.test_workload_variable_workload_defaults_error()

ramble.test.application_language.test_workload_variable_workload_defaults_works()

ramble.test.cache_fetch module

ramble.test.cache_fetch.test_fetch(tmpdir, _fetch_method)

Ensure a fetch after expanding is effectively a no-op.

ramble.test.cache_fetch.test_fetch_missing_cache(tmpdir, _fetch_method)

Ensure raise a missing cache file.

ramble.test.commands module

ramble.test.commands.test_available_command()

ramble.test.commands.test_command_alias_output(mutable_config)

ramble.test.commands.test_command_output(tmpdir)

ramble.test.commands.test_missing_command()

ramble.test.concretize_builtin module

ramble.test.concretize_builtin.test_concretize_allows_invalid_experiment(mutable_config, mutable_mock_workspace_path, workspace_name)

ramble.test.concretize_builtin.test_concretize_does_not_set_required(mutable_config, mutable_mock_workspace_path, workspace_name)

Verify that concretizing an application with required set to True does not insert a required statement into software dict.

ramble.test.config module

ramble.test.config.test_default_configs_no_conflict(default_config)

Ensure the hard-coded config_defaults do not conflict with etc/defaults/config.yaml

ramble.test.config.test_duplicate_key_warning(capsys)

ramble.test.config.test_process_config_path_error(config, expected_error)

ramble.test.config.test_unhashable_yaml_keys_coverage()

ramble.test.context module

class ramble.test.context.TestContext(methodName='runTest')

Bases: TestCase

test_to_workspace_config()

test_to_workspace_config_all_attributes()

ramble.test.dry_run_helpers module

class ramble.test.dry_run_helpers.SCOPES(*values)

Bases: Enum

application = 2

experiment = 4

workload = 3

workspace = 1

ramble.test.dry_run_helpers.dry_run_config(section_name, injections, config_path, app_name, wl_name, batch_cmd='batch_submit')

Creates a new configuration with modifiers injected

Input argument injections is a list of tuples. Each tuple has two values, and takes the form:

(scope, injection_dict)

scope is the scope the injection dict should be injected into injection_dict is a dict representing the new injection into the config

config_path is the path to the config file that should be written

ramble.test.dry_run_helpers.search_files_for_string(file_list, string)

ramble.test.expander module

ramble.test.expander.build_variant_set()

ramble.test.expander.exp_dict()

ramble.test.expander.test_expand_var_name(input, output)

ramble.test.expander.test_expansion_namespaces()

ramble.test.expander.test_expansions(input, output, no_expand_vars, passes)

ramble.test.expander.test_extra_vars_propagation()

Test that extra_vars are propagated properly

ramble.test.expander.test_satisfies_works(input_list, output)

ramble.test.expander.test_typed_expansions(input, output, no_expand_vars, passes)

ramble.test.expander.test_variable_mutation()

Test that variable changes are reflected in expansions

ramble.test.experiment_result module

Tests on the ExperimentResult class

ramble.test.experiment_result.experiment_result()

Returns a basic experiment result

ramble.test.experiment_result.test_analyze_experiments_skips_none_fom(mutable_mock_apps_repo, monkeypatch, tmpdir)

Test that _analyze_experiments skips FOMs when value group is None

ramble.test.experiment_result.test_experiment_result_cache_invalidation_hash_change(tmpdir, experiment_result)

Test that the cache is invalidated if the experiment hash changes

ramble.test.experiment_result.test_experiment_result_cache_invalidation_new_file(tmpdir, experiment_result)

Test that the cache is invalidated if a file is newer than the cache

ramble.test.experiment_result.test_experiment_result_get_newest_experiment_file(tmpdir)

Test that the newest experiment file is found correctly

ramble.test.experiment_result.test_experiment_result_read_write_cache(tmpdir, experiment_result)

Test that the cache is written and read correctly

ramble.test.experiment_result.test_experiment_result_to_dict(mutable_mock_apps_repo)

ramble.test.experiment_result.test_extract_inmem_foms_skips_none(mutable_mock_apps_repo)

Test that extract_inmem_foms skips FOMs with None value

ramble.test.experiment_result.test_get_newest_experiment_file_inner_file_not_found(tmpdir, monkeypatch)

Test that FileNotFoundError is handled in inner loop of get_newest_experiment_file

ramble.test.experiment_result.test_get_newest_experiment_file_outer_file_not_found(tmpdir, monkeypatch)

Test that FileNotFoundError is handled in outer loop of get_newest_experiment_file

ramble.test.experiment_set module

ramble.test.experiment_set.test_chained_cycle_errors(workspace_name)

ramble.test.experiment_set.test_chained_experiment_has_correct_directory(workspace_name)

ramble.test.experiment_set.test_chained_experiments(workspace_name)

Test that chained experiments are rendered correctly.

ramble.test.experiment_set.test_chained_experiments_populate_new_experiments(workspace_name)

ramble.test.experiment_set.test_chained_invalid_order_errors(workspace_name)

ramble.test.experiment_set.test_cross_experiment_missing_experiment_errors(workspace_name)

ramble.test.experiment_set.test_cross_experiment_variable_references(workspace_name)

ramble.test.experiment_set.test_custom_executables_track_variables(workspace_name)

ramble.test.experiment_set.test_experiment_names_match(workspace_name)

ramble.test.experiment_set.test_explicit_zips_in_matrix(workspace_name)

ramble.test.experiment_set.test_explicit_zips_unconsumed(workspace_name)

ramble.test.experiment_set.test_explicit_zips_work(workspace_name)

ramble.test.experiment_set.test_full_experiments_from_dict(workspace_name)

ramble.test.experiment_set.test_matrix_experiments(workspace_name)

ramble.test.experiment_set.test_matrix_experiments_explicit_excludes(workspace_name)

ramble.test.experiment_set.test_matrix_multiplication_experiments(workspace_name)

ramble.test.experiment_set.test_matrix_undefined_var_errors(workspace_name, capsys)

ramble.test.experiment_set.test_matrix_vector_experiments(workspace_name)

ramble.test.experiment_set.test_missing_required_keyword_errors(workspace_name)

ramble.test.experiment_set.test_modifiers_no_version_set_correctly(workspace_name, mock_modifiers)

ramble.test.experiment_set.test_modifiers_set_correctly(workspace_name, mock_modifiers)

ramble.test.experiment_set.test_multi_matrix_experiments(workspace_name)

ramble.test.experiment_set.test_n_nodes_correct_defaults(workspace_name)

ramble.test.experiment_set.test_n_ranks_correct_defaults(workspace_name)

ramble.test.experiment_set.test_nonunique_vector_errors(workspace_name, capsys)

ramble.test.experiment_set.test_processes_per_node_correct_defaults(workspace_name)

ramble.test.experiment_set.test_repeated_experiments(workspace_name)

Test that repeated experiments are rendered correctly.

ramble.test.experiment_set.test_reserved_keywords_error_in_application(workspace_name, var)

ramble.test.experiment_set.test_reserved_keywords_error_in_experiment(workspace_name, var)

ramble.test.experiment_set.test_reserved_keywords_error_in_workload(workspace_name, var)

ramble.test.experiment_set.test_single_experiment_in_set()

ramble.test.experiment_set.test_single_var_explicit_zip(workspace_name)

ramble.test.experiment_set.test_unused_var_propagates_to_chain(workspace_name)

ramble.test.experiment_set.test_unused_vector_no_error(workspace_name)

ramble.test.experiment_set.test_unused_zip_no_error(workspace_name)

ramble.test.experiment_set.test_validation_in_render_repeat_experiments(workspace_name)

Test that validation is called in _render_repeat_experiments.

ramble.test.experiment_set.test_vector_experiment_in_set()

ramble.test.experiment_set.test_vector_experiment_with_explicit_excludes(workspace_name)

ramble.test.experiment_set.test_vector_experiment_with_late_where_excludes(workspace_name)

ramble.test.experiment_set.test_vector_experiment_with_multi_where_excludes(workspace_name)

ramble.test.experiment_set.test_vector_experiment_with_where_excludes(workspace_name)

ramble.test.experiment_set.test_vector_length_mismatch_errors(workspace_name, capsys)

ramble.test.experiment_set.test_zip_multi_use_var_errors(workspace_name, capsys)

ramble.test.experiment_set.test_zip_non_list_var_errors(workspace_name, capsys)

ramble.test.experiment_set.test_zip_variable_lengths_errors(workspace_name, capsys)

ramble.test.experiment_set.test_zipped_vector_experiments(workspace_name)

ramble.test.fetch_strategy module

Perform tests of the fetch_strategy functions

class ramble.test.fetch_strategy.TestCvsFetchStrategy

Bases: object

fetcher(tmp_path)

Create a CvsFetchStrategy with a mock stage.

mock_vcs_executables(monkeypatch)

Mock vcs executables.

test_archive(fetcher, mock_vcs_executables)

test_cachable()

test_fetch(fetcher, mock_vcs_executables, monkeypatch)

test_init()

test_mirror_id()

test_remove_untracked_files(fetcher, mock_vcs_executables, monkeypatch)

test_reset(fetcher, mock_vcs_executables, monkeypatch)

test_source_id()

test_str()

class ramble.test.fetch_strategy.TestFsCache

Bases: object

test_store_already_cached(tmp_path)

Test that store does nothing for an already cached fetcher.

test_store_cachable_and_destroy(tmp_path)

Test that store caches a cachable fetcher and destroy works.

test_store_uncachable(tmp_path)

Test that store does nothing for an uncachable fetcher.

class ramble.test.fetch_strategy.TestGitFetchStrategy

Bases: object

fetcher(tmp_path, monkeypatch)

Create a GitFetchStrategy with a mock stage.

mock_config(monkeypatch)

Mock ramble.config.

mock_git(monkeypatch)

Mock the git executable and related functions.

test_clone_basic(fetcher, mock_git, mock_config)

Test basic git clone.

test_clone_with_commit(fetcher, mock_git, mock_config)

Test clone with a specific commit.

test_clone_with_submodules(fetcher, mock_git, mock_config)

Test clone with submodules.

class ramble.test.fetch_strategy.TestHgFetchStrategy

Bases: object

fetcher(tmp_path)

Create a HgFetchStrategy with a mock stage.

mock_vcs_executables(monkeypatch)

Mock vcs executables.

test_archive(fetcher, mock_vcs_executables)

test_cachable()

test_fetch(fetcher, mock_vcs_executables, monkeypatch)

test_init()

test_mirror_id()

test_reset(fetcher, mock_vcs_executables, monkeypatch)

test_source_id()

test_str()

class ramble.test.fetch_strategy.TestSvnFetchStrategy

Bases: object

fetcher(tmp_path)

Create a SvnFetchStrategy with a mock stage.

mock_vcs_executables(monkeypatch)

Mock vcs executables.

test_archive(fetcher, mock_vcs_executables)

test_cachable()

test_fetch(fetcher, mock_vcs_executables, monkeypatch)

test_init()

test_mirror_id()

test_reset(fetcher, mock_vcs_executables, monkeypatch)

test_source_id()

test_str()

class ramble.test.fetch_strategy.TestURLFetchStrategy

Bases: object

fetcher(tmp_path)

Create a URLFetchStrategy with a mock stage.

mock_config(monkeypatch)

Mock ramble.config.

mock_curl(monkeypatch)

Mock the curl executable.

mock_tty(monkeypatch)

Mock tty.

test_fetch_curl_404(fetcher, mock_curl, mock_config, mock_tty, tmp_path)

Test fetch with curl when a 404 error occurs.

test_fetch_curl_cert_error(fetcher, mock_curl, mock_config, mock_tty)

Test fetch with curl when a certificate error occurs.

test_fetch_curl_content_mismatch(fetcher, mock_curl, mock_config, mock_tty, monkeypatch)

Test fetch with curl when content type is HTML.

test_fetch_curl_no_verify_ssl(fetcher, mock_curl, mock_config, mock_tty)

Test that -k is passed to curl when verify_ssl is false.

test_fetch_curl_success(fetcher, mock_curl, mock_config, mock_tty, tmp_path)

Test successful fetch with curl.

class ramble.test.fetch_strategy.TestVCSFetchStrategy

Bases: object

class DummyVCS(**kwargs)

Bases: VCSFetchStrategy

optional_attrs: List[str] = ['revision']

url_attr: str | None = 'dummy_url'

The URL attribute must be specified either at the package class level, or as a keyword argument to version(). It is used to distinguish fetchers for different versions in the package DSL.

mock_tar(monkeypatch)

Mock the tar executable.

test_archive(tmp_path, mock_tar)

Test the archive method.

test_archive_with_exclude(tmp_path, mock_tar)

Test the archive method with exclude patterns.

test_archive_with_srcdir(tmp_path, mock_tar, monkeypatch)

Test the archive method with stage.srcdir set.

test_check_and_expand()

Test that check() and expand() run without error.

test_init()

Test initialization of VCSFetchStrategy.

test_init_no_url()

Test that __init__ raises ValueError if url_attr is missing.

test_str()

Test __str__ method.

ramble.test.fetch_strategy.test_bad_from_url_scheme()

ramble.test.fetch_strategy.test_from_url_scheme(url, expected_fetcher_type)

ramble.test.gcs_fetch module

ramble.test.gcs_fetch.test_gcsfetchstrategy_bad_url(tmpdir, _fetch_method)

Ensure fetch with bad URL fails as expected.

ramble.test.gcs_fetch.test_gcsfetchstrategy_download(tmpdir, _fetch_method, monkeypatch)

Ensure fetch of fie.

ramble.test.gcs_fetch.test_gcsfetchstrategy_downloaded(tmpdir, _fetch_method)

Ensure fetch with archive file already downloaded is a noop.

ramble.test.gcs_fetch.test_gcsfetchstrategy_without_url(_fetch_method)

Ensure constructor with no URL fails.

ramble.test.get_file_path module

ramble.test.get_file_path.test_get_file_path(mock_applications, mock_file_auto_create, workspace_name)

ramble.test.impossible_when module

ramble.test.impossible_when.test_info_impossible_when(mock_applications)

ramble.test.impossible_when.test_info_truly_impossible(mock_applications)

ramble.test.impossible_when.test_info_value_conflict_impossible(mock_applications)

ramble.test.impossible_when.test_info_version_impossible(mock_applications)

ramble.test.mirror module

class ramble.test.mirror.MockFetcher

Bases: object

Mock fetcher object which implements the necessary functionality for testing MirrorCache

static archive(dst)

ramble.test.mirror.check_mirror(mirror_path, app_name, app_class)

ramble.test.mirror.create_archive(archive_dir, app_class)

ramble.test.mirror.test_mirror_cache_symlinks(tmpdir)

Confirm that the cosmetic symlink created in the mirror cache (which may be relative) targets the storage path correctly.

ramble.test.mirror.test_mirror_create(tmpdir, mutable_mock_workspace_path, app_name, tmpdir_factory)

ramble.test.mirror.test_mirror_str_and_repr()

ramble.test.mock_spack_runner module

class ramble.test.mock_spack_runner.MockPackageInfo(data)

Bases: object

to_dict()

to_version_text()

class ramble.test.mock_spack_runner.MockSpackRunner

Bases: object

activate()

add_config(config)

add_config_file(config_file)

add_include_file(path)

add_spec(spec)

added_packages()

apply_configs(stage_path=None)

concretize()

configure_env(env_path)

copy_from_external_env(env)

create_env(env_path)

create_stage_env()

deactivate()

generate_activate_command()

generate_deactivate_command()

generate_env_file()

generate_source_command()

get_package_path(spec)

get_version()

install()

inventory_hash()

migrate_stage_env(stage_env_path: str, ws_env_path: str)

package_definitions()

package_provenance()

set_compiler_config_dir(path)

set_dry_run(dry_run)

set_env(env_path, require_exists=True)

ramble.test.modifier_application module

ramble.test.modifier_application.test_wrfv4_aps_test(mutable_config, mutable_mock_workspace_path, workspace_name)

ramble.test.modifier_language module

Perform tests of the Application class

ramble.test.modifier_language.add_archive_pattern(mod_inst, archive_num=1)

ramble.test.modifier_language.add_compiler(mod_inst, spec_num=1)

ramble.test.modifier_language.add_env_var_modification(mod_inst, env_var_mod_num=1)

ramble.test.modifier_language.add_executable_modifier(mod_inst, exec_mod_num=1)

ramble.test.modifier_language.add_figure_of_merit(mod_inst, context_num=1)

ramble.test.modifier_language.add_figure_of_merit_context(mod_inst, context_num=1)

ramble.test.modifier_language.add_mode(mod_inst, mode_num=1)

ramble.test.modifier_language.add_modifier_variable(mod_inst, mod_var_num=1)

ramble.test.modifier_language.add_required_package(mod_inst, pkg_num=1)

ramble.test.modifier_language.add_software_spec(mod_inst, spec_num=1)

ramble.test.modifier_language.add_variable_modification(mod_inst, var_mod_num=1)

ramble.test.modifier_language.test_archive_pattern_directive(mod_class)

ramble.test.modifier_language.test_define_compiler_directive(mod_class)

ramble.test.modifier_language.test_env_var_modification_directive(mod_class)

ramble.test.modifier_language.test_executable_modifier_directive(mod_class)

ramble.test.modifier_language.test_figure_of_merit_context_directive(mod_class)

ramble.test.modifier_language.test_figure_of_merit_directive(mod_class)

ramble.test.modifier_language.test_merge_conditions_creates_when_list(mod_class)

ramble.test.modifier_language.test_mode_directive(mod_class)

ramble.test.modifier_language.test_modifier_class_attributes(mod_class)

ramble.test.modifier_language.test_modifier_conflict_usage_error()

ramble.test.modifier_language.test_modifier_type_features(mod_class)

ramble.test.modifier_language.test_modifier_variable_directive(mod_class)

ramble.test.modifier_language.test_required_package_directive(mod_class)

ramble.test.modifier_language.test_software_spec_directive(mod_class)

ramble.test.modifier_language.test_variable_modification_directive(mod_class)

ramble.test.modifier_language.test_variable_modification_invalid_method(mod_class)

ramble.test.modifier_language.test_variable_modification_modeless(mod_class)

ramble.test.namespace_trie module

ramble.test.namespace_trie.test_add_multiple(trie)

ramble.test.namespace_trie.test_add_none_multiple(trie)

ramble.test.namespace_trie.test_add_none_single(trie)

ramble.test.namespace_trie.test_add_single(trie)

ramble.test.namespace_trie.test_add_three(trie)

ramble.test.namespace_trie.trie()

ramble.test.package_manager_language module

Perform tests of the package manager class

ramble.test.package_manager_language.add_variable(pm_inst, pm_num=1)

ramble.test.package_manager_language.test_pkg_man_type_features(pm_class)

ramble.test.package_manager_language.test_pkg_man_variables(pm_class)

ramble.test.reports module

ramble.test.reports.create_test_exp_result(ramble_status: str, experiment_name: str, application_name: str, workload_name: str, foms: list, ramble_vars: dict | None, ramble_raw_vars: dict | None, **kwargs)

Creates an experiment results dict in the format of results imported from JSON or YAML.

Parameters:

• ramble_status – Status (e.g. “SUCCESS”, “FAILED”)

• experiment_name – name of the experiment

• application_name – name of the app

• workload_name – name of the workload

• foms – List of tuples (context, (fom_name, value, units, origin, origin_type, fom_type))

• ramble_vars – Dict of any variables to add to RAMBLE_VARIABLES

• ramble_raw_vars – Dict of any variables to add to RAMBLE_RAW_VARIABLES

• kwargs – Any kwargs will be added to the experiment dict as k/v pairs, (e.g., “n_nodes=1”)

ramble.test.reports.create_test_fom_result(name, value, units, origin, origin_type, fom_type)

ramble.test.reports.test_compare_plot(mutable_mock_workspace_path, tmpdir_factory)

ramble.test.reports.test_compare_plot_with_simplify_names(mutable_mock_workspace_path, tmpdir_factory)

ramble.test.reports.test_fom_plot(mutable_mock_workspace_path, tmpdir_factory)

ramble.test.reports.test_fom_plot_with_simplify_names(mutable_mock_workspace_path, tmpdir_factory)

ramble.test.reports.test_index_printing(mutable_mock_workspace_path, tmpdir_factory, format)

ramble.test.reports.test_multiline_plot(mutable_mock_workspace_path, mutable_config, tmpdir_factory)

ramble.test.reports.test_multiple_groupby(mutable_mock_workspace_path, tmpdir_factory, capsys)

ramble.test.reports.test_repeat_import(mutable_mock_workspace_path)

ramble.test.reports.test_scaling_plots(mutable_mock_workspace_path, tmpdir_factory, values)

ramble.test.reports.test_simplify_names()

ramble.test.reports.test_where_query(mutable_mock_workspace_path)

ramble.test.repository module

ramble.test.repository.extra_repo(tmpdir_factory, request)

ramble.test.repository.test_list_object_files(obj_name, obj_type, expected, mutable_apps_repo_path, mutable_mods_repo_path, mutable_pkg_mans_repo_path)

ramble.test.repository.test_repo_app_with_unknown_namespace(mutable_mock_apps_repo)

ramble.test.repository.test_repo_getapp(mutable_mock_apps_repo)

ramble.test.repository.test_repo_multi_getapp(mutable_mock_apps_repo, extra_repo)

ramble.test.repository.test_repo_multi_getappclass(mutable_mock_apps_repo, extra_repo)

ramble.test.repository.test_repo_unknown_app(mutable_mock_apps_repo)

ramble.test.software_environment module

ramble.test.software_environment.test_basic_software_environment(request, mutable_mock_workspace_path)

ramble.test.software_environment.test_compiler_in_environment_warns(request, mutable_mock_workspace_path, capsys)

ramble.test.software_environment.test_invalid_environment_error(request, mutable_mock_workspace_path)

ramble.test.software_environment.test_invalid_packages_error(request, mutable_mock_workspace_path)

ramble.test.software_environment.test_is_used_property(request, mutable_mock_workspace_path)

ramble.test.software_environment.test_multi_template_software_environments(request, mutable_mock_workspace_path)

ramble.test.software_environment.test_software_environments_no_packages(request, mutable_mock_workspace_path)

ramble.test.software_environment.test_software_environments_no_rendered_packages(request, mutable_mock_workspace_path)

ramble.test.software_environment.test_template_software_environments(request, mutable_mock_workspace_path)

ramble.test.software_environment.test_undefined_compiler_errors(request, mutable_mock_workspace_path)

ramble.test.software_environment.test_undefined_package_errors(request, mutable_mock_workspace_path)

ramble.test.spec module

class ramble.test.spec.TestSpec

Bases: object

Tests for the Spec class.

test_format()

test_format_errors(format_str)

test_init_empty_and_copy()

test_init_from_string(spec_str, expected_name, expected_namespace, expected_fullname)

ramble.test.spec_basic module

Perform tests of the Spec class

class ramble.test.spec_basic.TestSpec

Bases: object

test_spec_copy()

test_spec_examples()

ramble.test.stage module

Test that the Stage class works correctly.

class ramble.test.stage.StageInclude(*values)

Bases: IntEnum

extra = 3

hidden = 2

readme = 1

class ramble.test.stage.TestStage

Bases: object

stage_name = 'ramble-test-stage'

test_composite_stage_with_expand_resource(composite_stage_with_expanding_resource)

test_composite_stage_with_expand_resource_default_placement(composite_stage_with_expanding_resource)

For a resource which refers to a compressed archive which expands to a directory, check that by default the resource is placed in the source_path of the root stage with the name of the decompressed directory.

test_composite_stage_with_noexpand_resource(mock_stage_archive, mock_noexpand_resource)

test_ensure_one_stage_entry(mock_stage_archive)

test_expand_archive(expected_file_list, mock_stage_archive)

test_expand_archive_extra_expand(mock_stage_archive)

Test expand with an extra expand after expand (i.e., no-op).

test_fetch(mock_stage_archive, debug)

test_input_path_available(mock_stage_archive)

Ensure input path available but does not exist on instantiation.

test_keep_exceptions(mock_stage_archive)

test_keep_without_exceptions(mock_stage_archive)

test_no_keep_with_exceptions(mock_stage_archive)

test_no_keep_without_exceptions(mock_stage_archive)

test_no_search_if_default_succeeds(mock_stage_archive, failing_search_fn)

test_no_search_mirror_only(failing_fetch_strategy, failing_search_fn, tmpdir)

test_noexpand_stage_file(mock_noexpand_resource, tmpdir)

When creating a stage with a nonexpanding URL, the ‘archive_file’ property of the stage should refer to the path of that file.

test_restage(mock_stage_archive)

test_search_if_default_fails(failing_fetch_strategy, search_fn, err_msg, expected, tmpdir)

test_setup_and_destroy_name_with_tmp(mock_stage_archive)

test_setup_and_destroy_name_without_tmp(mock_stage_archive)

test_setup_no_name_fails(mock_stage_archive)

test_stage_constructor_no_fetcher()

Ensure Stage constructor with no URL or fetch strategy fails.

test_stage_constructor_with_path(tmpdir)

Ensure Stage constructor with a path uses it.

ramble.test.stage.check_destroy(stage, stage_name)

Figure out whether a stage was destroyed correctly.

ramble.test.stage.check_expand_archive(stage, stage_name, expected_file_list)

Ensure the expanded archive directory contains the expected structure and files as described in the module-level comments above.

ramble.test.stage.check_fetch(stage, stage_name)

Ensure the fetch resulted in a properly placed archive file as described in the module-level comments.

ramble.test.stage.check_setup(stage, stage_name, archive)

Figure out whether a stage was set up correctly.

ramble.test.stage.composite_stage_with_expanding_resource(mock_stage_archive, mock_expand_resource)

Sets up a composite for expanding resources prior to staging.

ramble.test.stage.failing_fetch_strategy()

Returns a fetch strategy that fails.

ramble.test.stage.failing_search_fn()

Returns a search function that fails! Always!

ramble.test.stage.mock_expand_resource(tmpdir)

Sets up an expandable resource in tmpdir prior to staging.

ramble.test.stage.mock_noexpand_resource(tmpdir)

Set up a non-expandable resource in the tmpdir prior to staging.

ramble.test.stage.mock_stage_archive(tmp_build_stage_dir)

Create the directories and files for the staged mock archive.

ramble.test.stage.search_fn()

Returns a search function that always succeeds.

ramble.test.stage.test_cannot_access(capsys)

Ensure can_access dies with the expected error.

ramble.test.stage.test_stage_create_replace_path(tmp_build_stage_dir)

Ensure stage creation replaces a non-directory path.

ramble.test.stage.tmp_build_stage_dir(tmpdir)

Use a temporary test directory for the stage root.

ramble.test.success_criteria module

ramble.test.success_criteria.generate_file(path)

ramble.test.success_criteria.remark_all(crit_list, file_path)

ramble.test.success_criteria.test_criteria_list(tmpdir)

ramble.test.success_criteria.test_single_criteria(tmpdir)

ramble.test.success_criteria.test_success_criteria_globbing()

ramble.test.test_context_columns module

class ramble.test.test_context_columns.TestContextColumns(methodName='runTest')

Bases: TestCase

test_autocolumn_context_name_variable()

test_autocolumn_match_instance_name_regex()

test_autocolumn_null_context()

test_autocolumn_origin_filter()

test_autocolumn_regex_groups()

test_context_column_ambiguous_names()

test_context_column_discovery()

test_context_column_fom_globbing()

test_context_column_manual_conflict()

test_context_column_mixed_sorting()

test_context_column_sorting()

test_context_column_where_clause()

test_table_transpose()

ramble.test.test_deployment module

class ramble.test.test_deployment.TestPushDeploymentPipeline(methodName='runTest')

Bases: TestCase

setUp()

Hook method for setting up the test fixture before exercising it.

tearDown()

Hook method for deconstructing the test fixture after testing it.

test_complete_copies_inventory_files()

ramble.test.test_results_tables module

class ramble.test.test_results_tables.TestResultsColumn(methodName='runTest')

Bases: TestCase

test_col_name()

test_extract_value_expression()

test_extract_value_fom()

test_extract_value_where_fails()

test_init()

test_init_both_expression_and_fom(mock_die)

test_init_missing_expression_and_fom(mock_die)

class ramble.test.test_results_tables.TestResultsTable(methodName='runTest')

Bases: TestCase

setUp()

Hook method for setting up the test fixture before exercising it.

test_add_where()

test_extract_row()

test_init()

test_to_csv(mock_import_pandas, mock_symlink)

class ramble.test.test_results_tables.TestResultsTables(methodName='runTest')

Bases: TestCase

setUp()

Hook method for setting up the test fixture before exercising it.

test_add_table_template()

test_build_tables()

test_output_tables()

ramble.test.uploader module

ramble.test.uploader.mock_results_with_metadata()

ramble.test.uploader.test_create_tables_dataset_does_not_exist(mock_bigquery_client)

ramble.test.uploader.test_create_tables_dataset_exists(mock_bigquery_client)

ramble.test.uploader.test_data_preparation(request, mock_applications)

ramble.test.uploader.test_experiment_metadata_preparation(mock_results_with_metadata, mutable_config)

ramble.test.uploader.test_fom_validation_fails_with_none()

Test that FOM validation fails when value is None

ramble.test.uploader.test_sqlite_uploader_chunked_upload_errors(tmpdir, mock_results_with_metadata, capsys)

ramble.test.uploader.test_sqlite_uploader_create_tables_and_upload(tmpdir, mock_results_with_metadata)

ramble.test.uploader.test_sqlite_uploader_create_tables_with_existing(tmpdir, mock_results_with_metadata, capsys)

ramble.test.uploader.test_sqlite_uploader_perform_upload_no_db(tmpdir, mock_results_with_metadata, capsys)

ramble.test.uploader.test_upload_results_errs(upload_uri, upload_type, results, expected_err_msg)

ramble.test.variant module

ramble.test.variant.test_boolean_variants(request)

ramble.test.variant.test_changed_variant_value_works_with_when(request)

ramble.test.variant.test_default_arg_works(request)

ramble.test.variant.test_default_variant_value_works_with_when(request)

ramble.test.variant.test_invalid_variant_value_errors(request)

ramble.test.variant.test_modifier_variants_works_with_when(test_name, mode, expected_spec, mutable_mock_workspace_path, mutable_mock_apps_repo, mock_modifiers)

ramble.test.variant.test_non_matched_variants_are_ignored(request)

ramble.test.variant.test_variant_expansion(workspace_name, variant_scope, expected_bool, expected_val)

ramble.test.variant.test_variant_info_works(request)

ramble.test.variant.test_variant_nesting_works(workspace_name, test_value)

ramble.test.version module

ramble.test.version.test_application_version_variant_when(workspace_name, version, expected_zlib)

ramble.test.version.test_define_version_variables_errors(workspace_name)

ramble.test.version.test_multi_modifier_versions(workspace_name)

ramble.test.version.test_non_pep440_application_version_variant_when(workspace_name, version, expected_zlib)

ramble.test.version.test_non_pep440_version_number(workspace_name)

ramble.test.version.test_only_one_preferred_version_allowed()

ramble.test.version.test_repeat_modifier_versions_error(workspace_name)

ramble.test.version.test_strict_versions_config(workspace_name, capsys)

ramble.test.version.test_strict_versions_directive(workspace_name)

Test that the strict_versions(False) directive works correctly.

ramble.test.version.test_version_variable_expansion_info(workspace_name)

ramble.test.version.test_versions_inherited_from_base_app(workspace_name)

ramble.test.when module

ramble.test.when.test_conflicts_version_when(workspace_name, version, validation, fails)

ramble.test.when.test_conflicts_when(workspace_name, zlib_type, validation, fails)

ramble.test.when.test_env_var_modification_when(workspace_name, env_var_mod_when, expected_exec)

ramble.test.when.test_executable_errors_when_overlapping_conditions(workspace_name)

ramble.test.when.test_executable_modification_when(workspace_name, exec_mod_when, expected_exec)

ramble.test.when.test_executable_when(workspace_name, exec_variant_on, exec_ver2_found, skipped_exec_found)

ramble.test.when.test_fom_context_enabled_when_true(workspace_name)

ramble.test.when.test_fom_enabled_when_true(workspace_name)

ramble.test.when.test_fom_errors_when_context_not_found(workspace_name)

ramble.test.when.test_fom_overwrites_when_inherited(workspace_name)

ramble.test.when.test_formatted_exec_when(workspace_name, inc_value, type_value)

ramble.test.when.test_input_when(workspace_name, input_when, expected_input_file)

ramble.test.when.test_modifier_variable_when(workspace_name, inc_value, mutable_mock_mods_repo)

ramble.test.when.test_obj_env_var_when(workspace_name, obj, mutable_mock_wms_repo, mutable_mock_pkg_mans_repo)

ramble.test.when.test_obj_required_key_when(workspace_name, obj, mutable_mock_wms_repo, mutable_mock_pkg_mans_repo)

ramble.test.when.test_obj_required_var_when(workspace_name, obj, mutable_mock_wms_repo, mutable_mock_pkg_mans_repo)

ramble.test.when.test_object_conflicts_expander_errors(workspace_name, variant_name)

ramble.test.when.test_object_conflicts_no_msg(workspace_name)

ramble.test.when.test_object_conflicts_warn_only(workspace_name)

ramble.test.when.test_package_manager_requirement_when(workspace_name)

ramble.test.when.test_package_manager_variable_when(workspace_name, inc_value, mutable_mock_pkg_mans_repo)

ramble.test.when.test_register_builtin_when(workspace_name, include_builtin, builtin_found)

ramble.test.when.test_register_phase_when(workspace_name)

ramble.test.when.test_register_template_when(workspace_name)

ramble.test.when.test_register_validator_when(workspace_name, validator_value, fails)

ramble.test.when.test_same_fom_name_different_context(workspace_name)

ramble.test.when.test_success_criteria_when(workspace_name)

ramble.test.when.test_variable_modification_when(workspace_name, var_mod_when, modifier_mode, expected_exec)

ramble.test.when.test_variable_when(workspace_name, inc_value, type_value)

ramble.test.when.test_variable_when_workload_constraint(workspace_name, workload_name)

ramble.test.when.test_workflow_manager_variable_when(workspace_name, inc_value, mutable_mock_wms_repo)

ramble.test.when.test_workload_definition_when(workspace_name, wl_def_when, expected_exec)

ramble.test.when.test_workload_errors_when_not_enabled(workspace_name)

ramble.test.when.test_workload_errors_when_overlapping_conditions(workspace_name)

ramble.test.when.test_workload_group_when(workspace_name, active_variant, active_workload, disabled_variant, disabled_workload)

ramble.test.workspace module

ramble.test.workspace.test_all_config_files()

ramble.test.workspace.test_all_workspace_names_multiple_dirs(tmpdir, monkeypatch)

ramble.test.workspace.test_get_workspace()

ramble.test.workspace.test_re_read(tmpdir)

ramble.test.workspace.test_read_file_content(tmpdir)

ramble.test.workspace.test_template_path()