--- /dev/null
+#!/usr/bin/env python
+
+# Copyright (c) 2021 Orange and others.
+#
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Apache License, Version 2.0
+# which accompanies this distribution, and is available at
+# http://www.apache.org/licenses/LICENSE-2.0
+
+"""Implement a Xtesting driver to run any Ansible playbook."""
+
+import logging
+import os
+import shutil
+import time
+
+import ansible_runner
+
+from xtesting.core import testcase
+
+
+class Ansible(testcase.TestCase):
+ """Class designed to run any Ansible playbook via ansible-runner."""
+
+ __logger = logging.getLogger(__name__)
+
+ def check_requirements(self):
+ """Check if ansible-playbook is in $PATH"""
+ self.is_skipped = not shutil.which("ansible-playbook")
+ if self.is_skipped:
+ self.__logger.warning("ansible-playbook is missing")
+
+ def run(self, **kwargs):
+ """ Wrap ansible_runner.interface.run()
+
+ It calls ansible_runner.interface.run() by converting the testcase
+ description data to kwargs. It only overrides quiet and artifact_dir to
+ implement the Xtesting behavior.
+
+ Following the playbook logic, criteria is considered as boolean
+ whatever the value set in testcases.yaml.
+
+ Args:
+ kwargs: Arbitrary keyword arguments.
+
+ Returns:
+ EX_OK if the playbook ran well.
+ EX_RUN_ERROR otherwise.
+ """
+ status = self.EX_RUN_ERROR
+ self.start_time = time.time()
+ if ("private_data_dir" in kwargs and
+ os.path.isdir(kwargs['private_data_dir'])):
+ try:
+ if not os.path.exists(self.res_dir):
+ os.makedirs(self.res_dir)
+ kwargs["quiet"] = True
+ kwargs["artifact_dir"] = self.res_dir
+ runner = ansible_runner.run(**kwargs)
+ self.details = runner.stats
+ if runner.rc == 0:
+ self.result = 100
+ status = self.EX_OK
+ except Exception: # pylint: # pylint: disable=broad-except
+ self.__logger.exception("Cannot execute the playbook")
+ else:
+ self.__logger.error(
+ "Please set a relevant private_data_dir in testcases.yaml")
+ self.stop_time = time.time()
+ return status
--- /dev/null
+#!/usr/bin/env python
+
+# Copyright (c) 2021 Orange and others.
+#
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Apache License, Version 2.0
+# which accompanies this distribution, and is available at
+# http://www.apache.org/licenses/LICENSE-2.0
+
+# pylint: disable=missing-docstring
+
+import logging
+import unittest
+
+import mock
+import munch
+
+from xtesting.core import ansible
+
+
+class RunTesting(unittest.TestCase):
+
+ def setUp(self):
+ self.test = ansible.Ansible()
+
+ @mock.patch("shutil.which", return_value=None)
+ def test_check1(self, which):
+ self.test.check_requirements()
+ self.assertEqual(self.test.is_skipped, True)
+ which.assert_called_once_with("ansible-playbook")
+
+ @mock.patch("shutil.which", return_value='/usr/bin/ansible-playbook')
+ def test_check2(self, which):
+ self.test.check_requirements()
+ self.assertEqual(self.test.is_skipped, False)
+ which.assert_called_once_with("ansible-playbook")
+
+ @mock.patch("os.path.isdir", return_value=False)
+ def test_fail1(self, isdir):
+ self.assertEqual(self.test.run(), self.test.EX_RUN_ERROR)
+ isdir.assert_not_called()
+
+ @mock.patch("os.path.isdir", return_value=False)
+ def test_fail2(self, isdir):
+ private_data_dir = "titi"
+ self.assertEqual(self.test.run(
+ private_data_dir=private_data_dir), self.test.EX_RUN_ERROR)
+ isdir.assert_called_once_with(private_data_dir)
+
+ @mock.patch("ansible_runner.run", side_effect=Exception)
+ @mock.patch("os.makedirs")
+ @mock.patch("os.path.exists", return_value=True)
+ @mock.patch("os.path.isdir", return_value=True)
+ def test_fail3(self, *args):
+ private_data_dir = "titi"
+ self.assertEqual(self.test.run(
+ private_data_dir=private_data_dir), self.test.EX_RUN_ERROR)
+ args[0].assert_called_once_with(private_data_dir)
+ args[1].assert_called_once_with(self.test.res_dir)
+ args[2].assert_not_called()
+ args[3].assert_called_with(
+ private_data_dir=private_data_dir, quiet=True,
+ artifact_dir=self.test.res_dir)
+
+ @mock.patch("ansible_runner.run", side_effect=Exception)
+ @mock.patch("os.makedirs")
+ @mock.patch("os.path.exists", return_value=False)
+ @mock.patch("os.path.isdir", return_value=True)
+ def test_fail4(self, *args):
+ private_data_dir = "titi"
+ self.assertEqual(self.test.run(
+ private_data_dir=private_data_dir), self.test.EX_RUN_ERROR)
+ args[0].assert_called_once_with(private_data_dir)
+ args[1].assert_called_once_with(self.test.res_dir)
+ args[2].assert_called_once_with(self.test.res_dir)
+ args[3].assert_called_with(
+ private_data_dir=private_data_dir, quiet=True,
+ artifact_dir=self.test.res_dir)
+
+ @mock.patch("ansible_runner.run")
+ @mock.patch("os.makedirs", side_effect=Exception)
+ @mock.patch("os.path.exists", return_value=False)
+ @mock.patch("os.path.isdir", return_value=True)
+ def test_fail5(self, *args):
+ private_data_dir = "titi"
+ self.assertEqual(self.test.run(
+ private_data_dir=private_data_dir), self.test.EX_RUN_ERROR)
+ args[0].assert_called_once_with(private_data_dir)
+ args[1].assert_called_once_with(self.test.res_dir)
+ args[2].assert_called_once_with(self.test.res_dir)
+ args[3].assert_not_called()
+
+ @mock.patch("ansible_runner.run", return_value={})
+ @mock.patch("os.makedirs")
+ @mock.patch("os.path.exists", return_value=False)
+ @mock.patch("os.path.isdir", return_value=True)
+ def test_fail6(self, *args):
+ private_data_dir = "titi"
+ self.assertEqual(self.test.run(
+ private_data_dir=private_data_dir, quiet=False,
+ artifact_dir="overridden"), self.test.EX_RUN_ERROR)
+ args[0].assert_called_once_with(private_data_dir)
+ args[1].assert_called_once_with(self.test.res_dir)
+ args[2].assert_called_once_with(self.test.res_dir)
+ args[3].assert_called_with(
+ private_data_dir=private_data_dir, quiet=True,
+ artifact_dir=self.test.res_dir)
+
+ @mock.patch("ansible_runner.run",
+ return_value=munch.Munch(rc=0, stats={"foo": "bar"}))
+ @mock.patch("os.makedirs")
+ @mock.patch("os.path.exists", return_value=False)
+ @mock.patch("os.path.isdir", return_value=True)
+ def test_res_ok(self, *args):
+ private_data_dir = "titi"
+ self.assertEqual(self.test.run(
+ private_data_dir=private_data_dir, quiet=False,
+ artifact_dir="overridden"), self.test.EX_OK)
+ args[0].assert_called_once_with(private_data_dir)
+ args[1].assert_called_once_with(self.test.res_dir)
+ args[2].assert_called_once_with(self.test.res_dir)
+ args[3].assert_called_with(
+ private_data_dir=private_data_dir, quiet=True,
+ artifact_dir=self.test.res_dir)
+ self.assertEqual(self.test.is_successful(), self.test.EX_OK)
+ self.assertEqual(self.test.details, {"foo": "bar"})
+
+ @mock.patch("ansible_runner.run",
+ return_value=munch.Munch(rc=1, stats={"foo": "bar"}))
+ @mock.patch("os.makedirs")
+ @mock.patch("os.path.exists", return_value=False)
+ @mock.patch("os.path.isdir", return_value=True)
+ def test_res_ko(self, *args):
+ private_data_dir = "titi"
+ self.assertEqual(self.test.run(
+ private_data_dir=private_data_dir, quiet=False,
+ artifact_dir="overridden"), self.test.EX_OK)
+ args[0].assert_called_once_with(private_data_dir)
+ args[1].assert_called_once_with(self.test.res_dir)
+ args[2].assert_called_once_with(self.test.res_dir)
+ args[3].assert_called_with(
+ private_data_dir=private_data_dir, quiet=True,
+ artifact_dir=self.test.res_dir)
+ self.assertEqual(self.test.is_successful(),
+ self.test.EX_TESTCASE_FAILED)
+ self.assertEqual(self.test.details, {"foo": "bar"})
+
+
+if __name__ == "__main__":
+ logging.disable(logging.CRITICAL)
+ unittest.main(verbosity=2)
Code Review / functest-xtesting.git / commitdiff