fix(metrics): add additional tests

Author: Umaaz

src/deep/api/plugin/metric/prometheus_metrics.py

@@ -144,6 +144,10 @@ def summary(self, name: str, labels: Dict[str, str], namespace: str, help_string
             deep.logging.exception(f"Error registering metric summary {namespace}_{name}")
             pass
 
+    @property
+    def _cache(self):
+        return self.__cache
+
     def shutdown(self):
         """Clean up and shutdown the plugin."""
         self.clear()

tests/unit_tests/api/plugin/metrics/test_otel_metrics.py

@@ -0,0 +1,117 @@
+#       Copyright (C) 2024  Intergral GmbH
+#
+#      This program is free software: you can redistribute it and/or modify
+#      it under the terms of the GNU Affero General Public License as published by
+#      the Free Software Foundation, either version 3 of the License, or
+#      (at your option) any later version.
+#
+#      This program is distributed in the hope that it will be useful,
+#      but WITHOUT ANY WARRANTY; without even the implied warranty of
+#      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#      GNU Affero General Public License for more details.
+#
+#      You should have received a copy of the GNU Affero General Public License
+#      along with this program.  If not, see <https://www.gnu.org/licenses/>.
+import unittest
+
+from mockito import when, mock, verify
+from opentelemetry.metrics import set_meter_provider, MeterProvider
+
+import deep.logging
+from deep.api.plugin.metric.otel_metrics import OTelMetrics
+
+
+class TestOtelMetrics(unittest.TestCase):
+    mock_provider = mock(MeterProvider)
+
+    @classmethod
+    def setUpClass(cls):
+        deep.logging.init()
+
+        set_meter_provider(cls.mock_provider)
+
+    def setUp(self):
+        self.deep_provider = mock()
+        when(self.mock_provider).get_meter('deep', '').thenReturn(self.deep_provider)
+        when(self.mock_provider).get_meter('deep', '', None).thenReturn(self.deep_provider)
+
+    def test_post_counter_twice(self):
+        metric = mock()
+        when(self.deep_provider).create_counter('test_counter', "unit", "help").thenReturn(metric)
+        metrics = OTelMetrics(None)
+        metrics.counter("counter", {}, "test", "help", "unit", 1)
+        metrics.counter("counter", {}, "test", "help", "unit", 1)
+
+        verify(self.deep_provider, 1).create_counter('test_counter', "unit", "help")
+        verify(metric, 2).add(1, {})
+
+    def test_post_counter(self):
+        metric = mock()
+        when(self.deep_provider).create_counter('test_counter', "unit", "help").thenReturn(metric)
+        metrics = OTelMetrics(None)
+        metrics.counter("counter", {}, "test", "help", "unit", 1)
+
+        verify(self.deep_provider, 1).create_counter('test_counter', "unit", "help")
+
+        verify(metric).add(1, {})
+
+    def test_post_histogram(self):
+        metric = mock()
+        when(self.deep_provider).create_histogram('test_histogram', "unit", "help").thenReturn(metric)
+        metrics = OTelMetrics(None)
+        metrics.histogram("histogram", {}, "test", "help", "unit", 1)
+
+        verify(metric).record(1, {})
+
+    def test_post_gauge(self):
+        metric = mock()
+        when(self.deep_provider).create_up_down_counter('test_gauge', "unit", "help").thenReturn(metric)
+        metrics = OTelMetrics(None)
+        metrics.gauge("gauge", {}, "test", "help", "unit", 1)
+
+        verify(metric).add(1, {})
+
+    def test_post_summary(self):
+        metric = mock()
+        when(self.deep_provider).create_histogram('test_summary', "unit", "help").thenReturn(metric)
+        metrics = OTelMetrics(None)
+        metrics.summary("summary", {}, "test", "help", "unit", 1)
+
+        verify(metric).record(1, {})
+
+    def test_post_counter_error(self):
+        metric = mock()
+        when(self.deep_provider).create_counter('test_counter', "unit", "help").thenRaise(Exception("test otel error"))
+        metrics = OTelMetrics(None)
+        metrics.counter("counter", {}, "test", "help", "unit", 1)
+
+        verify(self.deep_provider, 1).create_counter('test_counter', "unit", "help")
+
+        verify(metric, 0).add(1, {})
+
+    def test_post_histogram_error(self):
+        metric = mock()
+        when(self.deep_provider).create_histogram('test_histogram', "unit", "help").thenRaise(
+            Exception("test otel error"))
+        metrics = OTelMetrics(None)
+        metrics.histogram("histogram", {}, "test", "help", "unit", 1)
+
+        verify(metric, 0).record(1, {})
+
+    def test_post_gauge_error(self):
+        metric = mock()
+        when(self.deep_provider).create_up_down_counter('test_gauge', "unit", "help").thenRaise(
+            Exception("test otel error"))
+        metrics = OTelMetrics(None)
+        metrics.gauge("gauge", {}, "test", "help", "unit", 1)
+
+        verify(metric, 0).add(1, {})
+
+    def test_post_summary_error(self):
+        metric = mock()
+        when(self.deep_provider).create_histogram('test_summary', "unit", "help").thenRaise(
+            Exception("test otel error"))
+        metrics = OTelMetrics(None)
+        metrics.summary("summary", {}, "test", "help", "unit", 1)
+
+        verify(metric, 0).record(1, {})

tests/unit_tests/api/plugin/metrics/test_prometheus_metrics.py

@@ -29,10 +29,52 @@ def tearDown(self):
 
     def test_counter(self):
         self.plugin.counter("test", {}, "deep", "", "", 123)
+        self.assertEqual(1, len(self.plugin._cache))
 
     def test_counter_with_labels(self):
         self.plugin.counter("test_other", {'value': 'name'}, "deep", "", "", 123)
+        self.assertEqual(1, len(self.plugin._cache))
 
-    def test_duplicate_registration(self):
+    def test_duplicate_counter_registration(self):
         self.plugin.counter("test_other", {}, "deep", "", "", 123)
         self.plugin.counter("test_other", {'value': 'name'}, "deep", "", "", 123)
+        self.assertEqual(1, len(self.plugin._cache))
+
+    def test_gauge(self):
+        self.plugin.gauge("test", {}, "deep", "", "", 123)
+        self.assertEqual(1, len(self.plugin._cache))
+
+    def test_gauge_with_labels(self):
+        self.plugin.gauge("test_other", {'value': 'name'}, "deep", "", "", 123)
+        self.assertEqual(1, len(self.plugin._cache))
+
+    def test_duplicate_gauge_registration(self):
+        self.plugin.gauge("test_other", {}, "deep", "", "", 123)
+        self.plugin.gauge("test_other", {'value': 'name'}, "deep", "", "", 123)
+        self.assertEqual(1, len(self.plugin._cache))
+
+    def test_histogram(self):
+        self.plugin.histogram("test", {}, "deep", "", "", 123)
+        self.assertEqual(1, len(self.plugin._cache))
+
+    def test_histogram_with_labels(self):
+        self.plugin.histogram("test_other", {'value': 'name'}, "deep", "", "", 123)
+        self.assertEqual(1, len(self.plugin._cache))
+
+    def test_duplicate_histogram_registration(self):
+        self.plugin.histogram("test_other", {}, "deep", "", "", 123)
+        self.plugin.histogram("test_other", {'value': 'name'}, "deep", "", "", 123)
+        self.assertEqual(1, len(self.plugin._cache))
+
+    def test_summary(self):
+        self.plugin.summary("test", {}, "deep", "", "", 123)
+        self.assertEqual(1, len(self.plugin._cache))
+
+    def test_summary_with_labels(self):
+        self.plugin.summary("test_other", {'value': 'name'}, "deep", "", "", 123)
+        self.assertEqual(1, len(self.plugin._cache))
+
+    def test_duplicate_summary_registration(self):
+        self.plugin.summary("test_other", {}, "deep", "", "", 123)
+        self.plugin.summary("test_other", {'value': 'name'}, "deep", "", "", 123)
+        self.assertEqual(1, len(self.plugin._cache))