Merge "Configure ACL via static file"
[yardstick.git] / yardstick / tests / unit / benchmark / contexts / test_heat.py
index baf9f40..9c822b3 100644 (file)
@@ -1,5 +1,3 @@
-#!/usr/bin/env python
-
 ##############################################################################
 # Copyright (c) 2015 Ericsson AB and others.
 #
 ##############################################################################
 
 from collections import OrderedDict
-from itertools import count
 import logging
 import os
-import uuid
 
 import mock
-import unittest
 
+from yardstick import ssh
 from yardstick.benchmark.contexts import base
 from yardstick.benchmark.contexts import heat
 from yardstick.benchmark.contexts import model
+from yardstick.common import constants as consts
+from yardstick.common import exceptions as y_exc
+from yardstick.tests.unit import base as ut_base
 
 
 LOG = logging.getLogger(__name__)
 
 
-class HeatContextTestCase(unittest.TestCase):
-
-    def __init__(self, *args, **kwargs):
-        super(HeatContextTestCase, self).__init__(*args, **kwargs)
-        self.name_iter = ('vnf{:03}'.format(x) for x in count(0, step=3))
+class HeatContextTestCase(ut_base.BaseUnitTestCase):
 
     def setUp(self):
         self.test_context = heat.HeatContext()
         self.addCleanup(self._remove_contexts)
-        self.mock_context = mock.Mock(spec=heat.HeatContext())
 
-    def _remove_contexts(self):
-        if self.test_context in self.test_context.list:
-            self.test_context._delete_context()
+    @staticmethod
+    def _remove_contexts():
+        for context in base.Context.list:
+            context._delete_context()
+        base.Context.list = []
 
     def test___init__(self):
         self.assertIsNone(self.test_context._name)
@@ -59,8 +55,7 @@ class HeatContextTestCase(unittest.TestCase):
         self.assertIsNone(self.test_context._user)
         self.assertIsNone(self.test_context.template_file)
         self.assertIsNone(self.test_context.heat_parameters)
-        self.assertIsNotNone(self.test_context.key_uuid)
-        self.assertIsNotNone(self.test_context.key_filename)
+        self.assertIsNone(self.test_context.key_filename)
 
     @mock.patch('yardstick.benchmark.contexts.heat.PlacementGroup')
     @mock.patch('yardstick.benchmark.contexts.heat.ServerGroup')
@@ -104,14 +99,6 @@ class HeatContextTestCase(unittest.TestCase):
                                        servers['baz'])
         self.assertEqual(len(self.test_context.servers), 1)
 
-        if os.path.exists(self.test_context.key_filename):
-            try:
-                os.remove(self.test_context.key_filename)
-                os.remove(self.test_context.key_filename + ".pub")
-            except OSError:
-                LOG.exception("key_filename: %s",
-                              self.test_context.key_filename)
-
     def test_init_no_name_or_task_id(self):
         attrs = {}
         self.assertRaises(KeyError, self.test_context.init, attrs)
@@ -125,13 +112,32 @@ class HeatContextTestCase(unittest.TestCase):
         self.assertEqual(self.test_context.assigned_name, 'foo')
 
     def test_name_flags(self):
-        self.test_context._flags = base.Flags(**{"no_setup": True, "no_teardown": True})
+        self.test_context._flags = base.Flags(
+            **{"no_setup": True, "no_teardown": True})
         self.test_context._name = 'foo'
         self.test_context._task_id = '1234567890'
 
         self.assertEqual(self.test_context.name, 'foo')
         self.assertEqual(self.test_context.assigned_name, 'foo')
 
+    def test_init_no_setup_no_teardown(self):
+
+        attrs = {'name': 'foo',
+                 'task_id': '1234567890',
+                 'placement_groups': {},
+                 'server_groups': {},
+                 'networks': {},
+                 'servers': {},
+                 'flags': {
+                     'no_setup': True,
+                     'no_teardown': True,
+                     },
+                }
+
+        self.test_context.init(attrs)
+        self.assertTrue(self.test_context._flags.no_setup)
+        self.assertTrue(self.test_context._flags.no_teardown)
+
     @mock.patch('yardstick.benchmark.contexts.heat.HeatTemplate')
     def test__add_resources_to_template_no_servers(self, mock_template):
         self.test_context._name = 'ctx'
@@ -143,6 +149,7 @@ class HeatContextTestCase(unittest.TestCase):
         self.test_context.key_uuid = "2f2e4997-0a8e-4eb7-9fa4-f3f8fbbc393b"
         netattrs = {'cidr': '10.0.0.0/24', 'provider': None,
                     'external_network': 'ext_net'}
+
         self.test_context.networks = OrderedDict(
             {"mynet": model.Network("mynet", self.test_context,
                                            netattrs)})
@@ -150,7 +157,7 @@ class HeatContextTestCase(unittest.TestCase):
         self.test_context._add_resources_to_template(mock_template)
         mock_template.add_keypair.assert_called_with(
             "ctx-key",
-            "2f2e4997-0a8e-4eb7-9fa4-f3f8fbbc393b")
+            "ctx-12345678")
         mock_template.add_security_group.assert_called_with("ctx-secgroup")
         mock_template.add_network.assert_called_with(
             "ctx-12345678-mynet", 'physnet1', None, None, None, None)
@@ -186,8 +193,45 @@ class HeatContextTestCase(unittest.TestCase):
         with self.assertRaises(AttributeError):
             self.test_context.user = 'foo'
 
-    @mock.patch('yardstick.benchmark.contexts.heat.HeatTemplate')
-    def test_deploy(self, mock_template):
+    def test__create_new_stack(self):
+        template = mock.Mock()
+        self.test_context._create_new_stack(template)
+        template.create.assert_called_once()
+
+    def test__create_new_stack_stack_create_failed(self):
+        template = mock.Mock()
+        template.create.side_effect = y_exc.HeatTemplateError
+
+        self.assertRaises(y_exc.HeatTemplateError,
+                          self.test_context._create_new_stack,
+                          template)
+
+    def test__create_new_stack_keyboard_interrupt(self):
+        template = mock.Mock()
+        template.create.side_effect = KeyboardInterrupt
+        self.assertRaises(y_exc.StackCreationInterrupt,
+                          self.test_context._create_new_stack,
+                          template)
+
+    @mock.patch.object(os.path, 'exists', return_value=True)
+    @mock.patch.object(heat.HeatContext, '_add_resources_to_template')
+    @mock.patch.object(heat.HeatContext, '_create_new_stack')
+    def test_deploy_stack_creation_failed(self, mock_create,
+            mock_resources_template, mock_path_exists):
+        self.test_context._name = 'foo'
+        self.test_context._task_id = '1234567890'
+        self.test_context._name_task_id = 'foo-12345678'
+        mock_create.side_effect = y_exc.HeatTemplateError
+        self.assertRaises(y_exc.HeatTemplateError,
+                          self.test_context.deploy)
+
+        mock_path_exists.assert_called()
+        mock_resources_template.assert_called_once()
+
+    @mock.patch.object(os.path, 'exists', return_value=False)
+    @mock.patch.object(ssh.SSH, 'gen_keys')
+    @mock.patch.object(heat, 'HeatTemplate')
+    def test_deploy(self, mock_template, mock_genkeys, mock_path_exists):
         self.test_context._name = 'foo'
         self.test_context._task_id = '1234567890'
         self.test_context._name_task_id = '{}-{}'.format(
@@ -197,10 +241,106 @@ class HeatContextTestCase(unittest.TestCase):
         self.test_context.get_neutron_info = mock.MagicMock()
         self.test_context.deploy()
 
-        mock_template.assert_called_with('foo-12345678',
-                                         '/bar/baz/some-heat-file',
-                                         {'image': 'cirros'})
+        mock_template.assert_called_with(
+            'foo-12345678', template_file='/bar/baz/some-heat-file',
+            heat_parameters={'image': 'cirros'},
+            os_cloud_config=self.test_context._flags.os_cloud_config)
+        self.assertIsNotNone(self.test_context.stack)
+        key_filename = ''.join(
+            [consts.YARDSTICK_ROOT_PATH,
+             'yardstick/resources/files/yardstick_key-',
+             self.test_context._name_task_id])
+        mock_genkeys.assert_called_once_with(key_filename)
+        mock_path_exists.assert_any_call(key_filename)
+
+    @mock.patch.object(heat, 'HeatTemplate')
+    @mock.patch.object(os.path, 'exists', return_value=False)
+    @mock.patch.object(ssh.SSH, 'gen_keys')
+    @mock.patch.object(heat.HeatContext, '_retrieve_existing_stack')
+    @mock.patch.object(heat.HeatContext, '_create_new_stack')
+    def test_deploy_no_setup(self, mock_create_new_stack,
+            mock_retrieve_existing_stack, mock_genkeys, mock_path_exists,
+            *args):
+        self.test_context._name = 'foo'
+        self.test_context._task_id = '1234567890'
+        self.test_context.template_file = '/bar/baz/some-heat-file'
+        self.test_context.heat_parameters = {'image': 'cirros'}
+        self.test_context.get_neutron_info = mock.MagicMock()
+        self.test_context._flags.no_setup = True
+        self.test_context.deploy()
+
+        mock_create_new_stack.assert_not_called()
+        mock_retrieve_existing_stack.assert_called_with(self.test_context.name)
         self.assertIsNotNone(self.test_context.stack)
+        key_filename = ''.join(
+            [consts.YARDSTICK_ROOT_PATH,
+             'yardstick/resources/files/yardstick_key-',
+             self.test_context._name])
+        mock_genkeys.assert_called_once_with(key_filename)
+        mock_path_exists.assert_any_call(key_filename)
+
+    @mock.patch.object(heat, 'HeatTemplate')
+    @mock.patch.object(os.path, 'exists', return_value=False)
+    @mock.patch.object(ssh.SSH, 'gen_keys')
+    @mock.patch.object(heat.HeatContext, '_create_new_stack')
+    @mock.patch.object(heat.HeatContext, '_retrieve_existing_stack',
+                       return_value=None)
+    def test_deploy_try_retrieve_context_does_not_exist(self,
+            mock_retrieve_stack, mock_create_new_stack, mock_genkeys,
+            mock_path_exists, *args):
+        self.test_context._name = 'demo'
+        self.test_context._task_id = '1234567890'
+        self.test_context._flags.no_setup = True
+        self.test_context.template_file = '/bar/baz/some-heat-file'
+        self.test_context.get_neutron_info = mock.MagicMock()
+        self.test_context.deploy()
+
+        mock_retrieve_stack.assert_called_once_with(self.test_context._name)
+        mock_create_new_stack.assert_called()
+        key_filename = ''.join(
+            [consts.YARDSTICK_ROOT_PATH,
+             'yardstick/resources/files/yardstick_key-',
+             self.test_context._name])
+        mock_genkeys.assert_called_once_with(key_filename)
+        mock_path_exists.assert_any_call(key_filename)
+
+    @mock.patch.object(heat, 'HeatTemplate', return_value='heat_template')
+    @mock.patch.object(heat.HeatContext, '_add_resources_to_template')
+    @mock.patch.object(os.path, 'exists', return_value=False)
+    @mock.patch.object(ssh.SSH, 'gen_keys')
+    def test_deploy_ssh_key_before_adding_resources(self, mock_genkeys,
+            mock_path_exists, mock_add_resources, *args):
+        mock_manager = mock.Mock()
+        mock_manager.attach_mock(mock_add_resources,
+                                 '_add_resources_to_template')
+        mock_manager.attach_mock(mock_genkeys, 'gen_keys')
+        mock_manager.reset_mock()
+        self.test_context._name_task_id = 'demo-12345678'
+        self.test_context.get_neutron_info = mock.Mock()
+        with mock.patch.object(self.test_context, '_create_new_stack') as \
+                mock_create_stack, \
+                mock.patch.object(self.test_context, 'get_neutron_info') as \
+                mock_neutron_info:
+            self.test_context.deploy()
+
+        mock_neutron_info.assert_called_once()
+        mock_create_stack.assert_called_once()
+        key_filename = ''.join(
+            [consts.YARDSTICK_ROOT_PATH,
+             'yardstick/resources/files/yardstick_key-',
+             self.test_context._name_task_id])
+        mock_genkeys.assert_called_once_with(key_filename)
+        mock_path_exists.assert_any_call(key_filename)
+
+        mock_call_gen_keys = mock.call.gen_keys(key_filename)
+        mock_call_add_resources = (
+            mock.call._add_resources_to_template('heat_template'))
+        self.assertTrue(mock_manager.mock_calls.index(mock_call_gen_keys) <
+                        mock_manager.mock_calls.index(mock_call_add_resources))
+
+    def test_check_for_context(self):
+        pass
+        # check that the context exists
 
     def test_add_server_port(self):
         network1 = mock.MagicMock()
@@ -236,6 +376,7 @@ class HeatContextTestCase(unittest.TestCase):
             u'e-network_id': u'net987',
         }
         server = mock.MagicMock()
+        server.private_ip = None
         server.ports = OrderedDict([
             ('a', [{'stack_name': 'b', 'port': 'port_a'}]),
             ('c', [{'stack_name': 'd', 'port': 'port_c'},
@@ -262,15 +403,30 @@ class HeatContextTestCase(unittest.TestCase):
         self.assertEqual(len(server.interfaces), 3)
         self.assertDictEqual(server.interfaces['port_a'], expected)
 
+    @mock.patch('yardstick.benchmark.contexts.heat.os')
+    @mock.patch.object(heat.HeatContext, '_delete_key_file')
     @mock.patch('yardstick.benchmark.contexts.heat.HeatTemplate')
-    def test_undeploy(self, mock_template):
+    def test_undeploy(self, mock_template, mock_delete_key, *args):
         self.test_context.stack = mock_template
         self.test_context._name = 'foo'
         self.test_context._task_id = '1234567890'
         self.test_context._name_task_id = '{}-{}'.format(
             self.test_context._name, self.test_context._task_id[:8])
+        # mock_os.path.exists.return_value = True
+        self.test_context.key_filename = 'foo/bar/foobar'
         self.test_context.undeploy()
-        self.assertTrue(mock_template.delete.called)
+        mock_delete_key.assert_called()
+        mock_template.delete.assert_called_once()
+
+    @mock.patch('yardstick.benchmark.contexts.heat.HeatTemplate')
+    def test_undeploy_no_teardown(self, mock_template):
+        self.test_context.stack = mock_template
+        self.test_context._name = 'foo'
+        self.test_context._task_id = '1234567890'
+        self.test_context._flags.no_teardown = True
+        self.test_context.undeploy()
+
+        mock_template.delete.assert_not_called()
 
     @mock.patch('yardstick.benchmark.contexts.heat.HeatTemplate')
     @mock.patch('yardstick.benchmark.contexts.heat.os')
@@ -281,6 +437,7 @@ class HeatContextTestCase(unittest.TestCase):
         self.test_context._name_task_id = '{}-{}'.format(
             self.test_context._name, self.test_context._task_id)
         mock_os.path.exists.return_value = True
+        self.test_context.key_filename = 'foo/bar/foobar'
         self.assertIsNone(self.test_context.undeploy())
 
     @mock.patch("yardstick.benchmark.contexts.heat.pkg_resources")
@@ -311,7 +468,6 @@ class HeatContextTestCase(unittest.TestCase):
             'private_ip': '10.0.0.1',
             'public_ip': '127.0.0.1',
         }
-        self.test_context.key_uuid = uuid.uuid4()
         self.test_context._server_map = {
             'baz3': baz3_server,
             'foo2': foo2_server,
@@ -322,6 +478,7 @@ class HeatContextTestCase(unittest.TestCase):
             'private_ip_attr': 'private_ip',
             'public_ip_attr': 'public_ip',
         }
+        self.test_context.key_uuid = 'foo-42'
         result = self.test_context._get_server(attr_name)
         self.assertEqual(result['user'], 'bot')
         self.assertEqual(result['ip'], '127.0.0.1')
@@ -353,7 +510,6 @@ class HeatContextTestCase(unittest.TestCase):
             'private_ip': '10.0.0.1',
             'public_ip': '127.0.0.1',
         }
-        self.test_context.key_uuid = uuid.uuid4()
         self.test_context._server_map = {
             'baz3': baz3_server,
             'foo2': foo2_server,
@@ -362,6 +518,8 @@ class HeatContextTestCase(unittest.TestCase):
         attr_name = {
             'name': 'foo.bar-12345678',
         }
+
+        self.test_context.key_uuid = 'foo-42'
         result = self.test_context._get_server(attr_name)
         self.assertEqual(result['user'], 'bot')
         # no private ip attr mapping in the map results in None value in the result
@@ -386,12 +544,13 @@ class HeatContextTestCase(unittest.TestCase):
         baz3_server.context.user = 'zab'
 
         self.test_context._name = 'bar1'
+        self.test_context._task_id = '1234567890'
+        self.test_context._name_task_id = 'bar1-12345678'
         self.test_context.stack = mock.Mock()
         self.test_context.stack.outputs = {
             'private_ip': '10.0.0.1',
             'public_ip': '127.0.0.1',
         }
-        self.test_context.key_uuid = uuid.uuid4()
         self.test_context.generate_routing_table = mock.MagicMock(return_value=[])
 
         self.test_context._server_map = {
@@ -429,13 +588,13 @@ class HeatContextTestCase(unittest.TestCase):
             'private_ip': '10.0.0.1',
             'public_ip': '127.0.0.1',
         }
-        self.test_context.key_uuid = uuid.uuid4()
         self.test_context._server_map = {
             'baz3': baz3_server,
             'foo2': foo2_server,
             'wow4': None,
         }
 
+        self.test_context.key_uuid = 'foo-42'
         attr_name = 'wow4'
         result = self.test_context._get_server(attr_name)
         self.assertIsNone(result)
@@ -465,12 +624,12 @@ class HeatContextTestCase(unittest.TestCase):
             'private_ip': '10.0.0.1',
             'public_ip': '127.0.0.1',
         }
-        self.test_context.key_uuid = uuid.uuid4()
         self.test_context._server_map = {
             'baz3': baz3_server,
             'foo2': foo2_server,
         }
 
+        self.test_context.key_uuid = 'foo-42'
         attr_name = {
             'name': 'foo.wow4',
             'private_ip_attr': 'private_ip',
@@ -495,18 +654,19 @@ class HeatContextTestCase(unittest.TestCase):
         baz3_server.public_ip = None
         baz3_server.context.user = 'zab'
 
+        self.mock_context = mock.Mock(spec=heat.HeatContext())
         self.mock_context._name = 'bar1'
         self.test_context.stack = mock.Mock()
         self.mock_context.stack.outputs = {
             'private_ip': '10.0.0.1',
             'public_ip': '127.0.0.1',
         }
-        self.mock_context.key_uuid = uuid.uuid4()
         self.mock_context._server_map = {
             'baz3': baz3_server,
             'foo2': foo2_server,
         }
 
+        self.test_context.key_uuid = 'foo-42'
         attr_name = 'foo.wow4'
         result = self.test_context._get_server(attr_name)
         self.assertIsNone(result)