1 # Copyright (c) 2016 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.
16 from keystoneclient.exceptions import NotFound
17 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 or not
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, self.user_settings.name)
52 logger.info('Found user with name - ' + self.user_settings.name)
54 self.__user = keystone_utils.create_user(self.__keystone, self.user_settings)
56 logger.info('Did not create user due to cleanup mode')
62 Cleanse environment of user
67 keystone_utils.delete_user(self.__keystone, self.__user)
74 Returns the OpenStack user object populated in create()
75 :return: the Object or None if not created
79 def get_os_creds(self, project_name=None):
81 Returns an OSCreds object based on this user account and a project
82 :param project_name: the name of the project to leverage in the credentials
85 return OSCreds(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_id=self.__os_creds.user_domain_id,
91 project_domain_id=self.__os_creds.project_domain_id,
92 proxy_settings=self.__os_creds.proxy_settings)
96 def __init__(self, config=None, name=None, password=None, project_name=None, domain_name='default', email=None,
101 :param config: dict() object containing the configuration settings using the attribute names below as each
102 member's the key and overrides any of the other parameters.
103 :param name: the user's name (required)
104 :param password: the user's password (required)
105 :param project_name: the user's primary project name (optional)
106 :param domain_name: the user's domain name (default='default'). For v3 APIs
107 :param email: the user's email address (optional)
108 :param enabled: denotes whether or not the user is enabled (default True)
112 self.name = config.get('name')
113 self.password = config.get('password')
114 self.project_name = config.get('project_name')
115 self.email = config.get('email')
117 if config.get('domain_name'):
118 self.domain_name = config['domain_name']
120 self.domain_name = domain_name
122 if config.get('enabled') is not None:
123 self.enabled = config['enabled']
125 self.enabled = enabled
128 self.password = password
129 self.project_name = project_name
131 self.enabled = enabled
132 self.domain_name = domain_name
134 if not self.name or not self.password:
135 raise Exception('The attributes name and password are required for UserSettings')
137 if not isinstance(self.enabled, bool):
138 raise Exception('The attribute enabled must be of type boolean')