Refs #10190 Add unit tests for batch mode setting of user file

Code/Mantid/scripts/CMakeLists.txt

@@ -28,6 +28,7 @@ set ( TEST_PY_FILES
       test/ReflectometryQuickAuxiliaryTest.py
       test/RunDescriptorTest.py
       test/SansIsisGuiSettings.py
+      test/SANSBatchModeTest.py
       test/SANSUtilitytests.py
       test/SettingsTest.py
       test/ReductionSettingsTest.py

Code/Mantid/scripts/SANS/SANSBatchMode.py

@@ -437,7 +437,7 @@ def setUserFileInBatchMode(new_user_file, current_user_file, original_user_file,
         keep the user file loaded. If the new_user_file is empty then we default to
         original_user_file.
         @param new_user_file: The new user file. Note that this can be merely the filename (+ extension)
-        @param current_user_filie: The currently loaded user file
+        @param current_user_file: The currently loaded user file
         @param original_user_file: The originally loaded user file. This is used as a default
         @param original_settings: The original reducer
         @param original_prop_man_settings: Original properties settings

Code/Mantid/scripts/test/SANSBatchModeTest.py

@@ -0,0 +1,145 @@
+
+import unittest
+import re
+# Need to import mantid before we import SANSUtility
+import mantid
+from mantid.simpleapi import *
+from mantid.api import mtd, WorkspaceGroup
+from ISISCommandInterface import *
+from isis_reduction_steps import UserFile
+import SANSBatchMode as bm
+import time
+
+
+class TestSettingUserFileInBatchMode(unittest.TestCase):
+    def _create_minimal_user_files(self, amount):
+        temp_save_dir = config['defaultsave.directory']
+        if (temp_save_dir == ''):
+            temp_save_dir = os.getcwd()
+        base_name = 'batch_test_file_'
+        file_names = []
+        minimal_user_file = ("LOQ\n"
+                             "L/QXY 0 0.2 0.0125/lin\n")
+        for element in range(0,amount):
+            file_name = os.path.join(temp_save_dir, base_name + str(element) + '.txt')
+            file_names.append(file_name)
+            with open(file_name, 'w') as ff:
+                ff.write(minimal_user_file)
+        return file_names
+
+    def _delete_minimal_user_files(self, file_names):
+        for file_name in file_names:
+            if os.path.exists(file_name):
+                os.remove(file_name)
+
+    def _prepare_reducer(self, current_user_file, original_user_file):
+        # Set up original reducer in order to store a copy
+        Clean()
+        LOQ()
+        ReductionSingleton().user_settings = UserFile(original_user_file)
+        ReductionSingleton().user_settings.execute(ReductionSingleton())
+        original_settings = copy.deepcopy(ReductionSingleton().reference())
+        original_prop_man_settings = ReductionSingleton().settings.clone("TEMP_SETTINGS")
+
+        # Set up current reducer
+        Clean()
+        LOQ()
+        ReductionSingleton().user_settings = UserFile(current_user_file)
+        ReductionSingleton().user_settings.execute(ReductionSingleton())
+        return original_settings, original_prop_man_settings
+
+    def test_user_file_is_set_to_original_when_new_user_file_does_not_exist(self):
+        #Arrange
+        user_files = self._create_minimal_user_files(3)
+        new_user_file = "" # Create an invalid new user file
+        current_user_file = user_files[1]
+        original_user_file = user_files[2]
+        original_settings, original_prop_man_settings = self._prepare_reducer(current_user_file = current_user_file,
+                                                                              original_user_file = original_user_file)
+        # Act
+        reducer_address= str(ReductionSingleton().reference())
+        bm.setUserFileInBatchMode(new_user_file=new_user_file,
+                                  current_user_file=current_user_file,
+                                  original_user_file=original_user_file,
+                                  original_settings = original_settings,
+                                  original_prop_man_settings = original_prop_man_settings)
+        # Assert
+        self.assertTrue(str(ReductionSingleton().reference()) != reducer_address,
+                         ("The physical reducer should change."))
+        self.assertEqual(ReductionSingleton().user_settings.filename, original_user_file,
+                         ("The reducer should use the original user file,"
+                          "since we don't provide a valid new user file."))
+        # Clean up
+        self._delete_minimal_user_files(user_files)
+
+    def test_user_file_is_set_to_new__user_file_when_it_exists_and_is_different_from_orig_and_current(self):
+        #Arrange
+        user_files = self._create_minimal_user_files(3)
+        new_user_file = user_files[0]
+        current_user_file = user_files[1]
+        original_user_file = user_files[2]
+        original_settings, original_prop_man_settings = self._prepare_reducer(current_user_file = current_user_file,
+                                                                              original_user_file = original_user_file)
+        # Act
+        reducer_address= str(ReductionSingleton().reference())
+        bm.setUserFileInBatchMode(new_user_file=new_user_file,
+                                  current_user_file=current_user_file,
+                                  original_user_file=original_user_file,
+                                  original_settings = original_settings,
+                                  original_prop_man_settings = original_prop_man_settings)
+        # Assert
+        self.assertTrue(str(ReductionSingleton().reference()) != reducer_address,
+                        "The physical reducer should not change.")
+        self.assertEqual(ReductionSingleton().user_settings.filename, new_user_file,
+                         "The reducer should use the new user file.")
+        # Clean up
+        self._delete_minimal_user_files(user_files)
+
+    def test_reducer_is_not_reset_when_new_file_is_the_same_as_the_current_file(self):
+        #Arrange
+        user_files = self._create_minimal_user_files(3)
+        new_user_file = user_files[1]
+        current_user_file = user_files[1]
+        original_user_file = user_files[2]
+        original_settings, original_prop_man_settings = self._prepare_reducer(current_user_file = current_user_file,
+                                                                              original_user_file = original_user_file)
+        # Act
+        reducer_address= str(ReductionSingleton().reference())
+        bm.setUserFileInBatchMode(new_user_file=new_user_file,
+                                  current_user_file=current_user_file,
+                                  original_user_file=original_user_file,
+                                  original_settings = original_settings,
+                                  original_prop_man_settings = original_prop_man_settings)
+        # Assert
+        self.assertTrue(str(ReductionSingleton().reference()) == reducer_address,
+                        "The physical reducer should change.")
+        self.assertEqual(ReductionSingleton().user_settings.filename, current_user_file,
+                         "The reducer should use the current user file.")
+        # Clean up
+        self._delete_minimal_user_files(user_files)
+
+    def test_reducer_is_not_reset_if_file_to_set_is_original_and_current(self):
+        #Arrange
+        user_files = self._create_minimal_user_files(3)
+        new_user_file = user_files[1]
+        current_user_file = user_files[1]
+        original_user_file = user_files[1]
+        original_settings, original_prop_man_settings = self._prepare_reducer(current_user_file = current_user_file,
+                                                                              original_user_file = original_user_file)
+        # Act
+        reducer_address= str(ReductionSingleton().reference())
+        bm.setUserFileInBatchMode(new_user_file=new_user_file,
+                                  current_user_file=current_user_file,
+                                  original_user_file=original_user_file,
+                                  original_settings = original_settings,
+                                  original_prop_man_settings = original_prop_man_settings)
+        # Assert
+        self.assertTrue(str(ReductionSingleton().reference()) == reducer_address,
+                        "The physical reducer should not change.")
+        self.assertEqual(ReductionSingleton().user_settings.filename, current_user_file,
+                         "The reducer should use the current user file.")
+        # Clean up
+        self._delete_minimal_user_files(user_files)
+
+if __name__ == "__main__":
+    unittest.main()