Merge lp:~mandel/ubuntu-sso-client/retrieve-proxy-creds into lp:ubuntu-sso-client

[Manuel de la Peña]

- Changed the way in which the proxy settings are retrieved on windows to ensure that proxy() returns the correct one and not a null initialized one. This fixes the creds retrieval issue because the hostName is not longer '' (LP: #958938).

- Changed the way in which the proxy settings are retrieved on windows to ensure that proxy() returns the correct one and not a null initialized one. This fixes the creds retrieval issue because the hostName is not longer '' (LP: #958938).

Please make sure that you do IRL on windows since the tests are patching the QtNetwork objects that do the actual system calls.

[Roberto Alsina (ralsina)]

I see nothing wrong here, but couldn't do IRL testing.

review: Approve

[Alejandro J. Cura (alecu)]

Tested IRL, seems to be working.

review: Approve

=== modified file 'ubuntu_sso/utils/webclient/qtnetwork.py'
--- ubuntu_sso/utils/webclient/qtnetwork.py	2012-03-19 23:53:06 +0000
+++ ubuntu_sso/utils/webclient/qtnetwork.py	2012-03-22 12:13:26 +0000
@@ -28,6 +28,7 @@
     QNetworkAccessManager,
     QNetworkProxy,
     QNetworkProxyFactory,
+    QNetworkProxyQuery,
     QNetworkReply,
     QNetworkRequest,
     QSslCertificate,
@@ -46,6 +47,7 @@
 from ubuntu_sso.utils.webclient import gsettings
 
 logger = setup_logging("ubuntu_sso.utils.webclient.qtnetwork")
+PROXY_REQUEST = 'https://one.ubuntu.com'
 
 
 def build_proxy(settings_groups):
@@ -102,7 +104,12 @@
             else:
                 logger.info("Proxy is disabled.")
         else:
-            QNetworkProxyFactory.setUseSystemConfiguration(True)
+            if WebClient.proxy_instance is None:
+                logger.info("Querying OS for proxy.")
+                query = QNetworkProxyQuery(QUrl(PROXY_REQUEST))
+                proxies = QNetworkProxyFactory.systemProxyForQuery(query)
+                QNetworkProxy.setApplicationProxy(proxies[0])
+                WebClient.proxy_instance = proxies[0]
 
     def handle_proxy_auth(self, proxy, authenticator):
         """Proxy authentication is required."""

=== added file 'ubuntu_sso/utils/webclient/tests/test_qtnetwork.py'
--- ubuntu_sso/utils/webclient/tests/test_qtnetwork.py	1970-01-01 00:00:00 +0000
+++ ubuntu_sso/utils/webclient/tests/test_qtnetwork.py	2012-03-22 12:13:26 +0000
@@ -0,0 +1,157 @@
+# -*- coding: utf-8 -*-
+#
+# 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 AN 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/>.
+"""Specific tests for the qt implementation."""
+
+from twisted.internet import defer
+from ubuntuone.devtools.testcases import TestCase
+
+from ubuntu_sso.utils.webclient import qtnetwork
+
+
+class FakeQNetworkProxy(object):
+    """A fake network proxy class."""
+
+    def __init__(self, called):
+        """Create a new instance."""
+        self.called = called
+
+    def __call__(self, *args, **kwargs):
+        """Fake construnctor."""
+        return self
+
+    # pylint: disable=C0103
+    def setApplicationProxy(self, proxy):
+        """Set the application proxy."""
+        self.called.append(('setApplicationProxy', proxy))
+    # pylint: enable=C0103
+
+
+class FakeNetworkProxyFactory(object):
+    """A fake network proxy factory."""
+
+    def __init__(self, called, proxy):
+        """Create a new instance."""
+        self.called = called
+        self.proxy = proxy
+
+    def __call__(self, *args, **kwargs):
+        """Fake construnctor."""
+        return self
+
+    # pylint: disable=C0103
+    def systemProxyForQuery(self, query):
+        """Get the system proxy."""
+        self.called.append(('systemProxyForQuery', query))
+        return [self.proxy]
+    # pylint: enable=C0103
+
+
+class SetupProxyTestCase(TestCase):
+    """Test the proxy setup."""
+
+    @defer.inlineCallbacks
+    def setUp(self):
+        """Set the different tests."""
+        yield super(SetupProxyTestCase, self).setUp()
+        self.called = []
+        self.proxy = 'fake_proxy'
+
+        self.network_proxy = FakeQNetworkProxy(self.called)
+        self.patch(qtnetwork, 'QNetworkProxy', self.network_proxy)
+
+        self.network_proxy_factory = FakeNetworkProxyFactory(self.called,
+                                                              self.proxy)
+        self.patch(qtnetwork, 'QNetworkProxyFactory',
+                                              self.network_proxy_factory)
+
+        self.settings = dict(https=dict(username='user', password='pasword'))
+        self.patch(qtnetwork.gsettings, 'get_proxy_settings',
+                lambda: self.settings)
+
+        def fake_build_proxy(settings):
+            """Fake build proxy."""
+            self.called.append(('build_proxy', settings))
+            return self.proxy
+
+        self.patch(qtnetwork, 'build_proxy', fake_build_proxy)
+        qtnetwork.WebClient.proxy_instance = None
+        self.addCleanup(self._clean_webclient_instance)
+
+    def _set_old_platform(self, platform):
+        """Set back the platform."""
+        qtnetwork.sys.platform = platform
+
+    def _clean_webclient_instance(self):
+        """Set the webclient not to have a proxy."""
+        qtnetwork.WebClient.proxy_instance = None
+
+
+class SetupLinuxProxyTestCase(SetupProxyTestCase):
+    """Test setting up the proxy."""
+
+    @defer.inlineCallbacks
+    def setUp(self):
+        """Set the different tests."""
+        yield super(SetupLinuxProxyTestCase, self).setUp()
+        old_platform = qtnetwork.sys.platform
+        qtnetwork.sys.platform = 'linux'
+        self.addCleanup(self._set_old_platform, old_platform)
+
+    def test_setup_proxy(self):
+        """Test setting the proxy."""
+        qtnetwork.WebClient()
+        self.assertEqual(self.proxy, qtnetwork.WebClient.proxy_instance)
+        self.assertIn(('setApplicationProxy', self.proxy), self.called)
+        self.assertIn(('build_proxy', self.settings), self.called)
+
+    def test_setup_instance_present(self):
+        """Test when the instanc is present."""
+        # set the instance and assert we did not reset it
+        qtnetwork.WebClient.proxy_instance = 'other_proxy'
+        qtnetwork.WebClient()
+        self.assertNotEqual(self.proxy, qtnetwork.WebClient.proxy_instance)
+        self.assertNotIn(('setApplicationProxy', self.proxy), self.called)
+        self.assertNotIn(('build_proxy', self.settings), self.called)
+
+
+class SetupWindowsProxyTestCase(SetupProxyTestCase):
+    """Test setting up the proxy."""
+
+    @defer.inlineCallbacks
+    def setUp(self):
+        """Set the different tests."""
+        yield super(SetupWindowsProxyTestCase, self).setUp()
+        old_platform = qtnetwork.sys.platform
+        qtnetwork.sys.platform = 'win32'
+        self.addCleanup(self._set_old_platform, old_platform)
+        self.query = 'query'
+
+        self.patch(qtnetwork, 'QNetworkProxyQuery', lambda _: self.query)
+
+    def test_setup_proxy(self):
+        """Test setting the proxy."""
+        qtnetwork.WebClient()
+        self.assertEqual(self.proxy, qtnetwork.WebClient.proxy_instance)
+        self.assertIn(('systemProxyForQuery', self.query), self.called)
+        self.assertIn(('setApplicationProxy', self.proxy), self.called)
+
+    def test_setup_instance_present(self):
+        """Test when the instanc is present."""
+        qtnetwork.WebClient.proxy_instance = 'other_proxy'
+        qtnetwork.WebClient()
+        self.assertNotEqual(self.proxy, qtnetwork.WebClient.proxy_instance)
+        self.assertNotIn(('systemProxyForQuery', self.query), self.called)
+        self.assertNotIn(('setApplicationProxy', self.proxy), self.called)