health checks module
Project description
Bravo! You have received a Medical Diploma in Mergers from
the Orbital Convergence University International Air and Water Embassy of the Tangerine Planet.
You are now officially certified to include "mergers" in your practice.
mergers
description
This is a module that can reliably ascertain the health status of software.
(It's like a testing framework)
install
[ZSH] pip install mergers
documentation (this opens a server process that sends HTML)
[ZSH] mergers shares
internal status tests of the module
[ZSH] mergers internal-status
These checks are run with pypi "body_scan"
"mergers" is built from a fork of "body_scan"
("body_scan" checks are written with "unittest")
Tutorial
- Checks are started simultaneously, unless "--simultaneous no"
Create a status file (glob pattern *_status.py).
(The glob pattern can be modified with the progammatic python3 interface)
# status_1.py
def check_1 ():
print ("check 1")
def check_2 ():
print ("check 2")
def check_3 ():
raise Exception ("not 110%")
checks = {
"check 1": check_1,
"check 2": check_2,
"check 3": check_3
}
from a directory deeper than the status file "status_1.py"
[ZSH] mergers status
This is the equivalent of:
[ZSH] mergers status --glob-string "**/status_*.py"
The report then should appear like this
paths: [
{
"path": "../status_1.py",
"empty": false,
"parsed": true,
"stats": {
"passes": 2,
"alarms": 1
},
"checks": [
{
"check": "check 1",
"passed": true,
"elapsed": [
4.054199962411076e-05,
"seconds"
]
},
{
"check": "check 2",
"passed": true,
"elapsed": [
1.72930003827787e-05,
"seconds"
]
},
{
"check": "check 3",
"passed": false,
"exception": "Exception('not 110%')",
"exception trace": [
"Traceback (most recent call last):",
" File \"/home/veganecology/.local/lib/python3.11/site-packages/mergers/processes/scan/process/keg/check.py\", line 68, in start",
" checks [ check ] ()",
" File \"<string>\", line 13, in check_3",
"Exception: not 110%"
]
}
]
}
]
alarms: [
{
"path": "../status_1.py",
"checks": [
{
"check": "check 3",
"passed": false,
"exception": "Exception('not 110%')",
"exception trace": [
"Traceback (most recent call last):",
" File \"/home/veganecology/.local/lib/python3.11/site-packages/mergers/processes/scan/process/keg/check.py\", line 68, in start",
" checks [ check ] ()",
" File \"<string>\", line 13, in check_3",
"Exception: not 110%"
]
}
]
}
]
stats: {
"alarms": 0,
"empty": 0,
"checks": {
"passes": 2,
"alarms": 1
}
}
Advanced Tutorial
It's recommended to run mergers programmatilly.
An example of this can be found in the "_book/advanced tutorial"
section of the documentation.
Contacts
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.