snaps/provisioning/tests/ansible_utils_tests.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
  16 import uuid
  17
  18 import os
  19 import pkg_resources
  20 from scp import SCPClient
  21
  22 from snaps.config.flavor import FlavorConfig
  23 from snaps.config.keypair import KeypairConfig
  24 from snaps.config.network import PortConfig
  25
  26 from snaps.openstack import create_flavor
  27 from snaps.openstack import create_image
  28 from snaps.openstack import create_instance
  29 from snaps.openstack import create_keypairs
  30 from snaps.openstack import create_network
  31 from snaps.openstack import create_router
  32 from snaps.openstack.create_security_group import (
  33     SecurityGroupRuleSettings,  Direction, Protocol, OpenStackSecurityGroup,
  34     SecurityGroupSettings)
  35 from snaps.openstack.tests import openstack_tests
  36 from snaps.openstack.tests.create_instance_tests import check_dhcp_lease
  37 from snaps.openstack.tests.os_source_file_test import OSIntegrationTestCase
  38 from snaps.openstack.utils import nova_utils
  39 from snaps.provisioning import ansible_utils
  40
  41 VM_BOOT_TIMEOUT = 600
  42
  43 ip_1 = '10.0.1.100'
  44 ip_2 = '10.0.1.200'
  45
  46
  47 class AnsibleProvisioningTests(OSIntegrationTestCase):
  48     """
  49     Test for the CreateInstance class with two NIC/Ports, eth0 with floating IP
  50     and eth1 w/o
  51     """
  52
  53     def setUp(self):
  54         """
  55         Instantiates the CreateImage object that is responsible for downloading
  56         and creating an OS image file within OpenStack
  57         """
  58         super(self.__class__, self).__start__()
  59
  60         self.nova = nova_utils.nova_client(self.os_creds)
  61
  62         guid = self.__class__.__name__ + '-' + str(uuid.uuid4())
  63         self.keypair_priv_filepath = 'tmp/' + guid
  64         self.keypair_pub_filepath = self.keypair_priv_filepath + '.pub'
  65         self.keypair_name = guid + '-kp'
  66         self.vm_inst_name = guid + '-inst'
  67         self.test_file_local_path = 'tmp/' + guid + '-hello.txt'
  68         self.port_1_name = guid + '-port-1'
  69         self.port_2_name = guid + '-port-2'
  70         self.floating_ip_name = guid + 'fip1'
  71
  72         # Setup members to cleanup just in case they don't get created
  73         self.inst_creator = None
  74         self.keypair_creator = None
  75         self.sec_grp_creator = None
  76         self.flavor_creator = None
  77         self.router_creator = None
  78         self.network_creator = None
  79         self.image_creator = None
  80
  81         try:
  82             # Create Image
  83             os_image_settings = openstack_tests.ubuntu_image_settings(
  84                 name=guid + '-' + '-image',
  85                 image_metadata=self.image_metadata)
  86             self.image_creator = create_image.OpenStackImage(self.os_creds,
  87                                                              os_image_settings)
  88             self.image_creator.create()
  89
  90             # First network is public
  91             self.pub_net_config = openstack_tests.get_pub_net_config(
  92                 net_name=guid + '-pub-net', subnet_name=guid + '-pub-subnet',
  93                 router_name=guid + '-pub-router',
  94                 external_net=self.ext_net_name)
  95
  96             self.network_creator = create_network.OpenStackNetwork(
  97                 self.os_creds, self.pub_net_config.network_settings)
  98             self.network_creator.create()
  99
 100             # Create routers
 101             self.router_creator = create_router.OpenStackRouter(
 102                 self.os_creds, self.pub_net_config.router_settings)
 103             self.router_creator.create()
 104
 105             # Create Flavor
 106             self.flavor_creator = create_flavor.OpenStackFlavor(
 107                 self.admin_os_creds,
 108                 FlavorConfig(
 109                     name=guid + '-flavor-name', ram=2048, disk=10, vcpus=2,
 110                     metadata=self.flavor_metadata))
 111             self.flavor_creator.create()
 112
 113             # Create Key/Pair
 114             self.keypair_creator = create_keypairs.OpenStackKeypair(
 115                 self.os_creds, KeypairConfig(
 116                     name=self.keypair_name,
 117                     public_filepath=self.keypair_pub_filepath,
 118                     private_filepath=self.keypair_priv_filepath))
 119             self.keypair_creator.create()
 120
 121             # Create Security Group
 122             sec_grp_name = guid + '-sec-grp'
 123             rule1 = SecurityGroupRuleSettings(sec_grp_name=sec_grp_name,
 124                                               direction=Direction.ingress,
 125                                               protocol=Protocol.icmp)
 126             rule2 = SecurityGroupRuleSettings(sec_grp_name=sec_grp_name,
 127                                               direction=Direction.ingress,
 128                                               protocol=Protocol.tcp,
 129                                               port_range_min=22,
 130                                               port_range_max=22)
 131             self.sec_grp_creator = OpenStackSecurityGroup(
 132                 self.os_creds,
 133                 SecurityGroupSettings(name=sec_grp_name,
 134                                       rule_settings=[rule1, rule2]))
 135             self.sec_grp_creator.create()
 136
 137             # Create instance
 138             ports_settings = list()
 139             ports_settings.append(
 140                 PortConfig(
 141                     name=self.port_1_name,
 142                     network_name=self.pub_net_config.network_settings.name))
 143
 144             instance_settings = create_instance.VmInstanceSettings(
 145                 name=self.vm_inst_name,
 146                 flavor=self.flavor_creator.flavor_settings.name,
 147                 port_settings=ports_settings,
 148                 floating_ip_settings=[create_instance.FloatingIpSettings(
 149                     name=self.floating_ip_name, port_name=self.port_1_name,
 150                     router_name=self.pub_net_config.router_settings.name)])
 151
 152             self.inst_creator = create_instance.OpenStackVmInstance(
 153                 self.os_creds, instance_settings,
 154                 self.image_creator.image_settings,
 155                 keypair_settings=self.keypair_creator.keypair_settings)
 156         except:
 157             self.tearDown()
 158             raise
 159
 160     def tearDown(self):
 161         """
 162         Cleans the created objects
 163         """
 164         if self.inst_creator:
 165             try:
 166                 self.inst_creator.clean()
 167             except:
 168                 pass
 169
 170         if self.sec_grp_creator:
 171             try:
 172                 self.sec_grp_creator.clean()
 173             except:
 174                 pass
 175
 176         if self.keypair_creator:
 177             try:
 178                 self.keypair_creator.clean()
 179             except:
 180                 pass
 181
 182         if self.flavor_creator:
 183             try:
 184                 self.flavor_creator.clean()
 185             except:
 186                 pass
 187
 188         if os.path.isfile(self.keypair_pub_filepath):
 189             try:
 190                 os.remove(self.keypair_pub_filepath)
 191             except:
 192                 pass
 193
 194         if os.path.isfile(self.keypair_priv_filepath):
 195             try:
 196                 os.remove(self.keypair_priv_filepath)
 197             except:
 198                 pass
 199
 200         if self.router_creator:
 201             try:
 202                 self.router_creator.clean()
 203             except:
 204                 pass
 205
 206         if self.network_creator:
 207             try:
 208                 self.network_creator.clean()
 209             except:
 210                 pass
 211
 212         if self.image_creator and not self.image_creator.image_settings.exists:
 213             try:
 214                 self.image_creator.clean()
 215             except:
 216                 pass
 217
 218         if os.path.isfile(self.test_file_local_path):
 219             os.remove(self.test_file_local_path)
 220
 221         super(self.__class__, self).__clean__()
 222
 223     def test_apply_simple_playbook(self):
 224         """
 225         Tests application of an Ansible playbook that simply copies over a file
 226         1. Have a ~/.ansible.cfg (or alternate means) to
 227            set host_key_checking = False
 228         2. Set the following environment variable in your executing shell:
 229            ANSIBLE_HOST_KEY_CHECKING=False
 230         Should this not be performed, the creation of the host ssh key will
 231         cause your ansible calls to fail.
 232         """
 233         self.inst_creator.create(block=True)
 234
 235         priv_ip = self.inst_creator.get_port_ip(self.port_1_name)
 236         self.assertTrue(check_dhcp_lease(self.inst_creator, priv_ip))
 237
 238         # Apply Security Group
 239         self.inst_creator.add_security_group(
 240             self.sec_grp_creator.get_security_group())
 241
 242         # Block until VM's ssh port has been opened
 243         self.assertTrue(self.inst_creator.vm_ssh_active(block=True))
 244
 245         ssh_client = self.inst_creator.ssh_client()
 246         self.assertIsNotNone(ssh_client)
 247
 248         try:
 249             out = ssh_client.exec_command('pwd')[1].channel.in_buffer.read(
 250                 1024)
 251             self.assertIsNotNone(out)
 252             self.assertGreater(len(out), 1)
 253         finally:
 254             ssh_client.close()
 255
 256         # Need to use the first floating IP as subsequent ones are currently
 257         # broken with Apex CO
 258         ip = self.inst_creator.get_floating_ip().ip
 259         user = self.inst_creator.get_image_user()
 260         priv_key = self.inst_creator.keypair_settings.private_filepath
 261
 262         relative_pb_path = pkg_resources.resource_filename(
 263             'snaps.provisioning.tests.playbooks', 'simple_playbook.yml')
 264         retval = self.inst_creator.apply_ansible_playbook(relative_pb_path)
 265         self.assertEqual(0, retval)
 266
 267         ssh = ansible_utils.ssh_client(ip, user, priv_key,
 268                                        self.os_creds.proxy_settings)
 269         self.assertIsNotNone(ssh)
 270         scp = None
 271         try:
 272             scp = SCPClient(ssh.get_transport())
 273             scp.get('~/hello.txt', self.test_file_local_path)
 274         finally:
 275             if scp:
 276                 scp.close()
 277             ssh.close()
 278
 279         self.assertTrue(os.path.isfile(self.test_file_local_path))
 280
 281         test_file = None
 282
 283         try:
 284             with open(self.test_file_local_path) as test_file:
 285                 file_contents = test_file.readline()
 286                 self.assertEqual('Hello World!', file_contents)
 287         finally:
 288             if test_file:
 289                 test_file.close()
 290
 291     def test_apply_template_playbook(self):
 292         """
 293         Tests application of an Ansible playbook that applies a template to a
 294         file:
 295         1. Have a ~/.ansible.cfg (or alternate means) to set
 296            host_key_checking = False
 297         2. Set the following environment variable in your executing shell:
 298            ANSIBLE_HOST_KEY_CHECKING=False
 299         Should this not be performed, the creation of the host ssh key will
 300         cause your ansible calls to fail.
 301         """
 302         self.inst_creator.create(block=True)
 303
 304         priv_ip = self.inst_creator.get_port_ip(self.port_1_name)
 305         self.assertTrue(check_dhcp_lease(self.inst_creator, priv_ip))
 306
 307         # Apply Security Group
 308         self.inst_creator.add_security_group(
 309             self.sec_grp_creator.get_security_group())
 310
 311         # Block until VM's ssh port has been opened
 312         self.assertTrue(self.inst_creator.vm_ssh_active(block=True))
 313
 314         # Apply Security Group
 315         self.inst_creator.add_security_group(
 316             self.sec_grp_creator.get_security_group())
 317
 318         # Need to use the first floating IP as subsequent ones are currently
 319         # broken with Apex CO
 320         ip = self.inst_creator.get_floating_ip().ip
 321         user = self.inst_creator.get_image_user()
 322         priv_key = self.inst_creator.keypair_settings.private_filepath
 323
 324         relative_pb_path = pkg_resources.resource_filename(
 325             'snaps.provisioning.tests.playbooks',
 326             'template_playbook.yml')
 327         retval = self.inst_creator.apply_ansible_playbook(relative_pb_path,
 328                                                           variables={
 329                                                               'name': 'Foo'})
 330         self.assertEqual(0, retval)
 331
 332         ssh = ansible_utils.ssh_client(ip, user, priv_key,
 333                                        self.os_creds.proxy_settings)
 334         self.assertIsNotNone(ssh)
 335         scp = None
 336
 337         try:
 338             scp = SCPClient(ssh.get_transport())
 339             scp.get('/tmp/hello.txt', self.test_file_local_path)
 340         finally:
 341             if scp:
 342                 scp.close()
 343             ssh.close()
 344
 345         self.assertTrue(os.path.isfile(self.test_file_local_path))
 346
 347         test_file = None
 348         try:
 349             with open(self.test_file_local_path) as test_file:
 350                 file_contents = test_file.readline()
 351                 self.assertEqual('Hello Foo!', file_contents)
 352         finally:
 353             if test_file:
 354                 test_file.close()