Refactor oauth1 code for updates

The keystoneclient code for oauth1 support has changed.
As such, we should remove the delete, list and authenticate
functions, since they are not in keystoneclient.

Also, we must now pass in the project id when creating a
request token. Additionally we must now pass in roles
when authorizing a request token.

Added functional tests to ensure output and input args
are the same.

bp add-oauth-support
Change-Id: I559c18a73ad95a0c8b7a6a95f463b78334186f61

Author: Steve Martinelli

openstackclient/identity/v3/consumer.py

@@ -43,7 +43,7 @@ def get_parser(self, prog_name):
     def take_action(self, parsed_args):
         self.log.debug('take_action(%s)', parsed_args)
         identity_client = self.app.client_manager.identity
-        consumer = identity_client.consumers.create_consumer(
+        consumer = identity_client.oauth1.consumers.create(
             parsed_args.description
         )
         info = {}
@@ -69,8 +69,8 @@ def take_action(self, parsed_args):
         self.log.debug('take_action(%s)', parsed_args)
         identity_client = self.app.client_manager.identity
         consumer = utils.find_resource(
-            identity_client.consumers, parsed_args.consumer)
-        identity_client.consumers.delete_consumer(consumer.id)
+            identity_client.oauth1.consumers, parsed_args.consumer)
+        identity_client.oauth1.consumers.delete(consumer.id)
         return
 
 
@@ -82,7 +82,7 @@ class ListConsumer(lister.Lister):
     def take_action(self, parsed_args):
         self.log.debug('take_action(%s)', parsed_args)
         columns = ('ID', 'Description')
-        data = self.app.client_manager.identity.consumers.list_consumers()
+        data = self.app.client_manager.identity.oauth1.consumers.list()
         return (columns,
                 (utils.get_item_properties(
                     s, columns,
@@ -113,7 +113,7 @@ def take_action(self, parsed_args):
         self.log.debug('take_action(%s)', parsed_args)
         identity_client = self.app.client_manager.identity
         consumer = utils.find_resource(
-            identity_client.consumers, parsed_args.consumer)
+            identity_client.oauth1.consumers, parsed_args.consumer)
         kwargs = {}
         if parsed_args.description:
             kwargs['description'] = parsed_args.description
@@ -122,14 +122,9 @@ def take_action(self, parsed_args):
             sys.stdout.write("Consumer not updated, no arguments present")
             return
 
-        consumer = identity_client.consumers.update_consumer(
-            consumer.id,
-            **kwargs
-        )
-
-        info = {}
-        info.update(consumer._info)
-        return zip(*sorted(six.iteritems(info)))
+        consumer = identity_client.oauth1.consumers.update(
+            consumer.id, **kwargs)
+        return
 
 
 class ShowConsumer(show.ShowOne):
@@ -150,7 +145,7 @@ def take_action(self, parsed_args):
         self.log.debug('take_action(%s)', parsed_args)
         identity_client = self.app.client_manager.identity
         consumer = utils.find_resource(
-            identity_client.consumers, parsed_args.consumer)
+            identity_client.oauth1.consumers, parsed_args.consumer)
 
         info = {}
         info.update(consumer._info)

openstackclient/identity/v3/token.py

@@ -18,55 +18,8 @@
 import logging
 import six
 
-from cliff import command
-from cliff import lister
 from cliff import show
 
-from openstackclient.common import utils
-
-
-class AuthenticateAccessToken(show.ShowOne):
-    """Authenticate access token to receive keystone token"""
-
-    api = 'identity'
-    log = logging.getLogger(__name__ + '.AuthenticateAccessToken')
-
-    def get_parser(self, prog_name):
-        parser = super(AuthenticateAccessToken, self).get_parser(prog_name)
-        parser.add_argument(
-            '--consumer-key',
-            metavar='<consumer-key>',
-            help='Consumer key',
-            required=True
-        )
-        parser.add_argument(
-            '--consumer-secret',
-            metavar='<consumer-secret>',
-            help='Consumer secret',
-            required=True
-        )
-        parser.add_argument(
-            '--access-key',
-            metavar='<access-key>',
-            help='Access token key',
-            required=True
-        )
-        parser.add_argument(
-            '--access-secret',
-            metavar='<access-secret>',
-            help='Access token secret',
-            required=True
-        )
-        return parser
-
-    def take_action(self, parsed_args):
-        self.log.debug('take_action(%s)', parsed_args)
-        token_client = self.app.client_manager.identity.tokens
-        keystone_token = token_client.authenticate_access_token(
-            parsed_args.consumer_key, parsed_args.consumer_secret,
-            parsed_args.access_key, parsed_args.access_secret)
-        return zip(*sorted(six.iteritems(keystone_token)))
-
 
 class AuthorizeRequestToken(show.ShowOne):
     """Authorize request token command"""
@@ -78,17 +31,28 @@ def get_parser(self, prog_name):
         parser.add_argument(
             '--request-key',
             metavar='<request-key>',
-            help='Consumer key',
+            help='Request token key',
+            required=True
+        )
+        parser.add_argument(
+            '--role-ids',
+            metavar='<role-ids>',
+            help='Requested role IDs',
             required=True
         )
         return parser
 
     def take_action(self, parsed_args):
-        self.log.debug('take_action(%s)', parsed_args)
-        token_client = self.app.client_manager.identity.tokens
+        self.log.debug('take_action(%s)' % parsed_args)
+        identity_client = self.app.client_manager.identity
 
-        verifier_pin = token_client.authorize_request_token(
-            parsed_args.request_key)
+        roles = []
+        for r_id in parsed_args.role_ids.split():
+            roles.append(r_id)
+
+        verifier_pin = identity_client.oauth1.request_tokens.authorize(
+            parsed_args.request_key,
+            roles)
         info = {}
         info.update(verifier_pin._info)
         return zip(*sorted(six.iteritems(info)))
@@ -134,13 +98,15 @@ def get_parser(self, prog_name):
         return parser
 
     def take_action(self, parsed_args):
-        self.log.debug('take_action(%s)', parsed_args)
-        token_client = self.app.client_manager.identity.tokens
-        access_token = token_client.create_access_token(
+        self.log.debug('take_action(%s)' % parsed_args)
+        token_client = self.app.client_manager.identity.oauth1.access_tokens
+        access_token = token_client.create(
             parsed_args.consumer_key, parsed_args.consumer_secret,
             parsed_args.request_key, parsed_args.request_secret,
             parsed_args.verifier)
-        return zip(*sorted(six.iteritems(access_token)))
+        info = {}
+        info.update(access_token._info)
+        return zip(*sorted(six.iteritems(info)))
 
 
 class CreateRequestToken(show.ShowOne):
@@ -162,27 +128,24 @@ def get_parser(self, prog_name):
             help='Consumer secret',
             required=True
         )
-        parser.add_argument(
-            '--role-ids',
-            metavar='<role-ids>',
-            help='Requested role IDs',
-        )
         parser.add_argument(
             '--project-id',
             metavar='<project-id>',
             help='Requested project ID',
+            required=True
         )
         return parser
 
     def take_action(self, parsed_args):
-        self.log.debug('take_action(%s)', parsed_args)
-        token_client = self.app.client_manager.identity.tokens
-        request_token = token_client.create_request_token(
+        self.log.debug('take_action(%s)' % parsed_args)
+        token_client = self.app.client_manager.identity.oauth1.request_tokens
+        request_token = token_client.create(
             parsed_args.consumer_key,
             parsed_args.consumer_secret,
-            parsed_args.role_ids,
             parsed_args.project_id)
-        return zip(*sorted(six.iteritems(request_token)))
+        info = {}
+        info.update(request_token._info)
+        return zip(*sorted(six.iteritems(info)))
 
 
 class CreateToken(show.ShowOne):
@@ -201,64 +164,3 @@ def take_action(self, parsed_args):
         if 'tenant_id' in token:
             token['project_id'] = token.pop('tenant_id')
         return zip(*sorted(six.iteritems(token)))
-
-
-class DeleteAccessToken(command.Command):
-    """Delete access token command"""
-
-    log = logging.getLogger(__name__ + '.DeleteAccessToken')
-
-    def get_parser(self, prog_name):
-        parser = super(DeleteAccessToken, self).get_parser(prog_name)
-        parser.add_argument(
-            'user',
-            metavar='<user>',
-            help='Name or ID of user',
-        )
-        parser.add_argument(
-            'access_key',
-            metavar='<access-key>',
-            help='Access token to be deleted',
-        )
-        return parser
-
-    def take_action(self, parsed_args):
-        self.log.debug('take_action(%s)', parsed_args)
-
-        identity_client = self.app.client_manager.identity
-        user = utils.find_resource(
-            identity_client.users, parsed_args.user).id
-        identity_client.tokens.delete_access_token(user,
-                                                   parsed_args.access_key)
-        return
-
-
-class ListAccessToken(lister.Lister):
-    """List access tokens command"""
-
-    log = logging.getLogger(__name__ + '.ListAccessToken')
-
-    def get_parser(self, prog_name):
-        parser = super(ListAccessToken, self).get_parser(prog_name)
-        parser.add_argument(
-            'user',
-            metavar='<user>',
-            help='Name or ID of user',
-        )
-        return parser
-
-    def take_action(self, parsed_args):
-        self.log.debug('take_action(%s)', parsed_args)
-
-        identity_client = self.app.client_manager.identity
-        user = utils.find_resource(
-            identity_client.users, parsed_args.user).id
-
-        columns = ('ID', 'Consumer ID', 'Expires At',
-                   'Project Id', 'Authorizing User Id')
-        data = identity_client.tokens.list_access_tokens(user)
-        return (columns,
-                (utils.get_item_properties(
-                    s, columns,
-                    formatters={},
-                ) for s in data))

openstackclient/tests/identity/v3/fakes.py

@@ -139,13 +139,52 @@
     'role': {'id': role_id},
 }
 
+consumer_id = 'test consumer id'
+consumer_description = 'someone we trust'
+consumer_secret = 'test consumer secret'
+
+OAUTH_CONSUMER = {
+    'id': consumer_id,
+    'secret': consumer_secret,
+    'description': consumer_description
+}
+
+access_token_id = 'test access token id'
+access_token_secret = 'test access token secret'
+access_token_expires = '2014-05-18T03:13:18.152071Z'
+
+OAUTH_ACCESS_TOKEN = {
+    'id': access_token_id,
+    'expires': access_token_expires,
+    'key': access_token_id,
+    'secret': access_token_secret
+}
+
+request_token_id = 'test request token id'
+request_token_secret = 'test request token secret'
+request_token_expires = '2014-05-17T11:10:51.511336Z'
+
+OAUTH_REQUEST_TOKEN = {
+    'id': request_token_id,
+    'expires': request_token_expires,
+    'key': request_token_id,
+    'secret': request_token_secret
+}
+
+oauth_verifier_pin = '6d74XaDS'
+OAUTH_VERIFIER = {
+    'oauth_verifier': oauth_verifier_pin
+}
+
 
 class FakeIdentityv3Client(object):
     def __init__(self, **kwargs):
         self.domains = mock.Mock()
         self.domains.resource_class = fakes.FakeResource(None, {})
         self.groups = mock.Mock()
         self.groups.resource_class = fakes.FakeResource(None, {})
+        self.oauth1 = mock.Mock()
+        self.oauth1.resource_class = fakes.FakeResource(None, {})
         self.projects = mock.Mock()
         self.projects.resource_class = fakes.FakeResource(None, {})
         self.roles = mock.Mock()
@@ -169,6 +208,18 @@ def __init__(self, **kwargs):
         self.identity_providers.resource_class = fakes.FakeResource(None, {})
 
 
+class FakeOAuth1Client(FakeIdentityv3Client):
+    def __init__(self, **kwargs):
+        super(FakeOAuth1Client, self).__init__(**kwargs)
+
+        self.access_tokens = mock.Mock()
+        self.access_tokens.resource_class = fakes.FakeResource(None, {})
+        self.consumers = mock.Mock()
+        self.consumers.resource_class = fakes.FakeResource(None, {})
+        self.request_tokens = mock.Mock()
+        self.request_tokens.resource_class = fakes.FakeResource(None, {})
+
+
 class TestIdentityv3(utils.TestCommand):
     def setUp(self):
         super(TestIdentityv3, self).setUp()
@@ -187,3 +238,13 @@ def setUp(self):
             endpoint=fakes.AUTH_URL,
             token=fakes.AUTH_TOKEN
         )
+
+
+class TestOAuth1(utils.TestCommand):
+    def setUp(self):
+        super(TestOAuth1, self).setUp()
+
+        self.app.client_manager.identity = FakeOAuth1Client(
+            endpoint=fakes.AUTH_URL,
+            token=fakes.AUTH_TOKEN
+        )