Files
community.general/tests/unit/plugins/callback/test_splunk.py
2026-04-16 21:34:28 +02:00

83 lines
3.3 KiB
Python

# Copyright (c) Ansible Project
# 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 json
import unittest
from datetime import datetime
from unittest.mock import Mock, patch
import pytest
from ansible.executor.task_result import TaskResult
from ansible.release import __version__ as ansible_release
from ansible_collections.community.general.plugins.callback.splunk import SplunkHTTPCollectorSource
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 TestSplunkClient(unittest.TestCase):
@patch("ansible_collections.community.general.plugins.callback.splunk.socket")
def setUp(self, mock_socket):
mock_socket.gethostname.return_value = "my-host"
mock_socket.gethostbyname.return_value = "1.2.3.4"
self.splunk = SplunkHTTPCollectorSource()
self.mock_task = Mock("MockTask")
self.mock_task._role = "myrole"
self.mock_task._uuid = "myuuid"
self.task_fields = {"args": {}}
self.mock_host = Mock("MockHost")
self.mock_host.name = "myhost"
@patch("ansible_collections.community.general.plugins.callback.splunk.now")
@patch("ansible_collections.community.general.plugins.callback.splunk.open_url")
def test_timestamp_with_milliseconds(self, open_url_mock, mock_now):
mock_now.return_value = datetime(2020, 12, 1)
result = TaskResult(host=self.mock_host, task=self.mock_task, return_data={}, task_fields=self.task_fields)
self.splunk.send_event(
url="endpoint",
authtoken="token",
validate_certs=False,
include_milliseconds=True,
batch="abcefghi-1234-5678-9012-abcdefghijkl",
state="OK",
result=result,
runtime=100,
)
args, kwargs = open_url_mock.call_args
sent_data = json.loads(args[1])
self.assertEqual(sent_data["event"]["timestamp"], "2020-12-01 00:00:00.000000 +0000")
self.assertEqual(sent_data["event"]["host"], "my-host")
self.assertEqual(sent_data["event"]["ip_address"], "1.2.3.4")
@patch("ansible_collections.community.general.plugins.callback.splunk.now")
@patch("ansible_collections.community.general.plugins.callback.splunk.open_url")
def test_timestamp_without_milliseconds(self, open_url_mock, mock_now):
mock_now.return_value = datetime(2020, 12, 1)
result = TaskResult(host=self.mock_host, task=self.mock_task, return_data={}, task_fields=self.task_fields)
self.splunk.send_event(
url="endpoint",
authtoken="token",
validate_certs=False,
include_milliseconds=False,
batch="abcefghi-1234-5678-9012-abcdefghijkl",
state="OK",
result=result,
runtime=100,
)
args, kwargs = open_url_mock.call_args
sent_data = json.loads(args[1])
self.assertEqual(sent_data["event"]["timestamp"], "2020-12-01 00:00:00 +0000")
self.assertEqual(sent_data["event"]["host"], "my-host")
self.assertEqual(sent_data["event"]["ip_address"], "1.2.3.4")