CIME.tests package

Submodules

CIME.tests.base module

class CIME.tests.base.BaseTestCase(methodName='runTest')

Bases: TestCase

FAST_ONLY = None

GLOBAL_TIMEOUT = None

MACHINE = None

NO_BATCH = None

NO_CMAKE = None

NO_FORTRAN_RUN = None

NO_TEARDOWN = None

SCRIPT_DIR = '/home/runner/work/cime/cime/scripts'

TEST_COMPILER = None

TEST_MPILIB = None

TEST_ROOT = None

TOOLS_DIR = '/home/runner/work/cime/cime/CIME/Tools'

assert_dashboard_has_build(build_name, expected_count=1)

assert_test_status(test_name, test_status_obj, test_phase, expected_stat)

get_casedir(case_fragment, all_cases)

kill_python_subprocesses(sig=Signals.SIGKILL, expected_num_killed=None)

kill_subprocesses(name=None, sig=Signals.SIGKILL, expected_num_killed=None)

run_cmd_assert_result(cmd, from_dir=None, expected_stat=0, env=None, verbose=False, shell=True)

setUp()

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

setup_proxy()

tearDown()

Hook method for deconstructing the test fixture after testing it.

verify_perms(root_dir)

CIME.tests.base.typed_os_environ(key, default_value, expected_type=None)

CIME.tests.case_fake module

This module contains a fake implementation of the Case class that can be used for testing the tests.

class CIME.tests.case_fake.CaseFake(case_root, create_case_root=True)

Bases: object

case_setup(clean=False, test_mode=False, reset=False)

copy(newcasename, newcaseroot)

Create and return a copy of self, but with CASE and CASEBASEID set to newcasename, CASEROOT set to newcaseroot, and RUNDIR set appropriately.

Args:

newcasename (str): new value for CASE newcaseroot (str): new value for CASEROOT

create_clone(newcase, keepexe=False, mach_dir=None, project=None, cime_output_root=None, exeroot=None, rundir=None)

Create a clone of the current case. Also creates the CASEROOT directory for the clone case (given by newcase).

Args:

newcase (str): full path to the new case. This directory should not

already exist; it will be created

keepexe (bool, optional): Ignored mach_dir (str, optional): Ignored project (str, optional): Ignored cime_output_root (str, optional): New CIME_OUTPUT_ROOT for the clone exeroot (str, optional): New EXEROOT for the clone rundir (str, optional): New RUNDIR for the clone

Returns the clone case object

flush()

get_value(item)

Get the value of the given item

Returns None if item isn’t set for this case

Args:

item (str): variable of interest

load_env(reset=False)

make_rundir()

Make directory given by RUNDIR

set_exeroot()

Assumes CASEROOT is already set; sets an appropriate EXEROOT (nested inside CASEROOT)

set_initial_test_values()

set_rundir()

Assumes CASEROOT is already set; sets an appropriate RUNDIR (nested inside CASEROOT)

set_value(item, value)

Set the value of the given item to the given value

Args:

item (str): variable of interest value (any type): new value for item

CIME.tests.custom_assertions_test_status module

This module contains a class that extends unittest.TestCase, adding custom assertions that can be used when testing TestStatus.

class CIME.tests.custom_assertions_test_status.CustomAssertionsTestStatus(methodName='runTest')

Bases: TestCase

assert_core_phases(output, test_name, fails)

Asserts that ‘output’ contains a line for each of the core test phases for the given test_name. All results should be PASS except those given by the fails list, which should be FAILS.

assert_num_expected_unexpected_fails(output, num_expected, num_unexpected)

Asserts that the number of occurrences of expected and unexpected fails in ‘output’ matches the given numbers

assert_phase_absent(output, phase, test_name)

Asserts that ‘output’ does not contain a status line for the given phase and test_name

assert_status_of_phase(output, status, phase, test_name, xfail=None)

Asserts that ‘output’ contains a line showing the given status for the given phase for the given test_name.

‘xfail’ should have one of the following values: - None (the default): assertion passes regardless of whether there is an

EXPECTED/UNEXPECTED string

• ‘no’: The line should end with the phase, with no additional text after that

• ‘expected’: After the phase, the line should contain ‘(EXPECTED FAILURE)’

• ‘unexpected’: After the phase, the line should contain ‘(UNEXPECTED’

CIME.tests.scripts_regression_tests module

Script containing CIME python regression test suite. This suite should be run to confirm overall CIME correctness.

CIME.tests.scripts_regression_tests.cleanup(test_root)

CIME.tests.scripts_regression_tests.configure_tests(timeout, no_fortran_run, fast, no_batch, no_cmake, no_teardown, machine, compiler, mpilib, test_root, **kwargs)

CIME.tests.scripts_regression_tests.setup_arguments(parser)

CIME.tests.scripts_regression_tests.write_provenance_info(machine, test_compiler, test_mpilib, test_root)

CIME.tests.test_sys_bless_tests_results module

class CIME.tests.test_sys_bless_tests_results.TestBlessTestResults(methodName='runTest')

Bases: BaseTestCase

setUp()

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

tearDown()

Hook method for deconstructing the test fixture after testing it.

test_bless_test_results()

test_rebless_namelist()

CIME.tests.test_sys_build_system module

class CIME.tests.test_sys_build_system.TestBuildSystem(methodName='runTest')

Bases: BaseTestCase

test_clean_rebuild()

CIME.tests.test_sys_cime_case module

class CIME.tests.test_sys_cime_case.TestCimeCase(methodName='runTest')

Bases: BaseTestCase

test_case_clean()

test_case_submit_interface()

test_cime_case()

test_cime_case_allow_failed_prereq()

test_cime_case_build_threaded_1()

test_cime_case_build_threaded_2()

test_cime_case_force_pecount()

test_cime_case_mpi_serial()

test_cime_case_prereq()

test_cime_case_resubmit_immediate()

test_cime_case_st_archive_resubmit()

test_cime_case_test_custom_project()

test_cime_case_test_walltime_mgmt_1()

test_cime_case_test_walltime_mgmt_2()

test_cime_case_test_walltime_mgmt_3()

test_cime_case_test_walltime_mgmt_4()

test_cime_case_test_walltime_mgmt_5()

test_cime_case_test_walltime_mgmt_6()

test_cime_case_test_walltime_mgmt_7()

test_cime_case_test_walltime_mgmt_8()

test_cime_case_xmlchange_append()

test_configure()

test_create_test_longname()

test_env_loading()

test_self_build_cprnc()

test_xml_caching()

CIME.tests.test_sys_cime_performance module

class CIME.tests.test_sys_cime_performance.TestCimePerformance(methodName='runTest')

Bases: BaseTestCase

test_cime_case_ctrl_performance()

CIME.tests.test_sys_create_newcase module

class CIME.tests.test_sys_create_newcase.TestCreateNewcase(methodName='runTest')

Bases: BaseTestCase

classmethod setUpClass()

Hook method for setting up class fixture before running tests in the class.

tearDown()

Hook method for deconstructing the test fixture after testing it.

classmethod tearDownClass()

Hook method for deconstructing the class fixture after running all tests in the class.

test_a_createnewcase()

test_aa_no_flush_on_instantiate()

test_b_user_mods()

test_c_create_clone_keepexe()

test_d_create_clone_new_user()

test_dd_create_clone_not_writable()

test_e_xmlquery()

test_f_createnewcase_with_user_compset()

test_g_createnewcase_with_user_compset_and_env_mach_pes()

test_h_primary_component()

test_j_createnewcase_user_compset_vs_alias()

Create a compset using the alias and another compset using the full compset name and make sure they are the same by comparing the namelist files in CaseDocs. Ignore the modelio files and clean the directory names out first.

test_k_append_config()

test_ka_createnewcase_extra_machines_dir()

test_m_createnewcase_alternate_drivers()

test_n_createnewcase_bad_compset()

CIME.tests.test_sys_full_system module

class CIME.tests.test_sys_full_system.TestFullSystem(methodName='runTest')

Bases: BaseTestCase

test_full_system()

CIME.tests.test_sys_grid_generation module

class CIME.tests.test_sys_grid_generation.TestGridGeneration(methodName='runTest')

Bases: BaseTestCase

classmethod setUpClass()

Hook method for setting up class fixture before running tests in the class.

classmethod tearDownClass()

Hook method for deconstructing the class fixture after running all tests in the class.

test_gen_domain()

CIME.tests.test_sys_jenkins_generic_job module

class CIME.tests.test_sys_jenkins_generic_job.TestJenkinsGenericJob(methodName='runTest')

Bases: BaseTestCase

assert_num_leftovers(suite)

setUp()

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

simple_test(expect_works, extra_args, build_name=None)

tearDown()

Hook method for deconstructing the test fixture after testing it.

test_jenkins_generic_job()

test_jenkins_generic_job_kill()

test_jenkins_generic_job_realistic_dash()

test_jenkins_generic_job_save_timing()

threaded_test(expect_works, extra_args, build_name=None)

CIME.tests.test_sys_manage_and_query module

class CIME.tests.test_sys_manage_and_query.TestManageAndQuery(methodName='runTest')

Bases: BaseTestCase

Tests various scripts to manage and query xml files

setUp()

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

test_query_testlists_count_runs()

Make sure that query_testlists runs successfully with the –count argument

test_query_testlists_define_testtypes_runs()

Make sure that query_testlists runs successfully with the –define-testtypes argument

test_query_testlists_list_runs()

Make sure that query_testlists runs successfully with the –list argument

test_query_testlists_runs()

Make sure that query_testlists runs successfully

This simply makes sure that query_testlists doesn’t generate any errors when it runs. This helps ensure that changes in other utilities don’t break query_testlists.

CIME.tests.test_sys_query_config module

class CIME.tests.test_sys_query_config.TestQueryConfig(methodName='runTest')

Bases: BaseTestCase

setUp()

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

test_query_components()

test_query_compsets()

test_query_grids()

test_query_machines()

CIME.tests.test_sys_run_restart module

class CIME.tests.test_sys_run_restart.TestRunRestart(methodName='runTest')

Bases: BaseTestCase

test_run_restart()

test_run_restart_too_many_fails()

CIME.tests.test_sys_save_timings module

class CIME.tests.test_sys_save_timings.TestSaveTimings(methodName='runTest')

Bases: BaseTestCase

simple_test(manual_timing=False)

test_save_timings()

test_save_timings_manual()

test_success_recording()

CIME.tests.test_sys_single_submit module

class CIME.tests.test_sys_single_submit.TestSingleSubmit(methodName='runTest')

Bases: BaseTestCase

test_single_submit()

CIME.tests.test_sys_test_scheduler module

class CIME.tests.test_sys_test_scheduler.TestTestScheduler(methodName='runTest')

Bases: BaseTestCase

get_default_tests()

test_a_phases()

test_b_full()

test_c_use_existing()

test_chksum(strftime)

test_d_retry()

test_e_test_inferred_compiler()

test_force_rebuild()

test_testmods()

test_testmods_malformed()

test_testmods_missing()

CIME.tests.test_sys_unittest module

class CIME.tests.test_sys_unittest.TestUnitTest(methodName='runTest')

Bases: BaseTestCase

setUp()

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

classmethod setUpClass()

Hook method for setting up class fixture before running tests in the class.

classmethod tearDownClass()

Hook method for deconstructing the class fixture after running all tests in the class.

test_a_unit_test()

test_b_cime_f90_unit_tests()

CIME.tests.test_sys_user_concurrent_mods module

class CIME.tests.test_sys_user_concurrent_mods.TestUserConcurrentMods(methodName='runTest')

Bases: BaseTestCase

test_user_concurrent_mods()

CIME.tests.test_sys_wait_for_tests module

class CIME.tests.test_sys_wait_for_tests.TestWaitForTests(methodName='runTest')

Bases: BaseTestCase

live_test_impl(testdir, expected_results, last_phase, last_status)

setUp()

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

simple_test(testdir, expected_results, extra_args='', build_name=None)

tearDown()

Hook method for deconstructing the test fixture after testing it.

test_wait_for_test_all_pass()

test_wait_for_test_cdash_kill()

test_wait_for_test_cdash_pass()

test_wait_for_test_no_wait()

test_wait_for_test_test_status_integration_pass()

test_wait_for_test_test_status_integration_submit_fail()

test_wait_for_test_timeout()

test_wait_for_test_wait_for_missing_run_phase()

test_wait_for_test_wait_for_pend()

test_wait_for_test_wait_kill()

test_wait_for_test_with_fail()

threaded_test(testdir, expected_results, extra_args='', build_name=None)

CIME.tests.test_unit_aprun module

class CIME.tests.test_unit_aprun.TestUnitAprun(methodName='runTest')

Bases: TestCase

test_aprun()

test_aprun_extra_args()

CIME.tests.test_unit_baselines_performance module

class CIME.tests.test_unit_baselines_performance.TestUnitBaselinesPerformance(methodName='runTest')

Bases: TestCase

test__perf_get_memory(get_latest_cpl_logs, get_cpl_mem_usage)

test__perf_get_memory_override(get_latest_cpl_logs, get_cpl_mem_usage)

test__perf_get_throughput(get_latest_cpl_logs, get_cpl_throughput)

test_get_cpl_mem_usage(isfile)

test_get_cpl_mem_usage_gz()

test_get_cpl_throughput()

test_get_cpl_throughput_no_file()

test_get_latest_cpl_logs()

test_get_latest_cpl_logs_found_multiple()

test_get_latest_cpl_logs_found_single()

test_perf_compare_memory_baseline(get_latest_cpl_logs, read_baseline_file, get_cpl_mem_usage)

test_perf_compare_memory_baseline_above_threshold(get_latest_cpl_logs, read_baseline_file, get_cpl_mem_usage)

test_perf_compare_memory_baseline_no_baseline(get_latest_cpl_logs, read_baseline_file, get_cpl_mem_usage)

test_perf_compare_memory_baseline_no_baseline_file(get_latest_cpl_logs, read_baseline_file, get_cpl_mem_usage)

test_perf_compare_memory_baseline_no_tolerance(get_latest_cpl_logs, read_baseline_file, get_cpl_mem_usage)

test_perf_compare_memory_baseline_not_enough_samples(get_latest_cpl_logs, read_baseline_file, get_cpl_mem_usage)

test_perf_compare_throughput_baseline(get_latest_cpl_logs, read_baseline_file, _perf_get_throughput)

test_perf_compare_throughput_baseline_above_threshold(get_latest_cpl_logs, read_baseline_file, _perf_get_throughput)

test_perf_compare_throughput_baseline_no_baseline(get_latest_cpl_logs, read_baseline_file, _perf_get_throughput)

test_perf_compare_throughput_baseline_no_baseline_file(get_latest_cpl_logs, read_baseline_file, _perf_get_throughput)

test_perf_compare_throughput_baseline_no_tolerance(get_latest_cpl_logs, read_baseline_file, _perf_get_throughput)

test_perf_get_memory()

test_perf_get_memory_default(_perf_get_memory)

test_perf_get_throughput()

test_perf_get_throughput_default(_perf_get_throughput)

test_perf_write_baseline(perf_get_throughput, perf_get_memory, write_baseline_file)

test_read_baseline_file_content()

test_read_baseline_file_multi_line()

test_write_baseline_file()

test_write_baseline_runtimeerror(perf_get_throughput, perf_get_memory, write_baseline_file)

test_write_baseline_skip(perf_get_throughput, perf_get_memory, write_baseline_file)

CIME.tests.test_unit_baselines_performance.create_mock_case(tempdir, get_latest_cpl_logs=None)

CIME.tests.test_unit_bless_test_results module

class CIME.tests.test_unit_bless_test_results.TestUnitBlessTestResults(methodName='runTest')

Bases: TestCase

test_baseline_name_none(get_test_status_files, TestStatus, Case, bless_namelists, get_current_branch)

test_baseline_root_none(get_test_status_files, TestStatus, Case)

test_bless_all(get_test_status_files, TestStatus, Case)

test_bless_hist_only(get_test_status_files, TestStatus, Case, bless_history)

test_bless_history(compare_baseline)

test_bless_history_fail(compare_baseline, generate_baseline)

test_bless_history_force(compare_baseline, generate_baseline)

test_bless_memory(perf_compare_memory_baseline)

test_bless_memory_file_not_found_error(perf_compare_memory_baseline, perf_write_baseline)

test_bless_memory_force(perf_compare_memory_baseline, perf_write_baseline)

test_bless_memory_force_error(perf_compare_memory_baseline, perf_write_baseline)

test_bless_memory_general_error(perf_compare_memory_baseline, perf_write_baseline)

test_bless_memory_only(get_test_status_files, TestStatus, Case, _bless_memory, _bless_throughput)

test_bless_memory_report_only(perf_compare_memory_baseline)

test_bless_namelists_fail(run_cmd, get_scripts_root)

test_bless_namelists_force(run_cmd, get_scripts_root)

test_bless_namelists_new_test_id(run_cmd, get_scripts_root)

test_bless_namelists_new_test_root(run_cmd, get_scripts_root)

test_bless_namelists_only(get_test_status_files, TestStatus, Case, bless_namelists)

test_bless_namelists_pes_file(run_cmd, get_scripts_root)

test_bless_namelists_report_only()

test_bless_perf(get_test_status_files, TestStatus, Case, _bless_memory, _bless_throughput)

test_bless_tests_no_match(get_test_status_files, TestStatus, Case)

test_bless_tests_results_fail(get_test_status_files, TestStatus, Case, bless_namelists, bless_history, _bless_throughput, _bless_memory)

test_bless_tests_results_homme(get_test_status_files, TestStatus, Case, bless_namelists, bless_history, _bless_throughput, _bless_memory)

test_bless_throughput(perf_compare_throughput_baseline)

test_bless_throughput_file_not_found_error(perf_compare_throughput_baseline, perf_write_baseline)

test_bless_throughput_force(perf_compare_throughput_baseline, perf_write_baseline)

test_bless_throughput_force_error(perf_compare_throughput_baseline, perf_write_baseline)

test_bless_throughput_general_error(perf_compare_throughput_baseline)

test_bless_throughput_only(get_test_status_files, TestStatus, Case, _bless_memory, _bless_throughput)

test_bless_throughput_report_only(perf_compare_throughput_baseline)

test_exclude(get_test_status_files, TestStatus, Case)

test_is_bless_needed()

test_is_bless_needed_baseline_fail()

test_is_bless_needed_no_run_phase()

test_is_bless_needed_no_skip_fail()

test_is_bless_needed_overall_fail()

test_is_bless_needed_run_phase_fail()

test_multiple_files(get_test_status_files, TestStatus, Case)

test_no_skip_pass(get_test_status_files, TestStatus, Case, bless_namelists, bless_history, _bless_throughput, _bless_memory)

test_specific(get_test_status_files, TestStatus, Case)

CIME.tests.test_unit_case module

class CIME.tests.test_unit_case.TestCase(methodName='runTest')

Bases: TestCase

setUp()

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

test_copy(getuser, getfqdn, configure, create_caseroot, apply_user_mods, set_lookup_value, lock_file, strftime, read_xml)

test_create(get_user, getfqdn, configure, create_caseroot, apply_user_mods, set_lookup_value, lock_file, strftime, read_xml)

test_fix_sys_argv_quotes(read_xml)

test_fix_sys_argv_quotes_incomplete(read_xml)

test_fix_sys_argv_quotes_kv(read_xml)

test_fix_sys_argv_quotes_val(read_xml)

test_fix_sys_argv_quotes_val_quoted(read_xml)

test_new_hash(getuser, getfqdn, strftime, read_xml)

class CIME.tests.test_unit_case.TestCaseSubmit(methodName='runTest')

Bases: TestCase

test__submit(lock_file, unlock_file, basename)

test_check_case()

test_submit(read_xml, get_value, init, _submit)

class CIME.tests.test_unit_case.TestCase_RecordCmd(methodName='runTest')

Bases: TestCase

assert_calls_match(calls, expected)

setUp()

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

test_cmd_arg(get_value, flush, init)

test_error(strftime, get_value, flush, init)

test_init(strftime, get_value, flush, init)

test_sub_relative(strftime, get_value, flush, init)

CIME.tests.test_unit_case.make_valid_case(path)

Make the given path look like a valid case to avoid errors

CIME.tests.test_unit_case_fake module

This module contains unit tests of CaseFake

class CIME.tests.test_unit_case_fake.TestCaseFake(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_create_clone()

CIME.tests.test_unit_case_run module

class CIME.tests.test_unit_case_run.TestCaseSubmit(methodName='runTest')

Bases: TestCase

test_post_run_check(isfile, stat)

test_post_run_check_no_termination(isfile, stat)

CIME.tests.test_unit_case_setup module

class CIME.tests.test_unit_case_setup.TestCaseSetup(methodName='runTest')

Bases: TestCase

test_create_macros(_create_macros_cmake)

test_create_macros_cmake(copy_depends_files)

test_create_macros_copy_extra()

test_create_macros_copy_user()

CIME.tests.test_unit_case_setup.create_machines_dir()

Creates temp machines directory with fake content

CIME.tests.test_unit_compare_test_results module

This module contains unit tests for compare_test_results

class CIME.tests.test_unit_compare_test_results.TestCaseFake(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_baseline()

test_failed_early()

test_hist_only()

test_namelists_only()

CIME.tests.test_unit_compare_two module

This module contains unit tests of the core logic in SystemTestsCompareTwo.

class CIME.tests.test_unit_compare_two.Call(method, arguments)

Bases: tuple

arguments

Alias for field number 1

method

Alias for field number 0

class CIME.tests.test_unit_compare_two.SystemTestsCompareTwoFake(case1, run_one_suffix='base', run_two_suffix='test', separate_builds=False, multisubmit=False, case2setup_raises_exception=False, run_one_should_pass=True, run_two_should_pass=True, compare_should_pass=True)

Bases: SystemTestsCompareTwo

run_indv(suffix='base', st_archive=False, submit_resubmits=None, keep_init_generated_files=False)

This fake implementation appends to the log and raises an exception if it’s supposed to

Note that the Call object appended to the log has the current CASE name in addition to the method arguments. (This is mainly to ensure that the proper suffix is used for the proper case, but this extra check can be removed if it’s a maintenance problem.)

class CIME.tests.test_unit_compare_two.TestSystemTestsCompareTwo(methodName='runTest')

Bases: TestCase

get_caseroots(casename='mytest')

Returns a tuple (case1root, case2root)

get_compare_phase_name(mytest)

Returns a string giving the compare phase name for this test

setUp()

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

tearDown()

Hook method for deconstructing the test fixture after testing it.

test_compare_fails()

test_compare_passes()

test_internal_calls_multisubmit_failed_state()

test_resetup_case_single_exe()

test_run1_fails()

test_run2_fails()

test_run_phase_internal_calls()

test_run_phase_internal_calls_multisubmit_phase1()

test_run_phase_internal_calls_multisubmit_phase2()

test_run_phase_passes()

test_setup()

test_setup_case2_exists()

test_setup_error()

test_setup_separate_builds_sharedlibroot()

CIME.tests.test_unit_config module

class CIME.tests.test_unit_config.TestConfig(methodName='runTest')

Bases: TestCase

test_class()

test_class_external()

test_ignore()

test_load()

test_overwrite()

CIME.tests.test_unit_config.spy(method)

CIME.tests.test_unit_cs_status module

class CIME.tests.test_unit_cs_status.TestCsStatus(methodName='runTest')

Bases: CustomAssertionsTestStatus

create_test_dir(test_dir)

Creates the given test directory under testroot.

Returns the full path to the created test directory.

static create_test_status_core_passes(test_dir_path, test_name)

Creates a TestStatus file in the given path, with PASS status for all core phases

setUp()

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

set_last_core_phase_to_fail(test_dir_path, test_name)

Sets the last core phase to FAIL

Returns the name of this phase

static set_phase_to_status(test_dir_path, test_name, phase, status)

Sets the given phase to the given status for this test

tearDown()

Hook method for deconstructing the test fixture after testing it.

test_count_fails()

Test the count of fails with three tests

For first phase of interest: First test FAILs, second PASSes, third FAILs; count should be 2, and this phase should not appear individually for each test.

For second phase of interest: First test PASSes, second PASSes, third FAILs; count should be 1, and this phase should not appear individually for each test.

test_expected_fails()

With the expected_fails_file flag, expected failures should be flagged as such

test_fails_only()

With fails_only flag, only fails and pends should appear in the output

test_force_rebuild()

test_single_test()

cs_status for a single test should include some minimal expected output

test_two_tests()

cs_status for two tests (one with a FAIL) should include some minimal expected output

CIME.tests.test_unit_custom_assertions_test_status module

This module contains unit tests of CustomAssertionsTestStatus

class CIME.tests.test_unit_custom_assertions_test_status.TestCustomAssertions(methodName='runTest')

Bases: CustomAssertionsTestStatus

static output_line(status, test_name, phase, extra='')

test_assertCorePhases_missingPhase_fails()

assert_core_phases fails if there is a missing phase

test_assertCorePhases_passes()

assert_core_phases passes when it should

test_assertCorePhases_wrongName_fails()

assert_core_phases fails if the test name is wrong

test_assertCorePhases_wrongStatus_fails()

assert_core_phases fails if a phase has the wrong status

test_assertPhaseAbsent_fails()

assert_phase_absent should fail when the phase is present for the given test_name

test_assertPhaseAbsent_passes()

assert_phase_absent should pass when the phase is absent for the given test_name

test_assertStatusOfPhase_withExtra_passes()

Make sure assert_status_of_phase passes when there is some extra text at the end of the line

test_assertStatusOfPhase_xfailExpected_fails()

assert_status_of_phase should fail when xfail=’expected’ but the line does NOT contain the EXPECTED comment

test_assertStatusOfPhase_xfailExpected_passes()

assert_status_of_phase should pass when xfail=’expected’ and the line contains the EXPECTED comment

test_assertStatusOfPhase_xfailNo_fails()

assert_status_of_phase should fail when xfail=’no’ but the line contains the EXPECTED comment

test_assertStatusOfPhase_xfailNo_passes()

assert_status_of_phase should pass when xfail=’no’ and there is no EXPECTED/UNEXPECTED on the line

test_assertStatusOfPhase_xfailUnexpected_fails()

assert_status_of_phase should fail when xfail=’unexpected’ but the line does NOT contain the UNEXPECTED comment

test_assertStatusOfPhase_xfailUnexpected_passes()

assert_status_of_phase should pass when xfail=’unexpected’ and the line contains the UNEXPECTED comment

CIME.tests.test_unit_doctest module

class CIME.tests.test_unit_doctest.TestDocs(methodName='runTest')

Bases: BaseTestCase

test_lib_docs()

CIME.tests.test_unit_expected_fails_file module

class CIME.tests.test_unit_expected_fails_file.TestExpectedFailsFile(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_basic()

Basic test of the parsing of an expected fails file

test_invalid_file()

Given an invalid file, an exception should be raised in schema validation

test_same_test_appears_twice()

If the same test appears twice, its information should be appended.

This is not the typical, expected layout of the file, but it should be handled correctly in case the file is written this way.

CIME.tests.test_unit_grids module

This module tests some functionality of CIME.XML.grids

class CIME.tests.test_unit_grids.TestComponentGrids(methodName='runTest')

Bases: TestCase

Tests the _ComponentGrids helper class defined in CIME.XML.grids

test_check_num_elements_right_ndomains()

With the right number of domains for a component, check_num_elements should pass

test_check_num_elements_right_nmaps()

With the right number of maps between two components, check_num_elements should pass

test_check_num_elements_wrong_ndomains()

With the wrong number of domains for a component, check_num_elements should fail

test_check_num_elements_wrong_nmaps()

With the wrong number of maps between two components, check_num_elements should fail

class CIME.tests.test_unit_grids.TestGrids(methodName='runTest')

Bases: TestCase

Tests some functionality of CIME.XML.grids

Note that much of the functionality of CIME.XML.grids is NOT covered here

assert_grid_info_f09_g17(grid_info)

Asserts that expected grid info is present and correct when using _MODEL_GRID_F09_G17

assert_grid_info_f09_g17_3glc(grid_info)

Asserts that all domain info is present & correct for _MODEL_GRID_F09_G17_3GLC

setUp()

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

tearDown()

Hook method for deconstructing the test fixture after testing it.

test_get_grid_info_3glc()

Test of get_grid_info with 3 glc grids

test_get_grid_info_basic()

Basic test of get_grid_info

test_get_grid_info_extra_gridmaps()

Test of get_grid_info with some extra gridmaps

test_get_grid_info_extra_required_gridmaps()

Test of get_grid_info with some extra required gridmaps

class CIME.tests.test_unit_grids.TestGridsFunctions(methodName='runTest')

Bases: TestCase

Tests helper functions defined in CIME.XML.grids

These tests are in a separate class to avoid the unnecessary setUp and tearDown function of the main test class.

test_add_grid_info_existing()

Test of _add_grid_info when the given key already exists

test_add_grid_info_existing_with_value_for_multiple()

Test of _add_grid_info when the given key already exists and value_for_multiple is provided

test_add_grid_info_initial()

Test of _add_grid_info for the initial add of a given key

test_strip_grid_from_name_badname()

_strip_grid_from_name should raise an exception for a name not ending with _grid

test_strip_grid_from_name_basic()

Basic test of _strip_grid_from_name

CIME.tests.test_unit_hist_utils module

class CIME.tests.test_unit_hist_utils.TestHistUtils(methodName='runTest')

Bases: TestCase

test_copy_histfiles(safe_copy)

test_copy_histfiles_exclude(safe_copy)

CIME.tests.test_unit_locked_files module

class CIME.tests.test_unit_locked_files.TestLockedFiles(methodName='runTest')

Bases: TestCase

test_check_diff_env_batch()

test_check_diff_env_build()

test_check_diff_env_build_no_diff()

test_check_diff_env_build_pio_version()

test_check_diff_env_case()

test_check_diff_env_mach_pes()

test_check_diff_reset_and_rebuild()

test_check_diff_reset_and_rebuild_single()

test_check_lockedfile()

test_check_lockedfiles()

test_check_lockedfiles_quiet()

test_check_lockedfiles_skip()

test_diff_lockedfile()

test_diff_lockedfile_detect_difference()

test_diff_lockedfile_does_not_exist()

test_diff_lockedfile_not_supported()

test_is_locked()

test_lock_file()

test_lock_file_error_path()

test_lock_file_newname()

test_unlock_file()

test_unlock_file_error_path()

CIME.tests.test_unit_locked_files.create_batch_system(env_batch, batch_submit_value=None)

CIME.tests.test_unit_locked_files.create_fake_env(tempdir)

CIME.tests.test_unit_nmlgen module

class CIME.tests.test_unit_nmlgen.TestNamelistGenerator(methodName='runTest')

Bases: TestCase

test_init_defaults()

CIME.tests.test_unit_paramgen module

This module tests some functionality of CIME.ParamGen.paramgen’s ParamGen class

class CIME.tests.test_unit_paramgen.DummyCase

Bases: object

A dummy Case class that mimics CIME class objects’ get_value method.

get_value(varname)

class CIME.tests.test_unit_paramgen.TestParamGen(methodName='runTest')

Bases: TestCase

Tests some basic functionality of the CIME.ParamGen.paramgen’s ParamGen class

test_expandable_vars()

Tests the reduce method of ParamGen expandable vars in guards.

test_formula_expansion()

Tests the formula expansion feature of ParamGen.

test_init_data()

Tests the ParamGen initializer with and without an initial data.

test_match()

Tests the default behavior of returning the last match and the optional behavior of returning the first match.

test_nested_reduce()

Tests the reduce method of ParamGen on data with nested guards.

test_outer_guards()

Tests the reduce method on data with outer guards enclosing parameter definitions.

test_reduce()

Tests the reduce method of ParamGen on data with explicit guards (True or False).

test_undefined_var()

Tests the reduce method of ParamGen on nested guards where an undefined expandable var is specified below a guard that evaluates to False. The undefined var should not lead to an error since the enclosing guard evaluates to false.

class CIME.tests.test_unit_paramgen.TestParamGenXmlConstructor(methodName='runTest')

Bases: TestCase

A unit test class for testing ParamGen’s xml constructor.

test_default_var()

Test to check if default val is assigned when all guards eval to False

test_duplicate_entry_error()

Test to make sure duplicate ids raise the correct error when the “no_duplicates” flag is True.

test_mixed_guard()

Tests multiple key=value guards mixed with explicit (flexible) guards.

test_mixed_guard_first()

Tests multiple key=value guards mixed with explicit (flexible) guards with match=first option.

test_no_match()

Tests an xml entry with no match, i.e., no guards evaluating to True.

test_single_key_val_guard()

Test xml entry values with single key=value guards

class CIME.tests.test_unit_paramgen.TestParamGenYamlConstructor(methodName='runTest')

Bases: TestCase

A unit test class for testing ParamGen’s yaml constructor.

test_input_data_list()

Test mom.input_data_list file generation via a subset of original input_data_list.yaml

test_mom_input()

Test MOM_input file generation via a subset of original MOM_input.yaml

CIME.tests.test_unit_system_tests module

class CIME.tests.test_unit_system_tests.TestUnitSystemTests(methodName='runTest')

Bases: TestCase

test_check_for_memleak(get_latest_cpl_logs, perf_get_memory_list, append_testlog, load_coupler_customization)

test_check_for_memleak_found(get_latest_cpl_logs, perf_get_memory_list, append_testlog, load_coupler_customization)

test_check_for_memleak_not_enough_samples(get_latest_cpl_logs, perf_get_memory_list, append_testlog, load_coupler_customization)

test_check_for_memleak_runtime_error(get_latest_cpl_logs, perf_get_memory_list, append_testlog, load_coupler_customization)

test_compare_memory(append_testlog, perf_compare_memory_baseline)

test_compare_memory_erorr_diff(append_testlog, perf_compare_memory_baseline)

test_compare_memory_erorr_fail(append_testlog, perf_compare_memory_baseline)

test_compare_throughput(append_testlog, perf_compare_throughput_baseline)

test_compare_throughput_error_diff(append_testlog, perf_compare_throughput_baseline)

test_compare_throughput_fail(append_testlog, perf_compare_throughput_baseline)

test_dry_run()

test_generate_baseline()

test_kwargs()

CIME.tests.test_unit_system_tests.create_mock_case(tempdir, idx=None, cpllog_data=None)

CIME.tests.test_unit_system_tests_mvk module

class CIME.tests.test_unit_system_tests_mvk.TestSystemTestsMVK(methodName='runTest')

Bases: TestCase

tearDown()

Hook method for deconstructing the test fixture after testing it.

test__compare_baseline(evv, append_testlog)

test__compare_baseline_resubmit(evv, append_testlog)

test__generate_baseline(evv, append_testlog, _generate_baseline)

test_build_phase(build_indv, case_setup)

test_compare_baseline()

test_generate_namelist()

test_generate_namelist_multiple_components()

test_mvk()

test_testmod_complex(evv, find_test_mods)

test_testmod_simple(evv, find_test_mods)

test_update_testlog(machines, append_testlog)

test_update_testlog_htmlroot(machines, append_testlog, get_htmlroot)

test_update_testlog_urlroot_None(machines, append_testlog, get_urlroot)

CIME.tests.test_unit_system_tests_mvk.create_complex_case(case_name, temp_dir, run_dir, baseline_dir, compare_baseline=False, mock_evv_output=False)

CIME.tests.test_unit_system_tests_mvk.create_simple_case(model='e3sm', resubmit=0, generate_baseline=False)

CIME.tests.test_unit_system_tests_mvk.write_evv_output(evv_output_path, mock_evv_output)

CIME.tests.test_unit_test_status module

class CIME.tests.test_unit_test_status.TestTestStatus(methodName='runTest')

Bases: CustomAssertionsTestStatus

setUp()

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

test_current_is()

test_get_latest_phase()

test_psdump_corePhasesPass()

test_psdump_oneCorePhaseFails()

test_psdump_oneCorePhaseFailsAbsentFromXFails()

One phase fails. There is an expected fails list, but that phase is not in it.

test_psdump_oneCorePhaseFailsInXFails()

One phase fails. That phase is in the expected fails list.

test_psdump_oneCorePhasePassesInXFails()

One phase passes despite being in the expected fails list.

test_psdump_skipPasses()

With the skip_passes argument, only non-passes should appear

test_psdump_unexpectedPass_shouldBePresent()

Even with the skip_passes argument, an unexpected PASS should be present

CIME.tests.test_unit_two_link_to_case2_output module

This module contains unit tests of the method SystemTestsCompareTwo._link_to_case2_output

class CIME.tests.test_unit_two_link_to_case2_output.SystemTestsCompareTwoFake(case1, run_two_suffix='test')

Bases: SystemTestsCompareTwo

class CIME.tests.test_unit_two_link_to_case2_output.TestLinkToCase2Output(methodName='runTest')

Bases: TestCase

create_file_in_rundir2(mytest, core_filename, run2_suffix)

Creates a file in rundir2 named CASE2.CORE_FILENAME.nc.RUN2_SUFFIX (where CASE2 is the casename of case2)

Returns full path to the file created

setUp()

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

setup_test_and_directories(casename1, run2_suffix)

Returns test object

tearDown()

Hook method for deconstructing the test fixture after testing it.

test_basic()

test_existing_link()

CIME.tests.test_unit_user_mod_support module

class CIME.tests.test_unit_user_mod_support.TestUserModSupport(methodName='runTest')

Bases: TestCase

assertResults(expected_user_nl_cpl, expected_shell_commands_result, expected_sourcemod, msg='')

Asserts that the contents of the files in self._caseroot match expectations

If msg is provided, it is printed for some failing assertions

createUserMod(name, include_dirs=None)

Create a user_mods directory with the given name.

This directory is created within self._user_mods_parent_dir

For name=’foo’, it will contain:

• A user_nl_cpl file with contents: foo

• A shell_commands file with contents: echo foo >> /PATH/TO/CASEROOT/shell_commands_result

• A file in _SOURCEMODS named myfile.F90 with contents: foo

If include_dirs is given, it should be a list of strings, giving names of other user_mods directories to include. e.g., if include_dirs is [‘foo1’, ‘foo2’], then this will create a file ‘include_user_mods’ that contains paths to the ‘foo1’ and ‘foo2’ user_mods directories, one per line.

setUp()

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

tearDown()

Hook method for deconstructing the test fixture after testing it.

test_basic()

test_duplicate_includes()

Test multiple includes, where both include the same base mod.

The base mod should only be included once.

test_include()

If there is an included mod, the main one should appear after the included one so that it takes precedence.

test_keepexe()

test_two_applications()

If apply_user_mods is called twice, the second should appear after the first so that it takes precedence.

CIME.tests.test_unit_user_nl_utils module

class CIME.tests.test_unit_user_nl_utils.TestUserNLCopier(methodName='runTest')

Bases: TestCase

assertFileContentsEqual(expected, filepath, msg=None)

Asserts that the contents of the file given by ‘filepath’ are equal to the string given by ‘expected’. ‘msg’ gives an optional message to be printed if the assertion fails.

setUp()

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

tearDown()

Hook method for deconstructing the test fixture after testing it.

test_append()

test_append_list()

test_append_multiple_files()

test_append_without_files_raises_exception()

write_user_nl_file(component, contents, suffix='')

Write contents to a user_nl file in the case directory. Returns the basename (i.e., not the full path) of the file that is created.

For a component foo, with the default suffix of ‘’, the file name will be user_nl_foo

If the suffix is ‘_0001’, the file name will be user_nl_foo_0001

CIME.tests.test_unit_utils module

class CIME.tests.test_unit_utils.MockTime

Bases: object

class CIME.tests.test_unit_utils.TestFileContainsPythonFunction(methodName='runTest')

Bases: TestCase

Tests of file_contains_python_function

create_test_file(contents)

Creates a test file with the given contents, and returns the path to that file

setUp()

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

tearDown()

Hook method for deconstructing the test fixture after testing it.

test_contains_correct_def_and_others()

Test file_contains_python_function with a correct def mixed with other defs

test_does_not_contain_correct_def()

Test file_contains_python_function without the correct def

class CIME.tests.test_unit_utils.TestIndentStr(methodName='runTest')

Bases: TestCase

Test the indent_string function.

test_indent_string_multiline()

Test the indent_string function with a multi-line string

test_indent_string_singleline()

Test the indent_string function with a single-line string

class CIME.tests.test_unit_utils.TestLineDefinesPythonFunction(methodName='runTest')

Bases: TestCase

Tests of _line_defines_python_function

test_def_barfoo()

Test of a def of a different function

test_def_foo()

Test of a def of the function of interest

test_def_foo_indented()

Test of a def of the function of interest, but indented

test_def_foo_no_parens()

Test of a def of the function of interest, but without parentheses

test_def_foo_space()

Test of a def of the function of interest, with an extra space before the parentheses

test_def_foobar()

Test of a def of a different function

test_import_barfoo()

Test of an import of a different function

test_import_foo()

Test of an import of the function of interest

test_import_foo_indented()

Test of an import of the function of interest, but indented

test_import_foo_space()

Test of an import of the function of interest, with trailing spaces

test_import_foo_then_others()

Test of an import of the function of interest, along with others

test_import_foobar()

Test of an import of a different function

test_import_others_then_foo()

Test of an import of the function of interest, after others

class CIME.tests.test_unit_utils.TestUtils(methodName='runTest')

Bases: TestCase

assertMatchAllLines(tempdir, test_lines)

setUp()

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

test_copy_globs(safe_copy, glob)

test_import_and_run_sub_or_cmd()

test_import_and_run_sub_or_cmd_cime_py(importmodule)

test_import_and_run_sub_or_cmd_import(importmodule)

test_import_and_run_sub_or_cmd_run(func, isfile)

test_import_from_file()

test_run_and_log_case_status()

test_run_and_log_case_status_case_submit_error_on_batch()

test_run_and_log_case_status_case_submit_no_batch()

test_run_and_log_case_status_case_submit_on_batch()

test_run_and_log_case_status_custom_msg()

test_run_and_log_case_status_custom_msg_error_on_batch()

test_run_and_log_case_status_error()

CIME.tests.test_unit_utils.match_all_lines(data, lines)

CIME.tests.test_unit_xml_archive_base module

class CIME.tests.test_unit_xml_archive_base.TestXMLArchiveBase(methodName='runTest')

Bases: TestCase

test_exclude_testing()

test_extension_included()

test_match_files()

test_suffix()

CIME.tests.test_unit_xml_env_batch module

class CIME.tests.test_unit_xml_env_batch.TestXMLEnvBatch(methodName='runTest')

Bases: TestCase

test_get_job_deps()

test_get_queue_specs(get)

test_get_submit_args()

test_get_submit_args_job_queue()

test_set_job_defaults(get_default_queue, select_best_queue, get_queue_specs, text)

test_set_job_defaults_honor_walltimemax(get_default_queue, select_best_queue, get_queue_specs, text)

test_set_job_defaults_honor_walltimemin(get_default_queue, select_best_queue, get_queue_specs, text)

test_set_job_defaults_user_walltime(get_default_queue, select_best_queue, get_queue_specs, text)

test_set_job_defaults_walltimedef(get_default_queue, select_best_queue, get_queue_specs, text)

test_set_job_defaults_walltimemax_none(get_default_queue, select_best_queue, get_queue_specs, text)

test_set_job_defaults_walltimemin_none(get_default_queue, select_best_queue, get_queue_specs, text)

test_submit_jobs(_submit_single_job)

test_submit_jobs_dependency(_submit_single_job, get_batch_script_for_job, isfile)

test_submit_jobs_single(_submit_single_job, get_batch_script_for_job, isfile)

CIME.tests.test_unit_xml_env_mach_specific module

class CIME.tests.test_unit_xml_env_mach_specific.TestXMLEnvMachSpecific(methodName='runTest')

Bases: TestCase

test_aprun_get_args()

test_cmd_path(text, get_optional_child)

test_find_best_mpirun_match()

test_get_aprun_mode_default()

test_get_aprun_mode_not_valid()

test_get_aprun_mode_user_defined()

test_get_mpirun()

test_init_path(text, get_optional_child)

CIME.tests.test_unit_xml_grids module

class CIME.tests.test_unit_xml_grids.TestXMLGrids(methodName='runTest')

Bases: TestCase

test_read_config_grids()

CIME.tests.test_unit_xml_grids.write_config_grids(tempdir, config)

CIME.tests.test_unit_xml_machines module

class CIME.tests.test_unit_xml_machines.TestUnitXMLMachines(methodName='runTest')

Bases: TestCase

setUp()

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

test_has_batch_system()

test_is_valid_MPIlib()

test_is_valid_compiler()

CIME.tests.test_unit_xml_namelist_definition module

class CIME.tests.test_unit_xml_namelist_definition.TestXMLNamelistDefinition(methodName='runTest')

Bases: TestCase

test_set_nodes()

CIME.tests.test_unit_xml_tests module

class CIME.tests.test_unit_xml_tests.TestXMLTests(methodName='runTest')

Bases: TestCase

setUp()

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

test_support_single_exe(_setup_cases_if_not_yet_done)

test_support_single_exe_error(_setup_cases_if_not_yet_done)

CIME.tests.utils module

class CIME.tests.utils.CMakeTester(parent, cmake_string)

Bases: object

Helper class for checking CMake output.

Public methods: __init__ query_var assert_variable_equals assert_variable_matches

assert_variable_equals(var_name, value, env=None, var=None)

Assert that a variable in the CMakeLists has a given value.

Arguments: var_name - Name of variable to check. value - The string that the variable value should be equal to. env - Optional. Dict of environment variables to set when calling cmake. var - Optional. Dict of CMake variables to set when calling cmake.

assert_variable_matches(var_name, regex, env=None, var=None)

Assert that a variable in the CMkeLists matches a regex.

Arguments: var_name - Name of variable to check. regex - The regex to match. env - Optional. Dict of environment variables to set when calling cmake. var - Optional. Dict of CMake variables to set when calling cmake.

query_var(var_name, env, var)

Request the value of a variable in Macros.cmake, as a string.

Arguments: var_name - Name of the variable to query. env - A dict containing extra environment variables to set when calling

cmake.

var - A dict containing extra CMake variables to set when calling cmake.

class CIME.tests.utils.MakefileTester(parent, make_string)

Bases: object

Helper class for checking Makefile output.

Public methods: __init__ query_var assert_variable_equals assert_variable_matches

assert_variable_equals(var_name, value, env=None, var=None)

Assert that a variable in the Makefile has a given value.

Arguments: var_name - Name of variable to check. value - The string that the variable value should be equal to. env - Optional. Dict of environment variables to set when calling make. var - Optional. Dict of make variables to set when calling make.

assert_variable_matches(var_name, regex, env=None, var=None)

Assert that a variable in the Makefile matches a regex.

Arguments: var_name - Name of variable to check. regex - The regex to match. env - Optional. Dict of environment variables to set when calling make. var - Optional. Dict of make variables to set when calling make.

query_var(var_name, env, var)

Request the value of a variable in the Makefile, as a string.

Arguments: var_name - Name of the variable to query. env - A dict containing extra environment variables to set when calling

make.

var - A dict containing extra make variables to set when calling make.

(The distinction between env and var actually matters only for

CMake, though.)

class CIME.tests.utils.MockMachines(name, os_)

Bases: object

A mock version of the Machines object to simplify testing.

get_default_MPIlib(attributes=None)

get_default_compiler()

get_machine_name()

Return the name we were given.

get_value(var_name)

Allow the operating system to be queried.

is_valid_MPIlib(_)

Assume all MPILIB settings are valid.

is_valid_compiler(_)

Assume all compilers are valid.

class CIME.tests.utils.Mocker(ret=None, cmd=None, return_value=None, side_effect=None)

Bases: object

assert_called()

assert_called_with(i=None, args=None, kwargs=None)

property calls

property method_calls

patch(module, method=None, ret=None, is_property=False, update_value_only=False)

property ret

revert_mocks()

class CIME.tests.utils.TemporaryDirectory

Bases: object

CIME.tests.utils.chdir(path)

CIME.tests.utils.make_fake_teststatus(path, testname, status, phase)

CIME.tests.utils.parse_test_status(line)

Module contents