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