CIME.tests.test_unit_cs_status.TestCsStatus

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

Bases: CustomAssertionsTestStatus

Methods

__init__	Create an instance of the class that will use the named test method when executed.
addClassCleanup	Same as addCleanup, except the cleanup items are called even if setUpClass fails (unlike tearDownClass).
addCleanup	Add a function, with arguments, to be called when the test is completed.
addTypeEqualityFunc	Add a type specific assertEqual style function to compare a type.
assertAlmostEqual	Fail if the two objects are unequal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero, or by comparing that the difference between the two objects is more than the given delta.
assertCountEqual	Asserts that two iterables have the same elements, the same number of times, without regard to order.
assertDictEqual
assertEqual	Fail if the two objects are unequal as determined by the '==' operator.
assertFalse	Check that the expression is false.
assertGreater	Just like self.assertTrue(a > b), but with a nicer default message.
assertGreaterEqual	Just like self.assertTrue(a >= b), but with a nicer default message.
assertIn	Just like self.assertTrue(a in b), but with a nicer default message.
assertIs	Just like self.assertTrue(a is b), but with a nicer default message.
assertIsInstance	Same as self.assertTrue(isinstance(obj, cls)), with a nicer default message.
assertIsNone	Same as self.assertTrue(obj is None), with a nicer default message.
assertIsNot	Just like self.assertTrue(a is not b), but with a nicer default message.
assertIsNotNone	Included for symmetry with assertIsNone.
assertLess	Just like self.assertTrue(a < b), but with a nicer default message.
assertLessEqual	Just like self.assertTrue(a <= b), but with a nicer default message.
assertListEqual	A list-specific equality assertion.
assertLogs	Fail unless a log message of level level or higher is emitted on logger_name or its children.
assertMultiLineEqual	Assert that two multi-line strings are equal.
assertNoLogs	Fail unless no log messages of level level or higher are emitted on logger_name or its children.
assertNotAlmostEqual	Fail if the two objects are equal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero, or by comparing that the difference between the two objects is less than the given delta.
assertNotEqual	Fail if the two objects are equal as determined by the '!=' operator.
assertNotIn	Just like self.assertTrue(a not in b), but with a nicer default message.
assertNotIsInstance	Included for symmetry with assertIsInstance.
assertNotRegex	Fail the test if the text matches the regular expression.
assertRaises	Fail unless an exception of class expected_exception is raised by the callable when invoked with specified positional and keyword arguments.
assertRaisesRegex	Asserts that the message in a raised exception matches a regex.
assertRegex	Fail the test unless the text matches the regular expression.
assertSequenceEqual	An equality assertion for ordered sequences (like lists and tuples).
assertSetEqual	A set-specific equality assertion.
assertTrue	Check that the expression is true.
assertTupleEqual	A tuple-specific equality assertion.
assertWarns	Fail unless a warning of class warnClass is triggered by the callable when invoked with specified positional and keyword arguments.
assertWarnsRegex	Asserts that the message in a triggered warning matches a regexp.
assert_core_phases	Asserts that 'output' contains a line for each of the core test phases for the given test_name.
assert_num_expected_unexpected_fails	Asserts that the number of occurrences of expected and unexpected fails in 'output' matches the given numbers
assert_phase_absent	Asserts that 'output' does not contain a status line for the given phase and test_name
assert_status_of_phase	Asserts that 'output' contains a line showing the given status for the given phase for the given test_name.
countTestCases
create_test_dir	Creates the given test directory under testroot.
create_test_status_core_passes	Creates a TestStatus file in the given path, with PASS status for all core phases
debug	Run the test without collecting errors in a TestResult
defaultTestResult
doClassCleanups	Execute all class cleanup functions.
doCleanups	Execute all cleanup functions.
enterClassContext	Same as enterContext, but class-wide.
enterContext	Enters the supplied context manager.
fail	Fail immediately, with the given message.
id
run
setUp	Hook method for setting up the test fixture before exercising it.
setUpClass	Hook method for setting up class fixture before running tests in the class.
set_last_core_phase_to_fail	Sets the last core phase to FAIL
set_phase_to_status	Sets the given phase to the given status for this test
shortDescription	Returns a one-line description of the test, or None if no description has been provided.
skipTest	Skip this test.
subTest	Return a context manager that will return the enclosed block of code in a subtest identified by the optional message and keyword parameters.
tearDown	Hook method for deconstructing the test fixture after testing it.
tearDownClass	Hook method for deconstructing the class fixture after running all tests in the class.
test_count_fails	Test the count of fails with three tests
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

classmethod addClassCleanup(function, /, *args, **kwargs)

Same as addCleanup, except the cleanup items are called even if setUpClass fails (unlike tearDownClass).

addCleanup(function, /, *args, **kwargs)

Add a function, with arguments, to be called when the test is completed. Functions added are called on a LIFO basis and are called after tearDown on test failure or success.

Cleanup items are called even if setUp fails (unlike tearDown).

addTypeEqualityFunc(typeobj, function)

Add a type specific assertEqual style function to compare a type.

This method is for use by TestCase subclasses that need to register their own type equality functions to provide nicer error messages.

Args:

typeobj: The data type to call this function on when both values

are of the same type in assertEqual().

function: The callable taking two arguments and an optional

msg= argument that raises self.failureException with a useful error message when the two arguments are not equal.

assertAlmostEqual(first, second, places=None, msg=None, delta=None)

Fail if the two objects are unequal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero, or by comparing that the difference between the two objects is more than the given delta.

Note that decimal places (from zero) are usually not the same as significant digits (measured from the most significant digit).

If the two objects compare equal then they will automatically compare almost equal.

assertCountEqual(first, second, msg=None)

Asserts that two iterables have the same elements, the same number of times, without regard to order.

self.assertEqual(Counter(list(first)),

Counter(list(second)))

Example:

• [0, 1, 1] and [1, 0, 1] compare equal.

• [0, 0, 1] and [0, 1] compare unequal.

assertEqual(first, second, msg=None)

Fail if the two objects are unequal as determined by the ‘==’ operator.

assertFalse(expr, msg=None)

Check that the expression is false.

assertGreater(a, b, msg=None)

Just like self.assertTrue(a > b), but with a nicer default message.

assertGreaterEqual(a, b, msg=None)

Just like self.assertTrue(a >= b), but with a nicer default message.

assertIn(member, container, msg=None)

Just like self.assertTrue(a in b), but with a nicer default message.

assertIs(expr1, expr2, msg=None)

Just like self.assertTrue(a is b), but with a nicer default message.

assertIsInstance(obj, cls, msg=None)

Same as self.assertTrue(isinstance(obj, cls)), with a nicer default message.

assertIsNone(obj, msg=None)

Same as self.assertTrue(obj is None), with a nicer default message.

assertIsNot(expr1, expr2, msg=None)

Just like self.assertTrue(a is not b), but with a nicer default message.

assertIsNotNone(obj, msg=None)

Included for symmetry with assertIsNone.

assertLess(a, b, msg=None)

Just like self.assertTrue(a < b), but with a nicer default message.

assertLessEqual(a, b, msg=None)

Just like self.assertTrue(a <= b), but with a nicer default message.

assertListEqual(list1, list2, msg=None)

A list-specific equality assertion.

Args:

list1: The first list to compare. list2: The second list to compare. msg: Optional message to use on failure instead of a list of

differences.

assertLogs(logger=None, level=None)

Fail unless a log message of level level or higher is emitted on logger_name or its children. If omitted, level defaults to INFO and logger defaults to the root logger.

This method must be used as a context manager, and will yield a recording object with two attributes: output and records. At the end of the context manager, the output attribute will be a list of the matching formatted log messages and the records attribute will be a list of the corresponding LogRecord objects.

Example:

with self.assertLogs('foo', level='INFO') as cm:
    logging.getLogger('foo').info('first message')
    logging.getLogger('foo.bar').error('second message')
self.assertEqual(cm.output, ['INFO:foo:first message',
                             'ERROR:foo.bar:second message'])

assertMultiLineEqual(first, second, msg=None)

Assert that two multi-line strings are equal.

assertNoLogs(logger=None, level=None)

Fail unless no log messages of level level or higher are emitted on logger_name or its children.

This method must be used as a context manager.

assertNotAlmostEqual(first, second, places=None, msg=None, delta=None)

Fail if the two objects are equal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero, or by comparing that the difference between the two objects is less than the given delta.

Note that decimal places (from zero) are usually not the same as significant digits (measured from the most significant digit).

Objects that are equal automatically fail.

assertNotEqual(first, second, msg=None)

Fail if the two objects are equal as determined by the ‘!=’ operator.

assertNotIn(member, container, msg=None)

Just like self.assertTrue(a not in b), but with a nicer default message.

assertNotIsInstance(obj, cls, msg=None)

Included for symmetry with assertIsInstance.

assertNotRegex(text, unexpected_regex, msg=None)

Fail the test if the text matches the regular expression.

assertRaises(expected_exception, *args, **kwargs)

Fail unless an exception of class expected_exception is raised by the callable when invoked with specified positional and keyword arguments. If a different type of exception is raised, it will not be caught, and the test case will be deemed to have suffered an error, exactly as for an unexpected exception.

If called with the callable and arguments omitted, will return a context object used like this:

with self.assertRaises(SomeException):
    do_something()

An optional keyword argument ‘msg’ can be provided when assertRaises is used as a context object.

The context manager keeps a reference to the exception as the ‘exception’ attribute. This allows you to inspect the exception after the assertion:

with self.assertRaises(SomeException) as cm:
    do_something()
the_exception = cm.exception
self.assertEqual(the_exception.error_code, 3)

assertRaisesRegex(expected_exception, expected_regex, *args, **kwargs)

Asserts that the message in a raised exception matches a regex.

Args:

expected_exception: Exception class expected to be raised. expected_regex: Regex (re.Pattern object or string) expected

to be found in error message.

args: Function to be called and extra positional args. kwargs: Extra kwargs. msg: Optional message used in case of failure. Can only be used

when assertRaisesRegex is used as a context manager.

assertRegex(text, expected_regex, msg=None)

Fail the test unless the text matches the regular expression.

assertSequenceEqual(seq1, seq2, msg=None, seq_type=None)

An equality assertion for ordered sequences (like lists and tuples).

For the purposes of this function, a valid ordered sequence type is one which can be indexed, has a length, and has an equality operator.

Args:

seq1: The first sequence to compare. seq2: The second sequence to compare. seq_type: The expected datatype of the sequences, or None if no

datatype should be enforced.

msg: Optional message to use on failure instead of a list of

differences.

assertSetEqual(set1, set2, msg=None)

A set-specific equality assertion.

Args:

set1: The first set to compare. set2: The second set to compare. msg: Optional message to use on failure instead of a list of

differences.

assertSetEqual uses ducktyping to support different types of sets, and is optimized for sets specifically (parameters must support a difference method).

assertTrue(expr, msg=None)

Check that the expression is true.

assertTupleEqual(tuple1, tuple2, msg=None)

A tuple-specific equality assertion.

Args:

tuple1: The first tuple to compare. tuple2: The second tuple to compare. msg: Optional message to use on failure instead of a list of

differences.

assertWarns(expected_warning, *args, **kwargs)

Fail unless a warning of class warnClass is triggered by the callable when invoked with specified positional and keyword arguments. If a different type of warning is triggered, it will not be handled: depending on the other warning filtering rules in effect, it might be silenced, printed out, or raised as an exception.

If called with the callable and arguments omitted, will return a context object used like this:

with self.assertWarns(SomeWarning):
    do_something()

An optional keyword argument ‘msg’ can be provided when assertWarns is used as a context object.

The context manager keeps a reference to the first matching warning as the ‘warning’ attribute; similarly, the ‘filename’ and ‘lineno’ attributes give you information about the line of Python code from which the warning was triggered. This allows you to inspect the warning after the assertion:

with self.assertWarns(SomeWarning) as cm:
    do_something()
the_warning = cm.warning
self.assertEqual(the_warning.some_attribute, 147)

assertWarnsRegex(expected_warning, expected_regex, *args, **kwargs)

Asserts that the message in a triggered warning matches a regexp. Basic functioning is similar to assertWarns() with the addition that only warnings whose messages also match the regular expression are considered successful matches.

Args:

expected_warning: Warning class expected to be triggered. expected_regex: Regex (re.Pattern object or string) expected

to be found in error message.

args: Function to be called and extra positional args. kwargs: Extra kwargs. msg: Optional message used in case of failure. Can only be used

when assertWarnsRegex is used as a context manager.

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’

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

debug()

Run the test without collecting errors in a TestResult

classmethod doClassCleanups()

Execute all class cleanup functions. Normally called for you after tearDownClass.

doCleanups()

Execute all cleanup functions. Normally called for you after tearDown.

classmethod enterClassContext(cm)

Same as enterContext, but class-wide.

enterContext(cm)

Enters the supplied context manager.

If successful, also adds its __exit__ method as a cleanup function and returns the result of the __enter__ method.

fail(msg=None)

Fail immediately, with the given message.

failureException

alias of AssertionError

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.

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

shortDescription()

Returns a one-line description of the test, or None if no description has been provided.

The default implementation of this method returns the first line of the specified test method’s docstring.

skipTest(reason)

Skip this test.

subTest(msg=<object object>, **params)

Return a context manager that will return the enclosed block of code in a subtest identified by the optional message and keyword parameters. A failure in the subtest marks the test case as failed but resumes execution at the end of the enclosed block, allowing further test code to be executed.

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_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_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