# Copyright 2013 OpenStack Foundation # All Rights Reserved. # # 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. """ https://docs.openstack.org/api-ref/identity/v3/index.html#groups """ from urllib import parse as urllib from oslo_serialization import jsonutils as json from tempest.lib.common import rest_client class GroupsClient(rest_client.RestClient): api_version = "v3" def create_group(self, **kwargs): """Creates a group. For a full list of available parameters, please refer to the official API reference: https://docs.openstack.org/api-ref/identity/v3/index.html#create-group """ post_body = json.dumps({'group': kwargs}) resp, body = self.post('groups', post_body) self.expected_success(201, resp.status) body = json.loads(body) return rest_client.ResponseBody(resp, body) def show_group(self, group_id): """Get group details.""" resp, body = self.get('groups/%s' % group_id) self.expected_success(200, resp.status) body = json.loads(body) return rest_client.ResponseBody(resp, body) def list_groups(self, **params): """Lists the groups. For a full list of available parameters, please refer to the official API reference: https://docs.openstack.org/api-ref/identity/v3/#list-groups """ url = 'groups' if params: url += '?%s' % urllib.urlencode(params) resp, body = self.get(url) self.expected_success(200, resp.status) body = json.loads(body) return rest_client.ResponseBody(resp, body) def update_group(self, group_id, **kwargs): """Updates a group. For a full list of available parameters, please refer to the official API reference: https://docs.openstack.org/api-ref/identity/v3/index.html#update-group """ post_body = json.dumps({'group': kwargs}) resp, body = self.patch('groups/%s' % group_id, post_body) self.expected_success(200, resp.status) body = json.loads(body) return rest_client.ResponseBody(resp, body) def delete_group(self, group_id): """Delete a group.""" resp, body = self.delete('groups/%s' % group_id) self.expected_success(204, resp.status) return rest_client.ResponseBody(resp, body) def add_group_user(self, group_id, user_id): """Add user into group.""" resp, body = self.put('groups/%s/users/%s' % (group_id, user_id), None) self.expected_success(204, resp.status) return rest_client.ResponseBody(resp, body) def list_group_users(self, group_id, **params): """List users in group. For a full list of available parameters, please refer to the official API reference: https://docs.openstack.org/api-ref/identity/v3/#list-users-in-group """ url = 'groups/%s/users' % group_id if params: url += '?%s' % urllib.urlencode(params) resp, body = self.get(url) self.expected_success(200, resp.status) body = json.loads(body) return rest_client.ResponseBody(resp, body) def delete_group_user(self, group_id, user_id): """Delete user in group.""" resp, body = self.delete('groups/%s/users/%s' % (group_id, user_id)) self.expected_success(204, resp.status) return rest_client.ResponseBody(resp, body) def check_group_user_existence(self, group_id, user_id): """Check user in group.""" resp, _ = self.head('groups/%s/users/%s' % (group_id, user_id)) self.expected_success(204, resp.status) return rest_client.ResponseBody(resp)