1 # Copyright (c) 2017 Cable Television Laboratories, Inc. ("CableLabs")
2 # and others. All rights reserved.
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:
8 # http://www.apache.org/licenses/LICENSE-2.0
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.
20 from scp import SCPClient
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
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
48 class AnsibleProvisioningTests(OSIntegrationTestCase):
50 Test for the CreateInstance class with two NIC/Ports, eth0 with floating IP
56 Instantiates the CreateImage object that is responsible for downloading
57 and creating an OS image file within OpenStack
59 super(self.__class__, self).__start__()
61 self.nova = nova_utils.nova_client(self.os_creds)
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'
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
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,
89 self.image_creator.create()
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)
97 self.network_creator = create_network.OpenStackNetwork(
98 self.os_creds, self.pub_net_config.network_settings)
99 self.network_creator.create()
102 self.router_creator = create_router.OpenStackRouter(
103 self.os_creds, self.pub_net_config.router_settings)
104 self.router_creator.create()
107 self.flavor_creator = create_flavor.OpenStackFlavor(
110 name=guid + '-flavor-name', ram=2048, disk=10, vcpus=2,
111 metadata=self.flavor_metadata))
112 self.flavor_creator.create()
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()
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(
133 name=sec_grp_name, rule_settings=[rule1, rule2]))
134 self.sec_grp_creator.create()
137 ports_settings = list()
138 ports_settings.append(
140 name=self.port_1_name,
141 network_name=self.pub_net_config.network_settings.name))
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)])
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)
161 Cleans the created objects
163 if self.inst_creator:
165 self.inst_creator.clean()
169 if self.sec_grp_creator:
171 self.sec_grp_creator.clean()
175 if self.keypair_creator:
177 self.keypair_creator.clean()
181 if self.flavor_creator:
183 self.flavor_creator.clean()
187 if os.path.isfile(self.keypair_pub_filepath):
189 os.remove(self.keypair_pub_filepath)
193 if os.path.isfile(self.keypair_priv_filepath):
195 os.remove(self.keypair_priv_filepath)
199 if self.router_creator:
201 self.router_creator.clean()
205 if self.network_creator:
207 self.network_creator.clean()
211 if self.image_creator and not self.image_creator.image_settings.exists:
213 self.image_creator.clean()
217 if os.path.isfile(self.test_file_local_path):
218 os.remove(self.test_file_local_path)
220 super(self.__class__, self).__clean__()
222 def test_apply_simple_playbook(self):
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.
232 self.inst_creator.create(block=True)
234 priv_ip = self.inst_creator.get_port_ip(self.port_1_name)
235 self.assertTrue(check_dhcp_lease(self.inst_creator, priv_ip))
237 # Apply Security Group
238 self.inst_creator.add_security_group(
239 self.sec_grp_creator.get_security_group())
241 # Block until VM's ssh port has been opened
242 self.assertTrue(self.inst_creator.vm_ssh_active(block=True))
244 ssh_client = self.inst_creator.ssh_client()
245 self.assertIsNotNone(ssh_client)
248 out = ssh_client.exec_command('pwd')[1].channel.in_buffer.read(
250 self.assertIsNotNone(out)
251 self.assertGreater(len(out), 1)
255 # Need to use the first floating IP as subsequent ones are currently
256 # broken with Apex CO
257 ip = self.inst_creator.get_floating_ip().ip
258 user = self.inst_creator.get_image_user()
259 priv_key = self.inst_creator.keypair_settings.private_filepath
261 relative_pb_path = pkg_resources.resource_filename(
262 'snaps.provisioning.tests.playbooks', 'simple_playbook.yml')
263 retval = self.inst_creator.apply_ansible_playbook(relative_pb_path)
264 self.assertEqual(0, retval)
266 ssh = ansible_utils.ssh_client(ip, user, priv_key,
267 self.os_creds.proxy_settings)
268 self.assertIsNotNone(ssh)
271 scp = SCPClient(ssh.get_transport())
272 scp.get('~/hello.txt', self.test_file_local_path)
278 self.assertTrue(os.path.isfile(self.test_file_local_path))
283 with open(self.test_file_local_path) as test_file:
284 file_contents = test_file.readline()
285 self.assertEqual('Hello World!', file_contents)
290 def test_apply_template_playbook(self):
292 Tests application of an Ansible playbook that applies a template to a
294 1. Have a ~/.ansible.cfg (or alternate means) to set
295 host_key_checking = False
296 2. Set the following environment variable in your executing shell:
297 ANSIBLE_HOST_KEY_CHECKING=False
298 Should this not be performed, the creation of the host ssh key will
299 cause your ansible calls to fail.
301 self.inst_creator.create(block=True)
303 priv_ip = self.inst_creator.get_port_ip(self.port_1_name)
304 self.assertTrue(check_dhcp_lease(self.inst_creator, priv_ip))
306 # Apply Security Group
307 self.inst_creator.add_security_group(
308 self.sec_grp_creator.get_security_group())
310 # Block until VM's ssh port has been opened
311 self.assertTrue(self.inst_creator.vm_ssh_active(block=True))
313 # Apply Security Group
314 self.inst_creator.add_security_group(
315 self.sec_grp_creator.get_security_group())
317 # Need to use the first floating IP as subsequent ones are currently
318 # broken with Apex CO
319 ip = self.inst_creator.get_floating_ip().ip
320 user = self.inst_creator.get_image_user()
321 priv_key = self.inst_creator.keypair_settings.private_filepath
323 relative_pb_path = pkg_resources.resource_filename(
324 'snaps.provisioning.tests.playbooks',
325 'template_playbook.yml')
326 retval = self.inst_creator.apply_ansible_playbook(relative_pb_path,
329 self.assertEqual(0, retval)
331 ssh = ansible_utils.ssh_client(ip, user, priv_key,
332 self.os_creds.proxy_settings)
333 self.assertIsNotNone(ssh)
337 scp = SCPClient(ssh.get_transport())
338 scp.get('/tmp/hello.txt', self.test_file_local_path)
344 self.assertTrue(os.path.isfile(self.test_file_local_path))
348 with open(self.test_file_local_path) as test_file:
349 file_contents = test_file.readline()
350 self.assertEqual('Hello Foo!', file_contents)