discord.py: Add new module for discord notifications (#2398)

* first push: add discord module and test for notifications * fix the yaml docs and edit the result output * add link * fix link * fix docs and remove required=False in argument spec * add elements specd and more info about embeds * called str... * elements for embeds oc. * fix typo's in description and set checkmode to false * edit docs and module return * support checkmode with get method * fix unit test * handle exception and add new example for embeds * quote line * fix typos * fix yaml
2025-06-27 10:40:22 -07:00 · 2021-05-11 19:31:46 +02:00 · 2021-05-11 19:31:46 +02:00 · 0912e8cc7a
commit 0912e8cc7a
parent d22dd5056e
3 changed files with 319 additions and 0 deletions
--- a/tests/unit/plugins/modules/notification/test_discord.py
+++ b/tests/unit/plugins/modules/notification/test_discord.py
@ -0,0 +1,103 @@
+# 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
+
+import json
+import pytest
+from ansible_collections.community.general.tests.unit.compat.mock import Mock, patch
+from ansible_collections.community.general.plugins.modules.notification import discord
+from ansible_collections.community.general.tests.unit.plugins.modules.utils import AnsibleExitJson, AnsibleFailJson, ModuleTestCase, set_module_args
+
+
+class TestDiscordModule(ModuleTestCase):
+
+    def setUp(self):
+        super(TestDiscordModule, self).setUp()
+        self.module = discord
+
+    def tearDown(self):
+        super(TestDiscordModule, self).tearDown()
+
+    @pytest.fixture
+    def fetch_url_mock(self, mocker):
+        return mocker.patch('ansible.module_utils.notification.discord.fetch_url')
+
+    def test_without_parameters(self):
+        """Failure if no parameters set"""
+        with self.assertRaises(AnsibleFailJson):
+            set_module_args({})
+            self.module.main()
+
+    def test_without_content(self):
+        """Failure if content and embeds both are missing"""
+        set_module_args({
+            'webhook_id': 'xxx',
+            'webhook_token': 'xxx'
+        })
+        with self.assertRaises(AnsibleFailJson):
+            self.module.main()
+
+    def test_successful_message(self):
+        """Test a basic message successfully."""
+        set_module_args({
+            'webhook_id': 'xxx',
+            'webhook_token': 'xxx',
+            'content': 'test'
+        })
+
+        with patch.object(discord, "fetch_url") as fetch_url_mock:
+            fetch_url_mock.return_value = (None, {"status": 204, 'msg': 'OK (0 bytes)'})
+            with self.assertRaises(AnsibleExitJson):
+                self.module.main()
+
+            self.assertTrue(fetch_url_mock.call_count, 1)
+            call_data = json.loads(fetch_url_mock.call_args[1]['data'])
+            assert call_data['content'] == "test"
+
+    def test_message_with_username(self):
+        """Test a message with username set successfully."""
+        set_module_args({
+            'webhook_id': 'xxx',
+            'webhook_token': 'xxx',
+            'content': 'test',
+            'username': 'Ansible Bot'
+        })
+
+        with patch.object(discord, "fetch_url") as fetch_url_mock:
+            fetch_url_mock.return_value = (None, {"status": 204, 'msg': 'OK (0 bytes)'})
+            with self.assertRaises(AnsibleExitJson):
+                self.module.main()
+
+            self.assertTrue(fetch_url_mock.call_count, 1)
+            call_data = json.loads(fetch_url_mock.call_args[1]['data'])
+            assert call_data['username'] == "Ansible Bot"
+            assert call_data['content'] == "test"
+
+    def test_failed_message(self):
+        """Test failure because webhook id is wrong."""
+
+        set_module_args({
+            'webhook_id': 'wrong',
+            'webhook_token': 'xxx',
+            'content': 'test'
+        })
+
+        with patch.object(discord, "fetch_url") as fetch_url_mock:
+            fetch_url_mock.return_value = (None, {"status": 404, 'msg': 'HTTP Error 404: Not Found', 'body': '{"message": "Unknown Webhook", "code": 10015}'})
+            with self.assertRaises(AnsibleFailJson):
+                self.module.main()
+
+    def test_failed_message_without_body(self):
+        """Test failure with empty response body."""
+
+        set_module_args({
+            'webhook_id': 'wrong',
+            'webhook_token': 'xxx',
+            'content': 'test'
+        })
+
+        with patch.object(discord, "fetch_url") as fetch_url_mock:
+            fetch_url_mock.return_value = (None, {"status": 404, 'msg': 'HTTP Error 404: Not Found'})
+            with self.assertRaises(AnsibleFailJson):
+                self.module.main()