bn8/check_esphome_devices
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases 3 Wiki Activity

Configure pre-commit to run all tests on commit and use it for CI tests
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
Details
ci/woodpecker/tag/woodpecker Pipeline was successful
Details

Browse source
This commit is contained in:
Benjamin Renard 2023-01-19 14:59:57 +01:00
parent ce39354048
commit bf0a560566
Signed by: bn8
GPG key ID: 3E2E1CE1907115BC
3 changed files with 104 additions and 88 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
.pre-commit-config.yaml Normal file
View file

@ -0,0 +1,31 @@
# Pre-commit hooks to run tests and ensure code is cleaned.
# See https://pre-commit.com for more information
repos:
- repo: local
hooks:
- id: pylint
name: pylint
entry: pylint
language: system
types: [python]
require_serial: true
- repo: https://github.com/PyCQA/flake8
rev: 6.0.0
hooks:
- id: flake8
args: ['--max-line-length=100']
- repo: https://github.com/asottile/pyupgrade
rev: v3.3.1
hooks:
- id: pyupgrade
args: ['--keep-percent-format', '--py37-plus']
- repo: https://github.com/psf/black
rev: 22.12.0
hooks:
- id: black
args: ['--target-version', 'py37', '--line-length', '100']
- repo: https://github.com/PyCQA/isort
rev: 5.11.4
hooks:
- id: isort
args: ['--profile', 'black', '--line-length', '100']

15
.woodpecker.yml
View file

@ -4,19 +4,12 @@ clone:
tags: true tags: true
pipeline: pipeline:
test-pylint: tests:
group: test image: brenard/python-pre-commit:latest
image: debian
commands: commands:
- DEBIAN_FRONTEND=noninteractive apt-get -qq update < /dev/null > /dev/null - DEBIAN_FRONTEND=noninteractive apt-get -qq update < /dev/null > /dev/null
- DEBIAN_FRONTEND=noninteractive apt-get -qq -y install --no-install-recommends python3-requests pylint3 < /dev/null > /dev/null - DEBIAN_FRONTEND=noninteractive apt-get -qq -y install --no-install-recommends python3-requests < /dev/null > /dev/null
- python3 -m pylint check_esphome_devices - pre-commit run --all-files
test-flake8:
group: test
image: pipelinecomponents/flake8
commands:
- flake8 check_esphome_devices
build: build:
image: brenard/debian-python-deb image: brenard/debian-python-deb

146
check_esphome_devices
View file

@ -20,182 +20,174 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
""" """
import argparse import argparse
import sys
import time
import logging import logging
import re import re
import sys
import time
import requests import requests
# nagios exit code # nagios exit code
STATUS = { STATUS = {"OK": 0, "WARNING": 1, "CRITICAL": 2, "UNKNOWN": 3}
'OK': 0,
'WARNING': 1,
'CRITICAL': 2,
'UNKNOWN': 3
}
DEFAULT_HOST = 'http://127.0.0.1:6052' DEFAULT_HOST = "http://127.0.0.1:6052"
DEFAULT_RETRY_COUNT = 4 DEFAULT_RETRY_COUNT = 4
DEFAULT_RETRY_DELAY = 1 DEFAULT_RETRY_DELAY = 1
parser = argparse.ArgumentParser() parser = argparse.ArgumentParser()
parser.add_argument( parser.add_argument("-d", "--debug", action="store_true", dest="debug", default=False)
'-d', '--debug',
action="store_true",
dest="debug",
default=False
)
parser.add_argument( parser.add_argument(
'-H', '--host', "-H",
"--host",
action="store", action="store",
dest="host", dest="host",
help=f'ESPHome dashboard URL (default: {DEFAULT_HOST})', help=f"ESPHome dashboard URL (default: {DEFAULT_HOST})",
type=str, type=str,
default=DEFAULT_HOST default=DEFAULT_HOST,
) )
parser.add_argument( parser.add_argument(
'-r', '--retry', "-r",
"--retry",
action="store", action="store",
dest="retry_count", dest="retry_count",
help=( help=("Number of retry to retreive device status " f"(default: {DEFAULT_RETRY_COUNT})"),
'Number of retry to retreive device status '
f'(default: {DEFAULT_RETRY_COUNT})'),
type=int, type=int,
default=DEFAULT_RETRY_COUNT default=DEFAULT_RETRY_COUNT,
) )
parser.add_argument( parser.add_argument(
'-D', '--delay', "-D",
"--delay",
action="store", action="store",
dest="retry_delay", dest="retry_delay",
help=( help=(
'Delay in second between two retry to retreive device status ' "Delay in second between two retry to retreive device status "
f'(default: {DEFAULT_RETRY_DELAY}s)'), f"(default: {DEFAULT_RETRY_DELAY}s)"
),
type=int, type=int,
default=DEFAULT_RETRY_DELAY default=DEFAULT_RETRY_DELAY,
) )
def exclude_pattern(value): def exclude_pattern(value):
""" Check and compile exclusion pattern parameter """ """Check and compile exclusion pattern parameter"""
return re.compile(value) return re.compile(value)
parser.add_argument( parser.add_argument(
'-x', '--exclude', "-x",
"--exclude",
action="append", action="append",
dest="exclude", dest="exclude",
help='Regex exclude pattern(s)', help="Regex exclude pattern(s)",
type=exclude_pattern, type=exclude_pattern,
default=[] default=[],
) )
options = parser.parse_args() options = parser.parse_args()
logging.basicConfig( logging.basicConfig(
level=logging.DEBUG if options.debug else logging.INFO, level=logging.DEBUG if options.debug else logging.INFO,
format='%(asctime)s - %(levelname)s - %(message)s') format="%(asctime)s - %(levelname)s - %(message)s",
)
if options.host[-1] == '/': if options.host[-1] == "/":
options.host = options.host[-1] options.host = options.host[-1]
def is_excluded(name): def is_excluded(name):
""" Check if device is excluded """ """Check if device is excluded"""
for pattern in options.exclude: for pattern in options.exclude:
if pattern.search(name): if pattern.search(name):
logging.debug('Device %s is excluded', name) logging.debug("Device %s is excluded", name)
return True return True
logging.debug('Device %s is not excluded', name) logging.debug("Device %s is not excluded", name)
return False return False
r = requests.get(f'{options.host}/devices') r = requests.get(f"{options.host}/devices")
devices_data = r.json() devices_data = r.json()
logging.debug('Devices data: %s (%s)', devices_data, type(devices_data)) logging.debug("Devices data: %s (%s)", devices_data, type(devices_data))
if not devices_data: if not devices_data:
print('UNKNOWN - Fail to retreive devices using ESPHome Dashboard API') print("UNKNOWN - Fail to retreive devices using ESPHome Dashboard API")
sys.exit(STATUS['UNKNOWN']) sys.exit(STATUS["UNKNOWN"])
COUNT = 0 COUNT = 0
while COUNT < options.retry_count: while COUNT < options.retry_count:
r = requests.get(f'{options.host}/ping') r = requests.get(f"{options.host}/ping")
COUNT += 1 COUNT += 1
ping_data = r.json() ping_data = r.json()
logging.debug('Ping data: %s (%s)', ping_data, type(ping_data)) logging.debug("Ping data: %s (%s)", ping_data, type(ping_data))
if ping_data: if ping_data:
UNREACHABLE = False UNREACHABLE = False
for dev in ping_data: for dev in ping_data:
if ( if not ping_data[dev] and not is_excluded(dev.replace(".yaml", "")):
not ping_data[dev]
and not is_excluded(dev.replace('.yaml', ''))
):
UNREACHABLE = True UNREACHABLE = True
break break
if not UNREACHABLE: if not UNREACHABLE:
break break
logging.debug('Wait %d seconds before retry...', options.retry_delay) logging.debug("Wait %d seconds before retry...", options.retry_delay)
time.sleep(options.retry_delay) time.sleep(options.retry_delay)
if not ping_data: if not ping_data:
print( print("UNKNOWN - Fail to retreive devices status " "using ESPHome Dashboard API")
'UNKNOWN - Fail to retreive devices status ' sys.exit(STATUS["UNKNOWN"])
'using ESPHome Dashboard API')
sys.exit(STATUS['UNKNOWN'])
UPDATE_AVAILABLE = 0 UPDATE_AVAILABLE = 0
UNREACHABLE_DEVICES = 0 UNREACHABLE_DEVICES = 0
NO_PING_DATA = 0 NO_PING_DATA = 0
errors = [] errors = []
devices = {} devices = {}
for dev in devices_data['configured']: for dev in devices_data["configured"]:
devices[dev['name']] = dev devices[dev["name"]] = dev
logging.debug('Device %s: %s', dev['name'], dev) logging.debug("Device %s: %s", dev["name"], dev)
if is_excluded(dev['name']): if is_excluded(dev["name"]):
continue continue
if dev['deployed_version'] != dev['current_version']: if dev["deployed_version"] != dev["current_version"]:
UPDATE_AVAILABLE += 1 UPDATE_AVAILABLE += 1
errors.append( errors.append(
f'Update available for device {dev["name"]} ' f'Update available for device {dev["name"]} '
f'({dev["deployed_version"]} => {dev["current_version"]})') f'({dev["deployed_version"]} => {dev["current_version"]})'
)
if dev['configuration'] not in ping_data: if dev["configuration"] not in ping_data:
NO_PING_DATA += 1 NO_PING_DATA += 1
errors.append( errors.append(f'No ping data found for device {dev["name"]} ' f'({dev["configuration"]})')
f'No ping data found for device {dev["name"]} ' elif not ping_data[dev["configuration"]]:
f'({dev["configuration"]})')
elif not ping_data[dev['configuration']]:
UNREACHABLE_DEVICES += 1 UNREACHABLE_DEVICES += 1
errors.append(f'Device {dev["name"]} is unreachable') errors.append(f'Device {dev["name"]} is unreachable')
if not errors: if not errors:
print(f'OK - no problem detected on the {len(devices)} devices') print(f"OK - no problem detected on the {len(devices)} devices")
EXIT_STATUS = STATUS['OK'] EXIT_STATUS = STATUS["OK"]
else: else:
msg = [] msg = []
if UNREACHABLE_DEVICES: if UNREACHABLE_DEVICES:
msg.append(f'{UNREACHABLE_DEVICES} unreachable devices') msg.append(f"{UNREACHABLE_DEVICES} unreachable devices")
if NO_PING_DATA: if NO_PING_DATA:
msg.append(f'{NO_PING_DATA} missing ping device status') msg.append(f"{NO_PING_DATA} missing ping device status")
if UPDATE_AVAILABLE: if UPDATE_AVAILABLE:
msg.append(f'{UPDATE_AVAILABLE} update available') msg.append(f"{UPDATE_AVAILABLE} update available")
print(f'WARNING - {", ".join(msg)}') print(f'WARNING - {", ".join(msg)}')
print("\n".join([f'- {error}' for error in errors])) print("\n".join([f"- {error}" for error in errors]))
EXIT_STATUS = STATUS['WARNING'] EXIT_STATUS = STATUS["WARNING"]
print("\nDevices:\n" + "\n".join([ print(
( "\nDevices:\n"
f'- {name} (version = ' + "\n".join(
f'{dev["deployed_version"] if dev["deployed_version"] else "unknown"}' [
f', address = {dev["address"] if dev["address"] else "unknown"})' (
f"- {name} (version = "
f'{dev["deployed_version"] if dev["deployed_version"] else "unknown"}'
f', address = {dev["address"] if dev["address"] else "unknown"})'
)
for name, dev in devices.items()
]
) )
for name, dev in devices.items() )
]))
sys.exit(EXIT_STATUS) sys.exit(EXIT_STATUS)