ramble.test namespace

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_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.info module
    • info_lines()
    • mock_print()
    • parser()
    • test_info_fields()
    • test_it_just_runs()
    • test_mock_spack_info_software()
    • test_spack_info_software()
  • ramble.test.cmd.list module
    • test_list()
    • 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.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_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_create_add_list_remove()
    • test_create_add_list_remove_flags()
    • test_help_option()
  • ramble.test.cmd.results module
    • test_file_import_rejects_invalid_files()
  • ramble.test.cmd.software_definitions module
    • test_software_definitions_conflicts_runs()
    • test_software_definitions_error_on_conflicts()
    • test_software_definitions_runs()
    • test_software_definitions_summary()
  • ramble.test.cmd.workspace module
    • add_basic()
    • check_basic()
    • check_info_basic()
    • check_info_zlib()
    • 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_force_concretize()
    • test_invalid_size_matrices_workspace()
    • test_invalid_template_name_errors()
    • test_invalid_vector_workspace()
    • test_matrix_vector_workspace_full()
    • test_multi_use_vector_var_matrices_workspace()
    • 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_fails()
    • test_workspace_archive()
    • test_workspace_archive_include_secrets()
    • test_workspace_config_precedence()
    • test_workspace_create_links()
    • test_workspace_dir()
    • test_workspace_dirs()
    • test_workspace_flag_anon()
    • test_workspace_flag_named()
    • test_workspace_from_template()
    • test_workspace_include()
    • test_workspace_info()
    • 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_no_empty_workloads()
    • test_workspace_simplify()
    • test_workspace_tar_archive()
    • test_workspace_tar_upload_archive()
    • test_workspace_tar_upload_archive_config_url()
    • workspace_deactivate()
    • write_variables_config_file()
  • ramble.test.cmd.workspace_concretize module
    • test_workspace_concretize_additive()
• ramble.test.end_to_end namespace
  • Submodules
  • ramble.test.end_to_end.analyze_fom_output module
    • test_analyze_fom_output()
    • test_analyze_print()
  • 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.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.custom_executables module
    • test_custom_executables()
  • 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_env_var_builtin()
    • test_env_var_from_app_only()
  • 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_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_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()
  • 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_mpi_cmd module
    • test_missing_mpi_cmd()
  • 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_validation module
    • test_object_validation()
  • 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()
  • 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_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.pip_test module
    • test_pip()
  • ramble.test.end_to_end.shared_context module
    • test_shared_contexts()
  • ramble.test.end_to_end.short_builtin_dep_name module
    • test_short_builtin_dep_name()
  • 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.test_configvar_dry_run module
    • test_configvar_dry_run()
  • ramble.test.end_to_end.test_target_shells module
    • test_target_shells_directive()
  • ramble.test.end_to_end.test_template module
    • test_template()
    • test_template_inherited()
  • 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.wrfv4_dry_run module
    • test_wrfv4_no_pkg_man_dry_run()
    • test_wrfv4_spack_dry_run()
• ramble.test.experimental namespace
  • Submodules
  • ramble.test.experimental.uploader module
    • test_upload_results_errs()
• ramble.test.modifier_functionality namespace
  • Submodules
  • 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.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_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.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()
  • ramble.test.package_manager_functionality.spack_runner module
    • test_config_compiler_find_attribute()
    • test_config_concretize_attribute()
    • test_config_install_attribute()
    • test_configs_apply_to_external_env()
    • test_default_concretize_flags()
    • test_default_install_flags()
    • test_env_activate()
    • test_env_add()
    • test_env_concretize()
    • test_env_concretize_skips_already_concretized_envs()
    • test_env_configs_apply()
    • test_env_create()
    • test_env_create_no_view()
    • test_env_deactivate()
    • test_env_include()
    • test_env_install()
    • test_env_view_link_types()
    • test_external_env_copies()
    • test_invalid_external_env_errors()
    • test_multiword_args()
    • test_new_compiler_installs()
• 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_variable_fom_comparison module
    • test_success_variable_fom_comparison()
• ramble.test.util namespace
  • Submodules
  • ramble.test.util.conversions module
    • test_canonical_none()
    • 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.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.stats module
    • test_stats_for_repeat_foms()
  • ramble.test.util.yaml_generation module
    • test_all_config_options()
    • 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.gke_mpi_workflow_manager module
    • test_gke_mpi_workflow()
  • ramble.test.workflow_manager_functionality.google_batch_workflow_manager module
    • test_google_batch_workflow_default()
  • ramble.test.workflow_manager_functionality.slurm_workflow_manager module
    • test_slurm_workflow()
    • test_slurm_workflow_default()
  • 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_workspace_setup_creates_inventory()

Submodules

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_input_file_directive(app_class)

ramble.test.application_language.test_software_spec_directive(app_class)

ramble.test.application_language.test_workload_directive(app_class)

ramble.test.application_tests module

Perform tests of the Application class

ramble.test.application_tests.basic_exp_dict()

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

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

ramble.test.application_tests.test_application_copy_is_deep(mutable_mock_apps_repo, app_name)

ramble.test.application_tests.test_basic_app(mutable_mock_apps_repo)

ramble.test.application_tests.test_class_attributes(mutable_mock_apps_repo)

ramble.test.application_tests.test_define_commands(mutable_mock_apps_repo)

test _define_commands

ramble.test.application_tests.test_derive_variables_for_template_path(mutable_mock_apps_repo)

_set_default_variables_for_template_path

ramble.test.application_tests.test_get_executable_graph_custom_executables(mutable_mock_apps_repo)

_get_executable_graph, test3, custom executables

ramble.test.application_tests.test_get_executable_graph_initial(mutable_mock_apps_repo)

_get_executable_graph, test1, workload executables

ramble.test.application_tests.test_get_executable_graph_yaml_defined(mutable_mock_apps_repo)

_get_executable_graph, test2, yaml-defined order

ramble.test.application_tests.test_register_builtin_app(mutable_mock_apps_repo)

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

ramble.test.application_tests.test_set_default_experiment_variables(mutable_mock_apps_repo)

_set_default_experiment_variables

ramble.test.application_tests.test_set_input_path(mutable_mock_apps_repo)

_set_input_path

ramble.test.application_tests.test_set_input_path_multi_input(mutable_mock_apps_repo)

Tests set_input_path with multiple inputs in a given workload

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

ramble.test.application_tests.test_workload_groups(mutable_mock_apps_repo)

ramble.test.application_tests.test_workload_groups_inherited(mutable_mock_apps_repo)

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_missing_command()

ramble.test.concretize_builtin module

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

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

ramble.test.config_test module

ramble.test.config_test.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.test_process_config_path_error(config, expected_error)

ramble.test.conftest module

class ramble.test.conftest.ConfigUpdate(root_for_conf, writer_mod, writer_key, monkeypatch)

Bases: object

class ramble.test.conftest.MockBundle

Bases: object

has_code = False

name = 'mock-bundle'

versions = {}

class ramble.test.conftest.MockCache

Bases: object

fetcher(target_path, digest, **kwargs)

store(copy_cmd, relative_dest)

class ramble.test.conftest.MockCacheFetcher

Bases: object

fetch()

class ramble.test.conftest.MockConfig(configuration, writer_key)

Bases: object

configuration()

writer_configuration()

class ramble.test.conftest.MockLayout(root)

Bases: object

check_installed(spec)

path_for_spec(spec)

ramble.test.conftest.clear_directive_functions()

Clear all overridden directive functions for subsequent tests.

ramble.test.conftest.config(mock_configuration_scopes)

This fixture activates/deactivates the mock configuration.

ramble.test.conftest.configuration_dir(tmpdir_factory, linux_os)

Copies mock configuration files in a temporary directory. Returns the directory path.

ramble.test.conftest.default_config()

Isolates the default configuration from the user configs.

This ensures we can test the real default configuration without having tests fail when the user overrides the defaults that we test against.

ramble.test.conftest.gen_mock_layout(tmpdir)

ramble.test.conftest.install_mockery_mutable_config(mutable_config, mock_applications)

Hooks fake applications and config directory into Ramble.

This is specifically for tests which want to use ‘install_mockery’ but also need to modify configuration (and hence would want to use ‘mutable config’): ‘install_mockery’ does not support this.

ramble.test.conftest.linux_os()

Returns a named tuple with attributes ‘name’ and ‘version’ representing the OS.

ramble.test.conftest.mock_applications(mock_apps_repo_path)

Use the ‘builtin.mock’ repository for applications instead of ‘builtin’

ramble.test.conftest.mock_apps_repo_path()

ramble.test.conftest.mock_archive(request, tmpdir_factory)

Creates a very simple archive directory with a configure script and a makefile that installs to a prefix. Tars it up into an archive.

ramble.test.conftest.mock_configuration_scopes(configuration_dir)

Create a persistent Configuration object from the configuration_dir.

ramble.test.conftest.mock_directive_bundle()

Return a mock bundle package for directive tests.

ramble.test.conftest.mock_executable(tmpdir)

Factory to create a mock executable in a temporary directory that output a custom string when run.

ramble.test.conftest.mock_fetch(mock_archive, monkeypatch)

Fake the URL for an input so it downloads from a file.

ramble.test.conftest.mock_fetch_cache(monkeypatch)

Substitutes ramble.paths.fetch_cache with a mock object that does nothing and raises on fetch.

ramble.test.conftest.mock_file_auto_create(monkeypatch)

ramble.test.conftest.mock_low_high_config(tmpdir)

Mocks two configuration scopes: ‘low’ and ‘high’.

ramble.test.conftest.mock_modifiers(mock_mods_repo_path)

Use the ‘builtin.mock’ repository for modifiersinstead of ‘builtin’

ramble.test.conftest.mock_mods_repo_path()

ramble.test.conftest.mock_package_managers(mock_pkg_mans_repo_path)

Use the ‘builtin.mock’ repository for package managers of ‘builtin’

ramble.test.conftest.mock_pkg_mans_repo_path()

ramble.test.conftest.mock_wms_repo_path()

ramble.test.conftest.mock_workflow_managers(mock_wms_repo_path)

Use the ‘builtin.mock’ repository for package managers of ‘builtin’

ramble.test.conftest.mutable_applications(mutable_apps_repo_path)

ramble.test.conftest.mutable_apps_repo_path()

ramble.test.conftest.mutable_config(tmpdir_factory, configuration_dir)

Like config, but tests can modify the configuration.

ramble.test.conftest.mutable_empty_config(tmpdir_factory, configuration_dir)

Empty configuration that can be modified by the tests.

ramble.test.conftest.mutable_mock_apps_repo(mock_apps_repo_path)

Function-scoped mock applications, for tests that need to modify them.

ramble.test.conftest.mutable_mock_mods_repo(mock_mods_repo_path)

Function-scoped mock modifiers, for tests that need to modify them.

ramble.test.conftest.mutable_mock_pkg_mans_repo(mock_pkg_mans_repo_path)

Function-scoped mock package managers, for tests that need to modify them.

ramble.test.conftest.mutable_mock_wms_repo(mock_wms_repo_path)

Function-scoped mock package managers, for tests that need to modify them.

ramble.test.conftest.mutable_mock_workspace_path(tmpdir_factory, mutable_config)

Fixture for mocking the internal ramble workspaces directory.

ramble.test.conftest.mutable_modifiers(mutable_mods_repo_path)

ramble.test.conftest.mutable_mods_repo_path()

ramble.test.conftest.mutable_package_managers(mutable_pkg_mans_repo_path)

ramble.test.conftest.mutable_pkg_mans_repo_path()

ramble.test.conftest.mutable_wms_repo_path()

ramble.test.conftest.mutable_workflow_managers(mutable_wms_repo_path)

ramble.test.conftest.no_chdir()

Ensure that no test changes Ramble’s working directory.

This prevents Ramble tests (and therefore Ramble commands) from changing the working directory and causing other tests to fail mysteriously. Tests should use working_dir or py.path’s .as_cwd() instead of os.chdir to avoid failing this check.

We assert that the working directory hasn’t changed, unless the original wd somehow ceased to exist.

ramble.test.conftest.no_path_access(monkeypatch)

ramble.test.conftest.print_all_logs(monkeypatch)

ramble.test.conftest.pytest_addoption(parser)

ramble.test.conftest.pytest_collection_modifyitems(config, items)

ramble.test.conftest.pytest_generate_tests(metafunc)

ramble.test.conftest.remove_whatever_it_is(path)

Type-agnostic remove.

ramble.test.conftest.working_env()

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.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_typed_expansions(input, output, no_expand_vars, passes)

ramble.test.experiment_result module

Tests on the ExperimentResult class

ramble.test.experiment_result.test_to_dict(mutable_mock_apps_repo)

ramble.test.experiment_set module

ramble.test.experiment_set.test_chained_cycle_errors(mutable_mock_workspace_path)

ramble.test.experiment_set.test_chained_experiment_has_correct_directory(mutable_mock_workspace_path, capsys)

ramble.test.experiment_set.test_chained_experiments_populate_new_experiments(mutable_mock_workspace_path, capsys)

ramble.test.experiment_set.test_chained_invalid_order_errors(mutable_mock_workspace_path)

ramble.test.experiment_set.test_cross_experiment_missing_experiment_errors(mutable_mock_workspace_path)

ramble.test.experiment_set.test_cross_experiment_variable_references(request, mutable_mock_workspace_path)

ramble.test.experiment_set.test_custom_executables_track_variables(request, mutable_mock_workspace_path)

ramble.test.experiment_set.test_experiment_names_match(mutable_mock_workspace_path)

ramble.test.experiment_set.test_explicit_zips_in_matrix(mutable_mock_workspace_path)

ramble.test.experiment_set.test_explicit_zips_unconsumed(mutable_mock_workspace_path)

ramble.test.experiment_set.test_explicit_zips_work(mutable_mock_workspace_path)

ramble.test.experiment_set.test_full_experiments_from_dict(mutable_mock_workspace_path)

ramble.test.experiment_set.test_matrix_experiments(mutable_mock_workspace_path)

ramble.test.experiment_set.test_matrix_experiments_explicit_excludes(mutable_mock_workspace_path)

ramble.test.experiment_set.test_matrix_multiplication_experiments(mutable_mock_workspace_path)

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

ramble.test.experiment_set.test_matrix_vector_experiments(mutable_mock_workspace_path)

ramble.test.experiment_set.test_missing_required_keyword_errors(mutable_mock_workspace_path, var, capsys)

ramble.test.experiment_set.test_modifiers_set_correctly(mutable_mock_workspace_path, mock_modifiers, capsys)

ramble.test.experiment_set.test_multi_matrix_experiments(mutable_mock_workspace_path)

ramble.test.experiment_set.test_n_nodes_correct_defaults(mutable_mock_workspace_path)

ramble.test.experiment_set.test_n_ranks_correct_defaults(mutable_mock_workspace_path)

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

ramble.test.experiment_set.test_processes_per_node_correct_defaults(mutable_mock_workspace_path)

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

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

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

ramble.test.experiment_set.test_single_experiment_in_set(mutable_mock_workspace_path)

ramble.test.experiment_set.test_single_var_explicit_zip(mutable_mock_workspace_path)

ramble.test.experiment_set.test_unused_var_propagates_to_chain(request, mutable_mock_workspace_path)

ramble.test.experiment_set.test_unused_vector_no_error(request, mutable_mock_workspace_path)

ramble.test.experiment_set.test_unused_zip_no_error(request, mutable_mock_workspace_path)

ramble.test.experiment_set.test_vector_experiment_in_set(mutable_mock_workspace_path)

ramble.test.experiment_set.test_vector_experiment_with_explicit_excludes(mutable_mock_workspace_path)

ramble.test.experiment_set.test_vector_experiment_with_multi_where_excludes(mutable_mock_workspace_path)

ramble.test.experiment_set.test_vector_experiment_with_where_excludes(mutable_mock_workspace_path)

ramble.test.experiment_set.test_vector_length_mismatch_errors(request, mutable_mock_workspace_path, capsys)

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

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

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

ramble.test.experiment_set.test_zipped_vector_experiments(mutable_mock_workspace_path)

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)

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)

ramble.test.mirror_tests module

class ramble.test.mirror_tests.MockFetcher

Bases: object

Mock fetcher object which implements the necessary functionality for testing MirrorCache

static archive(dst)

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

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

ramble.test.mirror_tests.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_tests.test_mirror_create(tmpdir, mutable_mock_workspace_path, app_name, tmpdir_factory)

ramble.test.modifier_application module

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

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_mode_directive(mod_class)

ramble.test.modifier_language.test_modifier_class_attributes(mod_class)

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_missing_mode(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(success, name, n_nodes, wl_ns, ramble_vars, ramble_raw_vars, context, fom_name, fom_value, units, origin, origin_type, fom_type, better_direction, fv, ifv, normalized=False, repeat_index='0')

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

ramble.test.reports.test_fom_plot(mutable_mock_workspace_path, 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_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_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_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.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_create_stage_root(tmpdir, no_path_access)

Test _create_stage_root permissions.

test_create_stage_root_bad_uid(tmpdir, monkeypatch)

Test the code path that uses an existing user path – whether $user in $tempdir or not – and triggers the generation of the UID mismatch warning.

This situation can happen with some config:build_stage settings for teams using a common service account for installing software.

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_first_accessible_path(tmpdir)

Test _first_accessible_path names.

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_resolve_paths()

Test _resolve_paths.

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.check_stage_dir_perms(prefix, path)

Check the stage directory perms to ensure match expectations.

ramble.test.stage.clear_stage_root(monkeypatch)

Ensure spack.stage._stage_root is not set at test start.

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, clear_stage_root)

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.workspace_tests module

ramble.test.workspace_tests.test_re_read(tmpdir)

ramble.test.workspace_tests.test_read_file_content(tmpdir)

ramble.test.workspace_tests.workspace_deactivate()