Merge branch 'feature/error-handling' into develop

Closes #504: design generic error handling solution.

* app-wide logging config.
* --logfile command line argument.
* created basic exception hierarchy
* conductor pushes exceptions to error queue
* in Qt, error dialogs are created from exception attributes

7 files changed, 165 insertions, 105 deletions

diff --git a/src/leap/baseapp/constants.py b/src/leap/baseapp/constants.py
index 763df23b..e312be21 100644
--- a/src/leap/baseapp/constants.py
+++ b/src/leap/baseapp/constants.py
@@ -1 +1,6 @@
+# This timer used for polling vpn manager state.
+
+# XXX what is an optimum polling interval?
+# too little will be overkill, too much will
+# miss transition states.
 TIMER_MILLISECONDS = 250.0
diff --git a/src/leap/baseapp/dialogs.py b/src/leap/baseapp/dialogs.py
index 4b1b5b62..d4acb09d 100644
--- a/src/leap/baseapp/dialogs.py
+++ b/src/leap/baseapp/dialogs.py
@@ -1,33 +1,47 @@
+import logging
+
 from PyQt4.QtGui import (QDialog, QFrame, QPushButton, QLabel, QMessageBox)
 
+logger = logging.getLogger(name=__name__)
+
 
 class ErrorDialog(QDialog):
-    def __init__(self, parent=None):
+    def __init__(self, parent=None, errtype=None, msg=None, label=None):
         super(ErrorDialog, self).__init__(parent)
-
         frameStyle = QFrame.Sunken | QFrame.Panel
         self.warningLabel = QLabel()
         self.warningLabel.setFrameStyle(frameStyle)
         self.warningButton = QPushButton("QMessageBox.&warning()")
 
+        if msg is not None:
+            self.msg = msg
+        if label is not None:
+            self.label = label
+        if errtype == "critical":
+            self.criticalMessage(self.msg, self.label)
+
     def warningMessage(self, msg, label):
         msgBox = QMessageBox(QMessageBox.Warning,
                              "QMessageBox.warning()", msg,
                              QMessageBox.NoButton, self)
         msgBox.addButton("&Ok", QMessageBox.AcceptRole)
-        msgBox.addButton("&Cancel", QMessageBox.RejectRole)
         if msgBox.exec_() == QMessageBox.AcceptRole:
-            self.warningLabel.setText("Save Again")
-        else:
-            self.warningLabel.setText("Continue")
+            pass
+            # do whatever we want to do after
+            # closing the dialog. we can pass that
+            # in the constructor
 
     def criticalMessage(self, msg, label):
         msgBox = QMessageBox(QMessageBox.Critical,
                              "QMessageBox.critical()", msg,
                              QMessageBox.NoButton, self)
         msgBox.addButton("&Ok", QMessageBox.AcceptRole)
-        msgBox.addButton("&Cancel", QMessageBox.RejectRole)
-        if msgBox.exec_() == QMessageBox.AcceptRole:
-            self.warningLabel.setText("Save Again")
-        else:
-            self.warningLabel.setText("Continue")
+        msgBox.exec_()
+
+        # It's critical, so we exit.
+        # We should better emit a signal and connect it
+        # with the proper shutdownAndQuit method, but
+        # this suffices for now.
+        logger.info('Quitting')
+        import sys
+        sys.exit()
diff --git a/src/leap/baseapp/eip.py b/src/leap/baseapp/eip.py
index 029ce0ba..afdb7adc 100644
--- a/src/leap/baseapp/eip.py
+++ b/src/leap/baseapp/eip.py
@@ -1,3 +1,4 @@
+import logging
 import time
 
 from PyQt4 import QtCore
@@ -7,8 +8,10 @@ from leap.baseapp import constants
 from leap.eip import exceptions as eip_exceptions
 from leap.eip.eipconnection import EIPConnection
 
+logger = logging.getLogger(name=__name__)
 
-class EIPConductorApp(object):
+
+class EIPConductorAppMixin(object):
     """
     initializes an instance of EIPConnection,
     gathers errors, and passes status-change signals
@@ -48,64 +51,90 @@ class EIPConductorApp(object):
                 lambda: self.start_or_stopVPN())
 
     def error_check(self):
+        """
+        consumes the conductor error queue.
+        pops errors, and acts accordingly (launching user dialogs).
+        """
+        logger.debug('error check')
+
+        #####################################
+        # XXX refactor in progress (by #504)
+
+        errq = self.conductor.error_queue
+        while errq.qsize() != 0:
+            logger.debug('%s errors left in conductor queue', errq.qsize())
+            error = errq.get()
+
+            # redundant log, debugging the loop.
+            logger.error('%s: %s', error.__class__.__name__, error.message)
+
+            if issubclass(error.__class__, eip_exceptions.EIPClientError):
+                self.handle_eip_error(error)
+
+            else:
+                # This is not quite working. FIXME
+                import traceback
+                traceback.print_exc()
+                raise error
+
+            if error.failfirst is True:
+                break
+
+        #############################################
+        # old errors to check
+        # write test for them and them remove
+        # their corpses from here.
+
+        #if self.conductor.missing_vpn_keyfile is True:
+            #dialog = ErrorDialog()
+            #dialog.criticalMessage(
+                #'Could not find the vpn keys file',
+                #'error')
+
+        #if self.conductor.bad_keyfile_perms is True:
+            #dialog = ErrorDialog()
+            #dialog.criticalMessage(
+                #'The vpn keys file has bad permissions',
+                #'error')
+
+        # deprecated. configchecker takes care of that.
+        #if self.conductor.missing_definition is True:
+            #dialog = ErrorDialog()
+            #dialog.criticalMessage(
+                #'The default '
+                #'definition.json file cannot be found',
+                #'error')
+
+    def handle_eip_error(self, error):
+        """
+        check severity and launches
+        dialogs informing user about the errors.
+        in the future we plan to derive errors to
+        our log viewer.
+        """
 
-        # XXX refactor (by #504)
-
-        if self.conductor.missing_definition is True:
-            dialog = ErrorDialog()
-            dialog.criticalMessage(
-                'The default '
-                'definition.json file cannot be found',
-                'error')
-
-        if self.conductor.missing_provider is True:
-            dialog = ErrorDialog()
-            dialog.criticalMessage(
-                'Missing provider. Add a remote_ip entry '
-                'under section [provider] in eip.cfg',
-                'error')
-
-        if self.conductor.missing_vpn_keyfile is True:
-            dialog = ErrorDialog()
-            dialog.criticalMessage(
-                'Could not find the vpn keys file',
-                'error')
-
-        # ... btw, review pending.
-        # os.kill of subprocess fails if we have
-        # some of this errors.
-
-        if self.conductor.bad_provider is True:
-            dialog = ErrorDialog()
-            dialog.criticalMessage(
-                'Bad provider entry. Check that remote_ip entry '
-                'has an IP under section [provider] in eip.cfg',
-                'error')
-
-        if self.conductor.bad_keyfile_perms is True:
-            dialog = ErrorDialog()
-            dialog.criticalMessage(
-                'The vpn keys file has bad permissions',
-                'error')
-
-        if self.conductor.missing_auth_agent is True:
-            dialog = ErrorDialog()
-            dialog.warningMessage(
-                'We could not find any authentication '
-                'agent in your system.<br/>'
-                'Make sure you have '
-                '<b>polkit-gnome-authentication-agent-1</b> '
-                'running and try again.',
-                'error')
-
-        if self.conductor.missing_pkexec is True:
+        if getattr(error, 'usermessage', None):
+            message = error.usermessage
+        else:
+            message = error.message
+
+        # XXX
+        # check headless = False before
+        # launching dialog.
+        # (so Qt tests can assert stuff)
+
+        if error.critical:
+            logger.critical(error.message)
+            #critical error (non recoverable),
+            #we give user some info and quit.
+            #(critical error dialog will exit app)
+            ErrorDialog(errtype="critical",
+                        msg=message,
+                        label="critical error")
+
+        else:
             dialog = ErrorDialog()
-            dialog.warningMessage(
-                'We could not find <b>pkexec</b> in your '
-                'system.<br/> Do you want to try '
-                '<b>setuid workaround</b>? '
-                '(<i>DOES NOTHING YET</i>)',
-                'error')
+            dialog.warningMessage(message, 'error')
 
     @QtCore.pyqtSlot()
     def statusUpdate(self):
@@ -126,8 +155,9 @@ class EIPConductorApp(object):
         if self.conductor.with_errors:
             #XXX how to wait on pkexec???
             #something better that this workaround, plz!!
-            time.sleep(2)
-            print('errors. disconnect.')
+            time.sleep(5)
+            logger.debug('timeout')
+            logger.error('errors. disconnect')
             self.start_or_stopVPN()  # is stop
 
         state = self.conductor.poll_connection_state()
@@ -161,29 +191,30 @@ class EIPConductorApp(object):
         """
         stub for running child process with vpn
         """
+        if self.conductor.has_errors():
+            logger.debug('not starting vpn; conductor has errors')
+
         if self.eip_service_started is False:
             try:
                 self.conductor.connect()
-                # XXX move this to error queue
-            except eip_exceptions.EIPNoCommandError:
-                dialog = ErrorDialog()
-                dialog.warningMessage(
-                    'No suitable openvpn command found. '
-                    '<br/>(Might be a permissions problem)',
-                    'error')
-            if self.debugmode:
-                self.startStopButton.setText('&Disconnect')
-            self.eip_service_started = True
 
-            # XXX what is optimum polling interval?
-            # too little is overkill, too much
-            # will miss transition states..
+            except eip_exceptions.EIPNoCommandError as exc:
+                self.handle_eip_error(exc)
+
+            except Exception as err:
+                # raise generic exception (Bad Thing Happened?)
+                logger.exception(err)
+            else:
+                # no errors, so go on.
+                if self.debugmode:
+                    self.startStopButton.setText('&Disconnect')
+                self.eip_service_started = True
 
-            # XXX decouple! (timer is init by icons class).
-            # should bring it here?
-            # to its own class?
+                # XXX decouple! (timer is init by icons class).
+                # we could bring Timer Init to this Mixin
+                # or to its own Mixin.
+                self.timer.start(constants.TIMER_MILLISECONDS)
 
-            self.timer.start(constants.TIMER_MILLISECONDS)
             return
 
         if self.eip_service_started is True:
diff --git a/src/leap/baseapp/leap_app.py b/src/leap/baseapp/leap_app.py
index def95da1..f91b2329 100644
--- a/src/leap/baseapp/leap_app.py
+++ b/src/leap/baseapp/leap_app.py
@@ -1,9 +1,13 @@
+import logging
+
 from PyQt4 import QtGui
 
 from leap.gui import mainwindow_rc
 
+logger = logging.getLogger(name=__name__)
+
 
-class MainWindow(object):
+class MainWindowMixin(object):
     """
     create the main window
     for leap app
@@ -79,5 +83,7 @@ technolust</i>")
         # TODO:make sure to shutdown all child process / threads
         # in conductor
         # XXX send signal instead?
+        logger.info('Shutting down')
         self.conductor.cleanup()
+        logger.info('Exiting')
         QtGui.qApp.quit()
diff --git a/src/leap/baseapp/log.py b/src/leap/baseapp/log.py
index 0c98eb94..8a7f81c3 100644
--- a/src/leap/baseapp/log.py
+++ b/src/leap/baseapp/log.py
@@ -1,8 +1,12 @@
+import logging
+
 from PyQt4 import QtGui
 from PyQt4 import QtCore
 
+vpnlogger = logging.getLogger('leap.openvpn')
+
 
-class LogPane(object):
+class LogPaneMixin(object):
     """
     a simple log pane
     that writes new lines as they come
@@ -18,7 +22,6 @@ class LogPane(object):
         self.logbrowser = QtGui.QTextBrowser()
 
         startStopButton = QtGui.QPushButton("&Connect")
-        #startStopButton.clicked.connect(self.start_or_stopVPN)
         self.startStopButton = startStopButton
 
         logging_layout.addWidget(self.logbrowser)
@@ -56,5 +59,7 @@ class LogPane(object):
         """
         simple slot: writes new line to logger Pane.
         """
+        msg = line[:-1]
         if self.debugmode:
-            self.logbrowser.append(line[:-1])
+            self.logbrowser.append(msg)
+        vpnlogger.info(msg)
diff --git a/src/leap/baseapp/mainwindow.py b/src/leap/baseapp/mainwindow.py
index ac7fe9c4..10b23d9a 100644
--- a/src/leap/baseapp/mainwindow.py
+++ b/src/leap/baseapp/mainwindow.py
@@ -1,23 +1,22 @@
 # vim: set fileencoding=utf-8 :
 #!/usr/bin/env python
 import logging
-logging.basicConfig()
-logger = logging.getLogger(name=__name__)
-logger.setLevel(logging.DEBUG)
 
 from PyQt4 import QtCore
 from PyQt4 import QtGui
 
-from leap.baseapp.eip import EIPConductorApp
-from leap.baseapp.log import LogPane
-from leap.baseapp.systray import StatusAwareTrayIcon
-from leap.baseapp.leap_app import MainWindow
+from leap.baseapp.eip import EIPConductorAppMixin
+from leap.baseapp.log import LogPaneMixin
+from leap.baseapp.systray import StatusAwareTrayIconMixin
+from leap.baseapp.leap_app import MainWindowMixin
+
+logger = logging.getLogger(name=__name__)
 
 
 class LeapWindow(QtGui.QMainWindow,
-                 MainWindow, EIPConductorApp,
-                 StatusAwareTrayIcon,
-                 LogPane):
+                 MainWindowMixin, EIPConductorAppMixin,
+                 StatusAwareTrayIconMixin,
+                 LogPaneMixin):
     """
     main window for the leap app.
     Initializes all of its base classes
@@ -35,9 +34,9 @@ class LeapWindow(QtGui.QMainWindow,
         super(LeapWindow, self).__init__()
         if self.debugmode:
             self.createLogBrowser()
-        EIPConductorApp.__init__(self, opts=opts)
-        StatusAwareTrayIcon.__init__(self)
-        MainWindow.__init__(self)
+        EIPConductorAppMixin.__init__(self, opts=opts)
+        StatusAwareTrayIconMixin.__init__(self)
+        MainWindowMixin.__init__(self)
 
         # bind signals
         # XXX move to parent classes init??
diff --git a/src/leap/baseapp/systray.py b/src/leap/baseapp/systray.py
index f3832473..c696ee74 100644
--- a/src/leap/baseapp/systray.py
+++ b/src/leap/baseapp/systray.py
@@ -4,7 +4,7 @@ from PyQt4 import QtGui
 from leap.gui import mainwindow_rc
 
 
-class StatusAwareTrayIcon(object):
+class StatusAwareTrayIconMixin(object):
     """
     a mix of several functions needed
     to create a systray and make it