StatsD Module (#1793)

* Pushing my WIP * Update DOCUMENTATION * Update EXAMPLES * More friendly name * Finish up the counter and gauge logic * Cleanup DOCUMENTATION and add metric_type * Apply autopep8 * Fixup the exits * Stubbing out unit tests * Whitespace * Whitespace * Removing unused modules * Remove unused modules * Might have have a prefix * Rearrange imported modules * Cleanup the if/elif blob * Require python >= 2.7 * Update DOCUMENTATION Co-authored-by: Felix Fontein <felix@fontein.de> * Update DOCUMENTATION Co-authored-by: Felix Fontein <felix@fontein.de> * Add import guarding on statsd * Add missing future import * Include missing_required_lib * Fixing sanity tests * Fixing delta default and choices * Formatting * Close tcp connection * Refactoring and unit tests * Fix pep8 sanity tests * Putting requirements.txt back to main * Apply suggestions from code review Co-authored-by: Mark Mercado <mmercado@digitalocean.com> Co-authored-by: Felix Fontein <felix@fontein.de>
2025-04-25 20:01:25 -07:00 · 2021-02-16 05:46:39 -05:00 · 2021-02-16 05:46:39 -05:00 · 6165438689
commit 6165438689
parent 3778eac1ba
4 changed files with 274 additions and 0 deletions
--- a/tests/unit/plugins/modules/monitoring/test_statsd.py
+++ b/tests/unit/plugins/modules/monitoring/test_statsd.py
@ -0,0 +1,101 @@
+# 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 pytest
+
+from ansible_collections.community.general.plugins.modules.monitoring import statsd
+from ansible_collections.community.general.tests.unit.compat.mock import patch, MagicMock
+from ansible_collections.community.general.tests.unit.plugins.modules.utils import AnsibleExitJson, AnsibleFailJson, ModuleTestCase, set_module_args
+
+
+class FakeStatsD(MagicMock):
+
+    def incr(self, *args, **kwargs):
+        pass
+
+    def gauge(self, *args, **kwargs):
+        pass
+
+    def close(self, *args, **kwargs):
+        pass
+
+
+class TestStatsDModule(ModuleTestCase):
+
+    def setUp(self):
+        super(TestStatsDModule, self).setUp()
+        statsd.HAS_STATSD = True
+        self.module = statsd
+
+    def tearDown(self):
+        super(TestStatsDModule, self).tearDown()
+
+    def patch_udp_statsd_client(self, **kwargs):
+        return patch('ansible_collections.community.general.plugins.modules.monitoring.statsd.udp_statsd_client', autospec=True, **kwargs)
+
+    def patch_tcp_statsd_client(self, **kwargs):
+        return patch('ansible_collections.community.general.plugins.modules.monitoring.statsd.tcp_statsd_client', autospec=True, **kwargs)
+
+    def test_udp_without_parameters(self):
+        """Test udp without parameters"""
+        with self.patch_udp_statsd_client(side_effect=FakeStatsD) as fake_statsd:
+            with self.assertRaises(AnsibleFailJson) as result:
+                set_module_args({})
+                self.module.main()
+
+    def test_tcp_without_parameters(self):
+        """Test tcp without parameters"""
+        with self.patch_tcp_statsd_client(side_effect=FakeStatsD) as fake_statsd:
+            with self.assertRaises(AnsibleFailJson) as result:
+                set_module_args({})
+                self.module.main()
+
+    def test_udp_with_parameters(self):
+        """Test udp with parameters"""
+        with self.patch_udp_statsd_client(side_effect=FakeStatsD) as fake_statsd:
+            with self.assertRaises(AnsibleExitJson) as result:
+                set_module_args({
+                    'metric': 'my_counter',
+                    'metric_type': 'counter',
+                    'value': 1,
+                })
+                self.module.main()
+            self.assertEqual(result.exception.args[0]['msg'], 'Sent counter my_counter -> 1 to StatsD')
+            self.assertEqual(result.exception.args[0]['changed'], True)
+        with self.patch_udp_statsd_client(side_effect=FakeStatsD) as fake_statsd:
+            with self.assertRaises(AnsibleExitJson) as result:
+                set_module_args({
+                    'metric': 'my_gauge',
+                    'metric_type': 'gauge',
+                    'value': 3,
+                })
+                self.module.main()
+            self.assertEqual(result.exception.args[0]['msg'], 'Sent gauge my_gauge -> 3 (delta=False) to StatsD')
+            self.assertEqual(result.exception.args[0]['changed'], True)
+
+    def test_tcp_with_parameters(self):
+        """Test tcp with parameters"""
+        with self.patch_tcp_statsd_client(side_effect=FakeStatsD) as fake_statsd:
+            with self.assertRaises(AnsibleExitJson) as result:
+                set_module_args({
+                    'protocol': 'tcp',
+                    'metric': 'my_counter',
+                    'metric_type': 'counter',
+                    'value': 1,
+                })
+                self.module.main()
+            self.assertEqual(result.exception.args[0]['msg'], 'Sent counter my_counter -> 1 to StatsD')
+            self.assertEqual(result.exception.args[0]['changed'], True)
+        with self.patch_tcp_statsd_client(side_effect=FakeStatsD) as fake_statsd:
+            with self.assertRaises(AnsibleExitJson) as result:
+                set_module_args({
+                    'protocol': 'tcp',
+                    'metric': 'my_gauge',
+                    'metric_type': 'gauge',
+                    'value': 3,
+                })
+                self.module.main()
+            self.assertEqual(result.exception.args[0]['msg'], 'Sent gauge my_gauge -> 3 (delta=False) to StatsD')
+            self.assertEqual(result.exception.args[0]['changed'], True)