chore(deps): update devdeps non-major

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

.lycheeignore

@@ -0,0 +1 @@
+https://hub.docker.com/r/thegeeklab/*

.woodpecker/build-container.yml

@@ -6,15 +6,14 @@ when:
       - ${CI_REPO_DEFAULT_BRANCH}
 
 steps:
-  build:
+  - name: build
     image: docker.io/library/python:3.12
     commands:
-      - git fetch --depth=2147483647
       - pip install poetry poetry-dynamic-versioning -qq
       - poetry build
 
-  dryrun:
+  - name: dryrun
-    image: quay.io/thegeeklab/wp-docker-buildx:1
+    image: quay.io/thegeeklab/wp-docker-buildx:4
     settings:
       containerfile: Containerfile.multiarch
       dry_run: true
@@ -26,9 +25,9 @@ steps:
     when:
       - event: [pull_request]
 
-  publish-dockerhub:
+  - name: publish-dockerhub
+    image: quay.io/thegeeklab/wp-docker-buildx:4
     group: container
-    image: quay.io/thegeeklab/wp-docker-buildx:1
     settings:
       auto_tag: true
       containerfile: Containerfile.multiarch
@@ -47,9 +46,9 @@ steps:
         branch:
           - ${CI_REPO_DEFAULT_BRANCH}
 
-  publish-quay:
+  - name: publish-quay
+    image: quay.io/thegeeklab/wp-docker-buildx:4
     group: container
-    image: quay.io/thegeeklab/wp-docker-buildx:1
     settings:
       auto_tag: true
       containerfile: Containerfile.multiarch

.woodpecker/build-package.yml

@@ -6,27 +6,25 @@ when:
       - ${CI_REPO_DEFAULT_BRANCH}
 
 steps:
-  build:
+  - name: build
     image: docker.io/library/python:3.12
     commands:
-      - git fetch --depth=2147483647
       - pip install poetry poetry-dynamic-versioning -qq
       - poetry build
 
-  checksum:
+  - name: checksum
     image: quay.io/thegeeklab/alpine-tools
     commands:
       - cd dist/ && sha256sum * > ../sha256sum.txt
 
-  changelog:
+  - name: changelog
     image: quay.io/thegeeklab/git-sv
     commands:
-      - git fetch --depth=2147483647
       - git sv current-version
       - git sv release-notes -t ${CI_COMMIT_TAG:-next} -o CHANGELOG.md
       - cat CHANGELOG.md
 
-  publish-github:
+  - name: publish-github
     image: docker.io/plugins/github-release
     settings:
       api_key:
@@ -40,15 +38,14 @@ steps:
     when:
       - event: [tag]
 
-  publish-pypi:
+  - name: publish-pypi
     image: docker.io/library/python:3.12
     secrets:
-    - source: pypi_password
+      - source: pypi_password
-      target:  POETRY_HTTP_BASIC_PYPI_PASSWORD
+        target: POETRY_HTTP_BASIC_PYPI_PASSWORD
-    - source: pypi_username
+      - source: pypi_username
-      target:  POETRY_HTTP_BASIC_PYPI_USERNAME
+        target: POETRY_HTTP_BASIC_PYPI_USERNAME
     commands:
-      - git fetch --depth=2147483647
       - pip install poetry poetry-dynamic-versioning -qq
       - poetry publish -n
     when:

.woodpecker/docs.yml

@@ -6,51 +6,44 @@ when:
       - ${CI_REPO_DEFAULT_BRANCH}
 
 steps:
-  assets:
+  - name: assets
     image: quay.io/thegeeklab/alpine-tools
     commands:
       - make doc
 
-  markdownlint:
+  - name: markdownlint
     image: quay.io/thegeeklab/markdownlint-cli
     group: test
     commands:
       - markdownlint 'README.md' 'CONTRIBUTING.md'
 
-  spellcheck:
+  - name: spellcheck
     image: quay.io/thegeeklab/alpine-tools
     group: test
     commands:
-      - spellchecker --files '_docs/**/*.md' 'README.md' 'CONTRIBUTING.md' -d .dictionary -p spell indefinite-article syntax-urls
+      - spellchecker --files 'docs/**/*.md' 'README.md' 'CONTRIBUTING.md' -d .dictionary -p spell indefinite-article syntax-urls
     environment:
       FORCE_COLOR: "true"
-      NPM_CONFIG_LOGLEVEL: "error"
 
-  link-validation:
+  - name: link-validation
     image: docker.io/lycheeverse/lychee
     group: test
     commands:
       - lychee --no-progress --format detailed docs/content README.md
 
-  testbuild:
+  - name: build
-    image: quay.io/thegeeklab/hugo:0.115.2
+    image: quay.io/thegeeklab/hugo:0.125.7
-    commands:
-      - hugo --panicOnWarning -s docs/ -b http://localhost:8000/
-
-  build:
-    image: quay.io/thegeeklab/hugo:0.115.2
     commands:
       - hugo --panicOnWarning -s docs/
 
-  beautify:
+  - name: beautify
     image: quay.io/thegeeklab/alpine-tools
     commands:
       - html-beautify -r -f 'docs/public/**/*.html'
     environment:
       FORCE_COLOR: "true"
-      NPM_CONFIG_LOGLEVEL: error
 
-  publish:
+  - name: publish
     image: quay.io/thegeeklab/wp-s3-action
     settings:
       access_key:
@@ -69,15 +62,15 @@ steps:
       - event: [push, manual]
         branch:
           - ${CI_REPO_DEFAULT_BRANCH}
-        status: [success]
+        status: [success, failure]
 
-  pushrm-dockerhub:
+  - name: pushrm-dockerhub
     image: docker.io/chko/docker-pushrm:1
     secrets:
       - source: docker_password
-        target:  DOCKER_PASS
+        target: DOCKER_PASS
       - source: docker_username
-        target:  DOCKER_USER
+        target: DOCKER_USER
     environment:
       PUSHRM_FILE: README.md
       PUSHRM_SHORT: Prometheus Service Discovery for Proxmox VE
@@ -88,7 +81,7 @@ steps:
           - ${CI_REPO_DEFAULT_BRANCH}
         status: [success]
 
-  pushrm-quay:
+  - name: pushrm-quay
     image: docker.io/chko/docker-pushrm:1
     secrets:
       - source: quay_token

.woodpecker/lint.yml

@@ -6,22 +6,20 @@ when:
       - ${CI_REPO_DEFAULT_BRANCH}
 
 steps:
-  check-format:
+  - name: check-format
     image: docker.io/library/python:3.12
     commands:
-      - git fetch --depth=2147483647
       - pip install poetry poetry-dynamic-versioning -qq
       - poetry install
-      - poetry run yapf -dr ./${CI_REPO_NAME//-/}
+      - poetry run ruff format --check --diff ./${CI_REPO_NAME//-/}
     environment:
       PY_COLORS: "1"
 
-  check-coding:
+  - name: check-coding
     image: docker.io/library/python:3.12
     commands:
-      - git fetch --depth=2147483647
       - pip install poetry poetry-dynamic-versioning -qq
       - poetry install
-      - poetry run ruff ./${CI_REPO_NAME//-/}
+      - poetry run ruff check ./${CI_REPO_NAME//-/}
     environment:
       PY_COLORS: "1"

.woodpecker/notify.yml

@@ -8,7 +8,7 @@ when:
 runs_on: [success, failure]
 
 steps:
-  matrix:
+  - name: matrix
     image: quay.io/thegeeklab/wp-matrix
     settings:
       homeserver:

.woodpecker/test.yml

@@ -5,19 +5,10 @@ when:
     branch:
       - ${CI_REPO_DEFAULT_BRANCH}
 
-matrix:
+variables:
-  PYTHON_VERSION:
+  - &pytest_base
-    - "3.8"
+    group: pytest
-    - "3.9"
-    - "3.10"
-    - "3.11"
-    - "3.12"
-
-steps:
-  pytest:
-    image: docker.io/library/python:${PYTHON_VERSION}
     commands:
-      - git fetch --depth=2147483647
       - pip install poetry poetry-dynamic-versioning -qq
       - poetry install
       - poetry run pytest --cov-append
@@ -25,3 +16,24 @@ steps:
       - poetry run ${CI_REPO_NAME} --help
     environment:
       PY_COLORS: "1"
+
+steps:
+  - name: python-312
+    image: docker.io/library/python:3.12
+    <<: *pytest_base
+
+  - name: python-311
+    image: docker.io/library/python:3.11
+    <<: *pytest_base
+
+  - name: python-310
+    image: docker.io/library/python:3.10
+    <<: *pytest_base
+
+  - name: python-39
+    image: docker.io/library/python:3.9
+    <<: *pytest_base
+
+  - name: python-38
+    image: docker.io/library/python:3.8
+    <<: *pytest_base

Containerfile.multiarch

@@ -1,4 +1,4 @@
-FROM python:3.12-alpine@sha256:a5d1738d6abbdff3e81c10b7f86923ebcb340ca536e21e8c5ee7d938d263dba1
+FROM python:3.12-alpine@sha256:5365725a6cd59b72a927628fdda9965103e3dc671676c89ef3ed8b8b0e22e812
 
 LABEL maintainer="Robert Kaussow <mail@thegeeklab.de>"
 LABEL org.opencontainers.image.authors="Robert Kaussow <mail@thegeeklab.de>"

Makefile

@@ -1,5 +1,5 @@
 # renovate: datasource=github-releases depName=thegeeklab/hugo-geekdoc
-THEME_VERSION := v0.44.0
+THEME_VERSION := v0.45.0
 THEME := hugo-geekdoc
 BASEDIR := docs
 THEMEDIR := $(BASEDIR)/themes

prometheuspvesd/cli.py

@@ -59,7 +59,7 @@ class PrometheusSD:
             "--config",
             dest="config_file",
             action="store",
-            help="location of configuration file"
+            help="location of configuration file",
         )
         parser.add_argument(
             "-o", "--output", dest="output_file", action="store", help="output file"
@@ -73,14 +73,14 @@ class PrometheusSD:
             dest="loop_delay",
             action="store",
             type=int,
-            help="delay between discovery runs"
+            help="delay between discovery runs",
         )
         parser.add_argument(
             "--no-service",
             dest="service",
             action="store_false",
             default=None,
-            help="run discovery only once"
+            help="run discovery only once",
         )
         parser.add_argument(
             "-f",
@@ -88,7 +88,7 @@ class PrometheusSD:
             dest="logging.format",
             metavar="LOG_FORMAT",
             action="store",
-            help="used log format"
+            help="used log format",
         )
         parser.add_argument(
             "-v", dest="logging.level", action="append_const", const=-1, help="increase log level"
@@ -113,15 +113,16 @@ class PrometheusSD:
         except ValueError as e:
             self.log.sysexit_with_message(f"Can not set log level.\n{e!s}")
 
-        required = [("pve.server", config.config["pve"]["server"]),
+        required = [
-                    ("pve.user", config.config["pve"]["user"])]
+            ("pve.server", config.config["pve"]["server"]),
+            ("pve.user", config.config["pve"]["user"]),
+        ]
         for name, value in required:
             if not value:
                 self.log.sysexit_with_message(f"Option '{name}' is required but not set")
 
-        if (
+        if not config.config["pve"]["password"] and not (
-            not config.config["pve"]["password"]
+            config.config["pve"]["token_name"] and config.config["pve"]["token_value"]
-            and not (config.config["pve"]["token_name"] and config.config["pve"]["token_value"])
         ):
             self.log.sysexit_with_message(
                 "Either 'pve.password' or 'pve.token_name' and 'pve.token_value' "
@@ -144,7 +145,7 @@ class PrometheusSD:
             )
             start_http_server(
                 self.config.config["metrics"]["port"],
-                addr=self.config.config["metrics"]["address"]
+                addr=self.config.config["metrics"]["address"],
             )
 
         while True:

prometheuspvesd/client.py

@@ -1,4 +1,5 @@
 """Proxmox Client."""
+
 import requests
 from prometheus_client import Counter
 
@@ -10,6 +11,7 @@ from prometheuspvesd.utils import to_bool
 
 try:
     from proxmoxer import ProxmoxAPI
+
     HAS_PROXMOXER = True
 except ImportError:
     HAS_PROXMOXER = False
@@ -53,7 +55,7 @@ class ProxmoxClient:
                     token_name=self.config.config["pve"]["token_name"],
                     token_value=self.config.config["pve"]["token_value"],
                     verify_ssl=to_bool(self.config.config["pve"]["verify_ssl"]),
-                    timeout=self.config.config["pve"]["auth_timeout"]
+                    timeout=self.config.config["pve"]["auth_timeout"],
                 )
 
             return ProxmoxAPI(
@@ -61,7 +63,7 @@ class ProxmoxClient:
                 user=self.config.config["pve"]["user"],
                 password=self.config.config["pve"]["password"],
                 verify_ssl=to_bool(self.config.config["pve"]["verify_ssl"]),
-                timeout=self.config.config["pve"]["auth_timeout"]
+                timeout=self.config.config["pve"]["auth_timeout"],
             )
         except requests.RequestException as e:
             PVE_REQUEST_COUNT_ERROR_TOTAL.inc()
@@ -98,5 +100,6 @@ class ProxmoxClient:
 
     def get_network_interfaces(self, pve_node, vmid):
         self.logger.debug(f"fetching network interfaces for {vmid} on {pve_node}")
-        return self._do_request(pve_node, "qemu", vmid, "agent",
+        return self._do_request(pve_node, "qemu", vmid, "agent", "network-get-interfaces")[
-                                "network-get-interfaces")["result"]
+            "result"
+        ]

prometheuspvesd/config.py

@@ -34,130 +34,130 @@ class Config:
         "metrics.enabled": {
             "default": True,
             "env": "METRICS_ENABLED",
-            "type": environs.Env().bool
+            "type": environs.Env().bool,
         },
         "metrics.address": {
             "default": "127.0.0.1",
             "env": "METRICS_ADDRESS",
-            "type": environs.Env().str
+            "type": environs.Env().str,
         },
         "metrics.port": {
             "default": 8000,
             "env": "METRICS_PORT",
-            "type": environs.Env().int
+            "type": environs.Env().int,
         },
         "config_file": {
             "default": "",
             "env": "CONFIG_FILE",
-            "type": environs.Env().str
+            "type": environs.Env().str,
         },
         "logging.level": {
             "default": "WARNING",
             "env": "LOG_LEVEL",
             "file": True,
-            "type": environs.Env().str
+            "type": environs.Env().str,
         },
         "logging.format": {
             "default": "console",
             "env": "LOG_FORMAT",
             "file": True,
-            "type": environs.Env().str
+            "type": environs.Env().str,
         },
         "output_file": {
             "default": default_output_file,
             "env": "OUTPUT_FILE",
             "file": True,
-            "type": environs.Env().str
+            "type": environs.Env().str,
         },
         "output_file_mode": {
             "default": "0640",
             "env": "OUTPUT_FILE_MODE",
             "file": True,
-            "type": environs.Env().str
+            "type": environs.Env().str,
         },
         "loop_delay": {
             "default": 300,
             "env": "LOOP_DELAY",
             "file": True,
-            "type": environs.Env().int
+            "type": environs.Env().int,
         },
         "service": {
             "default": True,
             "env": "SERVICE",
             "file": True,
-            "type": environs.Env().bool
+            "type": environs.Env().bool,
         },
         "exclude_state": {
             "default": [],
             "env": "EXCLUDE_STATE",
             "file": True,
-            "type": environs.Env().list
+            "type": environs.Env().list,
         },
         "exclude_vmid": {
             "default": [],
             "env": "EXCLUDE_VMID",
             "file": True,
-            "type": environs.Env().list
+            "type": environs.Env().list,
         },
         "include_vmid": {
             "default": [],
             "env": "INCLUDE_VMID",
             "file": True,
-            "type": environs.Env().list
+            "type": environs.Env().list,
         },
         "exclude_tags": {
             "default": [],
             "env": "EXCLUDE_TAGS",
             "file": True,
-            "type": environs.Env().list
+            "type": environs.Env().list,
         },
         "include_tags": {
             "default": [],
             "env": "INCLUDE_TAGS",
             "file": True,
-            "type": environs.Env().list
+            "type": environs.Env().list,
         },
         "pve.server": {
             "default": "",
             "env": "PVE_SERVER",
             "file": True,
-            "type": environs.Env().str
+            "type": environs.Env().str,
         },
         "pve.user": {
             "default": "",
             "env": "PVE_USER",
             "file": True,
-            "type": environs.Env().str
+            "type": environs.Env().str,
         },
         "pve.password": {
             "default": "",
             "env": "PVE_PASSWORD",
             "file": True,
-            "type": environs.Env().str
+            "type": environs.Env().str,
         },
         "pve.token_name": {
             "default": "",
             "env": "PVE_TOKEN_NAME",
             "file": True,
-            "type": environs.Env().str
+            "type": environs.Env().str,
         },
         "pve.token_value": {
             "default": "",
             "env": "PVE_TOKEN_VALUE",
             "file": True,
-            "type": environs.Env().str
+            "type": environs.Env().str,
         },
         "pve.auth_timeout": {
             "default": 5,
             "env": "PVE_AUTH_TIMEOUT",
             "file": True,
-            "type": environs.Env().int
+            "type": environs.Env().int,
         },
         "pve.verify_ssl": {
             "default": True,
             "env": "PVE_VERIFY_SSL",
             "file": True,
-            "type": environs.Env().bool
+            "type": environs.Env().bool,
         },
     }
 
@@ -245,7 +245,8 @@ class Config:
                     try:
                         file_dict = ruamel.yaml.YAML(typ="safe", pure=True).load(s)
                     except (
-                        ruamel.yaml.composer.ComposerError, ruamel.yaml.scanner.ScannerError
+                        ruamel.yaml.composer.ComposerError,
+                        ruamel.yaml.scanner.ScannerError,
                     ) as e:
                         message = f"{e.context} {e.problem}"
                         raise prometheuspvesd.exception.ConfigError(
@@ -284,20 +285,19 @@ class Config:
         try:
             anyconfig.validate(config, self.schema, ac_schema_safe=False)
         except jsonschema.exceptions.ValidationError as e:
-            schema_error = "Failed validating '{validator}' in schema{schema}\n{message}".format(
+            schema = format_as_index(list(e.relative_schema_path)[:-1], 0)
-                validator=e.validator,
+            schema_error = f"Failed validating '{e.validator}' in schema {schema}\n{e.message}"
-                schema=format_as_index(list(e.relative_schema_path)[:-1], 0),
-                message=e.message
-            )
             raise prometheuspvesd.exception.ConfigError("Configuration error", schema_error) from e
 
         return True
 
     def _add_dict_branch(self, tree, vector, value):
         key = vector[0]
-        tree[key] = value \
+        tree[key] = (
-            if len(vector) == 1 \
+            value
-            else self._add_dict_branch(tree[key] if key in tree else {}, vector[1:], value)
+            if len(vector) == 1
+            else self._add_dict_branch(tree.get(key, {}), vector[1:], value)
+        )
         return tree
 
 

prometheuspvesd/discovery.py

@@ -111,17 +111,22 @@ class Discovery:
         filtered = []
         for item in pve_list:
             obj = defaultdict(dict, item)
+            tags = []
+            tags_excl = self.config.config["exclude_tags"]
+
+            if isinstance(obj["tags"], str):
+                tags = obj["tags"].split(";")
+                self.logger.debug(f"vmid {obj['vmid']}: discovered tags: {tags}")
+
             if (
                 len(self.config.config["include_vmid"]) > 0
                 and str(obj["vmid"]) not in self.config.config["include_vmid"]
             ):
                 continue
 
-            if (
+            if len(self.config.config["include_tags"]) > 0 and (
-                len(self.config.config["include_tags"]) > 0 and (
+                bool(obj["tags"]) is False  # continue if tags is not set
-                    bool(obj["tags"]) is False  # continue if tags is not set
+                or set(tags).isdisjoint(self.config.config["include_tags"])
-                    or set(obj["tags"].split(",")).isdisjoint(self.config.config["include_tags"])
-                )
             ):
                 continue
 
@@ -134,10 +139,11 @@ class Discovery:
             if str(obj["vmid"]) in self.config.config["exclude_vmid"]:
                 continue
 
-            if (
+            if isinstance(obj["tags"], str) and not set(tags).isdisjoint(tags_excl):
-                isinstance(obj["tags"], str)
+                self.logger.debug(
-                and not set(obj["tags"].split(",")).isdisjoint(self.config.config["exclude_tags"])
+                    f"vmid {obj['vmid']}: "
-            ):
+                    f"excluded by tags: {list(set(tags).intersection(tags_excl))}"
+                )
                 continue
 
             filtered.append(item.copy())
@@ -162,7 +168,7 @@ class Discovery:
             try:
                 qemu_list = self._filter(self.client.get_all_vms(node))
                 container_list = self._filter(self.client.get_all_containers(node))
-            except Exception as e:  # noqa
+            except Exception as e:
                 raise APIError(str(e)) from e
 
             # Merge QEMU and Containers lists from this node
@@ -183,10 +189,10 @@ class Discovery:
                 config = self.client.get_instance_config(node, pve_type, vmid)
 
                 try:
-                    description = (config["description"])
+                    description = config["description"]
                 except KeyError:
                     description = None
-                except Exception as e:  # noqa
+                except Exception as e:
                     raise APIError(str(e)) from e
 
                 try:

prometheuspvesd/logger.py

@@ -46,14 +46,14 @@ class LogFilter:
 class SimpleFormatter(logging.Formatter):
     """Logging Formatter for simple logs."""
 
-    def format(self, record):  # noqa
+    def format(self, record):
         return logging.Formatter.format(self, record)
 
 
 class MultilineFormatter(logging.Formatter):
     """Logging Formatter to reset color after newline characters."""
 
-    def format(self, record):  # noqa
+    def format(self, record):
         record.msg = record.msg.replace("\n", f"\n{colorama.Style.RESET_ALL}... ")
         return logging.Formatter.format(self, record)
 
@@ -61,7 +61,7 @@ class MultilineFormatter(logging.Formatter):
 class MultilineJsonFormatter(jsonlogger.JsonFormatter):
     """Logging Formatter to remove newline characters."""
 
-    def format(self, record):  # noqa
+    def format(self, record):
         record.msg = record.msg.replace("\n", " ")
         return jsonlogger.JsonFormatter.format(self, record)
 

prometheuspvesd/test/fixtures/fixtures.py

@@ -3,8 +3,7 @@
 import environs
 import pytest
 
-from prometheuspvesd.model import Host
+from prometheuspvesd.model import Host, HostList
-from prometheuspvesd.model import HostList
 
 
 @pytest.fixture
@@ -13,131 +12,118 @@ def builtins():
         "metrics.enabled": {
             "default": True,
             "env": "METRICS_ENABLED",
-            "type": environs.Env().bool
+            "type": environs.Env().bool,
         },
         "metrics.address": {
             "default": "127.0.0.1",
             "env": "METRICS_ADDRESS",
-            "type": environs.Env().str
+            "type": environs.Env().str,
-        },
-        "metrics.port": {
-            "default": 8000,
-            "env": "METRICS_PORT",
-            "type": environs.Env().int
-        },
-        "config_file": {
-            "default": "",
-            "env": "CONFIG_FILE",
-            "type": environs.Env().str
         },
+        "metrics.port": {"default": 8000, "env": "METRICS_PORT", "type": environs.Env().int},
+        "config_file": {"default": "", "env": "CONFIG_FILE", "type": environs.Env().str},
         "logging.level": {
             "default": "WARNING",
             "env": "LOG_LEVEL",
             "file": True,
-            "type": environs.Env().str
+            "type": environs.Env().str,
         },
         "logging.format": {
             "default": "console",
             "env": "LOG_FORMAT",
             "file": True,
-            "type": environs.Env().str
+            "type": environs.Env().str,
         },
         "output_file": {
             "default": "dummy",
             "env": "OUTPUT_FILE",
             "file": True,
-            "type": environs.Env().str
+            "type": environs.Env().str,
         },
         "output_file_mode": {
             "default": "0640",
             "env": "OUTPUT_FILE_MODE",
             "file": True,
-            "type": environs.Env().str
+            "type": environs.Env().str,
         },
         "loop_delay": {
             "default": 300,
             "env": "LOOP_DELAY",
             "file": True,
-            "type": environs.Env().int
+            "type": environs.Env().int,
-        },
-        "service": {
-            "default": False,
-            "env": "SERVICE",
-            "file": True,
-            "type": environs.Env().bool
         },
+        "service": {"default": False, "env": "SERVICE", "file": True, "type": environs.Env().bool},
         "exclude_state": {
             "default": [],
             "env": "EXCLUDE_STATE",
             "file": True,
-            "type": environs.Env().list
+            "type": environs.Env().list,
         },
         "exclude_vmid": {
             "default": [],
             "env": "EXCLUDE_VMID",
             "file": True,
-            "type": environs.Env().list
+            "type": environs.Env().list,
         },
         "exclude_tags": {
             "default": [],
             "env": "EXCLUDE_TAGS",
             "file": True,
-            "type": environs.Env().list
+            "type": environs.Env().list,
         },
         "include_vmid": {
             "default": [],
             "env": "INCLUDE_VMID",
             "file": True,
-            "type": environs.Env().list
+            "type": environs.Env().list,
         },
         "include_tags": {
             "default": [],
             "env": "INCLUDE_TAGS",
             "file": True,
-            "type": environs.Env().list
+            "type": environs.Env().list,
         },
         "pve.server": {
             "default": "dummyserver",
             "env": "PVE_SERVER",
             "file": True,
-            "type": environs.Env().str
+            "type": environs.Env().str,
         },
         "pve.user": {
             "default": "dummyuser",
             "env": "PVE_USER",
             "file": True,
-            "type": environs.Env().str
+            "type": environs.Env().str,
         },
         "pve.password": {
             "default": "dummypass",
             "env": "PVE_PASSWORD",
             "file": True,
-            "type": environs.Env().str
+            "type": environs.Env().str,
         },
         "pve.token_name": {
             "default": "dummyname",
             "env": "PVE_TOKEN_NAME",
             "file": True,
-            "type": environs.Env().str
+            "type": environs.Env().str,
         },
         "pve.token_value": {
             "default": "dummyvalue",
             "env": "PVE_TOKEN_VALUE",
             "file": True,
-            "type": environs.Env().str
+            "type": environs.Env().str,
         },
         "pve.auth_timeout": {
             "default": 5,
             "env": "PVE_AUTH_TIMEOUT",
             "file": True,
-            "type": environs.Env().int
+            "type": environs.Env().int,
         },
         "pve.verify_ssl": {
             "default": True,
             "env": "PVE_VERIFY_SSL",
             "file": True,
-            "type": environs.Env().bool
+            "type": environs.Env().bool,
-        }
+        },
     }
 
 
@@ -149,16 +135,9 @@ def defaults():
         "exclude_vmid": [],
         "include_tags": [],
         "include_vmid": [],
-        "logging": {
+        "logging": {"format": "console", "level": "WARNING"},
-            "format": "console",
-            "level": "WARNING"
-        },
         "loop_delay": 300,
-        "metrics": {
+        "metrics": {"address": "127.0.0.1", "enabled": True, "port": 8000},
-            "address": "127.0.0.1",
-            "enabled": True,
-            "port": 8000
-        },
         "output_file": "dummy",
         "output_file_mode": "0640",
         "pve": {
@@ -168,7 +147,7 @@ def defaults():
             "user": "",
             "token_name": "",
             "token_value": "",
-            "verify_ssl": True
+            "verify_ssl": True,
         },
         "service": True,
     }
@@ -176,20 +155,22 @@ def defaults():
 
 @pytest.fixture
 def nodes():
-    return [{
+    return [
-        "level": "",
+        {
-        "id": "node/example-node",
+            "level": "",
-        "disk": 4783488,
+            "id": "node/example-node",
-        "cpu": 0.0935113631167406,
+            "disk": 4783488,
-        "maxcpu": 24,
+            "cpu": 0.0935113631167406,
-        "maxmem": 142073272990,
+            "maxcpu": 24,
-        "mem": 135884478304,
+            "maxmem": 142073272990,
-        "node": "example-node",
+            "mem": 135884478304,
-        "type": "node",
+            "node": "example-node",
-        "status": "online",
+            "type": "node",
-        "maxdisk": 504209920,
+            "status": "online",
-        "uptime": 200
+            "maxdisk": 504209920,
-    }]
+            "uptime": 200,
+        }
+    ]
 
 
 @pytest.fixture
@@ -212,7 +193,7 @@ def qemus():
             "status": "running",
             "netout": 12159205236,
             "mem": 496179157,
-            "tags": "unmonitored,excluded,postgres"
+            "tags": "unmonitored;excluded;postgres",
         },
         {
             "diskwrite": 0,
@@ -230,7 +211,7 @@ def qemus():
             "disk": 0,
             "status": "running",
             "netout": 12159205236,
-            "mem": 496179157
+            "mem": 496179157,
         },
         {
             "diskwrite": 0,
@@ -249,7 +230,7 @@ def qemus():
             "status": "prelaunch",
             "netout": 12159205236,
             "mem": 496179157,
-            "tags": "monitored"
+            "tags": "monitored",
         },
     ]
 
@@ -261,19 +242,17 @@ def instance_config():
         "description": '{"groups": "test-group"}',
         "net0": "virtio=D8-85-75-47-2E-8D,bridge=vmbr122,ip=192.0.2.25,ip=2001:db8::666:77:8888",
         "cpu": 2,
-        "cores": 2
+        "cores": 2,
     }
 
 
 @pytest.fixture
 def agent_info():
     return {
-        "supported_commands": [{
+        "supported_commands": [
-            "name": "guest-network-get-interfaces",
+            {"name": "guest-network-get-interfaces", "enabled": True, "success-response": True}
-            "enabled": True,
+        ],
-            "success-response": True
+        "version": "5.2.0",
-        }],
-        "version": "5.2.0"
     }
 
 
@@ -310,16 +289,8 @@ def networks():
         {
             "hardware-address": "00:00:00:00:00:00",
             "ip-addresses": [
-                {
+                {"ip-address": "127.0.0.1", "ip-address-type": "ipv4", "prefix": 8},
-                    "ip-address": "127.0.0.1",
+                {"ip-address": "::1", "ip-address-type": "ipv6", "prefix": 128},
-                    "ip-address-type": "ipv4",
-                    "prefix": 8
-                },
-                {
-                    "ip-address": "::1",
-                    "ip-address-type": "ipv6",
-                    "prefix": 128
-                },
             ],
             "name": "lo",
             "statistics": {
@@ -330,26 +301,18 @@ def networks():
                 "tx-bytes": 9280,
                 "tx-dropped": 0,
                 "tx-errs": 0,
-                "tx-packets": 92
+                "tx-packets": 92,
-            }
+            },
         },
         {
             "hardware-address": "92:0b:bd:c1:f8:39",
             "ip-addresses": [
-                {
+                {"ip-address": "192.0.2.1", "ip-address-type": "ipv4", "prefix": 32},
-                    "ip-address": "192.0.2.1",
+                {"ip-address": "192.0.2.4", "ip-address-type": "ipv4", "prefix": 32},
-                    "ip-address-type": "ipv4",
-                    "prefix": 32
-                },
-                {
-                    "ip-address": "192.0.2.4",
-                    "ip-address-type": "ipv4",
-                    "prefix": 32
-                },
                 {
                     "ip-address": "2001:db8:3333:4444:5555:6666:7777:8888",
                     "ip-address-type": "ipv6",
-                    "prefix": 64
+                    "prefix": 64,
                 },
             ],
             "name": "eth0",
@@ -361,13 +324,10 @@ def networks():
                 "tx-bytes": 12185866619,
                 "tx-dropped": 0,
                 "tx-errs": 0,
-                "tx-packets": 14423878
+                "tx-packets": 14423878,
-            }
+            },
-        },
-        {
-            "hardware-address": "ba:97:85:bd:9a:a5",
-            "name": "eth1"
         },
+        {"hardware-address": "ba:97:85:bd:9a:a5", "name": "eth1"},
     ]
 
 
@@ -383,31 +343,35 @@ def inventory():
 
 @pytest.fixture
 def labels():
-    return [{
+    return [
-        "targets": ["100.example.com"],
+        {
-        "labels": {
+            "targets": ["100.example.com"],
-            "__meta_pve_ipv4": "192.0.2.1",
+            "labels": {
-            "__meta_pve_ipv6": "False",
+                "__meta_pve_ipv4": "192.0.2.1",
-            "__meta_pve_name": "100.example.com",
+                "__meta_pve_ipv6": "False",
-            "__meta_pve_type": "qemu",
+                "__meta_pve_name": "100.example.com",
-            "__meta_pve_vmid": "100"
+                "__meta_pve_type": "qemu",
-        }
+                "__meta_pve_vmid": "100",
-    }, {
+            },
-        "targets": ["101.example.com"],
+        },
-        "labels": {
+        {
-            "__meta_pve_ipv4": "192.0.2.2",
+            "targets": ["101.example.com"],
-            "__meta_pve_ipv6": "False",
+            "labels": {
-            "__meta_pve_name": "101.example.com",
+                "__meta_pve_ipv4": "192.0.2.2",
-            "__meta_pve_type": "qemu",
+                "__meta_pve_ipv6": "False",
-            "__meta_pve_vmid": "101"
+                "__meta_pve_name": "101.example.com",
-        }
+                "__meta_pve_type": "qemu",
-    }, {
+                "__meta_pve_vmid": "101",
-        "targets": ["102.example.com"],
+            },
-        "labels": {
+        },
-            "__meta_pve_ipv4": "192.0.2.3",
+        {
-            "__meta_pve_ipv6": "False",
+            "targets": ["102.example.com"],
-            "__meta_pve_name": "102.example.com",
+            "labels": {
-            "__meta_pve_type": "qemu",
+                "__meta_pve_ipv4": "192.0.2.3",
-            "__meta_pve_vmid": "102"
+                "__meta_pve_ipv6": "False",
-        }
+                "__meta_pve_name": "102.example.com",
-    }]
+                "__meta_pve_type": "qemu",
+                "__meta_pve_vmid": "102",
+            },
+        },
+    ]

prometheuspvesd/test/unit/conftest.py

@@ -1,8 +1,12 @@
 """Pytest conftest fixtures."""
+
+import logging
 import os
 import sys
+from contextlib import contextmanager
 
 import pytest
+from _pytest.logging import LogCaptureHandler
 
 from prometheuspvesd.utils import Singleton
 
@@ -14,9 +18,43 @@ def reset_singletons():
 
 @pytest.fixture(autouse=True)
 def reset_os_environment():
-    os.environ = {}
+    os.environ.clear()
 
 
 @pytest.fixture(autouse=True)
 def reset_sys_argv():
     sys.argv = ["prometheus-pve-sd"]
+
+
+@contextmanager
+def local_caplog_fn(level=logging.INFO, name="prometheuspvesd"):
+    """
+    Context manager that captures records from non-propagating loggers.
+
+    After the end of the 'with' statement, the log level is restored to its original
+    value. Code adapted from https://github.com/pytest-dev/pytest/issues/3697#issuecomment-790925527.
+
+    :param int level: The level.
+    :param logging.Logger logger: The logger to update.
+    """
+
+    logger = logging.getLogger(name)
+
+    old_level = logger.level
+    logger.setLevel(level)
+
+    handler = LogCaptureHandler()
+    logger.addHandler(handler)
+
+    try:
+        yield handler
+    finally:
+        logger.setLevel(old_level)
+        logger.removeHandler(handler)
+
+
+@pytest.fixture
+def local_caplog():
+    """Fixture that yields a context manager for capturing records from non-propagating loggers."""
+
+    yield local_caplog_fn

prometheuspvesd/test/unit/test_cli.py

@@ -1,4 +1,5 @@
 """Test CLI class."""
+
 import json
 
 import pytest
@@ -30,22 +31,22 @@ def test_cli_required_error(mocker, capsys):
 
 
 @pytest.mark.parametrize(
-    "testinput", [{
+    "testinput",
-        "pve.user": "dummy",
+    [
-        "pve.password": "",
+        {"pve.user": "dummy", "pve.password": "", "pve.token_name": "", "pve.token_value": ""},
-        "pve.token_name": "",
+        {
-        "pve.token_value": ""
+            "pve.user": "dummy",
-    }, {
+            "pve.password": "",
-        "pve.user": "dummy",
+            "pve.token_name": "dummy",
-        "pve.password": "",
+            "pve.token_value": "",
-        "pve.token_name": "dummy",
+        },
-        "pve.token_value": ""
+        {
-    }, {
+            "pve.user": "dummy",
-        "pve.user": "dummy",
+            "pve.password": "",
-        "pve.password": "",
+            "pve.token_name": "",
-        "pve.token_name": "",
+            "pve.token_value": "dummy",
-        "pve.token_value": "dummy"
+        },
-    }]
+    ],
 )
 def test_cli_auth_required_error(mocker, capsys, builtins, testinput):
     for key, value in testinput.items():
@@ -59,22 +60,21 @@ def test_cli_auth_required_error(mocker, capsys, builtins, testinput):
         PrometheusSD()
 
     stdout, stderr = capsys.readouterr()
-    assert "Either 'pve.password' or 'pve.token_name' and 'pve.token_value' are required but not set" in stderr
+    assert (
+        "Either 'pve.password' or 'pve.token_name' and 'pve.token_value' are required but not set"
+        in stderr
+    )
     assert e.value.code == 1
 
 
 @pytest.mark.parametrize(
-    "testinput", [{
+    "testinput",
-        "pve.password": "dummy",
+    [
-        "pve.token_name": "",
+        {"pve.password": "dummy", "pve.token_name": "", "pve.token_value": ""},
-        "pve.token_value": ""
+        {"pve.password": "", "pve.token_name": "dummy", "pve.token_value": "dummy"},
-    }, {
+    ],
-        "pve.password": "",
-        "pve.token_name": "dummy",
-        "pve.token_value": "dummy"
-    }]
 )
-def test_cli_auth_no_error(mocker, capsys, builtins, testinput):
+def test_cli_auth_no_error(mocker, builtins, testinput):
     for key, value in testinput.items():
         builtins[key]["default"] = value
 
@@ -91,7 +91,7 @@ def test_cli_auth_no_error(mocker, capsys, builtins, testinput):
 def test_cli_config_error(mocker, capsys):
     mocker.patch(
         "prometheuspvesd.config.SingleConfig.__init__",
-        side_effect=prometheuspvesd.exception.ConfigError("Dummy Config Exception")
+        side_effect=prometheuspvesd.exception.ConfigError("Dummy Config Exception"),
     )
     mocker.patch.object(ProxmoxClient, "_auth", return_value=mocker.create_autospec(ProxmoxAPI))
     mocker.patch.object(PrometheusSD, "_fetch", return_value=True)

prometheuspvesd/test/unit/test_config.py

@@ -1,4 +1,5 @@
 """Test Config class."""
+
 import pytest
 import ruamel.yaml
 
@@ -25,7 +26,7 @@ def test_yaml_config(mocker, defaults):
     assert config.config == defaults
 
 
-def test_yaml_config_error(mocker, capsys):
+def test_yaml_config_error(mocker):
     mocker.patch(
         "prometheuspvesd.config.default_config_file", "./prometheuspvesd/test/data/config.yml"
     )

prometheuspvesd/test/unit/test_discovery.py

@@ -1,5 +1,7 @@
 """Test Discovery class."""
 
+import logging
+
 import pytest
 from proxmoxer import ProxmoxAPI
 
@@ -11,6 +13,10 @@ pytest_plugins = [
 ]
 
 
+def records_to_messages(records):
+    return [r.getMessage() for r in records]
+
+
 @pytest.fixture
 def discovery(mocker):
     mocker.patch.object(ProxmoxClient, "_auth", return_value=mocker.create_autospec(ProxmoxAPI))
@@ -32,19 +38,27 @@ def test_exclude_state(discovery, qemus):
     assert len(filtered) == 2
 
 
-def test_exclude_tags(discovery, qemus):
+def test_exclude_tags(discovery, qemus, local_caplog):
     discovery.config.config["exclude_tags"] = ["unmonitored"]
-    filtered = discovery._filter(qemus)
 
+    with local_caplog(level=logging.DEBUG) as caplog:
+        filtered = discovery._filter(qemus)
+
+    assert (
+        "vmid 100: discovered tags: ['unmonitored', 'excluded', 'postgres']"
+        in records_to_messages(caplog.records)
+    )
+    assert "vmid 100: excluded by tags: ['unmonitored']"
     assert len(filtered) == 2
 
 
 @pytest.mark.parametrize(
-    "testinput,expected", [
+    "testinput,expected",
+    [
         (["monitored"], 1),
         (["monitored", "postgres"], 2),
         ([], 3),
-    ]
+    ],
 )
 def test_include_tags(discovery, qemus, testinput, expected):
     discovery.config.config["include_tags"] = testinput
@@ -53,10 +67,13 @@ def test_include_tags(discovery, qemus, testinput, expected):
     assert len(filtered) == expected
 
 
-@pytest.mark.parametrize("testinput,expected", [
+@pytest.mark.parametrize(
-    (["101", "100"], 2),
+    "testinput,expected",
-    ([], 3),
+    [
-])
+        (["101", "100"], 2),
+        ([], 3),
+    ],
+)
 def test_include_vmid(discovery, qemus, testinput, expected):
     discovery.config.config["include_vmid"] = testinput
     filtered = discovery._filter(qemus)

prometheuspvesd/test/unit/test_model.py

@@ -1,4 +1,5 @@
 """Test Host class."""
+
 import pytest
 
 from prometheuspvesd.model import Host
@@ -9,34 +10,41 @@ pytest_plugins = [
 
 
 @pytest.mark.parametrize(
-    "testinput,expected", [
+    "testinput,expected",
-        ({
+    [
-            "vmid": 101,
+        (
-            "hostname": "host1",
+            {
-            "ipv4_address": False,
+                "vmid": 101,
-            "ipv6_address": False,
+                "hostname": "host1",
-            "pve_type": "qemu",
+                "ipv4_address": False,
-        }, {
+                "ipv6_address": False,
-            "__meta_pve_vmid": "101",
+                "pve_type": "qemu",
-            "__meta_pve_name": "host1",
+            },
-            "__meta_pve_ipv4": "False",
+            {
-            "__meta_pve_ipv6": "False",
+                "__meta_pve_vmid": "101",
-            "__meta_pve_type": "qemu",
+                "__meta_pve_name": "host1",
-        }),
+                "__meta_pve_ipv4": "False",
-        ({
+                "__meta_pve_ipv6": "False",
-            "vmid": "202",
+                "__meta_pve_type": "qemu",
-            "hostname": "host2",
+            },
-            "ipv4_address": "129.168.0.1",
+        ),
-            "ipv6_address": "2001:db8:3333:4444:5555:6666:7777:8888",
+        (
-            "pve_type": "qemu",
+            {
-        }, {
+                "vmid": "202",
-            "__meta_pve_vmid": "202",
+                "hostname": "host2",
-            "__meta_pve_name": "host2",
+                "ipv4_address": "129.168.0.1",
-            "__meta_pve_ipv4": "129.168.0.1",
+                "ipv6_address": "2001:db8:3333:4444:5555:6666:7777:8888",
-            "__meta_pve_ipv6": "2001:db8:3333:4444:5555:6666:7777:8888",
+                "pve_type": "qemu",
-            "__meta_pve_type": "qemu",
+            },
-        }),
+            {
-    ]
+                "__meta_pve_vmid": "202",
+                "__meta_pve_name": "host2",
+                "__meta_pve_ipv4": "129.168.0.1",
+                "__meta_pve_ipv6": "2001:db8:3333:4444:5555:6666:7777:8888",
+                "__meta_pve_type": "qemu",
+            },
+        ),
+    ],
 )
 def test_host(testinput, expected):
     host = Host(

prometheuspvesd/utils.py

@@ -17,7 +17,7 @@ def strtobool(value):
         "f": False,
         "false": False,
         "off": False,
-        "0": False
+        "0": False,
     }
 
     try:

pyproject.toml

@@ -30,49 +30,37 @@ repository = "https://github.com/thegeeklab/prometheus-pve-sd/"
 version = "0.0.0"
 
 [tool.poetry.dependencies]
-anyconfig = "0.13.0"
+anyconfig = "0.14.0"
 appdirs = "1.4.4"
 colorama = "0.4.6"
-environs = "9.5.0"
+environs = "11.0.0"
-jsonschema = "4.19.2"
+jsonschema = "4.22.0"
 nested-lookup = "0.2.25"
-prometheus-client = "0.18.0"
+prometheus-client = "0.20.0"
 proxmoxer = "2.0.1"
 python = "^3.8.0"
 python-json-logger = "2.0.7"
 requests = "2.31.0"
-"ruamel.yaml" = "0.18.5"
+"ruamel.yaml" = "0.18.6"
 
 [tool.poetry.scripts]
 prometheus-pve-sd = "prometheuspvesd.cli:main"
 
 [tool.poetry.group.dev.dependencies]
-ruff = "0.1.3"
+ruff = "0.4.5"
-pytest = "7.4.3"
+pytest = "8.2.1"
-pytest-mock = "3.12.0"
+pytest-mock = "3.14.0"
-pytest-cov = "4.1.0"
+pytest-cov = "5.0.0"
 toml = "0.10.2"
-yapf = "0.40.2"
 
 [tool.poetry-dynamic-versioning]
 enable = true
 style = "semver"
 vcs = "git"
 
-[tool.isort]
-default_section = "THIRDPARTY"
-force_single_line = true
-line_length = 99
-sections = ["FUTURE", "STDLIB", "THIRDPARTY", "FIRSTPARTY", "LOCALFOLDER"]
-skip_glob = ["**/.env*", "**/env/*", "**/.venv/*", "**/docs/*"]
-
 [tool.pytest.ini_options]
 addopts = "prometheuspvesd --cov=prometheuspvesd --cov-report=xml:coverage.xml --cov-report=term-missing --no-cov-on-fail --cov-fail-under=80"
-filterwarnings = [
+filterwarnings = ["ignore::FutureWarning", "ignore::DeprecationWarning"]
-  "ignore::FutureWarning",
-  "ignore::DeprecationWarning",
-  "ignore:.*pep8.*:FutureWarning",
-]
 
 [tool.coverage.run]
 omit = ["**/test/*"]
@@ -83,17 +71,21 @@ requires = ["poetry-core>=1.0.0", "poetry-dynamic-versioning"]
 
 [tool.ruff]
 exclude = [
-    ".git",
+  ".git",
-    "__pycache__",
+  "__pycache__",
-    "build",
+  "build",
-    "dist",
+  "dist",
-    "test",
+  "*.pyc",
-    "*.pyc",
+  "*.egg-info",
-    "*.egg-info",
+  ".cache",
-    ".cache",
+  ".eggs",
-    ".eggs",
+  "env*",
-    "env*",
 ]
+
+line-length = 99
+indent-width = 4
+
+[tool.ruff.lint]
 # Explanation of errors
 #
 # D102: Missing docstring in public method
@@ -104,47 +96,42 @@ exclude = [
 # D203: One blank line required before class docstring
 # D212: Multi-line docstring summary should start at the first line
 ignore = [
-    "D102",
+  "D102",
-    "D103",
+  "D103",
-    "D105",
+  "D105",
-    "D107",
+  "D107",
-    "D202",
+  "D202",
-    "D203",
+  "D203",
-    "D212",
+  "D212",
-    "UP038",
+  "UP038",
-    "RUF012",
+  "RUF012",
 ]
-line-length = 99
 select = [
-    "D",
+  "D",
-    "E",
+  "E",
-    "F",
+  "F",
-    "Q",
+  "Q",
-    "W",
+  "W",
-    "I",
+  "I",
-    "S",
+  "S",
-    "BLE",
+  "BLE",
-    "N",
+  "N",
-    "UP",
+  "UP",
-    "B",
+  "B",
-    "A",
+  "A",
-    "C4",
+  "C4",
-    "T20",
+  "T20",
-    "SIM",
+  "SIM",
-    "RET",
+  "RET",
-    "ARG",
+  "ARG",
-    "ERA",
+  "ERA",
-    "RUF",
+  "RUF",
 ]
 
-[tool.ruff.flake8-quotes]
+[tool.ruff.lint.per-file-ignores]
-inline-quotes = "double"
+"test_*.py" = ["S"]
 
-[tool.yapf]
+[tool.ruff.format]
-based_on_style = "google"
+quote-style = "double"
-column_limit = 99
+indent-style = "space"
-dedent_closing_brackets = true
+line-ending = "lf"
-coalesce_brackets = true
-split_before_logical_operator = true
-indent_dictionary_value = true
-allow_split_before_dict_value = false

renovate.json

@@ -1,4 +1,12 @@
 {
   "$schema": "https://docs.renovatebot.com/renovate-schema.json",
-  "extends": ["github>thegeeklab/renovate-presets"]
+  "extends": ["github>thegeeklab/renovate-presets"],
+  "packageRules": [
+    {
+      "matchManagers": ["woodpecker"],
+      "matchFileNames": [".woodpecker/test.yml"],
+      "matchPackageNames": ["docker.io/library/python"],
+      "enabled": false
+    }
+  ]
 }