moved network checks to its own class

so it can be more easily moved to base.checks and reused
when eip is a module.

2 files changed, 133 insertions, 77 deletions

diff --git a/src/leap/eip/checks.py b/src/leap/eip/checks.py
index 412be27b..24e97335 100644
--- a/src/leap/eip/checks.py
+++ b/src/leap/eip/checks.py
@@ -20,8 +20,6 @@ logger = logging.getLogger(name=__name__)
 """
 EIPConfigChecker
 ----------
-this is the first of 3 consecutive checks that we're implementing.
-
 It is used from the eip conductor (a instance of EIPConnection that is
 managed from the QtApp), running `run_all` method before trying to call
 `connect` or any other of the state-changing methods.
@@ -32,13 +30,87 @@ into base.tests to be invoked by the base leap init routines.
 However, I'm testing them alltogether for the sake of having the whole unit
 reachable and testable as a whole.
 
-Other related checkers - not implemented yet -:
-* LeapNetworkChecker
+LeapNetworkChecker
+------------------
+Network checks. To be moved to base.
+docs TBD
+
+ProviderCertChecker
+-------------------
+Checks on certificates.
+docs TBD
 """
 
 
 class LeapNetworkChecker(object):
-    pass
+    """
+    all network related checks
+    """
+    # XXX to be moved to leap.base.checks
+    # TODO eventually, use a more portable solution
+    # like psutil
+
+    def run_all(self, checker=None):
+        if not checker:
+            checker = self
+        self.error = None  # ?
+
+        # for MVS
+        checker.test_internet_connection()
+        checker.is_internet_up()
+        checker.ping_gateway()
+
+    def test_internet_connection(self):
+        # XXX we're not passing the error anywhere.
+        # XXX we probably should raise an exception here?
+        # unless we use this as smoke test
+        try:
+            requests.get('http://216.172.161.165')
+        except (requests.HTTPError, requests.RequestException) as e:
+            self.error = e.message
+        except requests.ConenctionError as e:
+            if e.message == "[Errno 113] No route to host":
+                if not self.is_internet_up():
+                    self.error = "No valid internet connection found."
+                else:
+                    self.error = "Provider server appears to be down."
+
+    def is_internet_up(self):
+        iface, gateway = self.get_default_interface_gateway()
+        self.ping_gateway(self)
+
+    def get_default_interface_gateway(self):
+        """only impletemented for linux so far."""
+        if not platform.system() == "Linux":
+            raise NotImplementedError
+
+        with open("/proc/net/route") as f:
+            route_table = f.readlines()
+        #toss out header
+        route_table.pop(0)
+
+        default_iface = None
+        gateway = None
+        while route_table:
+            line = route_table.pop(0)
+            iface, destination, gateway = line.split('\t')[0:3]
+            if destination == '00000000':
+                default_iface = iface
+                break
+
+        if not default_iface:
+            raise eipexceptions.NoDefaultInterfaceFoundError
+
+        if default_iface not in netifaces.interfaces():
+            raise eipexceptions.InterfaceNotFoundError
+
+        return default_iface, gateway
+
+    def ping_gateway(self, gateway):
+        #TODO: Discuss how much packet loss (%) is acceptable.
+        packet_loss = ping.quiet_ping(gateway)[0]
+        if packet_loss > baseconstants.MAX_ICMP_PACKET_LOSS:
+            raise eipexceptions.NoConnectionToGateway
 
 
 class ProviderCertChecker(object):
@@ -153,6 +225,7 @@ class ProviderCertChecker(object):
         # XXX TODO
         # waiting on #507. If we're not using PyOpenSSL or anything alike
         # we will have to roll our own x509 parsing to extract time info.
+        # XXX use gnutls
 
     def is_valid_pemfile(self, cert_s=None):
         """
@@ -322,54 +395,6 @@ class EIPConfigChecker(object):
         # We should WRITE eip config if missing or
         # incomplete at this point
 
-    def test_internet_connection(self):
-        try:
-            requests.get('http://216.172.161.165')
-        except (requests.HTTPError, requests.RequestException) as e:
-            self.error = e.message
-        except requests.ConenctionError as e:
-            if e.message == "[Errno 113] No route to host":
-                if not self.is_internet_up():
-                    self.error = "No valid internet connection found."
-                else:
-                    self.error = "Provider server appears to be down."
-
-    def is_internet_up(self):
-        iface, gateway = self.get_default_interface_gateway()
-        self.ping_gateway(self)
-
-    def get_default_interface_gateway(self):
-        """only impletemented for linux so far."""
-        if not platform.system() == "Linux":
-            raise NotImplementedError
-
-        f = open("/proc/net/route")
-        route_table = f.readlines()
-        #toss out header
-        route_table.pop(0)
-
-        default_iface = None
-        gateway = None
-        while route_table:
-            line = route_table.pop(0)
-            iface, destination, gateway = line.split('\t')[0:3]
-            if destination == '00000000':
-                default_iface = iface
-                break
-
-        if not default_iface:
-            raise eipexceptions.NoDefaultInterfaceFoundError
-
-        if default_iface not in netifaces.interfaces():
-            raise eipexceptions.InterfaceNotFoundError
-
-        return default_iface, gateway
-
-    def ping_gateway(self, gateway):
-        #TODO: Discuss how much packet loss (%) is acceptable.
-        packet_loss = ping.quiet_ping(gateway)[0]
-        if packet_loss > 10:
-            raise eipexceptions.NoConnectionToGateway
 
     #
     # private helpers
diff --git a/src/leap/eip/tests/test_checks.py b/src/leap/eip/tests/test_checks.py
index caaa371f..bc7db79c 100644
--- a/src/leap/eip/tests/test_checks.py
+++ b/src/leap/eip/tests/test_checks.py
@@ -9,7 +9,7 @@ import os
 import urlparse
 
 from StringIO import StringIO
-from mock import patch, Mock, MagicMock
+from mock import (patch, Mock)
 
 import ping
 import requests
@@ -37,6 +37,60 @@ class NoLogRequestHandler:
         return ''
 
 
+class LeapNetworkCheckTest(BaseLeapTest):
+    # XXX to be moved to base.checks
+
+    __name__ = "leap_network_check_tests"
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def test_checker_should_implement_check_methods(self):
+        checker = eipchecks.LeapNetworkChecker()
+
+        self.assertTrue(hasattr(checker, "test_internet_connection"),
+                        "missing meth")
+        self.assertTrue(hasattr(checker, "is_internet_up"),
+                        "missing meth")
+        self.assertTrue(hasattr(checker, "ping_gateway"),
+                        "missing meth")
+
+    def test_checker_should_actually_call_all_tests(self):
+        checker = eipchecks.LeapNetworkChecker()
+
+        mc = Mock()
+        checker.run_all(checker=mc)
+        self.assertTrue(mc.test_internet_connection.called, "not called")
+        self.assertTrue(mc.ping_gateway.called, "not called")
+        self.assertTrue(mc.is_internet_up.called,
+                        "not called")
+
+    def test_get_default_interface_no_interface(self):
+        checker = eipchecks.LeapNetworkChecker()
+        with patch('leap.eip.checks.open', create=True) as mock_open:
+            with self.assertRaises(eipexceptions.NoDefaultInterfaceFoundError):
+                mock_open.return_value = StringIO(
+                    "Iface\tDestination Gateway\t"
+                    "Flags\tRefCntd\tUse\tMetric\t"
+                    "Mask\tMTU\tWindow\tIRTT")
+                checker.get_default_interface_gateway()
+
+    def test_ping_gateway_fail(self):
+        checker = eipchecks.LeapNetworkChecker()
+        with patch.object(ping, "quiet_ping") as mocked_ping:
+            with self.assertRaises(eipexceptions.NoConnectionToGateway):
+                mocked_ping.return_value = [11, "", ""]
+                checker.ping_gateway("4.2.2.2")
+
+    @unittest.skipUnless(_uid == 0, "root only")
+    def test_ping_gateway(self):
+        checker = eipchecks.LeapNetworkChecker()
+        checker.ping_gateway("4.2.2.2")
+
+
 class EIPCheckTest(BaseLeapTest):
 
     __name__ = "eip_check_tests"
@@ -61,7 +115,6 @@ class EIPCheckTest(BaseLeapTest):
                         "missing meth")
         self.assertTrue(hasattr(checker, "check_complete_eip_config"),
                         "missing meth")
-        self.assertTrue(hasattr(checker, "ping_gateway"), "missing meth")
 
     def test_checker_should_actually_call_all_tests(self):
         checker = eipchecks.EIPConfigChecker()
@@ -174,28 +227,6 @@ class EIPCheckTest(BaseLeapTest):
         sampleconfig = copy.copy(testdata.EIP_SAMPLE_JSON)
         checker.check_complete_eip_config(config=sampleconfig)
 
-    def test_get_default_interface_no_interface(self):
-        checker = eipchecks.EIPConfigChecker()
-        with patch('leap.eip.checks.open', create=True) as mock_open:
-            with self.assertRaises(eipexceptions.NoDefaultInterfaceFoundError):
-                mock_open.return_value = StringIO(
-                    "Iface\tDestination Gateway\t"
-                    "Flags\tRefCntd\tUse\tMetric\t"
-                    "Mask\tMTU\tWindow\tIRTT")
-                checker.get_default_interface_gateway()
-
-    def test_ping_gateway_fail(self):
-        checker = eipchecks.EIPConfigChecker()
-        with patch.object(ping, "quiet_ping") as mocked_ping:
-            with self.assertRaises(eipexceptions.NoConnectionToGateway):
-                mocked_ping.return_value = [11, "", ""]
-                checker.ping_gateway("4.2.2.2")
-
-    @unittest.skipUnless(_uid == 0, "root only")
-    def test_ping_gateway(self):
-        checker = eipchecks.EIPConfigChecker()
-        checker.ping_gateway("4.2.2.2")
-
 
 class ProviderCertCheckerTest(BaseLeapTest):