From 4dce16df850348892d3d814c246f2aaad33a9539 Mon Sep 17 00:00:00 2001 From: Benjamin Renard Date: Thu, 19 Jan 2023 12:51:32 +0100 Subject: [PATCH] Initial release --- .gitignore | 3 ++ .woodpecker.yml | 70 +++++++++++++++++++++++++++ README.md | 41 ++++++++++++++++ build.sh | 62 ++++++++++++++++++++++++ check_forgejo_upgrade | 109 ++++++++++++++++++++++++++++++++++++++++++ debian/compat | 1 + debian/control | 15 ++++++ debian/copyright | 20 ++++++++ debian/dirs | 1 + debian/install | 1 + debian/rules | 4 ++ debian/source/format | 1 + 12 files changed, 328 insertions(+) create mode 100644 .gitignore create mode 100644 .woodpecker.yml create mode 100644 README.md create mode 100755 build.sh create mode 100755 check_forgejo_upgrade create mode 100644 debian/compat create mode 100644 debian/control create mode 100644 debian/copyright create mode 100644 debian/dirs create mode 100644 debian/install create mode 100755 debian/rules create mode 100644 debian/source/format diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..1be693d --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +*~ +.*.swp +/dist diff --git a/.woodpecker.yml b/.woodpecker.yml new file mode 100644 index 0000000..04857a1 --- /dev/null +++ b/.woodpecker.yml @@ -0,0 +1,70 @@ +clone: + git: + image: woodpeckerci/plugin-git + tags: true + +pipeline: + test-pylint: + group: test + image: debian:stable-slim + commands: + - 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 + - python3 -m pylint check_forgejo_upgrade + + test-flake8: + group: test + image: pipelinecomponents/flake8 + commands: + - flake8 check_forgejo_upgrade + + build: + image: brenard/debian-python-deb + when: + event: tag + commands: + - echo "$GPG_KEY"|base64 -d|gpg --import + - ./build.sh --quiet + secrets: [ maintainer_name, maintainer_email, gpg_key, debian_codename ] + + publish-dryrun: + group: publish + image: alpine + when: + event: tag + commands: + - ls dist/* dist/check-forgejo-upgrade-*/check_forgejo_upgrade + + publish-gitea: + group: publish + image: plugins/gitea-release + when: + event: tag + settings: + api_key: + from_secret: gitea_token + base_url: https://gitea.zionetrix.net + note: dist/release_notes.md + files: + - dist/check-forgejo-upgrade-*/check_forgejo_upgrade + - dist/*.deb + checksum: + - md5 + - sha512 + + publish-apt: + group: publish + image: brenard/aptly-publish + when: + event: tag + settings: + api_url: + from_secret: apt_api_url + api_username: + from_secret: apt_api_username + api_password: + from_secret: apt_api_password + repo_name: + from_secret: apt_repo_name + path: dist + source_name: check-forgejo-upgrade diff --git a/README.md b/README.md new file mode 100644 index 0000000..85f99b4 --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +# Monitoring plugin to check Forgejo instance upgrade status + +This Icinga/Nagios check plugin permit to check Forgejo instance upgrade status by comparing the local forgejo binary version against the latest stable release. + +## Installation + +``` +apt install git +git clone https://gitea.zionetrix.net/bn8/check_forgejo_upgrade.git /usr/local/src/check_forgejo_upgrade +mkdir -p /usr/local/lib/nagios/plugins +ln -s /usr/local/src/check_forgejo_upgrade/check_forgejo_upgrade /usr/local/lib/nagios/plugins/ +echo "command[check_forgejo_upgrade]=/usr/local/lib/nagios/plugins/check_forgejo_upgrade" > /etc/nagios/nrpe.d/forgejo.cfg +service nagios-nrpe-server reload +``` + +## Usage + +``` +usage: check_forgejo_upgrade [-h] [-d] [-p PATH] [-U URL] [--rc] + +optional arguments: + -h, --help show this help message and exit + -d, --debug + -p PATH, --path PATH Forgejo bin path + -U URL, --url URL Forgejo releases RSS URL + --rc Allow release candidate (default: only stable release are + considered) +``` + +## Copyright + +Copyright (c) 2023 Benjamin Renard + +## License + +This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License version 3 as published by the Free Software Foundation. + +This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. + +You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + diff --git a/build.sh b/build.sh new file mode 100755 index 0000000..762c456 --- /dev/null +++ b/build.sh @@ -0,0 +1,62 @@ +#!/bin/bash + +QUIET_ARG="" +[ "$1" == "--quiet" ] && QUIET_ARG="--quiet" + +# Enter source directory +cd $( dirname $0 ) + +echo "Clean previous build..." +rm -fr dist + +echo "Detect version using git describe..." +VERSION="$( git describe --tags|sed 's/^[^0-9]*//' )" + +echo "Create building environemt..." +BDIR=dist/check-forgejo-upgrade-$VERSION +mkdir -p $BDIR +[ -z "$QUIET_ARG" ] && RSYNC_ARG="-v" || RSYNC_ARG="" +rsync -a $RSYNC_ARG debian/ $BDIR/debian/ +cp check_forgejo_upgrade $BDIR/ + +echo "Set VERSION=$VERSION in gitdch using sed..." +sed -i "s/^VERSION *=.*$/VERSION = '$VERSION'/" $BDIR/check_forgejo_upgrade + +if [ -z "$DEBIAN_CODENAME" ] +then + echo "Retreive debian codename using lsb_release..." + DEBIAN_CODENAME=$( lsb_release -c -s ) +else + echo "Use debian codename from environment ($DEBIAN_CODENAME)" +fi + +echo "Generate debian changelog using gitdch..." +GITDCH_ARGS=('--verbose') +[ -n "$QUIET_ARG" ] && GITDCH_ARGS=('--warning') +if [ -n "$MAINTAINER_NAME" ] +then + echo "Use maintainer name from environment ($MAINTAINER_NAME)" + GITDCH_ARGS+=("--maintainer-name" "${MAINTAINER_NAME}") +fi +if [ -n "$MAINTAINER_EMAIL" ] +then + echo "Use maintainer email from environment ($MAINTAINER_EMAIL)" + GITDCH_ARGS+=("--maintainer-email" "$MAINTAINER_EMAIL") +fi +gitdch \ + --package-name check-forgejo-upgrade \ + --version "${VERSION}" \ + --code-name $DEBIAN_CODENAME \ + --output $BDIR/debian/changelog \ + --release-notes dist/release_notes.md \ + "${GITDCH_ARGS[@]}" + +if [ -n "$MAINTAINER_NAME" -a -n "$MAINTAINER_EMAIL" ] +then + echo "Set Maintainer field in debian control file ($MAINTAINER_NAME <$MAINTAINER_EMAIL>)..." + sed -i "s/^Maintainer: .*$/Maintainer: $MAINTAINER_NAME <$MAINTAINER_EMAIL>/" $BDIR/debian/control +fi + +echo "Build debian package..." +cd $BDIR +dpkg-buildpackage diff --git a/check_forgejo_upgrade b/check_forgejo_upgrade new file mode 100755 index 0000000..099f46b --- /dev/null +++ b/check_forgejo_upgrade @@ -0,0 +1,109 @@ +#!/usr/bin/python3 +""" +Icinga/Nagios plugin to check Forgejo instance upgrade status. + +Copyright (c) 2023 Benjamin Renard + +This program is free software; you can redistribute it and/or +modify it under the terms of the GNU General Public License version 3 +as published by the Free Software Foundation. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program; if not, write to the Free Software +Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. +""" + +import argparse +import logging +import re +import subprocess +import sys + +import requests +import xmltodict + +parser = argparse.ArgumentParser() + +parser.add_argument('-d', '--debug', action='store_true') +parser.add_argument( + '-p', '--path', type=str, + help='Forgejo bin path', default='forgejo') +parser.add_argument( + '-U', '--url', type=str, + help='Forgejo releases RSS URL', + default='https://forgejo.org/releases/rss.xml') +parser.add_argument( + '--rc', action='store_true', dest='include_rc', + help=( + 'Allow release candidate (default: only stable release are ' + 'considered)') +) + +options = parser.parse_args() + +logging.basicConfig(level=logging.DEBUG if options.debug else logging.WARNING) + +current = None + +cmd = [options.path, '--version'] +logging.debug( + 'Command use to retreive current version of Forgejo: %s', + ' '.join(cmd)) +out = None +exc = None +try: + out = subprocess.check_output(cmd) + logging.debug('Output:\n%s', out) + m = re.search('version ([^ ]+) built', out.decode('utf8', errors='ignore')) + if m: + current = m.group(1) +except Exception as err: + exc = err +logging.debug('Current version: %s', current) + +if not current: + print('UNKNOWN - Fail to retreive current Forgejo') + print(f'Command: {" ".join(cmd)}') + print('Output:') + print(out if out else "") + print('Exception:') + print(exc if exc else "") + sys.exit(3) + +latest = None +try: + logging.debug('Get releases RSS feed from %s...', options.url) + r = requests.get(options.url) + logging.debug('Data retreive:\n%s', r.text) + data = xmltodict.parse(r.text) + for item in data['rss']['channel']['item']: + version = re.sub('^v', '', item['title']) + if not options.include_rc and '-rc' in version: + logging.debug('Ignore release candidate %s', version) + continue + latest = version + break +except Exception: + pass +logging.debug('Latest version: %s', current) + +if not latest: + print( + 'UNKNOWN - Fail to retreive latest Forgejo release from the project ' + 'RSS feed') + print(f'Current version: {current}') + sys.exit(3) + +if latest == current: + print(f'OK - The latest release of Forgejo is currently used ({latest})') + sys.exit(0) + +print( + 'WARNING - The version of Forgejo currently used is not the latest ' + f'({current} vs {latest})') +sys.exit(1) diff --git a/debian/compat b/debian/compat new file mode 100644 index 0000000..b4de394 --- /dev/null +++ b/debian/compat @@ -0,0 +1 @@ +11 diff --git a/debian/control b/debian/control new file mode 100644 index 0000000..e18661c --- /dev/null +++ b/debian/control @@ -0,0 +1,15 @@ +Source: check-forgejo-upgrade +Section: admin +Priority: optional +Maintainer: Debian Zionetrix - check-forgejo-upgrade +Build-Depends: debhelper (>> 11.0.0) +Standards-Version: 3.9.6 + +Package: check-forgejo-upgrade +Architecture: all +Depends: ${misc:Depends}, python3, python3-requests +Description: Monitoring plugin to check Forgejo instance upgrade status + This Icinga/Nagios check plugin permit to check Forgejo instance upgrade + status by comparing the local forgejo binary version against the latest + stable release. + diff --git a/debian/copyright b/debian/copyright new file mode 100644 index 0000000..802bb35 --- /dev/null +++ b/debian/copyright @@ -0,0 +1,20 @@ +This package was written by Benjamin Renard . + +Copyright (C) 2023 Benjamin Renard + +check-forgejo-upgrade is licensed under the GNU general public license, version 3. + +check-forgejo-upgrade is free software; you can redistribute it and/or modify it under +the terms of the GNU General Public License as published by the Free Software +Foundation; either version 3, or (at your option) any later version. + +check-forgejo-upgrade is distributed in the hope that it will be useful, but WITHOUT ANY +WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A +PARTICULAR PURPOSE. See the GNU General Public License for more details. + +You should have received a copy of the GNU General Public License along with +check-forgejo-upgrade; see the file COPYING. If not, write to the Free Software +Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. + +On Debian systems, a copy of the GNU General Public License is available in +/usr/share/common-licenses/GPL-3 as part of the base-files package. diff --git a/debian/dirs b/debian/dirs new file mode 100644 index 0000000..b073cdc --- /dev/null +++ b/debian/dirs @@ -0,0 +1 @@ +usr/lib/nagios/plugins diff --git a/debian/install b/debian/install new file mode 100644 index 0000000..c11c16a --- /dev/null +++ b/debian/install @@ -0,0 +1 @@ +check_forgejo_upgrade usr/lib/nagios/plugins diff --git a/debian/rules b/debian/rules new file mode 100755 index 0000000..7451f59 --- /dev/null +++ b/debian/rules @@ -0,0 +1,4 @@ +#!/usr/bin/make -f +#export DH_VERBOSE=1 +%: + dh $@ diff --git a/debian/source/format b/debian/source/format new file mode 100644 index 0000000..d3827e7 --- /dev/null +++ b/debian/source/format @@ -0,0 +1 @@ +1.0