Changeset 9e426c1 in sasview for src/sas/qtgui

Timestamp:

Jun 21, 2016 8:07:33 AM (8 years ago)

Author:

Piotr Rozyczko <piotr.rozyczko@…>

Branches:

ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc

Children:

f82ab8c

Parents:

1042dba

Message:

More main window items, system close, update checker, doc viewer etc.

Location:

src/sas/qtgui

Files:

• DataExplorer.py (modified) (7 diffs)
• GuiManager.py (modified) (13 diffs)
• MainWindow.py (modified) (2 diffs)
• UI/AcknowledgementsUI.ui (added)
• UI/DataExplorerUI.py (deleted)
• UnitTesting/DataExplorerTest.py (modified) (5 diffs)
• UnitTesting/GuiManagerTest.py (modified) (4 diffs)
• UnitTesting/MainWindowTest.py (modified) (2 diffs)

src/sas/qtgui/DataExplorer.py

@@ -85 +85 @@
         """
         dir = QtGui.QFileDialog.getExistingDirectory(self, "Choose a directory", "",
-              QtGui.QFileDialog.ShowDirsOnly)
+              QtGui.QFileDialog.ShowDirsOnly | QtGui.QFileDialog.DontUseNativeDialog)
         if dir is None:
             return
@@ -171 +171 @@
         """
         Create a new matplotlib chart from selected data
+
+        TODO: Add 2D-functionality
         """
 
@@ -192 +194 @@
         # Location is automatically saved - no need to keep track of the last dir
         # But only with Qt built-in dialog (non-platform native)
-        paths = QtGui.QFileDialog.getOpenFileName(self, "Choose a file", "",
+        paths = QtGui.QFileDialog.getOpenFileNames(self, "Choose a file", "",
                 wlist, None, QtGui.QFileDialog.DontUseNativeDialog)
         if paths is None:
             return
 
+        if type(paths) == QtCore.QStringList:
+            paths = [str(f) for f in paths]
+
         if paths.__class__.__name__ != "list":
             paths = [paths]
 
-        path_str=[]
-        for path in paths:
-            if str(path):
-                path_str.append(str(path))
-
-        return path_str
+        return paths
 
     def readData(self, path):
@@ -402 +402 @@
         Post message to status bar and update the data manager
         """
+        # Don't show "empty" rows with data objects
+        self.proxy.setFilterRegExp(r"[^()]")
+
+        # Reset the model so the view gets updated.
         self.model.reset()
-        assert(type(output), tuple)
+        assert type(output)== tuple
 
         output_data = output[0]
@@ -433 +437 @@
         checkbox_item.setText(os.path.basename(p_file))
 
-        # Add "Info" item
-        # info_item = QtGui.QStandardItem("Info")
-
         # Add the actual Data1D/Data2D object
         object_item = QtGui.QStandardItem()
@@ -443 +444 @@
 
         # Add rows for display in the view
-        # self.addExtraRows(info_item, data)
         info_item = infoFromData(data)
 
@@ -452 +452 @@
         self.model.appendRow(checkbox_item)
         
-        # Don't show "empty" rows with data objects
-        self.proxy.setFilterRegExp(r"[^()]")
-
     def updateModelFromPerspective(self, model_item):
         """

src/sas/qtgui/GuiManager.py

@@ -1 +1 @@
 import sys
+import subprocess
+import logging
+import json
+import webbrowser
 
 from PyQt4 import QtCore
@@ -9 +13 @@
 # General SAS imports
 from sas.sasgui.guiframe.data_manager import DataManager
+from sas.sasgui.guiframe.proxy import Connection
+
 import LocalConfig
 from GuiUtils import *
+from UI.AcknowledgementsUI import Acknowledgements
 
 # Perspectives
@@ -21 +28 @@
     Main SasView window functionality
     """
+    HELP_DIRECTORY_LOCATION="html"
+
     def __init__(self, mainWindow=None, reactor=None, parent=None):
         """
@@ -56 +65 @@
         self.dockedFilesWidget.setWidget(self.filesWidget)
         self._workspace.addDockWidget(QtCore.Qt.DockWidgetArea(1), self.dockedFilesWidget)
+
+        self.ackWidget = Acknowledgements()
+
         # Disable the close button (?)
+
         # Show the Welcome panel
         self.welcomePanel = WelcomePanel()
@@ -63 +76 @@
         # Current help file
         self._helpView = QtWebKit.QWebView()
-        self._helpLocation = "html/index.html"
+        # Needs URL like path, so no path.join() here
+        self._helpLocation = self.HELP_DIRECTORY_LOCATION + "/index.html"
+
+        # Current tutorial location
+        self._tutorialLocation = os.path.join(self.HELP_DIRECTORY_LOCATION,
+                                              "_downloads",
+                                              "Tutorial.pdf")
 
         #==========================================================
@@ -77 +96 @@
         """
         """
-        print("FILE %s "%data)
         pass
     
@@ -161 +179 @@
             logging.info(msg)
 
+    def quitApplication(self):
+        """
+        Close the reactor and exit nicely.
+        """
+        # Display confirmation messagebox
+        quit_msg = "Are you sure you want to exit the application?"
+        reply = QtGui.QMessageBox.question(
+                        self._parent,
+                        'Warning',
+                        quit_msg,
+                        QtGui.QMessageBox.Yes,
+                        QtGui.QMessageBox.No)
+
+        if reply == QtGui.QMessageBox.No:
+            return
+
+        # Exit if yes
+        reactor.callFromThread(reactor.stop)
+        reactor.stop
+        sys.exit()
+
+    def checkUpdate(self):
+        """
+        Check with the deployment server whether a new version
+        of the application is available.
+        A thread is started for the connecting with the server. The thread calls
+        a call-back method when the current version number has been obtained.
+        """
+        version_info = {"version": "0.0.0"}
+        c = Connection(LocalConfig.__update_URL__, LocalConfig.UPDATE_TIMEOUT)
+        response = c.connect()
+        if response is not None:
+            try:
+                content = response.read().strip()
+                logging.info("Connected to www.sasview.org. Latest version: %s"
+                             % (content))
+                version_info = json.loads(content)
+            except:
+                logging.info("Failed to connect to www.sasview.org")
+        self.processVersion(version_info)  
+  
+    def processVersion(self, version_info, standalone=False):
+        """
+        Call-back method for the process of checking for updates.
+        This methods is called by a VersionThread object once the current
+        version number has been obtained. If the check is being done in the
+        background, the user will not be notified unless there's an update.
+
+        :param version: version string
+        :param standalone: True of the update is being checked in
+           the background, False otherwise.
+
+        """
+        try:
+            version = version_info["version"]
+            if version == "0.0.0":
+                msg = "Could not connect to the application server."
+                msg += " Please try again later."
+                #self.SetStatusText(msg)
+                self.communicate.statusBarUpdateSignal.emit(msg)
+
+            elif cmp(version, LocalConfig.__version__) > 0:
+                msg = "Version %s is available! " % str(version)
+                if not standalone:
+                    if "download_url" in version_info:
+                        webbrowser.open(version_info["download_url"])
+                    else:
+                        webbrowser.open(LocalConfig.__download_page__)
+                else:
+                    msg += "See the help menu to download it."
+                self.communicate.statusBarUpdateSignal.emit(msg)
+            else:
+                msg = "You have the latest version"
+                msg += " of %s" % str(LocalConfig.__appname__)
+                self.communicate.statusBarUpdateSignal.emit(msg)
+        except:
+            msg = "guiframe: could not get latest application"
+            msg += " version number\n  %s" % sys.exc_value
+            logging.error(msg)
+            if not standalone:
+                msg = "Could not connect to the application server."
+                msg += " Please try again later."
+                self.communicate.statusBarUpdateSignal.emit(msg)
+
     def addCallbacks(self):
         """
+        Method defining all signal connections for the gui manager
         """
         self.communicate = Communicate()
@@ -234 +337 @@
     def actionLoadData(self):
         """
-        Load file from Data Explorer
+        Menu File/Load Data File(s)
         """
         self.filesWidget.loadFile()
@@ -240 +343 @@
     def actionLoad_Data_Folder(self):
         """
+        Menu File/Load Data Folder
         """
         self.filesWidget.loadFolder()
@@ -272 +376 @@
         Close the reactor, exit the application.
         """
-        # display messagebox
-        quit_msg = "Are you sure you want to exit the application?"
-        reply = QtGui.QMessageBox.question(self._parent, 'Warning', quit_msg,
-                QtGui.QMessageBox.Yes, QtGui.QMessageBox.No)
-
-        if reply == QtGui.QMessageBox.No:
-            return
-
-        # exit if yes
-        reactor.callFromThread(reactor.stop)
-        sys.exit()
+        self.quitApplication()
 
     #============ EDIT =================
@@ -509 +603 @@
     def actionDocumentation(self):
         """
+        Display the documentation
+
+        TODO: use QNetworkAccessManager to assure _helpLocation is valid
         """
         self._helpView.load(QtCore.QUrl(self._helpLocation))
@@ -515 +612 @@
     def actionTutorial(self):
         """
-        """
-        print("actionTutorial TRIGGERED")
-        pass
+        Open the tutorial PDF file with default PDF renderer
+        """
+        # Not terribly safe here. Shell injection warning.
+        # isfile() helps but this probably needs a better solution.
+        if os.path.isfile(self._tutorialLocation):
+            result = subprocess.Popen([self._tutorialLocation], shell=True)
 
     def actionAcknowledge(self):
         """
-        """
-        print("actionAcknowledge TRIGGERED")
-        pass
+        Open the Acknowledgements widget
+        """
+        self.ackWidget.show()
 
     def actionAbout(self):
         """
-        """
+        Open the About box
+        """
+        
         print("actionAbout TRIGGERED")
         pass
@@ -533 +635 @@
     def actionCheck_for_update(self):
         """
-        """
-        print("actionCheck_for_update TRIGGERED")
-        pass
-
+        Menu Help/Check for Update
+        """
+        self.checkUpdate()
+
+        pass
+

src/sas/qtgui/MainWindow.py

@@ -21 +21 @@
         # Create the gui manager
         from GuiManager import GuiManager
-        guiManager = GuiManager(self, reactor, self)
+        self.guiManager = GuiManager(self, reactor, self)
 
+    def closeEvent(self, event):
+        from twisted.internet import reactor
+        reactor.stop
+        event.accept()
+        sys.exit()
         
 def SplashScreen():
@@ -60 +65 @@
     reactor.run()
 
-    # TODO : in the VS debugger, the Qt loop doesn't seem to end - investigate

src/sas/qtgui/UnitTesting/DataExplorerTest.py

@@ -72 +72 @@
         loadButton = self.form.cmdLoad
 
-        # Mock the system file open method
-        QtGui.QFileDialog.getOpenFileName = MagicMock(return_value=None)
+        filename = "cyl_400_20.txt"
+        # Initialize signal spy instances
+        spy_file_read = QtSignalSpy(self.form, self.form.communicate.fileReadSignal)
+
+        # Return no files.
+        QtGui.QFileDialog.getOpenFileNames = MagicMock(return_value=None)
 
         # Click on the Load button
@@ -79 +83 @@
 
         # Test the getOpenFileName() dialog called once
-        self.assertTrue(QtGui.QFileDialog.getOpenFileName.called)
-        QtGui.QFileDialog.getOpenFileName.assert_called_once()
+        self.assertTrue(QtGui.QFileDialog.getOpenFileNames.called)
+        QtGui.QFileDialog.getOpenFileNames.assert_called_once()
+
+        # Make sure the signal has not been emitted
+        self.assertEqual(spy_file_read.count(), 0)
+
+        # Now, return a single file
+        QtGui.QFileDialog.getOpenFileNames = MagicMock(return_value=filename)
+        
+        # Click on the Load button
+        QTest.mouseClick(loadButton, Qt.LeftButton)
+
+        # Test the getOpenFileName() dialog called once
+        self.assertTrue(QtGui.QFileDialog.getOpenFileNames.called)
+        QtGui.QFileDialog.getOpenFileNames.assert_called_once()
+
+        # Expected one spy instance
+        self.assertEqual(spy_file_read.count(), 1)
+        self.assertIn(filename, str(spy_file_read.called()[0]['args'][0]))
 
     def testDeleteButton(self):
@@ -131 +152 @@
         QTest.mouseClick(deleteButton, Qt.LeftButton)
 
-
     def testSendToButton(self):
         """
@@ -166 +186 @@
         # Assure the message box popped up
         QtGui.QMessageBox.assert_called_once()
-
 
     def testDataSelection(self):
@@ -272 +291 @@
         Test the callback method updating the data object
         """
-
         message="Loading Data Complete"
         data_dict = {"a1":Data1D()}

src/sas/qtgui/UnitTesting/GuiManagerTest.py

@@ -1 +1 @@
 import sys
+import subprocess
 import unittest
+import webbrowser
+import logging
 
 from PyQt4.QtGui import *
 from PyQt4.QtTest import QTest
 from PyQt4.QtCore import *
+from PyQt4.QtWebKit import *
 from mock import MagicMock
 
@@ -10 +14 @@
 from GuiManager import GuiManager
 from UI.MainWindowUI import MainWindow
+from UnitTesting.TestUtils import QtSignalSpy
 
 app = QApplication(sys.argv)
@@ -56 +61 @@
         pass
 
+    def testQuitApplication(self):
+        """
+        Test that the custom exit method is called on shutdown
+        """
+        # Must mask sys.exit, otherwise the whole testing process stops.
+        sys.exit = MagicMock()
+
+        # Say No to the close dialog
+        QMessageBox.question = MagicMock(return_value=QMessageBox.No)
+
+        # Open, then close the manager
+        self.manager.quitApplication()
+
+        # See that the MessageBox method got called
+        self.assertTrue(QMessageBox.question.called)
+        # sys.exit() not called this time
+        self.assertFalse(sys.exit.called)
+
+        # Say Yes to the close dialog
+        QMessageBox.question = MagicMock(return_value=QMessageBox.Yes)
+
+        # Open, then close the manager
+        self.manager.quitApplication()
+
+        # See that the MessageBox method got called
+        self.assertTrue(QMessageBox.question.called)
+        # Also, sys.exit() called
+        self.assertTrue(sys.exit.called)
+
+    def testCheckUpdate(self):
+        """
+        Tests the SasView website version polling
+        """
+        self.manager.processVersion = MagicMock()
+        version = {'update_url'  : 'http://www.sasview.org/sasview.latestversion', 
+                   'version'     : '3.1.2',
+                   'download_url': 'https://github.com/SasView/sasview/releases'}
+        self.manager.checkUpdate()
+
+        self.manager.processVersion.assert_called_with(version)
+
+        pass
+
+    def testProcessVersion(self):
+        """
+        Tests the version checker logic
+        """
+        # 1. version = 0.0.0
+        version_info = {u'version' : u'0.0.0'}
+        spy_status_update = QtSignalSpy(self.manager, self.manager.communicate.statusBarUpdateSignal)
+
+        self.manager.processVersion(version_info)
+
+        self.assertEqual(spy_status_update.count(), 1)
+        message = 'Could not connect to the application server. Please try again later.'
+        self.assertIn(message, str(spy_status_update.signal(index=0)))
+
+        # 2. version < LocalConfig.__version__
+        version_info = {u'version' : u'0.0.1'}
+        spy_status_update = QtSignalSpy(self.manager, self.manager.communicate.statusBarUpdateSignal)
+
+        self.manager.processVersion(version_info)
+
+        self.assertEqual(spy_status_update.count(), 1)
+        message = 'You have the latest version of SasView'
+        self.assertIn(message, str(spy_status_update.signal(index=0)))
+
+        # 3. version > LocalConfig.__version__
+        version_info = {u'version' : u'999.0.0'}
+        spy_status_update = QtSignalSpy(self.manager, self.manager.communicate.statusBarUpdateSignal)
+        webbrowser.open = MagicMock()
+
+        self.manager.processVersion(version_info)
+
+        self.assertEqual(spy_status_update.count(), 1)
+        message = 'Version 999.0.0 is available!'
+        self.assertIn(message, str(spy_status_update.signal(index=0)))
+
+        webbrowser.open.assert_called_with("https://github.com/SasView/sasview/releases")
+
+        # 4. version > LocalConfig.__version__ and standalone
+        version_info = {u'version' : u'999.0.0'}
+        spy_status_update = QtSignalSpy(self.manager, self.manager.communicate.statusBarUpdateSignal)
+        webbrowser.open = MagicMock()
+
+        self.manager.processVersion(version_info, standalone=True)
+
+        self.assertEqual(spy_status_update.count(), 1)
+        message = 'See the help menu to download it'
+        self.assertIn(message, str(spy_status_update.signal(index=0)))
+
+        self.assertFalse(webbrowser.open.called)
+
+        # 5. couldn't load version
+        version_info = {}
+        logging.error = MagicMock()
+        spy_status_update = QtSignalSpy(self.manager, self.manager.communicate.statusBarUpdateSignal)
+
+        self.manager.processVersion(version_info)
+
+        # Retrieve and compare arguments of the mocked call
+        message = "guiframe: could not get latest application version number"
+        args, _ = logging.error.call_args
+        self.assertIn(message, args[0])
+
+        # Check the signal message
+        message = 'Could not connect to the application server.'
+        self.assertIn(message, str(spy_status_update.signal(index=0)))
+
     def testActions(self):
         """
@@ -66 +180 @@
         """
         # Mock the system file open method
-        QFileDialog.getOpenFileName = MagicMock(return_value=None)
+        QFileDialog.getOpenFileNames = MagicMock(return_value=None)
 
         # invoke the action
+        self.manager.actionLoadData()
 
         # Test the getOpenFileName() dialog called once
-        #self.assertTrue(QtGui.QFileDialog.getOpenFileName.called)
-        #QtGui.QFileDialog.getOpenFileName.assert_called_once()
+        self.assertTrue(QFileDialog.getOpenFileNames.called)
         
-
-    # test each action separately
+    def testActionDocumentation(self):
+        """
+        Menu Help/Documentation
+        """
+        #Mock the QWebView method
+        QWebView.show = MagicMock()
+
+        # Assure the filename is correct
+        self.assertIn("index.html", self.manager._helpLocation)
+
+        # Invoke the action
+        self.manager.actionDocumentation()
+
+        # Check if show() got called
+        self.assertTrue(QWebView.show.called)
+
+    def testActionTutorial(self):
+        """
+        Menu Help/Tutorial
+        """
+        # Mock subprocess.Popen
+        subprocess.Popen = MagicMock()
+
+        tested_location = self.manager._tutorialLocation
+
+        # Assure the filename is correct
+        self.assertIn("Tutorial.pdf", tested_location)
+
+        # Invoke the action
+        self.manager.actionTutorial()
+
+        # Check if popen() got called
+        self.assertTrue(subprocess.Popen.called)
+
+        #Check the popen() call arguments
+        subprocess.Popen.assert_called_with([tested_location], shell=True)
+
+    def testActionAcknowledge(self):
+        """
+        Menu Help/Acknowledge
+        """
+        pass
+
+    def testActionCheck_for_update(self):
+        """
+        Menu Help/Check for update
+        """
+        # Just make sure checkUpdate is called.
+        self.manager.checkUpdate = MagicMock()
+
+        self.manager.actionCheck_for_update()
+
+        self.assertTrue(self.manager.checkUpdate.called)
+             
        
 if __name__ == "__main__":

src/sas/qtgui/UnitTesting/MainWindowTest.py

@@ -2 +2 @@
 import unittest
 
-from PyQt4.QtGui import *
-from PyQt4.QtTest import QTest
-from PyQt4.QtCore import *
+from PyQt4 import QtGui
+from PyQt4 import QtTest
+from PyQt4 import QtCore
 from mock import MagicMock
 
@@ -11 +11 @@
 from MainWindow import SplashScreen
 
-app = QApplication(sys.argv)
+app = QtGui.QApplication(sys.argv)
 
 class MainWindowTest(unittest.TestCase):
-    '''Test the Main Window GUI'''
+    """Test the Main Window GUI"""
     def setUp(self):
-        '''Create the GUI'''
+        """Create the GUI"""
 
         self.widget = MainSasViewWindow(None)
 
     def tearDown(self):
-        '''Destroy the GUI'''
-        self.widget.close()
+        """Destroy the GUI"""
         self.widget = None
 
     def testDefaults(self):
-        '''Test the GUI in its default state'''
-        self.assertIsInstance(self.widget, QMainWindow)
-        self.assertIsInstance(self.widget.centralWidget(), QWorkspace)
+        """Test the GUI in its default state"""
+        self.assertIsInstance(self.widget, QtGui.QMainWindow)
+        self.assertIsInstance(self.widget.centralWidget(), QtGui.QWorkspace)
         
     def testSplashScreen(self):
+        """ Test the splash screen """
+        splash = SplashScreen()
+        self.assertIsInstance(splash, QtGui.QSplashScreen)
+
+    def testExit(self):
         """
+        Test that the custom exit method is called on shutdown
         """
-        splash = SplashScreen()
-        self.assertIsInstance(splash, QSplashScreen)
+        # Must mask sys.exit, otherwise the whole testing process stops.
+        sys.exit = MagicMock()
+        QtGui.QMessageBox.question = MagicMock(return_value=QtGui.QMessageBox.Yes)
+
+        # Open, then close the main window
+        tmp_main = MainSasViewWindow(None)
+        tmp_main.close()
+
+        # See that the MessageBox method got called
+        self.assertTrue(QtGui.QMessageBox.question.called)
        
 if __name__ == "__main__":