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)
  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                 net_name=guid + '-pub-net', subnet_name=guid + '-pub-subnet',
  94                 router_name=guid + '-pub-router',
  95                 external_net=self.ext_net_name)
  96
  97             self.network_creator = create_network.OpenStackNetwork(
  98                 self.os_creds, self.pub_net_config.network_settings)
  99             self.network_creator.create()
 100
 101             # Create routers
 102             self.router_creator = create_router.OpenStackRouter(
 103                 self.os_creds, self.pub_net_config.router_settings)
 104             self.router_creator.create()
 105
 106             # Create Flavor
 107             self.flavor_creator = create_flavor.OpenStackFlavor(
 108                 self.admin_os_creds,
 109                 FlavorConfig(
 110                     name=guid + '-flavor-name', ram=2048, disk=10, vcpus=2,
 111                     metadata=self.flavor_metadata))
 112             self.flavor_creator.create()
 113
 114             # Create Key/Pair
 115             self.keypair_creator = create_keypairs.OpenStackKeypair(
 116                 self.os_creds, KeypairConfig(
 117                     name=self.keypair_name,
 118                     public_filepath=self.keypair_pub_filepath,
 119                     private_filepath=self.keypair_priv_filepath))
 120             self.keypair_creator.create()
 121
 122             # Create Security Group
 123             sec_grp_name = guid + '-sec-grp'
 124             rule1 = SecurityGroupRuleConfig(
 125                 sec_grp_name=sec_grp_name, direction=Direction.ingress,
 126                 protocol=Protocol.icmp)
 127             rule2 = SecurityGroupRuleConfig(
 128                 sec_grp_name=sec_grp_name, direction=Direction.ingress,
 129                 protocol=Protocol.tcp, port_range_min=22, port_range_max=22)
 130             self.sec_grp_creator = OpenStackSecurityGroup(
 131                 self.os_creds,
 132                 SecurityGroupConfig(
 133                     name=sec_grp_name, rule_settings=[rule1, rule2]))
 134             self.sec_grp_creator.create()
 135
 136             # Create instance
 137             ports_settings = list()
 138             ports_settings.append(
 139                 PortConfig(
 140                     name=self.port_1_name,
 141                     network_name=self.pub_net_config.network_settings.name))
 142
 143             instance_settings = VmInstanceConfig(
 144                 name=self.vm_inst_name,
 145                 flavor=self.flavor_creator.flavor_settings.name,
 146                 port_settings=ports_settings,
 147                 floating_ip_settings=[FloatingIpConfig(
 148                     name=self.floating_ip_name, port_name=self.port_1_name,
 149                     router_name=self.pub_net_config.router_settings.name)])
 150
 151             self.inst_creator = create_instance.OpenStackVmInstance(
 152                 self.os_creds, instance_settings,
 153                 self.image_creator.image_settings,
 154                 keypair_settings=self.keypair_creator.keypair_settings)
 155         except:
 156             self.tearDown()
 157             raise
 158
 159     def tearDown(self):
 160         """
 161         Cleans the created objects
 162         """
 163         if self.inst_creator:
 164             try:
 165                 self.inst_creator.clean()
 166             except:
 167                 pass
 168
 169         if self.sec_grp_creator:
 170             try:
 171                 self.sec_grp_creator.clean()
 172             except:
 173                 pass
 174
 175         if self.keypair_creator:
 176             try:
 177                 self.keypair_creator.clean()
 178             except:
 179                 pass
 180
 181         if self.flavor_creator:
 182             try:
 183                 self.flavor_creator.clean()
 184             except:
 185                 pass
 186
 187         if os.path.isfile(self.keypair_pub_filepath):
 188             try:
 189                 os.remove(self.keypair_pub_filepath)
 190             except:
 191                 pass
 192
 193         if os.path.isfile(self.keypair_priv_filepath):
 194             try:
 195                 os.remove(self.keypair_priv_filepath)
 196             except:
 197                 pass
 198
 199         if self.router_creator:
 200             try:
 201                 self.router_creator.clean()
 202             except:
 203                 pass
 204
 205         if self.network_creator:
 206             try:
 207                 self.network_creator.clean()
 208             except:
 209                 pass
 210
 211         if self.image_creator and not self.image_creator.image_settings.exists:
 212             try:
 213                 self.image_creator.clean()
 214             except:
 215                 pass
 216
 217         if os.path.isfile(self.test_file_local_path):
 218             os.remove(self.test_file_local_path)
 219
 220         super(self.__class__, self).__clean__()
 221
 222     def test_apply_simple_playbook(self):
 223         """
 224         Tests application of an Ansible playbook that simply copies over a file
 225         1. Have a ~/.ansible.cfg (or alternate means) to
 226            set host_key_checking = False
 227         2. Set the following environment variable in your executing shell:
 228            ANSIBLE_HOST_KEY_CHECKING=False
 229         Should this not be performed, the creation of the host ssh key will
 230         cause your ansible calls to fail.
 231         """
 232         self.inst_creator.create(block=True)
 233
 234         priv_ip = self.inst_creator.get_port_ip(self.port_1_name)
 235         self.assertTrue(check_dhcp_lease(self.inst_creator, priv_ip))
 236
 237         # Apply Security Group
 238         self.inst_creator.add_security_group(
 239             self.sec_grp_creator.get_security_group())
 240
 241         # Block until VM's ssh port has been opened
 242         self.assertTrue(self.inst_creator.vm_ssh_active(block=True))
 243
 244         # Block until cloud-init has completed
 245         self.assertTrue(self.inst_creator.cloud_init_complete(block=True))
 246
 247         ssh_client = self.inst_creator.ssh_client()
 248         self.assertIsNotNone(ssh_client)
 249
 250         try:
 251             out = ssh_client.exec_command('pwd')[1].channel.in_buffer.read(
 252                 1024)
 253             self.assertIsNotNone(out)
 254             self.assertGreater(len(out), 1)
 255         finally:
 256             ssh_client.close()
 257
 258         # Need to use the first floating IP as subsequent ones are currently
 259         # broken with Apex CO
 260         ip = self.inst_creator.get_floating_ip().ip
 261         user = self.inst_creator.get_image_user()
 262         priv_key = self.inst_creator.keypair_settings.private_filepath
 263
 264         relative_pb_path = pkg_resources.resource_filename(
 265             'snaps.provisioning.tests.playbooks', 'simple_playbook.yml')
 266         retval = self.inst_creator.apply_ansible_playbook(relative_pb_path)
 267         self.assertEqual(0, retval)
 268
 269         ssh = ansible_utils.ssh_client(ip, user, priv_key,
 270                                        self.os_creds.proxy_settings)
 271         self.assertIsNotNone(ssh)
 272         scp = None
 273         try:
 274             scp = SCPClient(ssh.get_transport())
 275             scp.get('~/hello.txt', self.test_file_local_path)
 276         finally:
 277             if scp:
 278                 scp.close()
 279             ssh.close()
 280
 281         self.assertTrue(os.path.isfile(self.test_file_local_path))
 282
 283         test_file = None
 284
 285         try:
 286             with open(self.test_file_local_path) as test_file:
 287                 file_contents = test_file.readline()
 288                 self.assertEqual('Hello World!', file_contents)
 289         finally:
 290             if test_file:
 291                 test_file.close()
 292
 293     def test_apply_template_playbook(self):
 294         """
 295         Tests application of an Ansible playbook that applies a template to a
 296         file:
 297         1. Have a ~/.ansible.cfg (or alternate means) to set
 298            host_key_checking = False
 299         2. Set the following environment variable in your executing shell:
 300            ANSIBLE_HOST_KEY_CHECKING=False
 301         Should this not be performed, the creation of the host ssh key will
 302         cause your ansible calls to fail.
 303         """
 304         self.inst_creator.create(block=True)
 305
 306         priv_ip = self.inst_creator.get_port_ip(self.port_1_name)
 307         self.assertTrue(check_dhcp_lease(self.inst_creator, priv_ip))
 308
 309         # Apply Security Group
 310         self.inst_creator.add_security_group(
 311             self.sec_grp_creator.get_security_group())
 312
 313         # Block until VM's ssh port has been opened
 314         self.assertTrue(self.inst_creator.vm_ssh_active(block=True))
 315
 316         # Block until cloud-init has completed
 317         self.assertTrue(self.inst_creator.cloud_init_complete(block=True))
 318
 319         # Apply Security Group
 320         self.inst_creator.add_security_group(
 321             self.sec_grp_creator.get_security_group())
 322
 323         # Need to use the first floating IP as subsequent ones are currently
 324         # broken with Apex CO
 325         ip = self.inst_creator.get_floating_ip().ip
 326         user = self.inst_creator.get_image_user()
 327         priv_key = self.inst_creator.keypair_settings.private_filepath
 328
 329         relative_pb_path = pkg_resources.resource_filename(
 330             'snaps.provisioning.tests.playbooks',
 331             'template_playbook.yml')
 332         retval = self.inst_creator.apply_ansible_playbook(relative_pb_path,
 333                                                           variables={
 334                                                               'name': 'Foo'})
 335         self.assertEqual(0, retval)
 336
 337         ssh = ansible_utils.ssh_client(ip, user, priv_key,
 338                                        self.os_creds.proxy_settings)
 339         self.assertIsNotNone(ssh)
 340         scp = None
 341
 342         try:
 343             scp = SCPClient(ssh.get_transport())
 344             scp.get('/tmp/hello.txt', self.test_file_local_path)
 345         finally:
 346             if scp:
 347                 scp.close()
 348             ssh.close()
 349
 350         self.assertTrue(os.path.isfile(self.test_file_local_path))
 351
 352         test_file = None
 353         try:
 354             with open(self.test_file_local_path) as test_file:
 355                 file_contents = test_file.readline()
 356                 self.assertEqual('Hello Foo!', file_contents)
 357         finally:
 358             if test_file:
 359                 test_file.close()