Seite 1 von 1

Unit-Tests opsi-cli-Plugins

Verfasst: 19 Mai 2025, 15:02
von SirTux
Hi,

gibt es bereits Best Practices für Unit Tests bei extern entwickelten opsi-Cli-Plugins? Ich habe gesehen, daß es hier ein paar Hilfsfunktionen gibt, aber die kann ich ja nicht ohne weiteres bei mir einbinden oder?

https://github.com/opsi-org/opsi-cli/bl ... s/utils.py

Ist es geplant das zu erleichtern? Ich würde mir vorstellen, daß ich diese zum Beispiel über

Code: Alles auswählen

opsi-cli plugin test $path_plugin
aufrufen kann und dann sinnvolle Hilfsfunktionen zur Verfügung habe.

Viele Grüße,
Stefan

Re: Unit-Tests opsi-cli-Plugins

Verfasst: 30 Mai 2025, 09:57
von n.doerrer
Moin,

ich denke, es ist sinnvoll die AnwenderInnen-Funktionalität von der Entwicklungs-Funktionalität zu trennen.
Die von Dir erwähnten Hilfsfunktionen kannst Du nutzen, wenn Du zusätzliche unit-tests mit in das "tests"-Verzeichnis legst.
Z.B.

Code: Alles auswählen

$ uv sync  # virtual environment anlegen wie in pyproject.toml spezifiziert
$ uv run pytest tests/test-my-custom-plugin.py  # funktionalität testen mit Zugriff auf die Dinge aus tests/utils.py und tests/conftest.py sowie natürlich opsi-cli
Allerdings hier eine Warnung: Die unit-tests und auch die dort verwendeten Hilfsfunktionen werden von uns intern genutzt und sind Änderungen unterworfen. Wir garantieren hier keine Stabilität im Vorhandensein und Handling der Funktionen.