v3 identity - group and project api

updated with latest comments
modified entry points in setup.py
added group.py (v3)
added project.py (v3)
fixed indentation
updated to include new headers

Change-Id: Ice68b6c5bacb68d2e95321d903043056a9b8e810

openstackclient/identity/client.py

@@ -24,6 +24,7 @@ LOG = logging.getLogger(__name__)
 API_NAME = 'identity'
 API_VERSIONS = {
     '2.0': 'keystoneclient.v2_0.client.Client',
+    '3': 'keystoneclient.v3.client.Client',
 }
 
 

openstackclient/identity/v3/__init__.py

@@ -0,0 +1,14 @@
+#   Copyright 2012-2013 OpenStack, LLC.
+#
+#   Licensed under the Apache License, Version 2.0 (the "License"); you may
+#   not use this file except in compliance with the License. You may obtain
+#   a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#   WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#   License for the specific language governing permissions and limitations
+#   under the License.
+#

openstackclient/identity/v3/group.py

@@ -0,0 +1,204 @@
+#   Copyright 2012-2013 OpenStack, LLC.
+#
+#   Licensed under the Apache License, Version 2.0 (the "License"); you may
+#   not use this file except in compliance with the License. You may obtain
+#   a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#   WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#   License for the specific language governing permissions and limitations
+#   under the License.
+#
+
+"""
+Group action implementations
+"""
+
+import logging
+
+from cliff import command
+from cliff import lister
+from cliff import show
+
+from openstackclient.common import utils
+
+
+class CreateGroup(show.ShowOne):
+    """Create group command"""
+
+    api = 'identity'
+    log = logging.getLogger(__name__ + '.CreateGroup')
+
+    def get_parser(self, prog_name):
+        parser = super(CreateGroup, self).get_parser(prog_name)
+        parser.add_argument(
+            'name',
+            metavar='<group-name>',
+            help='New group name',
+        )
+        parser.add_argument(
+            '--description',
+            metavar='<group-description>',
+            help='New group description',
+        )
+        parser.add_argument(
+            '--domain',
+            metavar='<group-domain>',
+            help='References the domain ID or name which owns the group',
+        )
+
+        return parser
+
+    def take_action(self, parsed_args):
+        self.log.debug('take_action(%s)' % parsed_args)
+        identity_client = self.app.client_manager.identity
+        if parsed_args.domain:
+            domain = utils.find_resource(
+                identity_client.domains, parsed_args.domain).id
+        else:
+            domain = None
+        group = identity_client.groups.create(
+            parsed_args.name,
+            domain=domain,
+            description=parsed_args.description,
+        )
+
+        info = {}
+        info.update(group._info)
+        return zip(*sorted(info.iteritems()))
+
+
+class DeleteGroup(command.Command):
+    """Delete group command"""
+
+    api = 'identity'
+    log = logging.getLogger(__name__ + '.DeleteGroup')
+
+    def get_parser(self, prog_name):
+        parser = super(DeleteGroup, self).get_parser(prog_name)
+        parser.add_argument(
+            'group',
+            metavar='<group>',
+            help='Name or ID of group to delete',
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        self.log.debug('take_action(%s)' % parsed_args)
+        identity_client = self.app.client_manager.identity
+        group = utils.find_resource(
+            identity_client.groups, parsed_args.group)
+        identity_client.groups.delete(group.id)
+        return
+
+
+class ListGroup(lister.Lister):
+    """List group command"""
+
+    api = 'identity'
+    log = logging.getLogger(__name__ + '.ListGroup')
+
+    def get_parser(self, prog_name):
+        parser = super(ListGroup, self).get_parser(prog_name)
+        parser.add_argument(
+            '--long',
+            action='store_true',
+            default=False,
+            help='Additional fields are listed in output',
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        self.log.debug('take_action(%s)' % parsed_args)
+        if parsed_args.long:
+            columns = ('ID', 'Name', 'Domain ID', 'Description')
+        else:
+            columns = ('ID', 'Name')
+        data = self.app.client_manager.identity.groups.list()
+        return (columns,
+                (utils.get_item_properties(
+                    s, columns,
+                    formatters={},
+                ) for s in data),
+               )
+
+
+class SetGroup(command.Command):
+    """Set group command"""
+
+    api = 'identity'
+    log = logging.getLogger(__name__ + '.SetGroup')
+
+    def get_parser(self, prog_name):
+        parser = super(SetGroup, self).get_parser(prog_name)
+        parser.add_argument(
+            'group',
+            metavar='<group>',
+            help='Name or ID of group to change',
+        )
+        parser.add_argument(
+            '--name',
+            metavar='<new-group-name>',
+            help='New group name',
+        )
+        parser.add_argument(
+            '--domain',
+            metavar='<group-domain>',
+            help='New domain name or ID that will now own the group',
+        )
+        parser.add_argument(
+            '--description',
+            metavar='<group-description>',
+            help='New group description',
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        self.log.debug('take_action(%s)' % parsed_args)
+        identity_client = self.app.client_manager.identity
+        group = utils.find_resource(
+            identity_client.groups, parsed_args.group)
+        kwargs = {}
+        if parsed_args.name:
+            kwargs['name'] = parsed_args.name
+        if parsed_args.description:
+            kwargs['description'] = parsed_args.description
+        if parsed_args.domain:
+            domain = utils.find_resource(
+                identity_client.domains, parsed_args.domain).id
+            kwargs['domain'] = domain
+
+        if not len(kwargs):
+            stdout.write("Group not updated, no arguments present")
+            return
+        identity_client.groups.update(group.id, **kwargs)
+        return
+
+
+class ShowGroup(show.ShowOne):
+    """Show group command"""
+
+    api = 'identity'
+    log = logging.getLogger(__name__ + '.ShowGroup')
+
+    def get_parser(self, prog_name):
+        parser = super(ShowGroup, self).get_parser(prog_name)
+        parser.add_argument(
+            'group',
+            metavar='<group>',
+            help='Name or ID of group to display',
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        self.log.debug('take_action(%s)' % parsed_args)
+        identity_client = self.app.client_manager.identity
+        group = utils.find_resource(
+            identity_client.groups, parsed_args.group)
+
+        info = {}
+        info.update(group._info)
+        return zip(*sorted(info.iteritems()))

openstackclient/identity/v3/project.py

@@ -0,0 +1,236 @@
+#   Copyright 2012-2013 OpenStack, LLC.
+#
+#   Licensed under the Apache License, Version 2.0 (the "License"); you may
+#   not use this file except in compliance with the License. You may obtain
+#   a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#   WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#   License for the specific language governing permissions and limitations
+#   under the License.
+#
+
+"""
+Project action implementations
+"""
+
+import logging
+
+from cliff import command
+from cliff import lister
+from cliff import show
+
+from openstackclient.common import utils
+
+
+class CreateProject(show.ShowOne):
+    """Create project command"""
+
+    api = 'identity'
+    log = logging.getLogger(__name__ + '.CreateProject')
+
+    def get_parser(self, prog_name):
+        parser = super(CreateProject, self).get_parser(prog_name)
+        parser.add_argument(
+            'project_name',
+            metavar='<project-name>',
+            help='New project name',
+        )
+        parser.add_argument(
+            '--domain',
+            metavar='<project-domain>',
+            help='References the domain name or ID which owns the project',
+        )
+        parser.add_argument(
+            '--description',
+            metavar='<project-description>',
+            help='New project description',
+        )
+        # FIXME (stevemar): need to update enabled/disabled as per Dolph's
+        # comments in 19999/4
+        enable_group = parser.add_mutually_exclusive_group()
+        enable_group.add_argument(
+            '--enable',
+            dest='enabled',
+            action='store_true',
+            default=True,
+            help='Enable project',
+        )
+        enable_group.add_argument(
+            '--disable',
+            dest='enabled',
+            action='store_false',
+            help='Disable project',
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        self.log.debug('take_action(%s)' % parsed_args)
+        identity_client = self.app.client_manager.identity
+        if parsed_args.domain:
+            domain = utils.find_resource(
+                identity_client.domains, parsed_args.domain).id
+        else:
+            domain = None
+        project = identity_client.projects.create(
+            parsed_args.project_name,
+            domain=domain,
+            description=parsed_args.description,
+            enabled=parsed_args.enabled,
+        )
+
+        info = {}
+        info.update(project._info)
+        return zip(*sorted(info.iteritems()))
+
+
+class DeleteProject(command.Command):
+    """Delete project command"""
+
+    api = 'identity'
+    log = logging.getLogger(__name__ + '.DeleteProject')
+
+    def get_parser(self, prog_name):
+        parser = super(DeleteProject, self).get_parser(prog_name)
+        parser.add_argument(
+            'project',
+            metavar='<project>',
+            help='Name or ID of project to delete',
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        self.log.debug('take_action(%s)' % parsed_args)
+        identity_client = self.app.client_manager.identity
+        project = utils.find_resource(
+            identity_client.projects, parsed_args.project)
+        identity_client.projects.delete(project.id)
+        return
+
+
+class ListProject(lister.Lister):
+    """List project command"""
+
+    api = 'identity'
+    log = logging.getLogger(__name__ + '.ListProject')
+
+    def get_parser(self, prog_name):
+        parser = super(ListProject, self).get_parser(prog_name)
+        parser.add_argument(
+            '--long',
+            action='store_true',
+            default=False,
+            help='Additional fields are listed in output',
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        self.log.debug('take_action(%s)' % parsed_args)
+        if parsed_args.long:
+            columns = ('ID', 'Name', 'Domain ID', 'Description', 'Enabled')
+        else:
+            columns = ('ID', 'Name')
+        data = self.app.client_manager.identity.projects.list()
+        return (columns,
+                (utils.get_item_properties(
+                    s, columns,
+                    formatters={},
+                ) for s in data),
+               )
+
+
+class SetProject(command.Command):
+    """Set project command"""
+
+    api = 'identity'
+    log = logging.getLogger(__name__ + '.SetProject')
+
+    def get_parser(self, prog_name):
+        parser = super(SetProject, self).get_parser(prog_name)
+        parser.add_argument(
+            'project',
+            metavar='<project>',
+            help='Name or ID of project to change',
+        )
+        parser.add_argument(
+            '--name',
+            metavar='<new-project-name>',
+            help='New project name',
+        )
+        parser.add_argument(
+            '--domain',
+            metavar='<project-domain>',
+            help='New domain name or ID that will now own the project',
+        )
+        parser.add_argument(
+            '--description',
+            metavar='<project-description>',
+            help='New project description',
+        )
+        enable_group = parser.add_mutually_exclusive_group()
+        enable_group.add_argument(
+            '--enable',
+            dest='enabled',
+            action='store_true',
+            default=True,
+            help='Enable project (default)',
+        )
+        enable_group.add_argument(
+            '--disable',
+            dest='enabled',
+            action='store_false',
+            help='Disable project',
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        self.log.debug('take_action(%s)' % parsed_args)
+        identity_client = self.app.client_manager.identity
+        project = utils.find_resource(
+            identity_client.projects, parsed_args.project)
+        kwargs = {}
+        if parsed_args.name:
+            kwargs['name'] = parsed_args.name
+        if parsed_args.domain:
+            domain = utils.find_resource(
+                identity_client.domains, parsed_args.domain).id
+            kwargs['domain'] = domain
+        if parsed_args.description:
+            kwargs['description'] = parsed_args.description
+        if 'enabled' in parsed_args:
+            kwargs['enabled'] = parsed_args.enabled
+
+        if kwargs == {}:
+            stdout.write("Project not updated, no arguments present")
+            return
+        project.update(**kwargs)
+        return
+
+
+class ShowProject(show.ShowOne):
+    """Show project command"""
+
+    api = 'identity'
+    log = logging.getLogger(__name__ + '.ShowProject')
+
+    def get_parser(self, prog_name):
+        parser = super(ShowProject, self).get_parser(prog_name)
+        parser.add_argument(
+            'project',
+            metavar='<project>',
+            help='Name or ID of project to display',
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        self.log.debug('take_action(%s)' % parsed_args)
+        identity_client = self.app.client_manager.identity
+        project = utils.find_resource(
+            identity_client.projects, parsed_args.project)
+
+        info = {}
+        info.update(project._info)
+        return zip(*sorted(info.iteritems()))

setup.py

@@ -112,6 +112,18 @@ setuptools.setup(
             'list_image=openstackclient.image.v2.image:ListImage',
             'show_image=openstackclient.image.v2.image:ShowImage',
             'save_image=openstackclient.image.v2.image:SaveImage',
+            'create_group=openstackclient.identity.v3.group:CreateGroup',
+            'delete_group=openstackclient.identity.v3.group:DeleteGroup',
+            'set_group=openstackclient.identity.v3.group:SetGroup',
+            'show_group=openstackclient.identity.v3.group:ShowGroup',
+            'list_group=openstackclient.identity.v3.group:ListGroup',
+            'create_project=' +
+                'openstackclient.identity.v3.project:CreateProject',
+            'delete_project=' +
+                'openstackclient.identity.v3.project:DeleteProject',
+            'set_project=openstackclient.identity.v3.project:SetProject',
+            'show_project=openstackclient.identity.v3.project:ShowProject',
+            'list_project=openstackclient.identity.v3.project:ListProject',
         ]
     }
 )