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 self.__user:
  53             logger.info('Found user with name - ' + self.user_settings.name)
  54         elif not cleanup:
  55             self.__user = keystone_utils.create_user(self.__keystone,
  56                                                      self.user_settings)
  57         else:
  58             logger.info('Did not create user due to cleanup mode')
  59
  60         return self.__user
  61
  62     def clean(self):
  63         """
  64         Cleanse environment of user
  65         :return: void
  66         """
  67         if self.__user:
  68             try:
  69                 keystone_utils.delete_user(self.__keystone, self.__user)
  70             except NotFound:
  71                 pass
  72             self.__user = None
  73
  74     def get_user(self):
  75         """
  76         Returns the OpenStack user object populated in create()
  77         :return: the Object or None if not created
  78         """
  79         return self.__user
  80
  81     def get_os_creds(self, project_name=None):
  82         """
  83         Returns an OSCreds object based on this user account and a project
  84         :param project_name: the name of the project to leverage in the
  85                              credentials
  86         :return:
  87         """
  88         return OSCreds(
  89             username=self.user_settings.name,
  90             password=self.user_settings.password,
  91             auth_url=self.__os_creds.auth_url,
  92             project_name=project_name,
  93             identity_api_version=self.__os_creds.identity_api_version,
  94             user_domain_id=self.__os_creds.user_domain_id,
  95             project_domain_id=self.__os_creds.project_domain_id,
  96             proxy_settings=self.__os_creds.proxy_settings)
  97
  98
  99 class UserSettings:
 100     def __init__(self, **kwargs):
 101
 102         """
 103         Constructor
 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
 108                             APIs
 109         :param email: the user's email address (optional)
 110         :param enabled: denotes whether or not the user is enabled
 111                         (default True)
 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
 119         if kwargs.get('domain_name'):
 120             self.domain_name = kwargs['domain_name']
 121         else:
 122             self.domain_name = 'default'
 123
 124         if kwargs.get('enabled') is not None:
 125             self.enabled = kwargs['enabled']
 126         else:
 127             self.enabled = True
 128
 129         if not self.name or not self.password:
 130             raise Exception(
 131                 'The attributes name and password are required for '
 132                 'UserSettings')
 133
 134         if not isinstance(self.enabled, bool):
 135             raise Exception('The attribute enabled must be of type boolean')