From 4f48919c9032dffaf11e2f6117223c10928fbf21 Mon Sep 17 00:00:00 2001 From: Justus Grunow Date: Fri, 9 May 2025 13:57:55 -0400 Subject: [PATCH 1/2] Still trying to figure out how to organize this correctly. Can now do "import plugin from monimon", and can run app with "python -m monimon.app", but Flask doesnt find it --- monimon.py | 49 ----------- __init__.py => monimon/__init__.py | 0 monimon/app.py | 81 +++++++++++++++++++ colors.py => monimon/colors.py | 0 hosts.yaml => monimon/hosts.yaml | 0 plugin.py => monimon/plugin.py | 0 {plugins => monimon/plugins}/__init__.py | 0 {plugins => monimon/plugins}/certexp.py | 0 {plugins => monimon/plugins}/httpcheck.py | 0 {plugins => monimon/plugins}/ping.py | 2 +- .../plugins}/ssl_expiration.py | 0 monimon/test.py | 16 ++++ requirements.txt | 1 + 13 files changed, 99 insertions(+), 50 deletions(-) delete mode 100755 monimon.py rename __init__.py => monimon/__init__.py (100%) create mode 100755 monimon/app.py rename colors.py => monimon/colors.py (100%) rename hosts.yaml => monimon/hosts.yaml (100%) rename plugin.py => monimon/plugin.py (100%) rename {plugins => monimon/plugins}/__init__.py (100%) rename {plugins => monimon/plugins}/certexp.py (100%) rename {plugins => monimon/plugins}/httpcheck.py (100%) rename {plugins => monimon/plugins}/ping.py (92%) rename {plugins => monimon/plugins}/ssl_expiration.py (100%) create mode 100755 monimon/test.py diff --git a/monimon.py b/monimon.py deleted file mode 100755 index c026191..0000000 --- a/monimon.py +++ /dev/null @@ -1,49 +0,0 @@ -#!/usr/bin/env python -import yaml -import pprint -import json -import sys -sys.path.append('plugins') -import pkgutil -import importlib -from colors import Colors -plugins = {} -for finder, name, ispkg in pkgutil.iter_modules(path=['plugins']): - plugins[name] = importlib.import_module(name) -row_format = "{:<30} {:<10} {:<6}" - -def translate_status(status): - if status: - return f"{Colors.GREEN}Success{Colors.END}" - else: - return f"{Colors.RED}Failure{Colors.END}" - - -with open('hosts.yaml', 'r') as file: - hosts = yaml.safe_load(file) - -for host, details in hosts['hosts'].items(): - for action in details['actions']: - # Start building the arguments dict that will get passed to the plugin. - # By default, the only item is the hostname. - arguments = {'hostname': details['hostname']} - - # Check if the action has any parameters defined in the YAML file, by - # checking if it's a string or a dict - if type(action) is str: - action_name = action - # If it's a dict, add each parameter to the arguments dict - elif type(action) is dict: - action_name = list(action)[0] - for argument, value in action[action_name].items(): - arguments[argument] = value - - #print(arguments) - result = getattr(plugins[action_name], action_name)(arguments) - #print(f"{host}\t{action_name}\t{result[0]}\t{result[1]}") - if type(result) is list: - print(row_format.format(f"{Colors.BOLD}{host}{Colors.END}", action_name, translate_status(result[0]))) - print(f"{Colors.YELLOW}{result[1]}{Colors.END}") - else: - print(row_format.format(host, action_name, translate_status(result))) - diff --git a/__init__.py b/monimon/__init__.py similarity index 100% rename from __init__.py rename to monimon/__init__.py diff --git a/monimon/app.py b/monimon/app.py new file mode 100755 index 0000000..1663893 --- /dev/null +++ b/monimon/app.py @@ -0,0 +1,81 @@ +#!/usr/bin/env python +import yaml +import pprint +import json +import sys +sys.path.append('monimon/plugins') +import pkgutil +import importlib +from monimon.colors import Colors +plugins = {} +for finder, name, ispkg in pkgutil.iter_modules(path=['monimon/plugins']): + plugins[name] = importlib.import_module(name) +row_format = "{:<30} {:<10} {:<6}" + +def format_status(status): + if status: + return f"{Colors.GREEN}Success{Colors.END}" + else: + return f"{Colors.RED}Failure{Colors.END}" + +def monitor(): + with open('monimon/hosts.yaml', 'r') as file: + hosts = yaml.safe_load(file) + + return_list = [] + for host, details in hosts['hosts'].items(): + for action in details['actions']: + # Start building the arguments dict that will get passed to the plugin. + # By default, the only item is the hostname. + arguments = {'hostname': details['hostname']} + + # Check if the action has any parameters defined in the YAML file, by + # checking if it's a string or a dict + if type(action) is str: + action_name = action + # If it's a dict, add each parameter to the arguments dict + elif type(action) is dict: + action_name = list(action)[0] + for argument, value in action[action_name].items(): + arguments[argument] = value + + #print(arguments) + result = getattr(plugins[action_name], action_name)(arguments) + #print(f"{host}\t{action_name}\t{result[0]}\t{result[1]}") + + return_dict = {'host': host, 'action_name': action_name} + if type(result) is list: + return_dict['result'] = result[0] + if len(result) > 1: + return_dict['details'] = result[1] + else: + return_dict['result'] = result + + return_list.append(return_dict) + return return_list + +if __name__ == 'app': + from flask import Flask + app = Flask(__name__) + + @app.route("/") + def print_monitor(): + return "Hello" + +elif __name__ == '__main__': + for result in monitor(): + print(row_format.format(f"{Colors.BOLD}{result['host']}{Colors.END}", + result['action_name'], + format_status(result['result']))) + if 'details' in result: + print(f"{Colors.YELLOW}{result['details']}{Colors.END}") + + + +#print(monitor()) +#if type(result) is list: +# print(row_format.format(f"{Colors.BOLD}{host}{Colors.END}", action_name, translate_status(result[0]))) +# print(f"{Colors.YELLOW}{result[1]}{Colors.END}") +#else: +# print(row_format.format(host, action_name, translate_status(result))) + diff --git a/colors.py b/monimon/colors.py similarity index 100% rename from colors.py rename to monimon/colors.py diff --git a/hosts.yaml b/monimon/hosts.yaml similarity index 100% rename from hosts.yaml rename to monimon/hosts.yaml diff --git a/plugin.py b/monimon/plugin.py similarity index 100% rename from plugin.py rename to monimon/plugin.py diff --git a/plugins/__init__.py b/monimon/plugins/__init__.py similarity index 100% rename from plugins/__init__.py rename to monimon/plugins/__init__.py diff --git a/plugins/certexp.py b/monimon/plugins/certexp.py similarity index 100% rename from plugins/certexp.py rename to monimon/plugins/certexp.py diff --git a/plugins/httpcheck.py b/monimon/plugins/httpcheck.py similarity index 100% rename from plugins/httpcheck.py rename to monimon/plugins/httpcheck.py diff --git a/plugins/ping.py b/monimon/plugins/ping.py similarity index 92% rename from plugins/ping.py rename to monimon/plugins/ping.py index 9119226..c04ea39 100644 --- a/plugins/ping.py +++ b/monimon/plugins/ping.py @@ -1,6 +1,6 @@ import os import subprocess -import plugin +import monimon.plugin as plugin x = plugin.Plugin() def ping(arguments): response = subprocess.run(["ping","-c","1",arguments['hostname']], diff --git a/plugins/ssl_expiration.py b/monimon/plugins/ssl_expiration.py similarity index 100% rename from plugins/ssl_expiration.py rename to monimon/plugins/ssl_expiration.py diff --git a/monimon/test.py b/monimon/test.py new file mode 100755 index 0000000..5ba5a10 --- /dev/null +++ b/monimon/test.py @@ -0,0 +1,16 @@ +#!/usr/bin/env python +import OpenSSL +import ssl +from datetime import datetime,timedelta +now = datetime.now() +cert = ssl.get_server_certificate(('secureassets.confederationcollege.ca', 443)) +x509 = OpenSSL.crypto.load_certificate(OpenSSL.crypto.FILETYPE_PEM, cert) +expiration_date = datetime.strptime(f"{x509.get_notAfter().decode("UTF-8")[0:-1]}UTC", "%Y%m%d%H%M%S%Z") +warning_date = expiration_date - timedelta(days = 30) +print(expiration_date) +print(warning_date) + +if (expiration_date - timedelta(days = 30)) > now: + print("WARNING") +else: + print("All good") diff --git a/requirements.txt b/requirements.txt index 8392d54..80a3edb 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1 +1,2 @@ PyYAML==6.0.2 +Flask==3.1.0 From acd9b5b6e31300872f7eab5d9965760e081f0a1c Mon Sep 17 00:00:00 2001 From: Justus Grunow Date: Thu, 15 May 2025 21:24:03 -0400 Subject: [PATCH 2/2] Now installable as package using 'pip install -e' after which imports work properly! --- .gitignore | 183 +++++++++++++++++++++++++++++++++++- monimon/cli.py | 37 ++++++++ monimon/{app.py => core.py} | 35 ------- pyproject.toml | 23 +++++ test.py | 2 + test.yaml | 8 ++ 6 files changed, 251 insertions(+), 37 deletions(-) create mode 100755 monimon/cli.py rename monimon/{app.py => core.py} (62%) mode change 100755 => 100644 create mode 100644 pyproject.toml create mode 100755 test.py create mode 100644 test.yaml diff --git a/.gitignore b/.gitignore index fe6bd50..01a730d 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,181 @@ -.venv/ -**/__pycache__/ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# UV +# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +#uv.lock + +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +#poetry.lock + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +#pdm.lock +# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it +# in version control. +# https://pdm.fming.dev/latest/usage/project/#working-with-version-control +.pdm.toml +.pdm-python +.pdm-build/ + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# PyCharm +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +#.idea/ + +# Ruff stuff: +.ruff_cache/ + +# PyPI configuration file +.pypirc + +# Cursor +# Cursor is an AI-powered code editor.`.cursorignore` specifies files/directories to +# exclude from AI features like autocomplete and code analysis. Recommended for sensitive data +# refer to https://docs.cursor.com/context/ignore-files +.cursorignore +.cursorindexingignore diff --git a/monimon/cli.py b/monimon/cli.py new file mode 100755 index 0000000..cad24a1 --- /dev/null +++ b/monimon/cli.py @@ -0,0 +1,37 @@ +#!/usr/bin/env python +from monimon.colors import Colors +from monimon import core +row_format = "{:<30} {:<10} {:<6}" + +def format_status(status): + if status: + return f"{Colors.GREEN}Success{Colors.END}" + else: + return f"{Colors.RED}Failure{Colors.END}" + + +if __name__ == 'app': + from flask import Flask + app = Flask(__name__) + + @app.route("/") + def print_monitor(): + return "Hello" + +elif __name__ == '__main__': + for result in core.monitor(): + print(row_format.format(f"{Colors.BOLD}{result['host']}{Colors.END}", + result['action_name'], + format_status(result['result']))) + if 'details' in result: + print(f"{Colors.YELLOW}{result['details']}{Colors.END}") + + + +#print(monitor()) +#if type(result) is list: +# print(row_format.format(f"{Colors.BOLD}{host}{Colors.END}", action_name, translate_status(result[0]))) +# print(f"{Colors.YELLOW}{result[1]}{Colors.END}") +#else: +# print(row_format.format(host, action_name, translate_status(result))) + diff --git a/monimon/app.py b/monimon/core.py old mode 100755 new mode 100644 similarity index 62% rename from monimon/app.py rename to monimon/core.py index 1663893..c801af6 --- a/monimon/app.py +++ b/monimon/core.py @@ -1,4 +1,3 @@ -#!/usr/bin/env python import yaml import pprint import json @@ -6,17 +5,9 @@ import sys sys.path.append('monimon/plugins') import pkgutil import importlib -from monimon.colors import Colors plugins = {} for finder, name, ispkg in pkgutil.iter_modules(path=['monimon/plugins']): plugins[name] = importlib.import_module(name) -row_format = "{:<30} {:<10} {:<6}" - -def format_status(status): - if status: - return f"{Colors.GREEN}Success{Colors.END}" - else: - return f"{Colors.RED}Failure{Colors.END}" def monitor(): with open('monimon/hosts.yaml', 'r') as file: @@ -53,29 +44,3 @@ def monitor(): return_list.append(return_dict) return return_list - -if __name__ == 'app': - from flask import Flask - app = Flask(__name__) - - @app.route("/") - def print_monitor(): - return "Hello" - -elif __name__ == '__main__': - for result in monitor(): - print(row_format.format(f"{Colors.BOLD}{result['host']}{Colors.END}", - result['action_name'], - format_status(result['result']))) - if 'details' in result: - print(f"{Colors.YELLOW}{result['details']}{Colors.END}") - - - -#print(monitor()) -#if type(result) is list: -# print(row_format.format(f"{Colors.BOLD}{host}{Colors.END}", action_name, translate_status(result[0]))) -# print(f"{Colors.YELLOW}{result[1]}{Colors.END}") -#else: -# print(row_format.format(host, action_name, translate_status(result))) - diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..a6cbe32 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,23 @@ +[project] +name = "monimon" +version = "0.0.1" +authors = [ + { name="Justus Grunow", email="jg@justus.ws" }, +] +description = "A dead-simple, extremely pluggable monitoring platform" +readme = "README.md" +requires-python = ">=3.13.2" +classifiers = [ + "Programming Language :: Python :: 3", + "Operating System :: OS Independent", +] +license = "GPL-3.0-only" +license-files = ["LICENSE"] + +[project.urls] +Homepage = "https://github.com/justusthane/monimon" +Issues = "https://github.com/justusthane/monimon/issues" + +[build-system] +requires = ["setuptools"] +build-backend = "setuptools.build_meta" diff --git a/test.py b/test.py new file mode 100755 index 0000000..ae466ac --- /dev/null +++ b/test.py @@ -0,0 +1,2 @@ +#!/usr/bin/env python +from plugins import plugin diff --git a/test.yaml b/test.yaml new file mode 100644 index 0000000..5f44083 --- /dev/null +++ b/test.yaml @@ -0,0 +1,8 @@ +--- +hosts: + webassets: + hostname: webassets.confederationcollege.ca + actions: + ping + httpcheck: + endpoint: https://webassets.confederationcollege.ca