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
18 from snaps.openstack.os_credentials import OSCreds
19 from snaps.openstack.utils import keystone_utils
21 __author__ = 'spisarski'
23 logger = logging.getLogger('create_user')
28 Class responsible for creating a user in OpenStack
31 def __init__(self, os_creds, user_settings):
34 :param os_creds: The OpenStack connection credentials
35 :param user_settings: The user settings
38 self.__os_creds = os_creds
39 self.user_settings = user_settings
41 self.__keystone = None
43 def create(self, cleanup=False):
45 Creates the user in OpenStack if it does not already exist
46 :param cleanup: Denotes whether or not this is being called for cleanup
47 :return: The OpenStack user object
49 self.__keystone = keystone_utils.keystone_client(self.__os_creds)
50 self.__user = keystone_utils.get_user(self.__keystone,
51 self.user_settings.name)
52 if not self.__user and not cleanup:
53 self.__user = keystone_utils.create_user(self.__keystone,
60 Cleanse environment of user
65 keystone_utils.delete_user(self.__keystone, self.__user)
72 Returns the OpenStack user object populated in create()
73 :return: the Object or None if not created
77 def get_os_creds(self, project_name=None):
79 Returns an OSCreds object based on this user account and a project
80 :param project_name: the name of the project to leverage in the
85 username=self.user_settings.name,
86 password=self.user_settings.password,
87 auth_url=self.__os_creds.auth_url,
88 project_name=project_name,
89 identity_api_version=self.__os_creds.identity_api_version,
90 user_domain_name=self.__os_creds.user_domain_name,
91 user_domain_id=self.__os_creds.user_domain_id,
92 project_domain_name=self.__os_creds.project_domain_name,
93 project_domain_id=self.__os_creds.project_domain_id,
94 interface=self.__os_creds.interface,
95 proxy_settings=self.__os_creds.proxy_settings,
96 cacert=self.__os_creds.cacert)
100 def __init__(self, **kwargs):
104 :param name: the user's name (required)
105 :param password: the user's password (required)
106 :param project_name: the user's primary project name (optional)
107 :param domain_name: the user's domain name (default='default'). For v3
109 :param email: the user's email address (optional)
110 :param enabled: denotes whether or not the user is enabled
112 :param roles: dict where key is the role name and value is a list of
116 self.name = kwargs.get('name')
117 self.password = kwargs.get('password')
118 self.project_name = kwargs.get('project_name')
119 self.email = kwargs.get('email')
120 self.domain_name = kwargs.get('domain_name', 'Default')
121 self.enabled = kwargs.get('enabled', True)
122 self.roles = kwargs.get('roles', dict())
124 if not self.name or not self.password:
125 raise UserSettingsException(
126 'The attributes name and password are required for '
129 if not isinstance(self.enabled, bool):
130 raise UserSettingsException('The attribute enabled must be of type'
134 class UserSettingsException(Exception):
136 Raised when there is a problem with the values set in the UserSettings