mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
517570a64f
* Add opentelemetry callback plugin * Apply suggestions from code review Co-authored-by: Felix Fontein <felix@fontein.de> * Formatting (text), booleans and renamed env variables * This should be done in a future release * Remove insecure in favour of the OTEL env variable. Add descriptions * Use OpenTelemetrySource * Move generate_distributed_traces * Move update_span_data and set_span_attribute * Move finish_task * Move start_task * Refactor to support UTs * Add first UT * Fix codestyle * opentelemetry callback entry in the botmeta * Fix linting * Fix signature * Mock methods * Use MagicMock * Mock the methods * UT for transform_to_boolean_or_default * Fix linting * Set test data * Mock _time_ns * Exclude tests for python <= 3.6 * Remove obsoleted setup task type configuration * Remove unused docs * Apply suggestions from code review Co-authored-by: Felix Fontein <felix@fontein.de> * Fix docs * unrequired logic that was originally took from https://github.com/ansible/ansible/blob/devel/lib/ansible/plugins/callback/junit.py\#L226 * Use raise_from for the required dependencies * Fix linting * Add requirements for the UTs * add missing dependency for the opentelemetry plugin in the UTs * Add ANSIBLE_ prefix for the ansible specific options * Add more context in the docs and remove duplicated docs * As suggested in the code review * Verify if the OTEL env variables for the endpoint were set * Fix docs typo * Fix linting * Revert "Fix linting" This reverts commit 3a54c827c5472553a6baf5598bc76a0f63f020c1. * Revert "Verify if the OTEL env variables for the endpoint were set" This reverts commit cab9d8648899c28c0345745690c4ec7a41f7e680. * Remove console_output as suggested * Apply suggestions from code review Co-authored-by: flowerysong <junk+github@flowerysong.com> * Delegate the definition of OTEL_EXPORTER_OTLP_INSECURE to the user * Move definitions above, close to the class that uses them Co-authored-by: Felix Fontein <felix@fontein.de> Co-authored-by: flowerysong <junk+github@flowerysong.com>
93 lines
3.7 KiB
Python
93 lines
3.7 KiB
Python
# (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.opentelemetry import OpenTelemetrySource, TaskData, CallbackModule
|
|
from collections import OrderedDict
|
|
import sys
|
|
|
|
OPENTELEMETRY_MINIMUM_PYTHON_VERSION = (3, 7)
|
|
|
|
|
|
class TestOpentelemetry(unittest.TestCase):
|
|
@patch('ansible_collections.community.general.plugins.callback.opentelemetry.socket')
|
|
def setUp(self, mock_socket):
|
|
# TODO: this python version validation won't be needed as long as the _time_ns call is mocked.
|
|
if sys.version_info < OPENTELEMETRY_MINIMUM_PYTHON_VERSION:
|
|
self.skipTest("Python %s+ is needed for OpenTelemetry" %
|
|
",".join(map(str, OPENTELEMETRY_MINIMUM_PYTHON_VERSION)))
|
|
|
|
mock_socket.gethostname.return_value = 'my-host'
|
|
mock_socket.gethostbyname.return_value = '1.2.3.4'
|
|
self.opentelemetry = OpenTelemetrySource(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.opentelemetry.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.opentelemetry.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.opentelemetry.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')
|