1 # Copyright (c) 2017 Cable Television Laboratories, Inc. ("CableLabs")
2 # and others. All rights reserved.
4 # Licensed under the Apache License, Version 2.0 (the "License");
5 # you may not use this file except in compliance with the License.
6 # You may obtain a copy of the License at:
8 # http://www.apache.org/licenses/LICENSE-2.0
10 # Unless required by applicable law or agreed to in writing, software
11 # distributed under the License is distributed on an "AS IS" BASIS,
12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 # See the License for the specific language governing permissions and
14 # limitations under the License.
17 from keystoneclient.exceptions import NotFound
19 from snaps.config.user import UserConfig
20 from snaps.openstack.openstack_creator import OpenStackIdentityObject
21 from snaps.openstack.os_credentials import OSCreds
22 from snaps.openstack.utils import keystone_utils
24 __author__ = 'spisarski'
26 logger = logging.getLogger('create_user')
29 class OpenStackUser(OpenStackIdentityObject):
31 Class responsible for managing a user in OpenStack
34 def __init__(self, os_creds, user_settings):
37 :param os_creds: The OpenStack connection credentials
38 :param user_settings: The user settings
41 super(self.__class__, self).__init__(os_creds)
43 self.user_settings = user_settings
48 Creates the user in OpenStack if it does not already exist
49 :return: The User domain object
51 super(self.__class__, self).initialize()
53 self.__user = keystone_utils.get_user(self._keystone,
54 self.user_settings.name)
57 def create(self, cleanup=False):
59 Creates a User if one does not already exist
60 :return: The User domain object
64 self.__user = keystone_utils.create_user(self._keystone,
70 Cleanse environment of user
75 keystone_utils.delete_user(self._keystone, self.__user)
80 super(self.__class__, self).clean()
84 Returns the OpenStack user object populated in create()
85 :return: the Object or None if not created
89 def get_os_creds(self, project_name=None):
91 Returns an OSCreds object based on this user account and a project
92 :param project_name: the name of the project to leverage in the
97 project_name = self._os_creds.project_name
100 username=self.user_settings.name,
101 password=self.user_settings.password,
102 auth_url=self._os_creds.auth_url,
103 project_name=project_name,
104 identity_api_version=self._os_creds.identity_api_version,
105 image_api_version=self._os_creds.image_api_version,
106 network_api_version=self._os_creds.network_api_version,
107 compute_api_version=self._os_creds.compute_api_version,
108 heat_api_version=self._os_creds.heat_api_version,
109 volume_api_version=self._os_creds.volume_api_version,
110 region_name=self._os_creds.region_name,
111 user_domain_name=self._os_creds.user_domain_name,
112 user_domain_id=self._os_creds.user_domain_id,
113 project_domain_name=self._os_creds.project_domain_name,
114 project_domain_id=self._os_creds.project_domain_id,
115 interface=self._os_creds.interface,
116 proxy_settings=self._os_creds.proxy_settings,
117 cacert=self._os_creds.cacert)
120 class UserSettings(UserConfig):
122 Class to hold the configuration settings required for creating OpenStack
127 def __init__(self, **kwargs):
128 from warnings import warn
129 warn('Use snaps.config.user.UserConfig instead',
131 super(self.__class__, self).__init__(**kwargs)