Merge lp:~mandel/ubuntu-sso-client/implement_windows_networkstatus into lp:ubuntu-sso-client

[Manuel de la Peña]

Added the network status implementation for windows.

Added the network status implementation for windows.

[Alejandro J. Cura (alecu)]

Launchpad shows this message: "Conflict adding file run-tests.bat. Moved existing file to run-tests.bat.moved."

This also happens when merging by hand.

Found a few typos (many!):
 * "nameing" -> "naming"
 * "deliberated because we are follwoing" -> "deliberate because we are following"
 * "For more ingo" -> "For more info"
 * "to run in an other" -> "to run in another"
 * "listent" -> "listen"
 * "the machine s connected" -> "the machine is connected"
 * "literner_thread" -> "listener_thread" (more than one replacement)

Otherwise the code looks fine.

review: Needs Fixing

[Alejandro J. Cura (alecu)]

The "literner" variable name typo is still present in some of the tests.

The really weird thing is that all tests pass, yet this error is only catched by the lint step:

ubuntu_sso/tests/networkstate/test_windows_networkstate.py:
    107: [E1123, TestNetworkManagerState.test_find_online_state_not_connected] Passing unexpected keyword argument 'literner_thread' in function call
    118: [E1123, TestNetworkManagerState.test_find_online_state_connected] Passing unexpected keyword argument 'literner_thread' in function call

review: Needs Fixing

[Alejandro J. Cura (alecu)]

Ran tests on Linux, detailed review of the code, looking good.

review: Approve (linux)

[Roberto Alsina (ralsina)]

+1

review: Approve

[Ubuntu One Auto Pilot (otto-pilot)]

The prerequisite lp:~mandel/ubuntu-sso-client/implement_windows_keyring has not yet been merged into lp:ubuntu-sso-client.

[lp:~mandel/ubuntu-sso-client/implement_windows_networkstatus]

689. By Manuel de la Peña on 2011-03-15

Merged with implement_windows_keyring and fixed conflicts.

=== modified file 'run-tests'
--- run-tests	2010-12-20 15:39:23 +0000
+++ run-tests	2011-03-15 08:28:29 +0000
@@ -33,5 +33,5 @@
 }
 
 echo "Running test suite for ""$MODULE"
-`which xvfb-run` u1trial "$MODULE" && style_check
+`which xvfb-run` u1trial "$MODULE" -i "test_windows_networkstate.py" && style_check
 rm -rf _trial_temp

=== modified file 'run-tests.bat'
--- run-tests.bat	2011-03-15 08:28:29 +0000
+++ run-tests.bat	2011-03-15 08:28:29 +0000
@@ -51,8 +51,8 @@
 :PYTHONPRESENT
 ECHO Python found, executing the tests...
 :: execute the tests with a number of ignored linux only modules
-"%PYTHONPATH%\python.exe" "%PYTHONPATH%\Scripts\u1trial" -c ubuntu_sso -i "test_gui.py, test_linux_keyring.py"
-"%PYTHONPATH%\python.exe" "%PYTHONPATH%\Scripts\u1lint"
+"%PYTHONPATH%\python.exe" "%PYTHONPATH%\Scripts\u1trial" -c ubuntu_sso -i "test_gui.py, test_linux_keyring.py, test_linux_network_state.py"
+"%PYTHONPATH%\python.exe" "%PYTHONPATH%\Scripts\u1lint" ubuntu_sso
 :: test for style if we can, if pep8 is not present, move to the end
 IF EXIST "%PYTHONPATH%Scripts\pep8.exe"
 "%PYTHONPATH%\Scripts\pep8.exe" --repeat ubuntu_sso

=== added directory 'ubuntu_sso/networkstate'
=== added file 'ubuntu_sso/networkstate/__init__.py'
--- ubuntu_sso/networkstate/__init__.py	1970-01-01 00:00:00 +0000
+++ ubuntu_sso/networkstate/__init__.py	2011-03-15 08:28:29 +0000
@@ -0,0 +1,40 @@
+# -*- coding: utf-8 -*-
+# Author: Manuel de la Pena <[e-mail]>
+#
+# Copyright 2011 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+# PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/>.
+"""Platform specific network status."""
+
+import sys
+
+# ignore global naming issues.
+# pylint: disable=C0103
+
+NetworkManagerState = None
+ONLINE = None
+OFFLINE = None
+UNKNOWN = None
+
+if sys.platform == 'win32':
+    from ubuntu_sso.networkstate import windows
+    NetworkManagerState = windows.NetworkManagerState
+    ONLINE = windows.ONLINE
+    OFFLINE = windows.OFFLINE
+    UNKNOWN = windows.UNKNOWN
+else:
+    from ubuntu_sso.networkstate import linux
+    NetworkManagerState = linux.NetworkManagerState
+    ONLINE = linux.ONLINE
+    OFFLINE = linux.OFFLINE
+    UNKNOWN = linux.UNKNOWN

=== renamed file 'ubuntu_sso/networkstate.py' => 'ubuntu_sso/networkstate/linux.py'
=== added file 'ubuntu_sso/networkstate/windows.py'
--- ubuntu_sso/networkstate/windows.py	1970-01-01 00:00:00 +0000
+++ ubuntu_sso/networkstate/windows.py	2011-03-15 08:28:29 +0000
@@ -0,0 +1,197 @@
+# -*- coding: utf-8 -*-
+# Author: Manuel de la Pena <[e-mail]>
+#
+# Copyright 2011 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+# PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/>.
+"""Network status implementation on Windows."""
+
+# pylint: disable=F0401
+import pythoncom
+# pylint: enable=F0401
+
+from ctypes import windll, byref
+from ctypes.wintypes import DWORD
+from threading import Thread
+# pylint: disable=F0401
+from win32com.server.policy import DesignatedWrapPolicy
+from win32com.client import Dispatch
+# pylint: enable=F0401
+
+from ubuntu_sso.logger import setup_logging
+
+logger = setup_logging("ubuntu_sso.networkstate")
+
+# naming errors are deliberated because we are following the COM naming to make
+# it clear for later developers.
+# pylint: disable=C0103
+
+# Values returned by the callback
+ONLINE, OFFLINE, UNKNOWN = object(), object(), object()
+
+## from EventSys.h
+PROGID_EventSystem = "EventSystem.EventSystem"
+PROGID_EventSubscription = "EventSystem.EventSubscription"
+
+# SENS (System Event Notification Service) values for the events,
+# this events contain the uuid of the event, the name of the event to be used
+# as well as the method name of the method in the ISesNetwork interface that
+# will be executed for the event.
+# For more info look at:
+# http://msdn.microsoft.com/en-us/library/aa377384(v=vs.85).aspx
+
+SUBSCRIPTION_NETALIVE = ('{cd1dcbd6-a14d-4823-a0d2-8473afde360f}',
+                         'UbuntuOne Network Alive',
+                         'ConnectionMade')
+
+SUBSCRIPTION_NETALIVE_NOQOC = ('{a82f0e80-1305-400c-ba56-375ae04264a1}',
+                               'UbuntuOne Net Alive No Info',
+                               'ConnectionMadeNoQOCInfo')
+
+SUBSCRIPTION_NETLOST = ('{45233130-b6c3-44fb-a6af-487c47cee611}',
+                        'UbuntuOne Network Lost',
+                        'ConnectionLost')
+
+SUBSCRIPTION_REACH = ('{4c6b2afa-3235-4185-8558-57a7a922ac7b}',
+                       'UbuntuOne Network Reach',
+                       'ConnectionMade')
+
+SUBSCRIPTION_REACH_NOQOC = ('{db62fa23-4c3e-47a3-aef2-b843016177cf}',
+                            'UbuntuOne Network Reach No Info',
+                            'ConnectionMadeNoQOCInfo')
+
+SUBSCRIPTION_REACH_NOQOC2 = ('{d4d8097a-60c6-440d-a6da-918b619ae4b7}',
+                             'UbuntuOne Network Reach No Info 2',
+                             'ConnectionMadeNoQOCInfo')
+
+SUBSCRIPTIONS = [SUBSCRIPTION_NETALIVE,
+                 SUBSCRIPTION_NETALIVE_NOQOC,
+                 SUBSCRIPTION_NETLOST,
+                 SUBSCRIPTION_REACH,
+                 SUBSCRIPTION_REACH_NOQOC,
+                 SUBSCRIPTION_REACH_NOQOC2]
+
+SENSGUID_EVENTCLASS_NETWORK = '{d5978620-5b9f-11d1-8dd2-00aa004abd5e}'
+SENSGUID_PUBLISHER = "{5fee1bd6-5b9b-11d1-8dd2-00aa004abd5e}"
+
+# uuid of the implemented com interface
+IID_ISesNetwork = '{d597bab1-5b9f-11d1-8dd2-00aa004abd5e}'
+
+
+class NetworkManager(DesignatedWrapPolicy):
+    """Implement ISesNetwork to know about the network status."""
+
+    _com_interfaces_ = [IID_ISesNetwork]
+    _public_methods_ = ['ConnectionMade',
+                        'ConnectionMadeNoQOCInfo',
+                        'ConnectionLost']
+    _reg_clsid_ = '{41B032DA-86B5-4907-A7F7-958E59333010}'
+    _reg_progid_ = "UbuntuOne.NetworkManager"
+
+    def __init__(self, connected_cb=None, connected_cb_info=None,
+                 disconnected_cb=None):
+        # pylint: disable=E1101
+        self._wrap_(self)
+        # pylint: enable=E1101
+        self.connected_cb = connected_cb
+        self.connected_cb_info = connected_cb_info
+        self.disconnected_cb = disconnected_cb
+
+    def ConnectionMade(self, *args):
+        """Tell that the connection is up again."""
+        logger.info('Connection was made.')
+        if self.connected_cb_info:
+            self.connected_cb_info()
+
+    def ConnectionMadeNoQOCInfo(self, *args):
+        """Tell that the connection is up again."""
+        logger.info('Connection was made no info.')
+        if self.connected_cb:
+            self.connected_cb()
+
+    def ConnectionLost(self, *args):
+        """Tell the connection was lost."""
+        logger.info('Connection was lost.')
+        if self.disconnected_cb:
+            self.disconnected_cb()
+
+    def register(self):
+        """Register to listen to network events."""
+        # call the CoInitialize to allow the registration to run in another
+        # thread
+        pythoncom.CoInitialize()
+        # interface to be used by com
+        manager_interface = pythoncom.WrapObject(self)
+        event_system = Dispatch(PROGID_EventSystem)
+        # register to listen to each of the events to make sure that
+        # the code will work on all platforms.
+        for current_event in SUBSCRIPTIONS:
+            # create an event subscription and add it to the event
+            # service
+            event_subscription = Dispatch(PROGID_EventSubscription)
+            event_subscription.EventClassId = SENSGUID_EVENTCLASS_NETWORK
+            event_subscription.PublisherID = SENSGUID_PUBLISHER
+            event_subscription.SubscriptionID = current_event[0]
+            event_subscription.SubscriptionName = current_event[1]
+            event_subscription.MethodName = current_event[2]
+            event_subscription.SubscriberInterface = manager_interface
+            event_subscription.PerUser = True
+            # store the event
+            try:
+                event_system.Store(PROGID_EventSubscription,
+                                   event_subscription)
+            except pythoncom.com_error as e:
+                logger.error(
+                    'Error registering %s to event %s', e, current_event[1])
+
+        pythoncom.PumpMessages()
+
+
+def is_machine_connected():
+    """Return if the machine is connected to the internet."""
+    wininet = windll.wininet
+    flags = DWORD()
+    connected = wininet.InternetGetConnectedState(byref(flags), None)
+    return connected == 1
+
+
+class NetworkManagerState(object):
+    """Check for status changed in the network on Windows."""
+
+    def __init__(self, result_cb, **kwargs):
+        """Initialize this instance with a result and error callbacks."""
+        self.result_cb = result_cb
+
+    def connection_made(self):
+        """Return the connection state over the call back."""
+        self.result_cb(ONLINE)
+
+    def connection_lost(self):
+        """Return the connection was lost over the call back."""
+        self.result_cb(OFFLINE)
+
+    def find_online_state(self, listener=None, listener_thread=None):
+        """Get the network state and return it thru the set callback."""
+        # check the current status right now
+        if is_machine_connected():
+            self.result_cb(ONLINE)
+        else:
+            self.result_cb(OFFLINE)
+        if listener is None:
+            # start listening for network changes
+            listener = NetworkManager(connected_cb=self.connection_made,
+                                      disconnected_cb=self.connection_lost)
+        if listener_thread is None:
+            listener_thread = Thread(target=listener.register,
+                                     name='Ubuntu SSO NetworkManager')
+        listener_thread.start()

=== modified file 'ubuntu_sso/tests/bin/show_nm_state'
--- ubuntu_sso/tests/bin/show_nm_state	2010-12-20 14:29:18 +0000
+++ ubuntu_sso/tests/bin/show_nm_state	2011-03-15 08:28:29 +0000
@@ -23,7 +23,7 @@
 
 from dbus.mainloop.glib import DBusGMainLoop
 
-from ubuntu_sso.networkstate import NetworkManagerState, NM_STATE_NAMES
+from ubuntu_sso.networkstate.linux import NetworkManagerState, NM_STATE_NAMES
 
 DBusGMainLoop(set_as_default=True)
 

=== added directory 'ubuntu_sso/tests/networkstate'
=== added file 'ubuntu_sso/tests/networkstate/__init__.py'
--- ubuntu_sso/tests/networkstate/__init__.py	1970-01-01 00:00:00 +0000
+++ ubuntu_sso/tests/networkstate/__init__.py	2011-03-15 08:28:29 +0000
@@ -0,0 +1,17 @@
+# -*- coding: utf-8 -*-
+# Author: Manuel de la Pena <[e-mail]>
+#
+# Copyright 2011 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+# PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/>.
+"""Test the different networkstatus implementations."""

=== renamed file 'ubuntu_sso/tests/test_networkstate.py' => 'ubuntu_sso/tests/networkstate/test_linux_networkstate.py'
--- ubuntu_sso/tests/test_networkstate.py	2010-09-30 18:57:38 +0000
+++ ubuntu_sso/tests/networkstate/test_linux_networkstate.py	2011-03-15 08:28:29 +0000
@@ -20,11 +20,11 @@
 """Tests for the network state detection code."""
 
 from ubuntu_sso.networkstate import (NetworkManagerState,
-                                     DBUS_UNKNOWN_SERVICE,
-                                     ONLINE, OFFLINE, UNKNOWN,
-                                     NM_STATE_DISCONNECTED,
-                                     NM_STATE_CONNECTING,
-                                     NM_STATE_CONNECTED)
+                                     ONLINE, OFFLINE, UNKNOWN)
+from ubuntu_sso.networkstate.linux import  (DBUS_UNKNOWN_SERVICE,
+                                            NM_STATE_DISCONNECTED,
+                                            NM_STATE_CONNECTING,
+                                            NM_STATE_CONNECTED)
 
 from mocker import ARGS, KWARGS, ANY, MockerTestCase
 

=== added file 'ubuntu_sso/tests/networkstate/test_windows_networkstate.py'
--- ubuntu_sso/tests/networkstate/test_windows_networkstate.py	1970-01-01 00:00:00 +0000
+++ ubuntu_sso/tests/networkstate/test_windows_networkstate.py	2011-03-15 08:28:29 +0000
@@ -0,0 +1,119 @@
+# -*- coding: utf-8 -*-
+#
+# Author: Manuel de la Pena<[e-mail]>
+#
+# Copyright 2011 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+# PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/>.
+"""Tests for the network manager."""
+from mocker import MockerTestCase
+from ubuntu_sso.networkstate.windows import (
+    NetworkManager,
+    NetworkManagerState,
+    ONLINE,
+    OFFLINE)
+
+
+class TestNetworkManager(MockerTestCase):
+    """Test he Network Manager."""
+
+    def setUp(self):
+        super(TestNetworkManager, self).setUp()
+        self.connection_info = self.mocker.mock()
+        self.connection_no_info = self.mocker.mock()
+        self.disconnected = self.mocker.mock()
+        self.manager = NetworkManager(self.connection_no_info,
+                                      self.connection_info, self.disconnected)
+
+    def test_connection_made(self):
+        """Ensure db is called."""
+        self.connection_info()
+        self.mocker.replay()
+        self.manager.ConnectionMade()
+
+    def test_connection_made_no_cb(self):
+        """Ensure db is called."""
+        self.manager.connected_cb_info = None
+        self.mocker.replay()
+        self.manager.ConnectionMade()
+
+    def test_connection_made_no_info(self):
+        """Ensure db is called."""
+        self.connection_no_info()
+        self.mocker.replay()
+        self.manager.ConnectionMadeNoQOCInfo()
+
+    def test_connection_made_no_info_no_cb(self):
+        """Ensure db is called."""
+        self.manager.connected_cb = None
+        self.mocker.replay()
+        self.manager.ConnectionMadeNoQOCInfo()
+
+    def test_disconnection(self):
+        """Ensure db is called."""
+        self.disconnected()
+        self.mocker.replay()
+        self.manager.ConnectionLost()
+
+    def test_disconnection_no_cb(self):
+        """Ensure db is called."""
+        self.manager.disconnected_cb = None
+        self.mocker.replay()
+        self.manager.ConnectionLost()
+
+
+class TestNetworkManagerState(MockerTestCase):
+    """Test he Network Manager State."""
+
+    def setUp(self):
+        super(TestNetworkManagerState, self).setUp()
+        self.network_manager = self.mocker.mock()
+        self.is_connected = self.mocker.replace(
+            'ubuntu_sso.networkstate.windows.is_machine_connected')
+        self.thread = self.mocker.mock()
+        self.cb = self.mocker.mock()
+        self.state = NetworkManagerState(self.cb)
+
+    def test_connection_made(self):
+        """Test that the cb is actually called."""
+        self.cb(ONLINE)
+        self.mocker.replay()
+        self.state.connection_made()
+
+    def test_connection_lost(self):
+        """Test that the cb is actually called."""
+        self.cb(OFFLINE)
+        self.mocker.replay()
+        self.state.connection_lost()
+
+    def test_find_online_state_not_connected(self):
+        """Test that we do find the online state correctly."""
+        self.is_connected()
+        self.mocker.result(False)
+        self.cb(OFFLINE)
+        self.mocker.result(self.thread)
+        self.thread.start()
+        self.mocker.replay()
+        self.state.find_online_state(listener=self.network_manager,
+                                     listener_thread=self.thread)
+
+    def test_find_online_state_connected(self):
+        """Test that we do find the online state correctly."""
+        self.is_connected()
+        self.mocker.result(ONLINE)
+        self.cb(ONLINE)
+        self.mocker.result(self.thread)
+        self.thread.start()
+        self.mocker.replay()
+        self.state.find_online_state(listener=self.network_manager,
+                                     listener_thread=self.thread)