mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-06-05 15:57:05 +00:00
23bd56990c
* Start opentelemetry spans on host start instead of task start v2_playbook_on_task_start does not have the host information, so spans would always start at the same time for every host in that task, even if they started at different times, like when hosts > forks with strategy host_pinned. This also hides the duration of the task for that host. This change uses the newer v2_runner_on_start callback and adds the acutal host start time to the span. The change is backwards compatible with ansible versions that do not have v2_runner_on_start and makes no assumptions around the ordering of v2_runner_on_start and v2_playbook_on_task_start. * Add changelog fragment * Remove redundant callback hooks v2_runner_on_starts gets called by ansible right after the strategy has called on_task_start or on_handler_start. So there is no need to keep this code as the minimum ansible-core version is guaranteed to have this function. on_cleanup (removed around ansible-core 2.0) and on_no_hosts (removed around ansible-core 2.5) never get called. * Fix unreachable hosts causing exceptions If finish_task is never called for a host the result object stays None, which caused an exception in update_span_data. This was the case for unreachable hosts, as the callback plugin did not implement v2_runner_on_unreachable. * Fix import order in test_opentelemetry
244 lines
9.8 KiB
Python
244 lines
9.8 KiB
Python
# Copyright (c) 2021, Victor Martinez <VictorMartinezRubio@gmail.com>
|
|
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
|
|
|
from __future__ import annotations
|
|
|
|
import unittest
|
|
from collections import OrderedDict
|
|
from unittest.mock import MagicMock, Mock, patch
|
|
|
|
import pytest
|
|
from ansible.executor.task_result import TaskResult
|
|
from ansible.playbook.task import Task
|
|
from ansible.release import __version__ as ansible_release
|
|
|
|
from ansible_collections.community.general.plugins.callback.opentelemetry import HostData, OpenTelemetrySource, TaskData
|
|
|
|
if tuple(int(x) for x in ansible_release.split(".")[:2]) >= (2, 21):
|
|
# https://github.com/ansible/ansible/issues/86761
|
|
pytest.skip("Temporarily skipping callback tests for ansible-core >= 2.21", allow_module_level=True)
|
|
|
|
|
|
class TestOpentelemetry(unittest.TestCase):
|
|
@patch("ansible_collections.community.general.plugins.callback.opentelemetry.socket")
|
|
def setUp(self, mock_socket):
|
|
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
|
|
)
|
|
self.mock_span = Mock("MockSpan")
|
|
self.mock_span.set_status = MagicMock()
|
|
self.mock_span.set_attributes = MagicMock()
|
|
self.mock_span.end = MagicMock()
|
|
|
|
def test_run_task_with_host(self):
|
|
tasks_data = OrderedDict()
|
|
|
|
self.opentelemetry.start_task(tasks_data, False, "myplay", self.mock_task, self.mock_host)
|
|
|
|
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, {})
|
|
|
|
host_data = task_data.host_data["myhost_uuid"]
|
|
self.assertEqual(host_data.uuid, "myhost_uuid")
|
|
self.assertEqual(host_data.name, "myhost")
|
|
self.assertIsNotNone(host_data.start)
|
|
|
|
self.opentelemetry.finish_task(tasks_data, "ok", self.my_task_result, "")
|
|
self.assertEqual(host_data.status, "ok")
|
|
|
|
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")
|
|
|
|
@patch("ansible_collections.community.general.plugins.callback.opentelemetry.Status", create=True)
|
|
@patch("ansible_collections.community.general.plugins.callback.opentelemetry.StatusCode", create=True)
|
|
def test_update_span_data(self, mock_status_code, mock_status):
|
|
unfinished_host = HostData("myhost_uuid", "myhost", "unreachable")
|
|
self.opentelemetry.update_span_data(self.mock_task, unfinished_host, self.mock_span, True, True)
|
|
self.mock_span.end.assert_called()
|
|
|
|
def test_get_error_message(self):
|
|
test_cases = (
|
|
("my-exception", "my-msg", None, "my-exception"),
|
|
(None, "my-msg", None, "my-msg"),
|
|
(None, None, None, "failed"),
|
|
)
|
|
|
|
for tc in test_cases:
|
|
result = self.opentelemetry.get_error_message(generate_test_data(tc[0], tc[1], tc[2]))
|
|
self.assertEqual(result, tc[3])
|
|
|
|
def test_get_error_message_from_results(self):
|
|
test_cases = (
|
|
("my-exception", "my-msg", None, False, None),
|
|
(None, "my-msg", None, False, None),
|
|
(None, None, None, False, None),
|
|
("my-exception", "my-msg", None, True, "shell(none) - my-exception"),
|
|
(None, "my-msg", None, True, "shell(none) - my-msg"),
|
|
(None, None, None, True, "shell(none) - failed"),
|
|
)
|
|
|
|
for tc in test_cases:
|
|
result = self.opentelemetry.get_error_message_from_results(
|
|
[generate_test_data(tc[0], tc[1], tc[2], tc[3])], "shell"
|
|
)
|
|
self.assertEqual(result, tc[4])
|
|
|
|
def test_enrich_error_message(self):
|
|
test_cases = (
|
|
(
|
|
"my-exception",
|
|
"my-msg",
|
|
"my-stderr",
|
|
'message: "my-msg"\nexception: "my-exception"\nstderr: "my-stderr"',
|
|
),
|
|
("my-exception", None, "my-stderr", 'message: "failed"\nexception: "my-exception"\nstderr: "my-stderr"'),
|
|
(None, "my-msg", "my-stderr", 'message: "my-msg"\nexception: "None"\nstderr: "my-stderr"'),
|
|
("my-exception", "my-msg", None, 'message: "my-msg"\nexception: "my-exception"\nstderr: "None"'),
|
|
(
|
|
"my-exception",
|
|
"my-msg",
|
|
"\nline1\nline2",
|
|
'message: "my-msg"\nexception: "my-exception"\nstderr: "\nline1\nline2"',
|
|
),
|
|
)
|
|
|
|
for tc in test_cases:
|
|
result = self.opentelemetry.enrich_error_message(generate_test_data(tc[0], tc[1], tc[2]))
|
|
self.assertEqual(result, tc[3])
|
|
|
|
def test_enrich_error_message_from_results(self):
|
|
test_cases = (
|
|
("my-exception", "my-msg", "my-stderr", False, ""),
|
|
("my-exception", None, "my-stderr", False, ""),
|
|
(None, "my-msg", "my-stderr", False, ""),
|
|
("my-exception", "my-msg", None, False, ""),
|
|
("my-exception", "my-msg", "\nline1\nline2", False, ""),
|
|
(
|
|
"my-exception",
|
|
"my-msg",
|
|
"my-stderr",
|
|
True,
|
|
'shell(none) - message: "my-msg"\nexception: "my-exception"\nstderr: "my-stderr"\n',
|
|
),
|
|
(
|
|
"my-exception",
|
|
None,
|
|
"my-stderr",
|
|
True,
|
|
'shell(none) - message: "failed"\nexception: "my-exception"\nstderr: "my-stderr"\n',
|
|
),
|
|
(
|
|
None,
|
|
"my-msg",
|
|
"my-stderr",
|
|
True,
|
|
'shell(none) - message: "my-msg"\nexception: "None"\nstderr: "my-stderr"\n',
|
|
),
|
|
(
|
|
"my-exception",
|
|
"my-msg",
|
|
None,
|
|
True,
|
|
'shell(none) - message: "my-msg"\nexception: "my-exception"\nstderr: "None"\n',
|
|
),
|
|
(
|
|
"my-exception",
|
|
"my-msg",
|
|
"\nline1\nline2",
|
|
True,
|
|
'shell(none) - message: "my-msg"\nexception: "my-exception"\nstderr: "\nline1\nline2"\n',
|
|
),
|
|
)
|
|
|
|
for tc in test_cases:
|
|
result = self.opentelemetry.enrich_error_message_from_results(
|
|
[generate_test_data(tc[0], tc[1], tc[2], tc[3])], "shell"
|
|
)
|
|
self.assertEqual(result, tc[4])
|
|
|
|
def test_url_from_args(self):
|
|
test_cases = (
|
|
({}, ""),
|
|
({"url": "my-url"}, "my-url"),
|
|
({"url": "my-url", "api_url": "my-api_url"}, "my-url"),
|
|
({"api_url": "my-api_url"}, "my-api_url"),
|
|
({"api_url": "my-api_url", "chart_repo_url": "my-chart_repo_url"}, "my-api_url"),
|
|
)
|
|
|
|
for tc in test_cases:
|
|
result = self.opentelemetry.url_from_args(tc[0])
|
|
self.assertEqual(result, tc[1])
|
|
|
|
def test_parse_and_redact_url_if_possible(self):
|
|
test_cases = (
|
|
({}, None),
|
|
({"url": "wrong"}, None),
|
|
({"url": "https://my-url"}, "https://my-url"),
|
|
({"url": "https://user:pass@my-url"}, "https://my-url"),
|
|
({"url": "https://my-url:{{ my_port }}"}, "https://my-url:{{ my_port }}"),
|
|
({"url": "https://{{ my_hostname }}:{{ my_port }}"}, None),
|
|
({"url": "{{my_schema}}{{ my_hostname }}:{{ my_port }}"}, None),
|
|
)
|
|
|
|
for tc in test_cases:
|
|
result = self.opentelemetry.parse_and_redact_url_if_possible(tc[0])
|
|
if tc[1]:
|
|
self.assertEqual(result.geturl(), tc[1])
|
|
else:
|
|
self.assertEqual(result, tc[1])
|
|
|
|
|
|
def generate_test_data(exception=None, msg=None, stderr=None, failed=False):
|
|
res_data = OrderedDict()
|
|
if exception:
|
|
res_data["exception"] = exception
|
|
if msg:
|
|
res_data["msg"] = msg
|
|
if stderr:
|
|
res_data["stderr"] = stderr
|
|
res_data["failed"] = failed
|
|
return res_data
|