.rst .pdf

repository open issue suggest edit

mcstasscript.tests.test_ManagedMcrun.TestManagedMcrun

class mcstasscript.tests.test_ManagedMcrun.TestManagedMcrun(methodName='runTest')

Testing the ManagedMcrun class that sets up McStas runs, runs the simulation and loads the data.

Here the simulation is not actually performed, this will be done in integration tests. The surrounding plumbing and data loading is tested.

__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.
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.
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_ManagedMcrun_init_defaults()	Check default values are set up correctly
test_ManagedMcrun_init_invalid_mpi_error()	An error should occur if negative mpi is given
test_ManagedMcrun_init_invalid_ncount_error()	An error should occur if negative ncount is given
test_ManagedMcrun_init_invalid_parameters_error()	An error should occur if parameters is given as non dict
test_ManagedMcrun_init_no_folder_error()	An error should occur if no filename is given
test_ManagedMcrun_init_set_custom_flags()	Check custom_flags can be given by user
test_ManagedMcrun_init_set_parameters()	Check parameters can be given as dictionary
test_ManagedMcrun_init_set_values()	Check values given to ManagedMcrun are internalized
test_ManagedMcrun_init_simple()	Check shortest possible initialization works
test_ManagedMcrun_load_data_Event()	Use test_data_set to test load_data for event data
test_ManagedMcrun_load_data_L_mon()	Use test_data_set to test load_data for L_mon
test_ManagedMcrun_load_data_L_mon_direct()	Use test_data_set to test load_data for L_mon with direct path
test_ManagedMcrun_load_data_PSD()	Use test_data_set to test load_data for PSD
test_ManagedMcrun_load_data_PSD4PI()	Use test_data_set to test load_data for PSD_4PI
test_ManagedMcrun_load_data_no_mcsim_file()	Check an error occurs when pointed to directory without mcsim file
test_ManagedMcrun_load_data_nonexisting()	If folder does not exists, a warning should be shown and None returned
test_ManagedMcrun_run_simulation_NeXus(mock_sub)	Check run with NeXus works
test_ManagedMcrun_run_simulation_basic(mock_sub)	Check a basic system call is correct
test_ManagedMcrun_run_simulation_basic_path(...)	Check a basic system call is correct, with different path format
test_ManagedMcrun_run_simulation_compile(...)	Check run with force_compile set to False works
test_ManagedMcrun_run_simulation_no_standard(...)	Check a non standard system call is correct
test_ManagedMcrun_run_simulation_openacc(...)	Check run with openacc works
test_ManagedMcrun_run_simulation_parameters(...)	Check a run with parameters is correct
test_ManagedMcrun_run_simulation_with_gravity(...)	Check a non standard system call is correct when including gravity

Attributes

longMessage
maxDiff

test_ManagedMcrun_init_defaults()

Check default values are set up correctly

test_ManagedMcrun_init_invalid_mpi_error()

An error should occur if negative mpi is given

test_ManagedMcrun_init_invalid_ncount_error()

An error should occur if negative ncount is given

test_ManagedMcrun_init_invalid_parameters_error()

An error should occur if parameters is given as non dict

test_ManagedMcrun_init_no_folder_error()

An error should occur if no filename is given

test_ManagedMcrun_init_set_custom_flags()

Check custom_flags can be given by user

test_ManagedMcrun_init_set_parameters()

Check parameters can be given as dictionary

test_ManagedMcrun_init_set_values()

Check values given to ManagedMcrun are internalized

run_path set to an existing folder in the test directory

test_ManagedMcrun_init_simple()

Check shortest possible initialization works

test_ManagedMcrun_load_data_Event()

Use test_data_set to test load_data for event data

test_ManagedMcrun_load_data_L_mon()

Use test_data_set to test load_data for L_mon

test_ManagedMcrun_load_data_L_mon_direct()

Use test_data_set to test load_data for L_mon with direct path

test_ManagedMcrun_load_data_PSD()

Use test_data_set to test load_data for PSD

test_ManagedMcrun_load_data_PSD4PI()

Use test_data_set to test load_data for PSD_4PI

test_data_set contains three data files and some junk, the mccode.sim file contains names of the data files so only these are loaded.

test_ManagedMcrun_load_data_no_mcsim_file()

Check an error occurs when pointed to directory without mcsim file

test_ManagedMcrun_load_data_nonexisting()

If folder does not exists, a warning should be shown and None returned

test_ManagedMcrun_run_simulation_NeXus(mock_sub)

Check run with NeXus works

test_ManagedMcrun_run_simulation_basic(mock_sub)

Check a basic system call is correct

test_ManagedMcrun_run_simulation_basic_path(mock_sub)

Check a basic system call is correct, with different path format

test_ManagedMcrun_run_simulation_compile(mock_sub)

Check run with force_compile set to False works

test_ManagedMcrun_run_simulation_no_standard(mock_sub)

Check a non standard system call is correct

Here multiple options are used and ncount is a float that should be rounded by the class.

test_ManagedMcrun_run_simulation_openacc(mock_sub)

Check run with openacc works

test_ManagedMcrun_run_simulation_parameters(mock_sub)

Check a run with parameters is correct

test_ManagedMcrun_run_simulation_with_gravity(mock_sub)

Check a non standard system call is correct when including gravity

Here multiple options are used and ncount is a float that should be rounded by the class.

previous

mcstasscript.tests.test_ManagedMcrun

next

mcstasscript.tests.test_ManagedMcrun.Test_load_functions