From c2f99db8b4d8f021b29a4e3aae483ba715936a66 Mon Sep 17 00:00:00 2001 From: Ross Brattain Date: Mon, 13 Mar 2017 22:08:06 -0700 Subject: Add Ansible executor class for node context import the AnsibleCommon class to execute Ansible playbooks Update node context support to use AnsibleCommon needs unittests We must call ansible-playbook as an executable, so we must create temp files for inventory, and for the playbooks. AnsibleCommon has evolved to be quite flexible, it auto-generates the inventory from the context['nodes'] and generates groups from the node Role. We also support either a single playbook filename, or a list of filenames. If given a list we dynamically generate a playbook that includes the other playbooks. We support adding any number of extra_vars using a temp JSON file. Also designed to be extended by subclassing. Change-Id: I5bd0a2b4547feaadd70b7e2b8801f19371b99df0 Signed-off-by: Ross Brattain --- tests/unit/benchmark/contexts/test_node.py | 6 +- tests/unit/common/test_ansible_common.py | 213 +++++++++++++++++++++++++++++ 2 files changed, 215 insertions(+), 4 deletions(-) create mode 100644 tests/unit/common/test_ansible_common.py (limited to 'tests') diff --git a/tests/unit/benchmark/contexts/test_node.py b/tests/unit/benchmark/contexts/test_node.py index 9b5761c8d..a2e2f7b9a 100644 --- a/tests/unit/benchmark/contexts/test_node.py +++ b/tests/unit/benchmark/contexts/test_node.py @@ -131,10 +131,8 @@ class NodeContextTestCase(unittest.TestCase): self.test_context.env = {} self.assertEqual(self.test_context._dispatch_ansible('ansible'), None) - @mock.patch("{}.subprocess".format(PREFIX)) - def test__do_ansible_job(self, mock_subprocess): - mock_subprocess.Popen = mock.MagicMock() - mock_subprocess.communicate = mock.Mock() + @mock.patch("{}.AnsibleCommon".format(PREFIX)) + def test__do_ansible_job(self, mock_ansible): self.assertEqual(None, self.test_context._do_ansible_job('dummy')) def test_successful_init(self): diff --git a/tests/unit/common/test_ansible_common.py b/tests/unit/common/test_ansible_common.py new file mode 100644 index 000000000..a1eaf969e --- /dev/null +++ b/tests/unit/common/test_ansible_common.py @@ -0,0 +1,213 @@ +# Copyright (c) 2016-2017 Intel Corporation +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import absolute_import + +import os +import tempfile +from collections import defaultdict + +import mock +import unittest + +from six.moves.configparser import ConfigParser + +from yardstick.common import ansible_common + +PREFIX = 'yardstick.common.ansible_common' + + +class OverwriteDictTestCase(unittest.TestCase): + + def test_overwrite_dict_cfg(self): + c = ConfigParser(allow_no_value=True) + d = { + "section_a": "empty_value", + "section_b": {"key_c": "val_d", "key_d": "val_d"}, + "section_c": ["key_c", "key_d"], + } + ansible_common.overwrite_dict_to_cfg(c, d) + # Python3 and Python2 convert empty values into None or '' + # we don't really care but we need to compare correctly for unittest + self.assertTrue(c.has_option("section_a", "empty_value")) + self.assertEqual(sorted(c.items("section_b")), [('key_c', 'val_d'), ('key_d', 'val_d')]) + self.assertTrue(c.has_option("section_c", "key_c")) + self.assertTrue(c.has_option("section_c", "key_d")) + + +class FilenameGeneratorTestCase(unittest.TestCase): + @mock.patch('{}.NamedTemporaryFile'.format(PREFIX)) + def test__handle_existing_file(self, mock_tmp): + f = ansible_common.FileNameGenerator._handle_existing_file("/dev/null") + + def test_get_generator_from_file(self): + f = ansible_common.FileNameGenerator.get_generator_from_filename("/dev/null", "", "", "") + + def test_get_generator_from_file_middle(self): + f = ansible_common.FileNameGenerator.get_generator_from_filename("/dev/null", "", "", + "null") + + def test_get_generator_from_file_prefix(self): + f = ansible_common.FileNameGenerator.get_generator_from_filename("/dev/null", "", "null", + "middle") + + +class AnsibleNodeTestCase(unittest.TestCase): + def test_ansible_node(self): + a = ansible_common.AnsibleNode() + + def test_ansible_node_len(self): + a = ansible_common.AnsibleNode() + len(a) + + def test_ansible_node_repr(self): + a = ansible_common.AnsibleNode() + repr(a) + + def test_ansible_node_iter(self): + a = ansible_common.AnsibleNode() + for _ in a: + pass + + def test_is_role(self): + a = ansible_common.AnsibleNode() + self.assertFalse(a.is_role("", default="foo")) + + def test_ansible_node_get_tuple(self): + a = ansible_common.AnsibleNode({"name": "name"}) + self.assertEqual(a.get_tuple(), ('name', a)) + + def test_gen_inventory_line(self): + a = ansible_common.AnsibleNode(defaultdict(str)) + self.assertEqual(a.gen_inventory_line(), "") + + def test_ansible_node_delitem(self): + a = ansible_common.AnsibleNode({"name": "name"}) + del a['name'] + + def test_ansible_node_getattr(self): + a = ansible_common.AnsibleNode({"name": "name"}) + self.assertEqual(getattr(a, "nosuch", None), None) + + +class AnsibleNodeDictTestCase(unittest.TestCase): + def test_ansible_node_dict(self): + n = ansible_common.AnsibleNode() + a = ansible_common.AnsibleNodeDict(n, {}) + + def test_ansible_node_dict_len(self): + n = ansible_common.AnsibleNode() + a = ansible_common.AnsibleNodeDict(n, {}) + len(a) + + def test_ansible_node_dict_repr(self): + n = ansible_common.AnsibleNode() + a = ansible_common.AnsibleNodeDict(n, {}) + repr(a) + + def test_ansible_node_dict_iter(self): + n = ansible_common.AnsibleNode() + a = ansible_common.AnsibleNodeDict(n, {}) + for _ in a: + pass + + def test_ansible_node_dict_get(self): + n = ansible_common.AnsibleNode() + a = ansible_common.AnsibleNodeDict(n, {}) + self.assertIsNone(a.get("")) + + def test_gen_inventory_lines_for_all_of_type(self): + n = ansible_common.AnsibleNode() + a = ansible_common.AnsibleNodeDict(n, {}) + self.assertEqual(a.gen_inventory_lines_for_all_of_type(""), []) + + +class AnsibleCommonTestCase(unittest.TestCase): + def test_get_timeouts(self): + self.assertAlmostEquals(ansible_common.AnsibleCommon.get_timeout(-100), 1200.0) + + def test__init__(self): + a = ansible_common.AnsibleCommon({}) + + def test_reset(self): + a = ansible_common.AnsibleCommon({}) + a.reset() + + def test_do_install_no_dir(self): + a = ansible_common.AnsibleCommon({}) + self.assertRaises(OSError, a.do_install, '', '') + + def test_gen_inventory_dict(self): + a = ansible_common.AnsibleCommon({}) + a.inventory_dict = {} + self.assertIsNone(a.gen_inventory_ini_dict()) + + def test_deploy_dir(self): + a = ansible_common.AnsibleCommon({}) + self.assertRaises(ValueError, getattr, a, "deploy_dir") + + def test_deploy_dir_set(self): + a = ansible_common.AnsibleCommon({}) + a.deploy_dir = "" + + def test_deploy_dir_set_get(self): + a = ansible_common.AnsibleCommon({}) + a.deploy_dir = "d" + self.assertEqual(a.deploy_dir, "d") + + @mock.patch('{}.open'.format(PREFIX)) + def test__gen_ansible_playbook_file_list(self, mock_open): + d = tempfile.mkdtemp() + try: + a = ansible_common.AnsibleCommon({}) + a._gen_ansible_playbook_file(["a"], d) + finally: + os.rmdir(d) + + @mock.patch('{}.NamedTemporaryFile'.format(PREFIX)) + @mock.patch('{}.open'.format(PREFIX)) + def test__gen_ansible_playbook_file_list_multiple(self, mock_open, mock_tmp): + d = tempfile.mkdtemp() + try: + a = ansible_common.AnsibleCommon({}) + a._gen_ansible_playbook_file(["a", "b"], d) + finally: + os.rmdir(d) + + @mock.patch('{}.NamedTemporaryFile'.format(PREFIX)) + @mock.patch('{}.Popen'.format(PREFIX)) + @mock.patch('{}.open'.format(PREFIX)) + def test_do_install_tmp_dir(self, mock_open, mock_popen, mock_tmp): + mock_popen.return_value.communicate.return_value = "", "" + mock_popen.return_value.wait.return_value = 0 + d = tempfile.mkdtemp() + try: + a = ansible_common.AnsibleCommon({}) + a.do_install('', d) + finally: + os.rmdir(d) + + @mock.patch('{}.NamedTemporaryFile'.format(PREFIX)) + @mock.patch('{}.Popen'.format(PREFIX)) + @mock.patch('{}.open'.format(PREFIX)) + def test_execute_ansible_check(self, mock_open, mock_popen, mock_tmp): + mock_popen.return_value.communicate.return_value = "", "" + mock_popen.return_value.wait.return_value = 0 + d = tempfile.mkdtemp() + try: + a = ansible_common.AnsibleCommon({}) + a.execute_ansible('', d, ansible_check=True, verbose=True) + finally: + os.rmdir(d) -- cgit 1.2.3-korg