Merge lp:~gz/pyjuju/0.5_unicode_token_backport into lp:pyjuju/0.5

[Martin Packman]

Backport simple but niche issue with token encoding

See the original merge proposal for more details:

<https://code.launchpad.net/~gz/juju/os_token_string_type_1030897/+merge/127008>

[Martin Packman (gz)]

Test suite passes with change.

review: Approve

[John A Meinel (jameinel)]

review: Approve

=== modified file 'juju/providers/openstack/client.py'
--- juju/providers/openstack/client.py	2012-09-27 19:07:21 +0000
+++ juju/providers/openstack/client.py	2013-04-02 15:20:32 +0000
@@ -33,9 +33,9 @@
 from twisted.web.client import Agent
 # Older twisted versions don't expose _newclient exceptions via client module
 try:
-    from twisted.web.client import ResponseFailed
+    from twisted.web.client import ResponseDone, ResponseFailed
 except ImportError:
-    from twisted.web._newclient import ResponseFailed
+    from twisted.web._newclient import ResponseDone, ResponseFailed
 from twisted.web.http_headers import Headers
 from zope.interface import implements
 
@@ -249,7 +249,10 @@
     def _handle_v2_auth(self, result):
         access_details = self._json(result, 200, 'access')
         token_details = access_details["token"]
-        self.token = token_details["id"]
+        # Decoded json uses unicode for all string values, but that can upset
+        # twisted when serialising headers later. Really should encode at that
+        # point, but as keystone should only give ascii tokens a cast will do.
+        self.token = token_details["id"].encode("ascii")
 
         # TODO: care about token_details["expires"]
         # Don't need to we're not preserving tokens.

=== modified file 'juju/providers/openstack/tests/test_client.py'
--- juju/providers/openstack/tests/test_client.py	2012-09-27 19:07:21 +0000
+++ juju/providers/openstack/tests/test_client.py	2013-04-02 15:20:32 +0000
@@ -62,10 +62,19 @@
 class FakeResponse(object):
     """Bare minimum needed to look like a twisted http response"""
 
-    def __init__(self, code, headers):
+    def __init__(self, code, headers, body=None):
         self.code = code
         self.headers = headers
-        self.length = 0
+        if body is None:
+            self.length = 0
+        else:
+            self.length = len(body)
+        self.body = body
+
+    def deliverBody(self, reader):
+        reader.connectionMade()
+        reader.dataReceived(self.body)
+        reader.connectionLost(client.ResponseDone())
 
 
 class ClientTests(testing.TestCase):
@@ -106,6 +115,18 @@
         self.mocker.result(self.mock_agent)
         return config, osc
 
+    def make_client_userpass(self):
+        config = {
+            "auth-url": "https://testing.invalid/v2.0/",
+            "username": "user",
+            "password": "pass",
+            "project-name": "project",
+            }
+        osc = client._OpenStackClient(self.get_credentials(config), True)
+        self.mock_agent(reactor, contextFactory=mocker.MATCH(self.is_checker))
+        self.mocker.result(self.mock_agent)
+        return config, osc
+
     @defer.inlineCallbacks
     def test_auth_legacy(self):
         config, osc = self.make_client_legacy()
@@ -119,10 +140,49 @@
         self.mocker.replay()
         log = self.capture_logging()
         yield osc.authenticate()
-        self.assertEqual("tok", osc.token)
-        self.assertEqual("http://testing.invalid/compute/path",
-            osc._make_url("compute", ["path"]))
-        self.assertIn("compute service not using secure", log.getvalue())
+        self.assertIsInstance(osc.token, str)
+        self.assertEqual("tok", osc.token)
+        self.assertEqual("http://testing.invalid/compute/path",
+            osc._make_url("compute", ["path"]))
+        self.assertIn("compute service not using secure", log.getvalue())
+
+    @defer.inlineCallbacks
+    def test_auth_userpass(self):
+        config, osc = self.make_client_userpass()
+        self.mock_agent.request("POST", "https://testing.invalid/v2.0/tokens",
+            mocker.ANY, mocker.ANY)
+        response = FakeResponse(200, http_headers.Headers({
+            "Content-Type": ["application/json"],
+            }),
+            json.dumps({'access': {
+                'token': {'id': "tok", 'expires': "shortly"},
+                'serviceCatalog': [
+                    {
+                        'type': "compute",
+                        'endpoints': [
+                            {'publicURL': "http://testing.invalid/compute"},
+                        ],
+                    },
+                    {
+                        'type': "object-store",
+                        'endpoints': [
+                            {'publicURL': "http://testing.invalid/objstore"},
+                        ],
+                    },
+                ],
+            }}))
+        self.mocker.result(defer.succeed(response))
+        self.mocker.replay()
+        log = self.capture_logging()
+        yield osc.authenticate()
+        self.assertIsInstance(osc.token, str)
+        self.assertEqual("tok", osc.token)
+        self.assertEqual("http://testing.invalid/compute/path",
+            osc._make_url("compute", ["path"]))
+        self.assertEqual("http://testing.invalid/objstore/path",
+            osc._make_url("object-store", ["path"]))
+        self.assertIn("compute service not using secure", log.getvalue())
+        self.assertIn("object-store service not using secure", log.getvalue())
 
     def test_cert_failure(self):
         config, osc = self.make_client_legacy()