# Copyright 2014 CERN # # 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. # """Identity v3 federation mapping action implementations""" import json import six from openstackclient.common import command from openstackclient.common import exceptions from openstackclient.common import utils class _RulesReader(object): """Helper class capable of reading rules from files""" def _read_rules(self, path): """Read and parse rules from path Expect the file to contain a valid JSON structure. :param path: path to the file :return: loaded and valid dictionary with rules :raises exception.CommandError: In case the file cannot be accessed or the content is not a valid JSON. Example of the content of the file: [ { "local": [ { "group": { "id": "85a868" } } ], "remote": [ { "type": "orgPersonType", "any_one_of": [ "Employee" ] }, { "type": "sn", "any_one_of": [ "Young" ] } ] } ] """ blob = utils.read_blob_file_contents(path) try: rules = json.loads(blob) except ValueError as e: raise exceptions.CommandError( 'An error occurred when reading ' 'rules from file %s: %s' % (path, e)) else: return rules class CreateMapping(command.ShowOne, _RulesReader): """Create new mapping""" def get_parser(self, prog_name): parser = super(CreateMapping, self).get_parser(prog_name) parser.add_argument( 'mapping', metavar='', help='New mapping name (must be unique)', ) parser.add_argument( '--rules', metavar='', required=True, help='Filename that contains a set of mapping rules (required)', ) return parser def take_action(self, parsed_args): identity_client = self.app.client_manager.identity rules = self._read_rules(parsed_args.rules) mapping = identity_client.federation.mappings.create( mapping_id=parsed_args.mapping, rules=rules) mapping._info.pop('links', None) return zip(*sorted(six.iteritems(mapping._info))) class DeleteMapping(command.Command): """Delete mapping""" def get_parser(self, prog_name): parser = super(DeleteMapping, self).get_parser(prog_name) parser.add_argument( 'mapping', metavar='', help='Mapping to delete', ) return parser def take_action(self, parsed_args): identity_client = self.app.client_manager.identity identity_client.federation.mappings.delete(parsed_args.mapping) class ListMapping(command.Lister): """List mappings""" def take_action(self, parsed_args): # NOTE(marek-denis): Since rules can be long and tedious I have decided # to only list ids of the mappings. If somebody wants to check the # rules, (s)he should show specific ones. identity_client = self.app.client_manager.identity data = identity_client.federation.mappings.list() columns = ('ID',) items = [utils.get_item_properties(s, columns) for s in data] return (columns, items) class SetMapping(command.Command, _RulesReader): """Set mapping properties""" def get_parser(self, prog_name): parser = super(SetMapping, self).get_parser(prog_name) parser.add_argument( 'mapping', metavar='', help='Mapping to modify', ) parser.add_argument( '--rules', metavar='', help='Filename that contains a new set of mapping rules', ) return parser def take_action(self, parsed_args): identity_client = self.app.client_manager.identity if not parsed_args.rules: self.app.log.error("No changes requested") return rules = self._read_rules(parsed_args.rules) mapping = identity_client.federation.mappings.update( mapping=parsed_args.mapping, rules=rules) mapping._info.pop('links', None) return zip(*sorted(six.iteritems(mapping._info))) class ShowMapping(command.ShowOne): """Display mapping details""" def get_parser(self, prog_name): parser = super(ShowMapping, self).get_parser(prog_name) parser.add_argument( 'mapping', metavar='', help='Mapping to display', ) return parser def take_action(self, parsed_args): identity_client = self.app.client_manager.identity mapping = identity_client.federation.mappings.get(parsed_args.mapping) mapping._info.pop('links', None) return zip(*sorted(six.iteritems(mapping._info)))