mcstasscript.tests.test_instrument_diagnostics.TestBeamDiagnostics

class mcstasscript.tests.test_instrument_diagnostics.TestBeamDiagnostics(methodName='runTest')

Tests for the BeamDiagnostics class which sets up event monitors at selected points along the beam path

__init__(methodName='runTest')

Create an instance of the class that will use the named test method when executed. Raises a ValueError if the instance does not have a method with the specified name.

Methods

__init__([methodName])	Create an instance of the class that will use the named test method when executed.
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.
addTypeEqualityFunc(typeobj, function)	Add a type specific assertEqual style function to compare a type.
assertAlmostEqual(first, second[, places, ...])	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.
assertAlmostEquals(**kwargs)
assertCountEqual(first, second[, msg])	Asserts that two iterables have the same elements, the same number of times, without regard to order.
assertDictContainsSubset(subset, dictionary)	Checks whether dictionary is a superset of subset.
assertDictEqual(d1, d2[, msg])
assertEqual(first, second[, msg])	Fail if the two objects are unequal as determined by the '==' operator.
assertEquals(**kwargs)
assertFalse(expr[, msg])	Check that the expression is false.
assertGreater(a, b[, msg])	Just like self.assertTrue(a > b), but with a nicer default message.
assertGreaterEqual(a, b[, msg])	Just like self.assertTrue(a >= b), but with a nicer default message.
assertIn(member, container[, msg])	Just like self.assertTrue(a in b), but with a nicer default message.
assertIs(expr1, expr2[, msg])	Just like self.assertTrue(a is b), but with a nicer default message.
assertIsInstance(obj, cls[, msg])	Same as self.assertTrue(isinstance(obj, cls)), with a nicer default message.
assertIsNone(obj[, msg])	Same as self.assertTrue(obj is None), with a nicer default message.
assertIsNot(expr1, expr2[, msg])	Just like self.assertTrue(a is not b), but with a nicer default message.
assertIsNotNone(obj[, msg])	Included for symmetry with assertIsNone.
assertLess(a, b[, msg])	Just like self.assertTrue(a < b), but with a nicer default message.
assertLessEqual(a, b[, msg])	Just like self.assertTrue(a <= b), but with a nicer default message.
assertListEqual(list1, list2[, msg])	A list-specific equality assertion.
assertLogs([logger, level])	Fail unless a log message of level level or higher is emitted on logger_name or its children.
assertMultiLineEqual(first, second[, msg])	Assert that two multi-line strings are equal.
assertNoLogs([logger, level])	Fail unless no log messages of level level or higher are emitted on logger_name or its children.
assertNotAlmostEqual(first, second[, ...])	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.
assertNotAlmostEquals(**kwargs)
assertNotEqual(first, second[, msg])	Fail if the two objects are equal as determined by the '!=' operator.
assertNotEquals(**kwargs)
assertNotIn(member, container[, msg])	Just like self.assertTrue(a not in b), but with a nicer default message.
assertNotIsInstance(obj, cls[, msg])	Included for symmetry with assertIsInstance.
assertNotRegex(text, unexpected_regex[, msg])	Fail the test if the text matches the regular expression.
assertNotRegexpMatches(**kwargs)
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.
assertRaisesRegex(expected_exception, ...)	Asserts that the message in a raised exception matches a regex.
assertRaisesRegexp(**kwargs)
assertRegex(text, expected_regex[, msg])	Fail the test unless the text matches the regular expression.
assertRegexpMatches(**kwargs)
assertSequenceEqual(seq1, seq2[, msg, seq_type])	An equality assertion for ordered sequences (like lists and tuples).
assertSetEqual(set1, set2[, msg])	A set-specific equality assertion.
assertTrue(expr[, msg])	Check that the expression is true.
assertTupleEqual(tuple1, tuple2[, msg])	A tuple-specific equality assertion.
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.
assertWarnsRegex(expected_warning, ...)	Asserts that the message in a triggered warning matches a regexp.
assert_(**kwargs)
countTestCases()
debug()	Run the test without collecting errors in a TestResult
defaultTestResult()
doClassCleanups()	Execute all class cleanup functions.
doCleanups()	Execute all cleanup functions.
enterClassContext(cm)	Same as enterContext, but class-wide.
enterContext(cm)	Enters the supplied context manager.
fail([msg])	Fail immediately, with the given message.
failIf(**kwargs)
failIfAlmostEqual(**kwargs)
failIfEqual(**kwargs)
failUnless(**kwargs)
failUnlessAlmostEqual(**kwargs)
failUnlessEqual(**kwargs)
failUnlessRaises(**kwargs)
id()
run([result])
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.
shortDescription()	Returns a one-line description of the test, or None if no description has been provided.
skipTest(reason)	Skip this test.
subTest([msg])	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_add_flag_from_user_var()	Check that add_flag accepts a variable name from user_var_list
test_add_flag_max_three()	Check that add_flag enforces a maximum of three flags
test_add_flag_not_in_instrument_raises()	Check that add_flag raises ValueError for a variable not declared in the instrument
test_add_flag_not_string_raises()	Check that add_flag raises ValueError for non-string input
test_add_flag_valid()	Check that add_flag accepts a variable name from declare_list
test_add_monitors_after_point()	Check that add_monitors creates a monitor with the correct name for an after-point
test_add_monitors_creates_monitor_components()	Check that add_monitors creates Monitor_nD components and sets the filename on each diagnostics point
test_add_monitors_ordered_by_component_sequence()	Check that add_monitors orders the diagnostics points according to their position in the instrument component sequence, regardless of the order they were added
test_add_point_after()	Check that add_point with after= creates a DiagnosticsPoint with before=False
test_add_point_before()	Check that add_point with before= creates a DiagnosticsPoint with before=True
test_add_point_both_before_and_after()	Check that add_point accepts both before= and after= simultaneously, creating two separate points
test_add_point_neither_raises()	Check that add_point raises ValueError when neither before nor after is specified
test_add_point_overwrites_existing()	Check that adding a point at an already-tracked location replaces the existing point rather than creating a duplicate
test_add_view()	Check that add_view creates a View with the specified parameters and appends it to the views list
test_clear_flags()	Check that clear_flags empties the flags list
test_clear_points()	Check that clear_points removes all diagnostics points
test_clear_views()	Check that clear_views removes all views
test_init()	Check that a new BeamDiagnostics object starts with empty lists and no data
test_remove_point_after()	Check that remove_point with after= removes the correct point
test_remove_point_before()	Check that remove_point with before= removes the correct point
test_remove_point_neither_raises()	Check that remove_point raises ValueError when neither before nor after is specified
test_repr_no_points_no_views()	Check that __repr__ reports empty state when no points or views added
test_repr_with_data()	Check that __repr__ reports data present when the data attribute has been set
test_show_flags(mock_stdout)	Check that show_flags prints each flag with its user index
test_show_points(mock_stdout)	Check that show_points prints each diagnostics point to stdout
test_show_views(mock_stdout)	Check that show_views prints each view to stdout

Attributes

longMessage
maxDiff

test_add_flag_from_user_var()

Check that add_flag accepts a variable name from user_var_list

test_add_flag_max_three()

Check that add_flag enforces a maximum of three flags

test_add_flag_not_in_instrument_raises()

Check that add_flag raises ValueError for a variable not declared in the instrument

test_add_flag_not_string_raises()

Check that add_flag raises ValueError for non-string input

test_add_flag_valid()

Check that add_flag accepts a variable name from declare_list

test_add_monitors_after_point()

Check that add_monitors creates a monitor with the correct name for an after-point

test_add_monitors_creates_monitor_components()

Check that add_monitors creates Monitor_nD components and sets the filename on each diagnostics point

test_add_monitors_ordered_by_component_sequence()

Check that add_monitors orders the diagnostics points according to their position in the instrument component sequence, regardless of the order they were added

test_add_point_after()

Check that add_point with after= creates a DiagnosticsPoint with before=False

test_add_point_before()

Check that add_point with before= creates a DiagnosticsPoint with before=True

test_add_point_both_before_and_after()

Check that add_point accepts both before= and after= simultaneously, creating two separate points

test_add_point_neither_raises()

Check that add_point raises ValueError when neither before nor after is specified

test_add_point_overwrites_existing()

Check that adding a point at an already-tracked location replaces the existing point rather than creating a duplicate

test_add_view()

Check that add_view creates a View with the specified parameters and appends it to the views list

test_clear_flags()

Check that clear_flags empties the flags list

test_clear_points()

Check that clear_points removes all diagnostics points

test_clear_views()

Check that clear_views removes all views

test_init()

Check that a new BeamDiagnostics object starts with empty lists and no data

test_remove_point_after()

Check that remove_point with after= removes the correct point

test_remove_point_before()

Check that remove_point with before= removes the correct point

test_remove_point_neither_raises()

Check that remove_point raises ValueError when neither before nor after is specified

test_repr_no_points_no_views()

Check that __repr__ reports empty state when no points or views added

test_repr_with_data()

Check that __repr__ reports data present when the data attribute has been set

test_show_flags(mock_stdout)

Check that show_flags prints each flag with its user index

test_show_points(mock_stdout)

Check that show_points prints each diagnostics point to stdout

test_show_views(mock_stdout)

Check that show_views prints each view to stdout