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 from snaps.config.security_group import (
  26     Direction, Protocol, SecurityGroupConfig, SecurityGroupRuleConfig)
  27 from snaps.config.vm_inst import VmInstanceConfig, FloatingIpConfig
  28
  29 from snaps.openstack import create_flavor
  30 from snaps.openstack import create_image
  31 from snaps.openstack import create_instance
  32 from snaps.openstack import create_keypairs
  33 from snaps.openstack import create_network
  34 from snaps.openstack import create_router
  35 from snaps.openstack.create_security_group import OpenStackSecurityGroup
  36 from snaps.openstack.tests import openstack_tests
  37 from snaps.openstack.tests.create_instance_tests import check_dhcp_lease
  38 from snaps.openstack.tests.os_source_file_test import OSIntegrationTestCase
  39 from snaps.openstack.utils import nova_utils
  40 from snaps.provisioning import ansible_utils
  41
  42 VM_BOOT_TIMEOUT = 600
  43
  44 ip_1 = '10.0.1.100'
  45 ip_2 = '10.0.1.200'
  46
  47
  48 class AnsibleProvisioningTests(OSIntegrationTestCase):
  49     """
  50     Test for the CreateInstance class with two NIC/Ports, eth0 with floating IP
  51     and eth1 w/o
  52     """
  53
  54     def setUp(self):
  55         """
  56         Instantiates the CreateImage object that is responsible for downloading
  57         and creating an OS image file within OpenStack
  58         """
  59         super(self.__class__, self).__start__()
  60
  61         self.nova = nova_utils.nova_client(self.os_creds, self.os_session)
  62
  63         guid = self.__class__.__name__ + '-' + str(uuid.uuid4())
  64         self.keypair_priv_filepath = 'tmp/' + guid
  65         self.keypair_pub_filepath = self.keypair_priv_filepath + '.pub'
  66         self.keypair_name = guid + '-kp'
  67         self.vm_inst_name = guid + '-inst'
  68         self.test_file_local_path = 'tmp/' + guid + '-hello.txt'
  69         self.port_1_name = guid + '-port-1'
  70         self.port_2_name = guid + '-port-2'
  71         self.floating_ip_name = guid + 'fip1'
  72
  73         # Setup members to cleanup just in case they don't get created
  74         self.inst_creator = None
  75         self.keypair_creator = None
  76         self.sec_grp_creator = None
  77         self.flavor_creator = None
  78         self.router_creator = None
  79         self.network_creator = None
  80         self.image_creator = None
  81
  82         try:
  83             # Create Image
  84             os_image_settings = openstack_tests.ubuntu_image_settings(
  85                 name=guid + '-' + '-image',
  86                 image_metadata=self.image_metadata)
  87             self.image_creator = create_image.OpenStackImage(self.os_creds,
  88                                                              os_image_settings)
  89             self.image_creator.create()
  90
  91             # First network is public
  92             self.pub_net_config = openstack_tests.get_pub_net_config(
  93                 project_name=self.os_creds.project_name,
  94                 net_name=guid + '-pub-net', subnet_name=guid + '-pub-subnet',
  95                 router_name=guid + '-pub-router',
  96                 external_net=self.ext_net_name)
  97
  98             self.network_creator = create_network.OpenStackNetwork(
  99                 self.os_creds, self.pub_net_config.network_settings)
 100             self.network_creator.create()
 101
 102             # Create routers
 103             self.router_creator = create_router.OpenStackRouter(
 104                 self.os_creds, self.pub_net_config.router_settings)
 105             self.router_creator.create()
 106
 107             # Create Flavor
 108             self.flavor_creator = create_flavor.OpenStackFlavor(
 109                 self.admin_os_creds,
 110                 FlavorConfig(
 111                     name=guid + '-flavor-name', ram=2048, disk=10, vcpus=2,
 112                     metadata=self.flavor_metadata))
 113             self.flavor_creator.create()
 114
 115             # Create Key/Pair
 116             self.keypair_creator = create_keypairs.OpenStackKeypair(
 117                 self.os_creds, KeypairConfig(
 118                     name=self.keypair_name,
 119                     public_filepath=self.keypair_pub_filepath,
 120                     private_filepath=self.keypair_priv_filepath))
 121             self.keypair_creator.create()
 122
 123             # Create Security Group
 124             sec_grp_name = guid + '-sec-grp'
 125             rule1 = SecurityGroupRuleConfig(
 126                 sec_grp_name=sec_grp_name, direction=Direction.ingress,
 127                 protocol=Protocol.icmp)
 128             rule2 = SecurityGroupRuleConfig(
 129                 sec_grp_name=sec_grp_name, direction=Direction.ingress,
 130                 protocol=Protocol.tcp, port_range_min=22, port_range_max=22)
 131             self.sec_grp_creator = OpenStackSecurityGroup(
 132                 self.os_creds,
 133                 SecurityGroupConfig(
 134                     name=sec_grp_name, 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 = VmInstanceConfig(
 145                 name=self.vm_inst_name,
 146                 flavor=self.flavor_creator.flavor_settings.name,
 147                 port_settings=ports_settings,
 148                 floating_ip_settings=[FloatingIpConfig(
 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         # Block until cloud-init has completed
 246         self.assertTrue(self.inst_creator.cloud_init_complete(block=True))
 247
 248         ssh_client = self.inst_creator.ssh_client()
 249         self.assertIsNotNone(ssh_client)
 250
 251         try:
 252             out = ssh_client.exec_command('pwd')[1].channel.in_buffer.read(
 253                 1024)
 254             self.assertIsNotNone(out)
 255             self.assertGreater(len(out), 1)
 256         finally:
 257             ssh_client.close()
 258
 259         # Need to use the first floating IP as subsequent ones are currently
 260         # broken with Apex CO
 261         ip = self.inst_creator.get_floating_ip().ip
 262         user = self.inst_creator.get_image_user()
 263         priv_key = self.inst_creator.keypair_settings.private_filepath
 264
 265         relative_pb_path = pkg_resources.resource_filename(
 266             'snaps.provisioning.tests.playbooks', 'simple_playbook.yml')
 267         retval = self.inst_creator.apply_ansible_playbook(relative_pb_path)
 268         self.assertEqual(0, retval)
 269
 270         ssh = ansible_utils.ssh_client(
 271             ip, user, private_key_filepath=priv_key,
 272             proxy_settings=self.os_creds.proxy_settings)
 273         self.assertIsNotNone(ssh)
 274         scp = None
 275         try:
 276             scp = SCPClient(ssh.get_transport())
 277             scp.get('~/hello.txt', self.test_file_local_path)
 278         finally:
 279             if scp:
 280                 scp.close()
 281             ssh.close()
 282
 283         self.assertTrue(os.path.isfile(self.test_file_local_path))
 284
 285         test_file = None
 286
 287         try:
 288             with open(self.test_file_local_path) as test_file:
 289                 file_contents = test_file.readline()
 290                 self.assertEqual('Hello World!', file_contents)
 291         finally:
 292             if test_file:
 293                 test_file.close()
 294
 295     def test_apply_template_playbook(self):
 296         """
 297         Tests application of an Ansible playbook that applies a template to a
 298         file:
 299         1. Have a ~/.ansible.cfg (or alternate means) to set
 300            host_key_checking = False
 301         2. Set the following environment variable in your executing shell:
 302            ANSIBLE_HOST_KEY_CHECKING=False
 303         Should this not be performed, the creation of the host ssh key will
 304         cause your ansible calls to fail.
 305         """
 306         self.inst_creator.create(block=True)
 307
 308         priv_ip = self.inst_creator.get_port_ip(self.port_1_name)
 309         self.assertTrue(check_dhcp_lease(self.inst_creator, priv_ip))
 310
 311         # Apply Security Group
 312         self.inst_creator.add_security_group(
 313             self.sec_grp_creator.get_security_group())
 314
 315         # Block until VM's ssh port has been opened
 316         self.assertTrue(self.inst_creator.vm_ssh_active(block=True))
 317
 318         # Block until cloud-init has completed
 319         self.assertTrue(self.inst_creator.cloud_init_complete(block=True))
 320
 321         # Apply Security Group
 322         self.inst_creator.add_security_group(
 323             self.sec_grp_creator.get_security_group())
 324
 325         # Need to use the first floating IP as subsequent ones are currently
 326         # broken with Apex CO
 327         ip = self.inst_creator.get_floating_ip().ip
 328         user = self.inst_creator.get_image_user()
 329         priv_key = self.inst_creator.keypair_settings.private_filepath
 330
 331         relative_pb_path = pkg_resources.resource_filename(
 332             'snaps.provisioning.tests.playbooks',
 333             'template_playbook.yml')
 334         retval = self.inst_creator.apply_ansible_playbook(
 335             relative_pb_path, variables={'name': 'Foo'})
 336         self.assertEqual(0, retval)
 337
 338         ssh = ansible_utils.ssh_client(
 339             ip, user, private_key_filepath=priv_key,
 340             proxy_settings=self.os_creds.proxy_settings)
 341         self.assertIsNotNone(ssh)
 342         scp = None
 343
 344         try:
 345             scp = SCPClient(ssh.get_transport())
 346             scp.get('/tmp/hello.txt', self.test_file_local_path)
 347         finally:
 348             if scp:
 349                 scp.close()
 350             ssh.close()
 351
 352         self.assertTrue(os.path.isfile(self.test_file_local_path))
 353
 354         test_file = None
 355         try:
 356             with open(self.test_file_local_path) as test_file:
 357                 file_contents = test_file.readline()
 358                 self.assertEqual('Hello Foo!', file_contents)
 359         finally:
 360             if test_file:
 361                 test_file.close()