Fix tests

qk4l · qk4l · commit 3d3fd536d1f7 · 2024-04-21T15:18:31.000+01:00
diff --git a/debian/zabbix-cachet.postinst b/debian/zabbix-cachet.postinst
@@ -1,4 +1,5 @@
 #!/bin/bash
+# TODO: Add pytz and updated versions
 pip3 install pyzabbix==0.7.4
 chmod 640 /etc/zabbix-cachet.yml
 systemctl status zabbix-cachet.service
diff --git a/requirements.txt b/requirements.txt
@@ -1,4 +1,7 @@
-PyYAML==5.1
-pyzabbix==0.7.4
-requests==2.20.0
-pytz==2019.3
+PyYAML>=5.4
+pyzabbix==1.2.1
+requests>=2.21.0
+pytz==2024.1
+# Dev only
+# pytest==8.1.1
+# pytest-env==1.1.3
diff --git a/src/zabbix_cachet/excepltions.py b/src/zabbix_cachet/excepltions.py
@@ -0,0 +1,17 @@
+import logging
+
+logger = logging.getLogger(__name__)
+
+
+class ZabbixCachetException(Exception):
+    def __init__(self, message=None, errors=None):
+        if errors:
+            message = ', '.join(errors)
+        self.errors = errors
+        if message:
+            logger.error(repr(message).rstrip())
+        super(Exception, self).__init__(message)
+
+
+class InvalidConfig(ZabbixCachetException):
+    pass
diff --git a/src/zabbix_cachet/main.py b/src/zabbix_cachet/main.py
@@ -16,7 +16,7 @@
 import pytz
 from operator import itemgetter
 
-__author__ = 'Artem Alexandrov <qk4l()tem4uk.ru>'
+__author__ = 'Artem Aleksandrov <qk4l()tem4uk.ru>'
 __license__ = """The MIT License (MIT)"""
 __version__ = '2.0.0'
 
diff --git a/src/zabbix_cachet/zabbix.py b/src/zabbix_cachet/zabbix.py
@@ -6,6 +6,8 @@
 import logging
 from pyzabbix import ZabbixAPI, ZabbixAPIException
 
+from zabbix_cachet.excepltions import InvalidConfig
+
 
 def pyzabbix_safe(fail_result=False):
 
@@ -41,7 +43,7 @@ class ZabbixService:
     serviceid: str
     status: str
     algorithm: str
-    triggerid: str
+    triggerid: str = None
     children: List['ZabbixService'] = field(default_factory=list)
     # TODO: Change to parents in future if will needed
     is_parents: bool = False
@@ -71,8 +73,9 @@ def __init__(self, server, user, password, verify=True):
         self.version = self.get_version()
         # Zabbix made significant changes in 6.0 https://support.zabbix.com/browse/ZBXNEXT-6674
         try:
-            if int(self.version.split('.')[0]) >= 6:
-                self.get_service = self.get_service_modern
+            self.version_major = int(self.version.split('.')[0])
+            if self.version_major >= 6:
+                self.get_service = self.get_service
             else:
                 self.get_service = self.get_service_legacy
         except (TypeError, IndexError) as err:
@@ -119,20 +122,21 @@ def get_event(self, triggerid):
             return zbx_event[-1]
         return zbx_event
 
-    def get_service_modern(self, name: str = '', serviceid: Union[List, str] = None,
-                           parentids: str = '') -> List[Dict]:
+    def get_service(self, name: str = '', serviceid: Union[List, str] = None,
+                    parentids: str = '') -> List[Dict]:
         """
-        For zabbix 6+
+        For zabbix 6.0 +
+        https://www.zabbix.com/documentation/6.0/en/manual/appendix/services_upgrade
         :return:
         """
         if name:
             services = self.zapi.service.get(selectChildren='extend', filter={'name': name})
         elif serviceid:
             services = self.zapi.service.get(selectChildren='extend', serviceids=serviceid)
         elif parentids:
-            services = self.zapi.service.get(selectDependencies='extend', parentids=parentids)
+            services = self.zapi.service.get(selectChildren='extend', parentids=parentids)
         else:
-            services = self.zapi.service.get(selectDependencies='extend')
+            services = self.zapi.service.get(selectChildren='extend')
 
         return services
 
@@ -167,7 +171,8 @@ def _init_zabbix_it_service(self, data: Dict) -> ZabbixService:
         logging.debug(f"Init ZabbixITService for {data.get('name')} ")
         zabbix_it_service = ZabbixService(name=data.get('name'),
                                           serviceid=data.get('serviceid'),
-                                          triggerid=data.get('triggerid'),
+                                          # TODO: Change for zbx 6
+                                          triggerid=data.get('triggerid', None),
                                           algorithm=data.get('algorithm'),
                                           status=data.get('status'))
         if 'parents' in data:
@@ -201,10 +206,14 @@ def get_itservices(self, root_name: str = None) -> List[ZabbixService]:
                 sys.exit(1)
             monitor_services = self._init_zabbix_it_service(root_service[0]).children
         else:
-            services = self.get_service()
-            for i in services:
-                # Do not proceed non-root services directly
-                if len(i['parents']) == 0:
-                    monitor_services.append(self._init_zabbix_it_service(i))
+            if self.version_major < 6:
+                services = self.get_service()
+                for i in services:
+                    # Do not proceed non-root services directly
+                    if len(i['parents']) == 0:
+                        monitor_services.append(self._init_zabbix_it_service(i))
+            else:
+                raise InvalidConfig(f"settings.root_service should be defined in you config yaml file because "
+                                    f"you use Zabbix version {self.version}")
         return monitor_services
 
diff --git a/tests/test_zabbix.py b/tests/test_zabbix.py
@@ -1,9 +1,11 @@
 import pytest
+import logging
 
 from zabbix_cachet.zabbix import Zabbix
 
 SERVICE_WITH_DEP_NAME = 'Service with dependencies'
 SERVICE_WO_DEP_NAME = 'Single Service'
+SERVICE_SEPARATE_ROOT = 'Separate service under root'
 
 TRIGGER_ID = '16199'
 SERVICES = [
@@ -20,6 +22,15 @@
      'goodsla': '99.9', 'sortorder': '0', 'dependencies': []}
 ]
 
+log_level = logging.getLevelName('DEBUG')
+log_level_requests = logging.getLevelName('DEBUG')
+logging.basicConfig(
+    level=log_level,
+    format='%(asctime)s %(levelname)s: (%(threadName)s) %(message)s',
+    datefmt='%Y-%m-%d %H:%M:%S %Z'
+)
+logging.getLogger("requests").setLevel(log_level_requests)
+
 
 @pytest.fixture(name='zabbix', scope='class')
 def zabbix_init(config):
@@ -29,50 +40,69 @@ def zabbix_init(config):
     zabbix = Zabbix(zabbix_config['server'], zabbix_config['user'], zabbix_config['pass'],
                     zabbix_config['https-verify'])
     root_service = zabbix.zapi.service.get(filter={'name': setting_config['root_service']})
+    root_separate = zabbix.zapi.service.get(filter={'name': SERVICE_SEPARATE_ROOT})
+
+    zabbix_service_template = {'name': '', 'algorithm': 0, 'sortorder': 0}
+    if not root_separate:
+        service = dict.copy(zabbix_service_template)
+        service.update({'name': SERVICE_SEPARATE_ROOT})
+        if zabbix.version_major < 6:
+            service.update({'showsla': 0})
+        zabbix.zapi.service.create(**service)
+
     if not root_service:
-        root_service = zabbix.zapi.service.create(
-            name=setting_config['root_service'],
-            algorithm=0,
-            sortorder=0,
-            showsla=0,
-        )
-        root_service_id = root_service['serviceids'][0]
-        zabbix.zapi.service.create(
-            name=SERVICE_WO_DEP_NAME,
-            algorithm=1,
-            sortorder=0,
-            showsla=0,
-            triggerid=TRIGGER_ID,
-            parentid=root_service_id
-        )
-        second_service = zabbix.zapi.service.create(
-            name=SERVICE_WITH_DEP_NAME,
-            algorithm=1,
-            sortorder=0,
-            showsla=0,
-            parentid=root_service_id,
-        )
-        second_service_id = second_service['serviceids'][0]
+        # root_service
+        service = dict.copy(zabbix_service_template)
+        service.update({'name': setting_config['root_service']})
+        if zabbix.version_major < 6:
+            service.update({'showsla': 0})
+        root_service = zabbix.zapi.service.create(**service)
+        root_service_id = int(root_service['serviceids'][0])
+
+        # SERVICE_WO_DEP_NAME
+        service = dict.copy(zabbix_service_template)
+        service.update({'name': SERVICE_WO_DEP_NAME})
+        if zabbix.version_major < 6:
+            service.update({'showsla': 0, 'triggerid': TRIGGER_ID, 'parentid': str(root_service_id)})
+        else:
+            service.update({
+                'parents': [{'serviceid': root_service_id}],
+                'problem_tags': [{'tag': 'scope', 'value': 'availability'}],
+            })
+        a = zabbix.zapi.service.create(**service)
+        print(a)
+        # SERVICE_WITH_DEP_NAME
+        service = dict.copy(zabbix_service_template)
+        service.update({'name': SERVICE_WITH_DEP_NAME})
+        if zabbix.version_major < 6:
+            service.update({'showsla': 0, 'parentid': str(root_service_id)})
+        else:
+            service.update({'parents': [{'serviceid': root_service_id}]})
+
+        second_service = zabbix.zapi.service.create(**service)
+        second_service_id = int(second_service['serviceids'][0])
+
+        # Dependency services
         for service_name in ('dependency1', 'dependency2'):
-            zabbix.zapi.service.create(
-                name=service_name,
-                algorithm=1,
-                sortorder=0,
-                showsla=0,
-                triggerid=TRIGGER_ID,
-                parentid=second_service_id,
-            )
+            service = dict.copy(zabbix_service_template)
+            service.update({'name': service_name})
+            if zabbix.version_major < 6:
+                service.update({'showsla': 0, 'triggerid': TRIGGER_ID, 'parentid': str(second_service_id)})
+            else:
+                service.update({
+                    'parents': [{'serviceid': second_service_id}],
+                    'problem_tags': [{'tag': 'scope', 'value': 'availability'}],
+                })
+            zabbix.zapi.service.create(**service)
+
     return zabbix
 
 
 def test_get_version(zabbix):
     assert isinstance(zabbix.version, str)
 
 
-def test_get_itservices(zabbix, config):
-    """
-    :return:
-    """
+def test_get_itservices_with_root(zabbix, config):
     it_services = zabbix.get_itservices(config['settings']['root_service'])
     assert len(it_services) == 2
     service_with_dep = it_services[1]
@@ -83,5 +113,20 @@ def test_get_itservices(zabbix, config):
     assert len(service_with_dep.children) == 2
     assert service_with_dep.children[0].name == 'dependency1'
     assert service_with_dep.children[1].name == 'dependency2'
-    assert service_with_dep.children[1].triggerid == TRIGGER_ID
+    if zabbix.version_major < 6:
+        assert service_with_dep.children[1].triggerid == TRIGGER_ID
     # print(it_services)
+
+
+def test_get_itservices_wo_root(zabbix, config):
+    # Not supported after 6.0
+    if zabbix.version_major >= 6:
+        return True
+    it_services = zabbix.get_itservices()
+    assert len(it_services) == 2
+    service_cachet = it_services[1]
+    service_separate = it_services[0]
+    assert service_cachet.name == config['settings']['root_service']
+    assert service_separate.name == SERVICE_SEPARATE_ROOT
+    assert len(service_cachet.children) == 2
+    assert len(service_separate.children) == 0

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`#!/bin/bash`
	`2`	`+# TODO: Add pytz and updated versions`
`2`	`3`	`pip3 install pyzabbix==0.7.4`
`3`	`4`	`chmod 640 /etc/zabbix-cachet.yml`
`4`	`5`	`systemctl status zabbix-cachet.service`