snaps/openstack/create_keypairs.py

   1 # Copyright (c) 2017 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 import os
  17
  18 from novaclient.exceptions import NotFound
  19
  20 from snaps.openstack.utils import nova_utils
  21
  22 __author__ = 'spisarski'
  23
  24 logger = logging.getLogger('OpenStackKeypair')
  25
  26
  27 class OpenStackKeypair:
  28     """
  29     Class responsible for creating a keypair in OpenStack
  30     """
  31
  32     def __init__(self, os_creds, keypair_settings):
  33         """
  34         Constructor - all parameters are required
  35         :param os_creds: The credentials to connect with OpenStack
  36         :param keypair_settings: The settings used to create a keypair
  37         """
  38         self.__nova = None
  39         self.__os_creds = os_creds
  40         self.keypair_settings = keypair_settings
  41         self.__nova = nova_utils.nova_client(os_creds)
  42
  43         # Attributes instantiated on create()
  44         self.__keypair = None
  45
  46     def create(self, cleanup=False):
  47         """
  48         Responsible for creating the keypair object.
  49         :param cleanup: Denotes whether or not this is being called for cleanup or not
  50         """
  51         self.__nova = nova_utils.nova_client(self.__os_creds)
  52
  53         logger.info('Creating keypair %s...' % self.keypair_settings.name)
  54
  55         self.__keypair = nova_utils.get_keypair_by_name(self.__nova, self.keypair_settings.name)
  56
  57         if not self.__keypair and not cleanup:
  58             if self.keypair_settings.public_filepath and os.path.isfile(self.keypair_settings.public_filepath):
  59                 logger.info("Uploading existing keypair")
  60                 self.__keypair = nova_utils.upload_keypair_file(self.__nova, self.keypair_settings.name,
  61                                                                 self.keypair_settings.public_filepath)
  62             else:
  63                 logger.info("Creating new keypair")
  64                 # TODO - Make this value configurable
  65                 keys = nova_utils.create_keys(1024)
  66                 self.__keypair = nova_utils.upload_keypair(self.__nova, self.keypair_settings.name,
  67                                                            nova_utils.public_key_openssh(keys))
  68                 nova_utils.save_keys_to_files(keys, self.keypair_settings.public_filepath,
  69                                               self.keypair_settings.private_filepath)
  70
  71         return self.__keypair
  72
  73     def clean(self):
  74         """
  75         Removes and deletes the keypair.
  76         """
  77         if self.__keypair:
  78             try:
  79                 nova_utils.delete_keypair(self.__nova, self.__keypair)
  80             except NotFound:
  81                 pass
  82             self.__keypair = None
  83
  84     def get_keypair(self):
  85         """
  86         Returns the OpenStack keypair object
  87         :return:
  88         """
  89         return self.__keypair
  90
  91
  92 class KeypairSettings:
  93     """
  94     Class representing a keypair configuration
  95     """
  96
  97     def __init__(self, config=None, name=None, public_filepath=None, private_filepath=None):
  98         """
  99         Constructor - all parameters are optional
 100         :param config: Should be a dict object containing the configuration settings using the attribute names below
 101                        as each member's the key and overrides any of the other parameters.
 102         :param name: The keypair name.
 103         :param public_filepath: The path to/from the filesystem where the public key file is or will be stored
 104         :param private_filepath: The path where the generated private key file will be stored
 105         :return:
 106         """
 107
 108         if config:
 109             self.name = config.get('name')
 110             self.public_filepath = config.get('public_filepath')
 111             self.private_filepath = config.get('private_filepath')
 112         else:
 113             self.name = name
 114             self.public_filepath = public_filepath
 115             self.private_filepath = private_filepath
 116
 117         if not self.name:
 118             raise Exception('The attributes name, public_filepath, and private_filepath are required')