Use poetry. Build project as module (#74)

qk4l · web-flow · commit 41d0a86de1d4 · 2024-05-26T21:47:17.000+01:00
diff --git a/.github/workloads/release.yml b/.github/workloads/release.yml
@@ -0,0 +1,15 @@
+name: CI
+on: pull_request
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+      - name: Install Poetry
+        run: curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python
+      - name: Add Poetry to path
+        run: echo "${HOME}/.poetry/bin" >> $GITHUB_PATH
+      - name: Install venv
+        run: poetry install
diff --git a/.gitignore b/.gitignore
@@ -5,3 +5,6 @@ venv
 config.yml
 /.pytest_cache/
 /src/zabbix_cachet.egg-info/
+/dist/
+/database.sqlite
+/config_zbx_old.yml
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,8 @@
+repos:
+  -   repo: https://github.com/python-poetry/poetry
+      rev: 1.8.0
+      hooks:
+        - id: poetry-check
+        - id: poetry-lock
+        - id: poetry-export
+          args: ["--without-hashes", "--format", "requirements.txt", "-o", "requirements.txt"]
diff --git a/README.md b/README.md
@@ -46,11 +46,14 @@ items of services that is exported to Cachet and Cachet`s API key.
     ```
 3. Drink a cup of tea (optional)
 
-## Git
-1. Clone this repository
+## Python package
+1. Install python package via pip
+   ```bash
+   pip install zabbix-cachet
+   ```
 2. Rename `config-example.yml` to `config.yml` and fill a file with your settings.
-3. Install python libs from `requirements.txt`
-4. Launch `zabbix-cachet.py`
+3. Define `CONFIG_FILE` environment variable which point to your `config.yml` or change current work directory to folder with config 
+4. Launch `zabbix-cachet`
 
 ## Apt
 1. Add official Zabbix-Cachet [PPA](https://launchpad.net/~reg-tem4uk/+archive/ubuntu/zabbix-cachet):
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,27 @@
+[tool.poetry]
+name = "zabbix-cachet"
+version = "2.1.1"
+description = "Python daemon which provides synchronisation between Zabbix IT Services and Cachet"
+authors = ["Artem Alexandrov <qk4l@tem4uk.ru>"]
+license = "MIT License"
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = ">3.8,<4.0"
+requests = ">2.21.0"
+pyyaml = ">=5.4"
+pyzabbix = "1.3.1"
+pytz = ">=2024.1"
+
+[tool.poetry.group.dev.dependencies]
+pytest = "8.2.0"
+pytest-env = "1.1.3"
+pylint = "^3.2.1"
+poetry-plugin-export = "^1.8.0"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry.scripts]
+zabbix-cachet = 'zabbix_cachet.main:main'
diff --git a/requirements.txt b/requirements.txt
@@ -1,7 +1,9 @@
-PyYAML>=5.4
-pyzabbix==1.3.1
-requests>=2.21.0
-pytz==2024.1
-# Dev only
-#pytest==8.2.0
-#pytest-env==1.1.3
+certifi==2024.2.2 ; python_full_version > "3.8.0" and python_version < "4.0"
+charset-normalizer==3.3.2 ; python_full_version > "3.8.0" and python_version < "4.0"
+idna==3.7 ; python_full_version > "3.8.0" and python_version < "4.0"
+packaging==24.0 ; python_full_version > "3.8.0" and python_version < "4.0"
+pytz==2024.1 ; python_full_version > "3.8.0" and python_version < "4.0"
+pyyaml==6.0.1 ; python_full_version > "3.8.0" and python_version < "4.0"
+pyzabbix==1.3.1 ; python_full_version > "3.8.0" and python_version < "4.0"
+requests==2.32.2 ; python_full_version > "3.8.0" and python_version < "4.0"
+urllib3==2.2.1 ; python_full_version > "3.8.0" and python_version < "4.0"
diff --git a/src/zabbix_cachet/main.py b/src/zabbix_cachet/main.py
@@ -4,13 +4,16 @@
 """
 import sys
 import os
+import pathlib
 import datetime
 from dataclasses import dataclass
 from typing import List, Union
 
 import time
 import threading
 import logging
+
+import requests
 import yaml
 import pytz
 
@@ -20,7 +23,51 @@
 
 __author__ = 'Artem Aleksandrov <qk4l()tem4uk.ru>'
 __license__ = """The MIT License (MIT)"""
-__version__ = '2.0.0'
+__version__ = '2.1.1'
+
+
+class Config:
+    _instance = None
+
+    def __new__(cls, *args, **kwargs):
+        if cls._instance is None:
+            cls._instance = super(Config, cls).__new__(cls, *args, **kwargs)
+        return cls._instance
+
+    def __init__(self):
+        if not hasattr(self, 'initialized'):
+            if os.getenv('CONFIG_FILE') is not None:
+                self.config_file = pathlib.Path(os.environ['CONFIG_FILE'])
+            else:
+                self.config_file = pathlib.Path.cwd() / 'config.yml'
+            if not self.config_file.is_file():
+                logging.error(
+                    f"Config file {self.config_file} is absent. Set CONFIG_FILE to change path or create it there.")
+                sys.exit(1)
+            config = read_config(self.config_file)
+            if not config:
+                sys.exit(1)
+            self.zabbix_config = config['zabbix']
+            self.cachet_config = config['cachet']
+            self.app_settings = config['settings']
+
+            if self.app_settings.get('time_zone'):
+                self.tz = pytz.timezone(self.app_settings['time_zone'])
+            else:
+                self.tz = None
+
+            incident_templates_defaults = {
+                'acknowledgement': "{message}\n\n###### {ack_time} by {author}\n\n______\n",
+                'investigation': '',
+                'resolving': '',
+            }
+
+            self.templates = config.get('templates')
+            for template_name, default_value in incident_templates_defaults.items():
+                if self.templates.get(template_name, None) is None:
+                    self.templates[template_name] = default_value
+
+            self.initialized = True
 
 
 @dataclass
@@ -39,7 +86,7 @@ def __str__(self):
         return f"{self.cachet_group_name}/{self.cachet_component_name} - {self.zbx_serviceid}"
 
 
-def triggers_watcher(service_map: List[ZabbixCachetMap]) -> bool:
+def triggers_watcher(service_map: List[ZabbixCachetMap], zapi: Zabbix, cachet: Cachet) -> bool:
     """
     Check zabbix triggers and update Cachet components
     Zabbix Priority:
@@ -57,6 +104,7 @@ def triggers_watcher(service_map: List[ZabbixCachetMap]) -> bool:
         4 - Fixed
     @return: boolean
     """
+    config = Config()
     for i in service_map:  # type: ZabbixCachetMap
         # inc_status = 1
         # comp_status = 1
@@ -79,9 +127,9 @@ def triggers_watcher(service_map: List[ZabbixCachetMap]) -> bool:
                 # component not operational mode. Resolve it.
                 last_inc = cachet.get_incident(i.cachet_component_id)
                 if str(last_inc['id']) != '0':
-                    if resolving_tmpl:
-                        inc_msg = resolving_tmpl.format(
-                            time=datetime.datetime.now(tz=tz).strftime('%b %d, %H:%M'),
+                    if config.templates['resolving']:
+                        inc_msg = config.templates['resolving'].format(
+                            time=datetime.datetime.now(tz=config.tz).strftime('%b %d, %H:%M'),
                         ) + cachet.get_incident(i.cachet_component_id)['message']
                     else:
                         inc_msg = cachet.get_incident(i.cachet_component_id)['message']
@@ -126,9 +174,9 @@ def triggers_watcher(service_map: List[ZabbixCachetMap]) -> bool:
                     # TODO: Add timezone?
                     #       Move format to config file
                     author = msg.get('name', '') + ' ' + msg.get('surname', '')
-                    ack_time = datetime.datetime.fromtimestamp(int(msg['clock']), tz=tz).strftime(
+                    ack_time = datetime.datetime.fromtimestamp(int(msg['clock']), tz=config.tz).strftime(
                         '%b %d, %H:%M')
-                    ack_msg = acknowledgement_tmpl.format(
+                    ack_msg = config.templates['acknowledgement'].format(
                         message=msg['message'],
                         ack_time=ack_time,
                         author=author
@@ -146,14 +194,14 @@ def triggers_watcher(service_map: List[ZabbixCachetMap]) -> bool:
             else:
                 comp_status = 2
 
-            if not inc_msg and investigating_tmpl:
+            if not inc_msg and config.templates['']:
                 if zbx_event:
                     zbx_event_clock = int(zbx_event.get('clock'))
-                    zbx_event_time = datetime.datetime.fromtimestamp(zbx_event_clock, tz=tz).strftime(
+                    zbx_event_time = datetime.datetime.fromtimestamp(zbx_event_clock, tz=config.tz).strftime(
                         '%b %d, %H:%M')
                 else:
                     zbx_event_time = ''
-                inc_msg = investigating_tmpl.format(
+                inc_msg = config.templates['investigation'].format(
                     group=i.cachet_group_name,
                     component=i.cachet_component_name,
                     time=zbx_event_time,
@@ -184,12 +232,14 @@ def triggers_watcher(service_map: List[ZabbixCachetMap]) -> bool:
     return True
 
 
-def triggers_watcher_worker(service_map, interval, tr_event):
+def triggers_watcher_worker(service_map, interval, tr_event: threading.Event, zapi: Zabbix, cachet: Cachet):
     """
     Worker for triggers_watcher. Run it continuously with specific interval
     @param service_map: list of tuples
     @param interval: interval in seconds
     @param tr_event: treading.Event object
+    @param zapi: Zabbix object
+    @param cachet: Cachet object
     @return:
     """
     logging.info('start trigger watcher')
@@ -198,7 +248,7 @@ def triggers_watcher_worker(service_map, interval, tr_event):
         # Do not run if Zabbix is not available
         if zapi.get_version():
             try:
-                triggers_watcher(service_map)
+                triggers_watcher(service_map, zapi=zapi, cachet=cachet)
             except Exception as e:
                 logging.error('triggers_watcher() raised an Exception. Something gone wrong')
                 logging.error(e, exc_info=True)
@@ -208,11 +258,13 @@ def triggers_watcher_worker(service_map, interval, tr_event):
     logging.info('end trigger watcher')
 
 
-def init_cachet(services: List[ZabbixService]) -> List[ZabbixCachetMap]:
+def init_cachet(services: List[ZabbixService], zapi: Zabbix, cachet: Cachet) -> List[ZabbixCachetMap]:
     """
     Init Cachet by syncing Zabbix service to it
     Also func create mapping batten Cachet components and Zabbix IT services
-    @param services: list of ZabbixService
+    :param services: list of ZabbixService
+    :param cachet: Cachet object
+    :param zapi: Zabbix object
     @return: list of tuples
     """
     # Zabbix Triggers to Cachet components id map
@@ -291,65 +343,39 @@ def read_config(config_f):
     return None
 
 
-if __name__ == '__main__':
-
-    if os.getenv('CONFIG_FILE') is not None:
-        config_file = os.environ['CONFIG_FILE']
-    else:
-        config_file = os.path.dirname(os.path.realpath(__file__)) + '/config.yml'
-    if not os.path.isfile(config_file):
-        logging.error(f"Config file {config_file} is absent. Set CONFIG_FILE to change path or create it there.")
-        sys.exit(1)
-    config = read_config(config_file)
-    if not config:
-        sys.exit(1)
-    ZABBIX = config['zabbix']
-    CACHET = config['cachet']
-    SETTINGS = config['settings']
-
-    if SETTINGS.get('time_zone'):
-        tz = pytz.timezone(SETTINGS['time_zone'])
-    else:
-        tz = None
-
-    # Templates for incident displaying
-    acknowledgement_tmpl_default = "{message}\n\n###### {ack_time} by {author}\n\n______\n"
-    templates = config.get('templates')
-    if templates:
-        acknowledgement_tmpl = templates.get('acknowledgement', acknowledgement_tmpl_default)
-        investigating_tmpl = templates.get('investigating', '')
-        resolving_tmpl = templates.get('resolving', '')
-    else:
-        acknowledgement_tmpl = acknowledgement_tmpl_default
-
+def main():
     exit_status = 0
+    config = Config()
+
     # Set Logging
-    log_level = logging.getLevelName(SETTINGS['log_level'])
-    log_level_requests = logging.getLevelName(SETTINGS['log_level_requests'])
+    log_level = logging.getLevelName(config.app_settings['log_level'])
+    log_level_requests = logging.getLevelName(config.app_settings['log_level_requests'])
     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)
-    logging.info(f'Zabbix Cachet v.{__version__} started (config: {config_file})')
+    logging.info(f'Zabbix Cachet v.{__version__} started (config: {config.config_file})')
     inc_update_t = threading.Thread()
     event = threading.Event()
     try:
-        zapi = Zabbix(ZABBIX['server'], ZABBIX['user'], ZABBIX['pass'], ZABBIX['https-verify'])
-        cachet = Cachet(CACHET['server'], CACHET['token'], CACHET['https-verify'])
+        zapi = Zabbix(config.zabbix_config['server'], config.zabbix_config['user'], config.zabbix_config['pass'],
+                      config.zabbix_config['https-verify'])
+        cachet = Cachet(config.cachet_config['server'], config.cachet_config['token'],
+                        config.cachet_config['https-verify'])
         logging.info('Zabbix ver: {}. Cachet ver: {}'.format(zapi.version, cachet.version))
         zbxtr2cachet = ''
         while True:
             try:
                 logging.debug('Getting list of Zabbix IT Services ...')
-                it_services = zapi.get_itservices(SETTINGS['root_service'])
+                it_services = zapi.get_itservices(config.app_settings['root_service'])
                 logging.debug('Zabbix IT Services: {}'.format(it_services))
                 # Create Cachet components and components groups
                 logging.debug('Syncing Zabbix with Cachet...')
-                zbxtr2cachet_new = init_cachet(it_services)
+                zbxtr2cachet_new = init_cachet(it_services, zapi, cachet)
             except ZabbixNotAvailable:
-                time.sleep(SETTINGS['update_comp_interval'])
+                time.sleep(config.app_settings['update_comp_interval'])
                 continue
             except ZabbixCachetException:
                 zbxtr2cachet_new = False
@@ -375,15 +401,22 @@ def read_config(config_f):
                 event.clear()
                 inc_update_t = threading.Thread(name='Trigger Watcher',
                                                 target=triggers_watcher_worker,
-                                                args=(zbxtr2cachet, SETTINGS['update_inc_interval'], event))
+                                                args=(zbxtr2cachet, config.app_settings['update_inc_interval'], event,
+                                                      zapi, cachet))
                 inc_update_t.daemon = True
                 inc_update_t.start()
-            time.sleep(SETTINGS['update_comp_interval'])
-
+            time.sleep(config.app_settings['update_comp_interval'])
+    except requests.exceptions.ConnectionError as err:
+        logging.error(f"Failed to connect: {err}")
+        exit_status = 1
     except KeyboardInterrupt:
         event.set()
         logging.info('Shutdown requested. See you.')
     except Exception as error:
         logging.exception(error)
         exit_status = 1
     sys.exit(exit_status)
+
+
+if __name__ == '__main__':
+    main()
diff --git a/src/zabbix_cachet/zabbix.py b/src/zabbix_cachet/zabbix.py
