snaps/openstack/create_user.py

   1 # Copyright (c) 2016 Cable Television Laboratories, Inc. ("CableLabs")
   2 #                    and others.  All rights reserved.
   3 #
   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:
   7 #
   8 #     http://www.apache.org/licenses/LICENSE-2.0
   9 #
  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.
  15 import logging
  16
  17 from keystoneclient.exceptions import NotFound
  18 from snaps.openstack.os_credentials import OSCreds
  19 from snaps.openstack.utils import keystone_utils
  20
  21 __author__ = 'spisarski'
  22
  23 logger = logging.getLogger('create_user')
  24
  25
  26 class OpenStackUser:
  27     """
  28     Class responsible for creating a user in OpenStack
  29     """
  30
  31     def __init__(self, os_creds, user_settings):
  32         """
  33         Constructor
  34         :param os_creds: The OpenStack connection credentials
  35         :param user_settings: The user settings
  36         :return:
  37         """
  38         self.__os_creds = os_creds
  39         self.user_settings = user_settings
  40         self.__user = None
  41         self.__keystone = None
  42
  43     def create(self, cleanup=False):
  44         """
  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
  48         """
  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,
  54                                                      self.user_settings)
  55
  56         return self.__user
  57
  58     def clean(self):
  59         """
  60         Cleanse environment of user
  61         :return: void
  62         """
  63         if self.__user:
  64             try:
  65                 keystone_utils.delete_user(self.__keystone, self.__user)
  66             except NotFound:
  67                 pass
  68             self.__user = None
  69
  70     def get_user(self):
  71         """
  72         Returns the OpenStack user object populated in create()
  73         :return: the Object or None if not created
  74         """
  75         return self.__user
  76
  77     def get_os_creds(self, project_name=None):
  78         """
  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
  81                              credentials
  82         :return:
  83         """
  84         return OSCreds(
  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_id=self.__os_creds.user_domain_id,
  91             project_domain_id=self.__os_creds.project_domain_id,
  92             interface=self.__os_creds.interface,
  93             proxy_settings=self.__os_creds.proxy_settings,
  94             cacert=self.__os_creds.cacert)
  95
  96
  97 class UserSettings:
  98     def __init__(self, **kwargs):
  99
 100         """
 101         Constructor
 102         :param name: the user's name (required)
 103         :param password: the user's password (required)
 104         :param project_name: the user's primary project name (optional)
 105         :param domain_name: the user's domain name (default='default'). For v3
 106                             APIs
 107         :param email: the user's email address (optional)
 108         :param enabled: denotes whether or not the user is enabled
 109                         (default True)
 110         :param roles: dict where key is the role name and value is a list of
 111                       project names
 112         """
 113
 114         self.name = kwargs.get('name')
 115         self.password = kwargs.get('password')
 116         self.project_name = kwargs.get('project_name')
 117         self.email = kwargs.get('email')
 118         self.domain_name = kwargs.get('domain_name', 'default')
 119         self.enabled = kwargs.get('enabled', True)
 120         self.roles = kwargs.get('roles', dict())
 121
 122         if not self.name or not self.password:
 123             raise UserSettingsException(
 124                 'The attributes name and password are required for '
 125                 'UserSettings')
 126
 127         if not isinstance(self.enabled, bool):
 128             raise UserSettingsException('The attribute enabled must be of type'
 129                                         ' boolean')
 130
 131
 132 class UserSettingsException(Exception):
 133     """
 134     Raised when there is a problem with the values set in the UserSettings
 135     class
 136     """