# 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 pytest
from unittest.mock import patch
from ansible_collections.community.general.plugins.modules import campfire
from ansible_collections.community.internal_test_tools.tests.unit.plugins.modules.utils import (
AnsibleExitJson,
AnsibleFailJson,
ModuleTestCase,
set_module_args,
)
class TestCampfireModule(ModuleTestCase):
def setUp(self):
super().setUp()
self.module = campfire
def tearDown(self):
super().tearDown()
@pytest.fixture
def fetch_url_mock(self, mocker):
return mocker.patch("ansible.module_utils.notification.campfire.fetch_url")
def test_without_required_parameters(self):
"""Failure must occurs when all parameters are missing"""
with self.assertRaises(AnsibleFailJson):
with set_module_args({}):
self.module.main()
def test_successful_message(self):
"""Test failure message"""
with set_module_args({"subscription": "test", "token": "abc", "room": "test", "msg": "test"}):
with patch.object(campfire, "fetch_url") as fetch_url_mock:
fetch_url_mock.return_value = (None, {"status": 200})
with self.assertRaises(AnsibleExitJson):
self.module.main()
assert fetch_url_mock.call_count == 1
url = fetch_url_mock.call_args[0][1]
data = fetch_url_mock.call_args[1]["data"]
assert url == "https://test.campfirenow.com/room/test/speak.xml"
assert data == "test"
def test_successful_message_with_notify(self):
"""Test failure message"""
with set_module_args({"subscription": "test", "token": "abc", "room": "test", "msg": "test", "notify": "bell"}):
with patch.object(campfire, "fetch_url") as fetch_url_mock:
fetch_url_mock.return_value = (None, {"status": 200})
with self.assertRaises(AnsibleExitJson):
self.module.main()
assert fetch_url_mock.call_count == 2
notify_call = fetch_url_mock.mock_calls[0]
url = notify_call[1][1]
data = notify_call[2]["data"]
assert url == "https://test.campfirenow.com/room/test/speak.xml"
assert data == "SoundMessagebell"
message_call = fetch_url_mock.mock_calls[1]
url = message_call[1][1]
data = message_call[2]["data"]
assert url == "https://test.campfirenow.com/room/test/speak.xml"
assert data == "test"
def test_failure_message(self):
"""Test failure message"""
with set_module_args({"subscription": "test", "token": "abc", "room": "test", "msg": "test"}):
with patch.object(campfire, "fetch_url") as fetch_url_mock:
fetch_url_mock.return_value = (None, {"status": 403})
with self.assertRaises(AnsibleFailJson):
self.module.main()