From f8dc1be57cac3072eaee28a617ec8950ba4f276a Mon Sep 17 00:00:00 2001
From: David Fairbrother <DavidFair@users.noreply.github.com>
Date: Mon, 20 Mar 2017 18:23:37 +0000
Subject: [PATCH] Re #19156 Added unit tests for RunDetails
---
.../ISISPowderRunDetailsTest.yaml.md5 | 1 +
.../ISISPowderRunDetailsTestCallable.yaml.md5 | 1 +
scripts/CMakeLists.txt | 1 +
.../isis_powder/routines/RunDetails.py | 20 +--
scripts/test/ISISPowderRunDetailsTest.py | 127 ++++++++++++++++++
5 files changed, 141 insertions(+), 9 deletions(-)
create mode 100644 Testing/Data/UnitTest/ISISPowderRunDetailsTest.yaml.md5
create mode 100644 Testing/Data/UnitTest/ISISPowderRunDetailsTestCallable.yaml.md5
create mode 100644 scripts/test/ISISPowderRunDetailsTest.py
diff --git a/Testing/Data/UnitTest/ISISPowderRunDetailsTest.yaml.md5 b/Testing/Data/UnitTest/ISISPowderRunDetailsTest.yaml.md5
new file mode 100644
index 00000000000..7279eca1d3e
--- /dev/null
+++ b/Testing/Data/UnitTest/ISISPowderRunDetailsTest.yaml.md5
@@ -0,0 +1 @@
+1c4e481dc080a73039743d7e2fdb461f
diff --git a/Testing/Data/UnitTest/ISISPowderRunDetailsTestCallable.yaml.md5 b/Testing/Data/UnitTest/ISISPowderRunDetailsTestCallable.yaml.md5
new file mode 100644
index 00000000000..a46f33621ee
--- /dev/null
+++ b/Testing/Data/UnitTest/ISISPowderRunDetailsTestCallable.yaml.md5
@@ -0,0 +1 @@
+3e14c49a4d8691f3fe7fe92a95dfc8f3
diff --git a/scripts/CMakeLists.txt b/scripts/CMakeLists.txt
index 10eca015430..941d1418b9a 100644
--- a/scripts/CMakeLists.txt
+++ b/scripts/CMakeLists.txt
@@ -47,6 +47,7 @@ set ( TEST_PY_FILES
test/ISISPowderAbsorptionTest.py
test/ISISPowderCommonTest.py
test/ISISPowderInstrumentSettingsTest.py
+ test/ISISPowderRunDetailsTest.py
test/ISISPowderYamlParserTest.py
test/PyChopTest.py
test/ReductionSettingsTest.py
diff --git a/scripts/Diffraction/isis_powder/routines/RunDetails.py b/scripts/Diffraction/isis_powder/routines/RunDetails.py
index c1e07a8417a..571e69b3dbb 100644
--- a/scripts/Diffraction/isis_powder/routines/RunDetails.py
+++ b/scripts/Diffraction/isis_powder/routines/RunDetails.py
@@ -18,15 +18,17 @@ def create_run_details_object(run_number_string, inst_settings, is_vanadium_run,
# Always make sure the offset file name is included
if splined_name_list:
- splined_name_list.append(offset_file_name)
+ # Force Python to make a copy so we don't modify original
+ new_splined_list = list(splined_name_list)
+ new_splined_list.append(offset_file_name)
else:
- splined_name_list = [offset_file_name]
+ new_splined_list = [offset_file_name]
# These can either be generic or custom so defer to another method
results_dict = _get_customisable_attributes(
cal_dict=cal_map_dict, inst_settings=inst_settings, empty_run_call=empty_run_call,
grouping_name_call=grouping_file_name_call, vanadium_run_call=vanadium_run_call,
- splined_name_list=splined_name_list)
+ splined_name_list=new_splined_list)
vanadium_run_string = results_dict["vanadium_runs"]
@@ -37,7 +39,6 @@ def create_run_details_object(run_number_string, inst_settings, is_vanadium_run,
else:
output_run_string = run_number_string
-
# Sample empty if there is one
sample_empty = inst_settings.sample_empty if hasattr(inst_settings, "sample_empty") else None
@@ -104,7 +105,11 @@ class RunDetailsFuncWrapper(object):
# Holds a callable method, associated args and return value so we can pass it in
# as a single method
- def __init__(self, function=None, func_kwargs=None):
+ def __init__(self, function=None, *args, **func_kwargs):
+ if args:
+ # If we allow args with position Python gets confused as the forwarded value can be in the first place too
+ raise RuntimeError("Cannot use un-named arguments with callable methods")
+
self.function = function
self.function_kwargs = func_kwargs
@@ -136,11 +141,8 @@ class RunDetailsFuncWrapper(object):
self._previous_callable = previous_callable
def add_to_func_chain(self, function, *args, **func_kwargs):
- if args:
- # If we allow args with position Python gets confused as the forwarded value can be in the first place too
- raise RuntimeError("Cannot use un-named arguments with callable methods")
# Construct a new object that will be the next in line
- next_in_chain = RunDetailsFuncWrapper(function=function, func_kwargs=func_kwargs)
+ next_in_chain = RunDetailsFuncWrapper(function=function, *args, **func_kwargs)
next_in_chain._set_previous_callable(self)
return next_in_chain
diff --git a/scripts/test/ISISPowderRunDetailsTest.py b/scripts/test/ISISPowderRunDetailsTest.py
new file mode 100644
index 00000000000..b61c78328b0
--- /dev/null
+++ b/scripts/test/ISISPowderRunDetailsTest.py
@@ -0,0 +1,127 @@
+from __future__ import (absolute_import, division, print_function)
+
+import mantid.api
+import tempfile
+import os
+import random
+import string
+import unittest
+import warnings
+
+from isis_powder.routines import RunDetails
+
+
+class ISISPowderInstrumentRunDetailsTest(unittest.TestCase):
+
+ def setup_mock_inst_settings(self, yaml_file_path):
+ calibration_dir = tempfile.mkdtemp()
+ self._folders_to_remove = [calibration_dir]
+
+ test_configuration_path = mantid.api.FileFinder.getFullPath(yaml_file_path)
+ if not test_configuration_path or len(test_configuration_path) <= 0:
+ self.fail("Could not find the unit test input file called: " + str(yaml_file_path))
+ mock_inst = MockInstSettings(cal_file_path=test_configuration_path, calibration_dir=calibration_dir)
+ return mock_inst
+
+ def tearDown(self):
+ for folder in self._folders_to_remove:
+ try:
+ os.rmdir(folder)
+ except OSError:
+ warnings.warn("Could not remove the folder at the following path:\n" + str(folder))
+
+ def test_create_run_details_object(self):
+ # These attributes are based on a flat YAML file at the specified path
+ expected_label = "16_4"
+ expected_vanadium_runs = "11-12"
+ expected_empty_runs = "13-14"
+ expected_offset_file_name = "offset_file_name"
+ run_number_string = "17-18"
+ mock_inst = self.setup_mock_inst_settings(yaml_file_path="ISISPowderRunDetailsTest.yaml")
+
+ output_obj = RunDetails.create_run_details_object(run_number_string=run_number_string, inst_settings=mock_inst,
+ is_vanadium_run=False)
+
+ self.assertEqual(output_obj.empty_runs, expected_empty_runs)
+ self.assertEqual(output_obj.grouping_file_path,
+ os.path.join(mock_inst.calibration_dir, mock_inst.grouping_file_name))
+ self.assertEqual(output_obj.label, expected_label)
+ self.assertEqual(output_obj.offset_file_path,
+ os.path.join(mock_inst.calibration_dir, expected_label, expected_offset_file_name))
+ self.assertEqual(output_obj.output_run_string, run_number_string)
+ self.assertEqual(output_obj.run_number, 17)
+ self.assertEqual(output_obj.vanadium_run_numbers, expected_vanadium_runs)
+
+ def test_create_run_details_object_when_van_cal(self):
+ # When we are running the vanadium calibration we expected the run number to take the vanadium
+ # number instead
+ run_number_string = "17-18"
+ expected_vanadium_runs = "11-12"
+ mock_inst = self.setup_mock_inst_settings(yaml_file_path="ISISPowderRunDetailsTest.yaml")
+ output_obj = RunDetails.create_run_details_object(run_number_string=run_number_string, inst_settings=mock_inst,
+ is_vanadium_run=True)
+
+ self.assertEqual(expected_vanadium_runs, output_obj.run_number)
+ self.assertEqual(output_obj.vanadium_run_numbers, output_obj.run_number)
+ self.assertEqual(expected_vanadium_runs, output_obj.output_run_string)
+
+ def test_callable_params_are_used(self):
+ # These attributes are based on a custom YAML file at the specified path
+ expected_label = "16_4"
+ expected_vanadium_runs = "11-12"
+ expected_empty_runs = "13-14"
+ expected_grouping_file_name = "grouping_file"
+ run_number_string = "17-18"
+ mock_inst = self.setup_mock_inst_settings(yaml_file_path="ISISPowderRunDetailsTestCallable.yaml")
+
+ # Get the YAML file as a dict first
+ wrapped_funcs = RunDetails.WrappedFunctionsRunDetails
+
+ yaml_callable = RunDetails.RunDetailsFuncWrapper(function=wrapped_funcs.get_cal_mapping_dict,
+ run_number_string=run_number_string, inst_settings=mock_inst)
+
+ empty_callable = yaml_callable.add_to_func_chain(function=wrapped_funcs.cal_dictionary_key_helper,
+ key="custom_empty_run_numbers")
+ vanadium_callable = yaml_callable.add_to_func_chain(function=wrapped_funcs.cal_dictionary_key_helper,
+ key="custom_vanadium_run_numbers")
+ grouping_callable = RunDetails.RunDetailsFuncWrapper(function=lambda: expected_grouping_file_name)
+
+ output_obj = RunDetails.create_run_details_object(run_number_string=run_number_string, inst_settings=mock_inst,
+ is_vanadium_run=True, empty_run_call=empty_callable,
+ vanadium_run_call=vanadium_callable,
+ grouping_file_name_call=grouping_callable)
+
+ self.assertEqual(output_obj.label, expected_label)
+ self.assertEqual(output_obj.empty_runs, expected_empty_runs)
+ self.assertEqual(output_obj.grouping_file_path,
+ os.path.join(mock_inst.calibration_dir, expected_grouping_file_name))
+ self.assertEqual(output_obj.vanadium_run_numbers, expected_vanadium_runs)
+ self.assertEqual(output_obj.run_number, expected_vanadium_runs)
+
+ def test_run_details_splined_name_list_is_used(self):
+ expected_vanadium_runs = "11-12"
+ expected_offset_file_name = "offset_file_name"
+ splined_name_list = ["bar", "bang", "baz"]
+ mock_inst = self.setup_mock_inst_settings(yaml_file_path="ISISPowderRunDetailsTest.yaml")
+ output_obj = RunDetails.create_run_details_object(run_number_string=10, inst_settings=mock_inst,
+ is_vanadium_run=False, splined_name_list=splined_name_list)
+
+ expected_splined_out_str = ''.join('_' + val for val in splined_name_list)
+ expected_output_name = "VanSplined_" + expected_vanadium_runs + expected_splined_out_str
+ expected_output_name += '_' + expected_offset_file_name + ".nxs"
+ expected_path = os.path.join(mock_inst.calibration_dir, output_obj.label, expected_output_name)
+ self.assertEqual(expected_path, output_obj.splined_vanadium_file_path)
+
+
+class MockInstSettings(object):
+ def __init__(self, cal_file_path, calibration_dir):
+ self.calibration_dir = calibration_dir
+ self.cal_mapping_path = cal_file_path
+ self.grouping_file_name = MockInstSettings.gen_random_string()
+
+ @staticmethod
+ def gen_random_string():
+ return ''.join(random.choice(string.lowercase) for _ in range(10))
+
+if __name__ == "__main__":
+ unittest.main()
--
GitLab