Merge lp:~dobey/ubuntuone-storage-protocol/update-4-2 into lp:ubuntuone-storage-protocol/stable-4-2

[dobey]

[Barry Warsaw]

    Switch from python-oauth to python-oauthlib for using OAuth.

[Mike McCracken (mikemc)]

review: Approve

[Ubuntu One Auto Pilot (otto-pilot)]

The attempt to merge lp:~dobey/ubuntuone-storage-protocol/update-4-2 into lp:ubuntuone-storage-protocol/stable-4-2 failed. Below is the output from the failed tests.

running build
running build_py
creating build
creating build/lib.linux-x86_64-2.7
creating build/lib.linux-x86_64-2.7/ubuntuone
copying ubuntuone/__init__.py -> build/lib.linux-x86_64-2.7/ubuntuone
creating build/lib.linux-x86_64-2.7/ubuntuone/storageprotocol
copying ubuntuone/storageprotocol/dircontent_pb2.py -> build/lib.linux-x86_64-2.7/ubuntuone/storageprotocol
copying ubuntuone/storageprotocol/delta.py -> build/lib.linux-x86_64-2.7/ubuntuone/storageprotocol
copying ubuntuone/storageprotocol/dircontent.py -> build/lib.linux-x86_64-2.7/ubuntuone/storageprotocol
copying ubuntuone/storageprotocol/sharersp.py -> build/lib.linux-x86_64-2.7/ubuntuone/storageprotocol
copying ubuntuone/storageprotocol/context.py -> build/lib.linux-x86_64-2.7/ubuntuone/storageprotocol
copying ubuntuone/storageprotocol/protocol_pb2.py -> build/lib.linux-x86_64-2.7/ubuntuone/storageprotocol
copying ubuntuone/storageprotocol/utils.py -> build/lib.linux-x86_64-2.7/ubuntuone/storageprotocol
copying ubuntuone/storageprotocol/errors.py -> build/lib.linux-x86_64-2.7/ubuntuone/storageprotocol
copying ubuntuone/storageprotocol/volumes.py -> build/lib.linux-x86_64-2.7/ubuntuone/storageprotocol
copying ubuntuone/storageprotocol/content_hash.py -> build/lib.linux-x86_64-2.7/ubuntuone/storageprotocol
copying ubuntuone/storageprotocol/proxy_tunnel.py -> build/lib.linux-x86_64-2.7/ubuntuone/storageprotocol
copying ubuntuone/storageprotocol/validators.py -> build/lib.linux-x86_64-2.7/ubuntuone/storageprotocol
copying ubuntuone/storageprotocol/__init__.py -> build/lib.linux-x86_64-2.7/ubuntuone/storageprotocol
copying ubuntuone/storageprotocol/client.py -> build/lib.linux-x86_64-2.7/ubuntuone/storageprotocol
copying ubuntuone/storageprotocol/request.py -> build/lib.linux-x86_64-2.7/ubuntuone/storageprotocol

Traceback (most recent call last):
  File "/usr/bin/u1trial", line 40, in <module>
    main()
  File "/usr/lib/python2.7/dist-packages/ubuntuone-dev-tools/ubuntuone/devtools/runners/__init__.py", line 277, in main
    suite = test_runner.get_suite(options)
  File "/usr/lib/python2.7/dist-packages/ubuntuone-dev-tools/ubuntuone/devtools/runners/__init__.py", line 173, in get_suite
    config['ignore-paths']))
  File "/usr/lib/python2.7/dist-packages/ubuntuone-dev-tools/ubuntuone/devtools/runners/__init__.py", line 157, in _collect_tests
    module_suite = self._load_unittest(filepath)
  File "/usr/lib/python2.7/dist-packages/ubuntuone-dev-tools/ubuntuone/devtools/runners/__init__.py", line 98, in _load_unittest
    module = __import__(modpath, None, None, [""])
  File "/mnt/tarmac/cache/ubuntuone-storage-protocol-stable-4-2/trunk/tests/test_query.py", line 35, in <module>
    from ubuntuone.storageprotocol.client import MultiQuery
  File "/mnt/tarmac/cache/ubuntuone-storage-protocol-stable-4-2/trunk/ubuntuone/storageprotocol/client.py", line 43, in <module>
    from oauthlib.oauth1 import Client, SIGNATURE_PLAINTEXT, SIGNATURE_TYPE_QUERY
ImportError: No module named oauthlib.oauth1

[lp:~dobey/ubuntuone-storage-protocol/update-4-2]

159. By Barry Warsaw on 2013-02-14

[Barry Warsaw]

    Switch from python-oauth to python-oauthlib for using OAuth.

=== modified file 'tests/test_client.py'
--- tests/test_client.py	2012-12-03 19:45:43 +0000
+++ tests/test_client.py	2013-02-14 20:28:33 +0000
@@ -38,6 +38,8 @@
 import unittest
 import uuid
 
+from urlparse import urlparse, parse_qsl
+
 from twisted.application import internet, service
 from twisted.internet import defer
 from twisted.internet.defer import Deferred, inlineCallbacks
@@ -48,10 +50,12 @@
 from ubuntuone.storageprotocol.client import (
     StorageClient, CreateUDF, ListVolumes, DeleteVolume, GetDelta, Unlink,
     Authenticate, MakeFile, MakeDir, PutContent, Move, BytesMessageProducer,
-    oauth, TwistedTimestampChecker, tx_timestamp_checker,
+    TwistedTimestampChecker, tx_timestamp_checker,
 )
+
 from ubuntuone.storageprotocol import volumes
 from tests import test_delta_info
+from oauthlib.oauth1 import Client
 
 # let's not get picky about aatributes outside __init__ in tests
 # pylint: disable=W0201
@@ -795,31 +799,43 @@
 
     def test_oauth_authenticate_uses_server_timestamp(self):
         """The oauth authentication uses the server timestamp."""
-        fromcandt_call = []
-
-        fake_token = oauth.OAuthToken('token', 'token_secret')
-        fake_consumer = oauth.OAuthConsumer('consumer_key', 'consumer_secret')
-
-        fake_timestamp = object()
+        timestamps = []
+
+        original_sign = Client.sign
+
+        def fake_sign(self, *args, **kwargs):
+            """A fake Client.sign()."""
+            url, headers, body = original_sign(self, *args, **kwargs)
+            timestamps.extend(
+                value for name, value in parse_qsl(urlparse(url).query)
+                if name == 'oauth_timestamp')
+            return url, headers, body
+
+        fake_timestamp = '801'
         timestamp_d = Deferred()
         self.patch(tx_timestamp_checker, "get_faithful_time",
                    lambda: timestamp_d)
-        original_fromcandt = oauth.OAuthRequest.from_consumer_and_token
-
-        @staticmethod
-        def fake_from_consumer_and_token(**kwargs):
-            """A fake from_consumer_and_token."""
-            fromcandt_call.append(kwargs)
-            return original_fromcandt(**kwargs)
-
-        self.patch(oauth.OAuthRequest, "from_consumer_and_token",
-                   fake_from_consumer_and_token)
+
+        self.patch(Client, 'sign', fake_sign)
         protocol = FakedProtocol()
-        protocol.oauth_authenticate(fake_consumer, fake_token)
-        self.assertEqual(len(fromcandt_call), 0)
+        # For backward compatibility of the API, oauth_authenticate() takes a
+        # consumer object and a token object.  Both of those must have .key
+        # and .secret attributes.  In modern OAuth1 (i.e. RFC 5849)
+        # terminology, the consumer is really the OAuth client, and the token
+        # is really the OAuth resource owner.
+
+        class OAuthClient:
+            key = 'consumer_key'
+            secret = 'consumer_secret'
+
+        class OAuthResourceOwner:
+            key = 'token'
+            secret = 'token_secret'
+        protocol.oauth_authenticate(OAuthResourceOwner, OAuthClient)
+        self.assertEqual(len(timestamps), 0)
         timestamp_d.callback(fake_timestamp)
-        parameters = fromcandt_call[0]["parameters"]
-        self.assertEqual(parameters["oauth_timestamp"], fake_timestamp)
+        self.assertEqual(len(timestamps), 1)
+        self.assertEqual(timestamps[0], fake_timestamp)
 
 
 class RootResource(resource.Resource):

=== modified file 'ubuntuone/storageprotocol/client.py'
--- ubuntuone/storageprotocol/client.py	2012-12-03 19:45:43 +0000
+++ ubuntuone/storageprotocol/client.py	2013-02-14 20:28:33 +0000
@@ -39,7 +39,8 @@
 
 from functools import partial
 from itertools import chain
-from oauth import oauth
+from urlparse import urlparse, parse_qsl
+from oauthlib.oauth1 import Client, SIGNATURE_PLAINTEXT, SIGNATURE_TYPE_QUERY
 
 from twisted.internet.protocol import ClientFactory
 from twisted.internet import reactor, defer
@@ -143,29 +144,30 @@
     def oauth_authenticate(self, consumer, token, metadata=None):
         """Authenticate to a server using the OAuth provider.
 
-        @param consumer: the OAuth consumer to authenticate with.
-        @type consumer: `oauth.OAuthConsumer`
-        @param token: a previously acquired OAuth access token.
-        @type consumer: `oauth.OAuthToken`
-        @param kwargs: key/values to send as metadata
+        @param consumer: the OAuth consumer (a.k.a. client in RFC 5849) to
+            authenticate with.
+        @type consumer: object having both a `.key` and `.secret` attribute.
+        @param token: a previously acquired OAuth access token (a.k.a.
+            resource owner in RFC 5849).
+        @type token: object having both a `.key` and `.secret` attribute.
+        @param metadata: key/values to send as metadata
 
         Return a deferred that will get called with the request
         object when completed.
 
         """
         timestamp = yield tx_timestamp_checker.get_faithful_time()
-        req = oauth.OAuthRequest.from_consumer_and_token(
-            oauth_consumer=consumer,
-            token=token,
-            parameters={"oauth_timestamp": timestamp},
-            http_method="GET",
-            http_url="storage://server")
-        req.sign_request(
-            oauth.OAuthSignatureMethod_PLAINTEXT(), consumer, token)
-
-        # Make sure all parameter values are strings.
+        client = Client(consumer.key, consumer.secret,
+                        token.key, token.secret,
+                        signature_method=SIGNATURE_PLAINTEXT,
+                        signature_type=SIGNATURE_TYPE_QUERY,
+                        timestamp=timestamp)
+        url, headers, body = client.sign('storage://server')
+        # Parse out the authentication parameters from the query string.
         auth_parameters = dict(
-            (key, str(value)) for key, value in req.parameters.iteritems())
+            (name, value) for name, value in
+            parse_qsl(urlparse(url).query)
+            if name.startswith('oauth_'))
         p = Authenticate(self, auth_parameters, metadata=metadata)
         p.start()
         result = yield p.deferred