Merge pull request #775 from mantidproject/774_remove_free_all_by_default

Author: Dimitar Tasev

mantidimaging/core/parallel/utility.py

@@ -32,12 +32,22 @@ def free_all_owned_by_this_instance():
         sa.delete(arr.name.decode("utf-8"))
 
 
+def has_other_shared_arrays() -> bool:
+    return len(sa.list()) > 0
+
+
+def free_all():
+    for arr in [array for array in sa.list()]:
+        sa.delete(arr.name.decode("utf-8"))
+
+
 def create_shared_name(file_name=None) -> str:
     return f"{INSTANCE_PREFIX}-{uuid.uuid4()}{f'-{os.path.basename(file_name)}' if file_name is not None else ''}"
 
 
 def delete_shared_array(name, silent_failure=False):
     try:
+        LOG.debug(f"Deleting array with name: {name}")
         sa.delete(f"shm://{name}")
     except FileNotFoundError as e:
         if not silent_failure:

mantidimaging/gui/windows/main/test/view_test.py

@@ -23,7 +23,8 @@
 class MainWindowViewTest(unittest.TestCase):
     def setUp(self) -> None:
         with mock.patch("mantidimaging.gui.windows.main.view.WelcomeScreenPresenter"):
-            self.view = MainWindowView()
+            with mock.patch("mantidimaging.gui.windows.main.view.has_other_shared_arrays", return_value=False):
+                self.view = MainWindowView()
         self.presenter = mock.MagicMock()
         self.view.presenter = self.presenter
 
@@ -306,3 +307,34 @@ def test_get_images_from_stack_uuid(self):
 
         self.presenter.get_stack_visualiser.assert_called_once_with(uuid)
         self.assertEqual(images, return_value)
+
+    @mock.patch("mantidimaging.gui.windows.main.view.has_other_shared_arrays")
+    @mock.patch("mantidimaging.gui.windows.main.view.free_all")
+    @mock.patch("mantidimaging.gui.windows.main.view.QMessageBox")
+    def test_ask_user_to_free_data(self, QMessageBox: Mock, free_all: Mock, has_other_shared_arrays: Mock):
+        has_other_shared_arrays.return_value = True
+        # makes the clickedButton the same return value mock as the addButton return
+        QMessageBox.return_value.clickedButton.return_value = QMessageBox.return_value.addButton.return_value
+
+        self.view.ask_user_to_free_data()
+
+        QMessageBox.return_value.setWindowTitle.assert_called_once()
+        QMessageBox.return_value.setText.assert_called_once()
+        self.assertEquals(QMessageBox.return_value.addButton.call_count, 2)
+        QMessageBox.return_value.exec.assert_called_once()
+        free_all.assert_called_once()
+
+    @mock.patch("mantidimaging.gui.windows.main.view.has_other_shared_arrays")
+    @mock.patch("mantidimaging.gui.windows.main.view.free_all")
+    @mock.patch("mantidimaging.gui.windows.main.view.QMessageBox")
+    def test_ask_user_to_free_data_ignore_pressed(self, QMessageBox: Mock, free_all: Mock,
+                                                  has_other_shared_arrays: Mock):
+        has_other_shared_arrays.return_value = True
+
+        self.view.ask_user_to_free_data()
+
+        QMessageBox.return_value.setWindowTitle.assert_called_once()
+        QMessageBox.return_value.setText.assert_called_once()
+        self.assertEquals(QMessageBox.return_value.addButton.call_count, 2)
+        QMessageBox.return_value.exec.assert_called_once()
+        free_all.assert_not_called()

mantidimaging/gui/windows/main/view.py

@@ -2,6 +2,7 @@
 # SPDX - License - Identifier: GPL-3.0-or-later
 
 from logging import getLogger
+from mantidimaging.core.parallel.utility import free_all, has_other_shared_arrays
 from mantidimaging.core.utility.projection_angle_parser import ProjectionAngleFileParser
 from typing import Optional
 from uuid import UUID
@@ -83,6 +84,23 @@ def __init__(self):
         if WelcomeScreenPresenter.show_today():
             self.show_about()
 
+        if has_other_shared_arrays():
+            self.ask_user_to_free_data()
+
+    def ask_user_to_free_data(self):
+        msg_box = QMessageBox(self)
+        msg_box.setWindowTitle("Previously loaded data found")
+        msg_box.setText("This can happen if Mantid Imaging crashes, or there are multiple instances running.\n\n"
+                        "If Mantid Imaging crashed it is recommended to just 'Release all previous data'.\n\n"
+                        "If you have another instance running it is recommended you 'Ignore' "
+                        "otherwise the other instance will be corrupted.")
+        delete_all = msg_box.addButton("Release all previous data", QMessageBox.ActionRole)
+        _ = msg_box.addButton(QMessageBox.Ignore)
+        msg_box.exec()
+
+        if msg_box.clickedButton() == delete_all:
+            free_all()
+
     def setup_shortcuts(self):
         self.actionLoad.triggered.connect(self.show_load_dialogue)
         self.actionSampleLoadLog.triggered.connect(self.load_sample_log_dialog)

mantidimaging/gui/windows/operations/test/test_view.py

@@ -17,7 +17,8 @@ class OperationsWindowsViewTest(unittest.TestCase):
     def setUp(self):
         # mock the view so it has the same methods
         with mock.patch("mantidimaging.gui.windows.main.view.WelcomeScreenPresenter"):
-            self.main_window = MainWindowView()
+            with mock.patch("mantidimaging.gui.windows.main.view.has_other_shared_arrays", return_value=False):
+                self.main_window = MainWindowView()
         self.window = FiltersWindowView(self.main_window)
 
     def test_collapse(self):

mantidimaging/gui/windows/stack_visualiser/test/view_test.py

@@ -38,7 +38,8 @@ def tearDown(self) -> None:
 
     def setUp(self):
         with mock.patch("mantidimaging.gui.windows.main.view.WelcomeScreenPresenter"):
-            self.window = MainWindowView()
+            with mock.patch("mantidimaging.gui.windows.main.view.has_other_shared_arrays", return_value=False):
+                self.window = MainWindowView()
         self.window.remove_stack = mock.Mock()
         self.dock, self.view, self.test_data = self._add_stack_visualiser()