Add elastic callback plugin (#3380) (#3542)

* Add elastic callback plugin * Capture task failures * Catch errors and add UTs * Skip 3.5< python versions and install dependency * fix lint * Fix linting * Fix linting * Add botmeta * Apply suggestions from code review Co-authored-by: Felix Fontein <felix@fontein.de> * It's not required * As suggested in the code review OrderedDict has been added to the Python stdlib since version 2.7 * Update plugins/callback/elastic.py Co-authored-by: Felix Fontein <felix@fontein.de> Co-authored-by: Felix Fontein <felix@fontein.de> (cherry picked from commit 905f4dcfa2) Co-authored-by: Victor Martinez <victormartinezrubio@gmail.com>
2025-06-03 14:59:09 -07:00 · 2021-10-11 07:35:09 +02:00 · 2021-10-11 07:35:09 +02:00 · 16aa776c93
commit 16aa776c93
parent d7d1659e34
4 changed files with 505 additions and 0 deletions
--- a/tests/unit/plugins/callback/test_elastic.py
+++ b/tests/unit/plugins/callback/test_elastic.py
@ -0,0 +1,91 @@
+# (C) 2021, Victor Martinez <VictorMartinezRubio@gmail.com>
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+from ansible.playbook.task import Task
+from ansible.executor.task_result import TaskResult
+from ansible_collections.community.general.tests.unit.compat import unittest
+from ansible_collections.community.general.tests.unit.compat.mock import patch, MagicMock, Mock
+from ansible_collections.community.general.plugins.callback.elastic import ElasticSource, TaskData
+from collections import OrderedDict
+import sys
+
+ELASTIC_MINIMUM_PYTHON_VERSION = (3, 6)
+
+
+class TestOpentelemetry(unittest.TestCase):
+    @patch('ansible_collections.community.general.plugins.callback.elastic.socket')
+    def setUp(self, mock_socket):
+        if sys.version_info < ELASTIC_MINIMUM_PYTHON_VERSION:
+            self.skipTest("Python %s+ is needed for Elastic" %
+                          ",".join(map(str, ELASTIC_MINIMUM_PYTHON_VERSION)))
+        mock_socket.gethostname.return_value = 'my-host'
+        mock_socket.gethostbyname.return_value = '1.2.3.4'
+        self.elastic = ElasticSource(display=None)
+        self.task_fields = {'args': {}}
+        self.mock_host = Mock('MockHost')
+        self.mock_host.name = 'myhost'
+        self.mock_host._uuid = 'myhost_uuid'
+        self.mock_task = Task()
+        self.mock_task.action = 'myaction'
+        self.mock_task.no_log = False
+        self.mock_task._role = 'myrole'
+        self.mock_task._uuid = 'myuuid'
+        self.mock_task.args = {}
+        self.mock_task.get_name = MagicMock(return_value='mytask')
+        self.mock_task.get_path = MagicMock(return_value='/mypath')
+        self.my_task = TaskData('myuuid', 'mytask', '/mypath', 'myplay', 'myaction', '')
+        self.my_task_result = TaskResult(host=self.mock_host, task=self.mock_task, return_data={}, task_fields=self.task_fields)
+
+    def test_start_task(self):
+        tasks_data = OrderedDict()
+
+        self.elastic.start_task(
+            tasks_data,
+            False,
+            'myplay',
+            self.mock_task
+        )
+
+        task_data = tasks_data['myuuid']
+        self.assertEqual(task_data.uuid, 'myuuid')
+        self.assertEqual(task_data.name, 'mytask')
+        self.assertEqual(task_data.path, '/mypath')
+        self.assertEqual(task_data.play, 'myplay')
+        self.assertEqual(task_data.action, 'myaction')
+        self.assertEqual(task_data.args, '')
+
+    def test_finish_task_with_a_host_match(self):
+        tasks_data = OrderedDict()
+        tasks_data['myuuid'] = self.my_task
+
+        self.elastic.finish_task(
+            tasks_data,
+            'ok',
+            self.my_task_result
+        )
+
+        task_data = tasks_data['myuuid']
+        host_data = task_data.host_data['myhost_uuid']
+        self.assertEqual(host_data.uuid, 'myhost_uuid')
+        self.assertEqual(host_data.name, 'myhost')
+        self.assertEqual(host_data.status, 'ok')
+
+    def test_finish_task_without_a_host_match(self):
+        result = TaskResult(host=None, task=self.mock_task, return_data={}, task_fields=self.task_fields)
+        tasks_data = OrderedDict()
+        tasks_data['myuuid'] = self.my_task
+
+        self.elastic.finish_task(
+            tasks_data,
+            'ok',
+            result
+        )
+
+        task_data = tasks_data['myuuid']
+        host_data = task_data.host_data['include']
+        self.assertEqual(host_data.uuid, 'include')
+        self.assertEqual(host_data.name, 'include')
+        self.assertEqual(host_data.status, 'ok')