[bugfix/testroutine] Pytest-Absturz in der Testroutine behoben (Flake8 entkoppelt)

[KoenigMjr]

Problem

Die CI-Pipeline ist aufgrund einer Inkompatibilität zwischen neueren pytest-Versionen (v8+) und den veralteten Plugins pytest-flake8 / pytest-flakes fehlgeschlagen. Da diese Plugins nicht mehr aktiv gepflegt werden, kam es beim Starten der Tests zu folgendem Validierungsfehler:

pluggy._manager.PluginValidationError: Plugin 'flake8' for hook 'pytest_collect_file'
hookimpl definition: pytest_collect_file(file_path, path, parent)
Argument(s) {'path'} are declared in the hookimpl but can not be found in the hookspec
Error: Process completed with exit code 1.

[Schrolli91]

Aber wie testet man das nun lokal? Gibt's da eine sinnvolle Lösung?

[KoenigMjr]

Gute Frage, wie immer!

Ich hab mir bei VSCodium (bzw. VSCode) nicht anders zu helfen gewusst, als einfach die Flake8 Erweiterung zu installieren und die Argumente dort zu hinterlegen.

Was bei mir einfach ist, weil ich die Regeln einfach global für alles beibehalte.
Wenn man Projektspezifische Ignore-Rules hat, weiß ich leider nicht wie man das bewerkstelligen sollte.

Ich mach mich mal schlau und melde mich mit dem Ergebnis.

[KoenigMjr]

also hab mir das mal bisschen zu gemüte geführt...

tatsächlich wäre der testlauf via terminal etwas umständlich:

flake8 . --extend-ignore=E402,E501,E722,W504,W605 && pytest -c 'test/pytest.ini'

Lösungsvorschlag:

Anlage einer .flake8-Datei im root mit dem Inhalt:

[flake8]
extend-ignore = E402, E501, E722, W504, W605

Dann schrumpft der Schritt in der run_pytest.yml auf:

- name: Run Flake8
      run: |
        flake8 .

und der befehl wäre dann:

flake8 . && pytest -c 'test/pytest.ini'

Frage: Gefällt die Lösung & Durchführen? :)

[Schrolli91]

Mir ist die exakte Lösung fast egal - aber deinen letzten Vorschlag finde ich ganz gut.
Cool fände ich allerdings, wenn man die Dinge in VS Code Tasks verpackt (.vscode/tasks.json).

Dann kann man das wenigstens einfach aus der IDE heraus ausführen.

[KoenigMjr]

So, jetzt ist der ganze Spaß ein bisschen ausgeartet... 😉

Was wurde verändert:

• Das Makefile als Gehirn: Ich habe ein zentrales Makefile hinzugefügt. Es ist der Single Point of Truth für das gesamte Setup – ein einfaches make install richtet das .venv ein und installiert die Requirements. Tippt man nur make, erscheint ein selbsterklärendes Help-Menü.
• Die .vscode/tasks.json: Um Redundanzen zu vermeiden, steuern die VS Code Tasks jetzt einfach das Makefile an.
• Shortcut: den Haupt-Check (make check, der erst lint und dann test ausführt) als Standard-Build-Task in VS Code hinterlegt. Im Editor nur noch Strg + Umschalt + B drücken, und das gesamte Projekt wird validiert.
• Die restliche Hygiene: Der Netzwerk-Test blockiert lokal dank @pytest.mark.skipif nicht mehr, läuft in der GitHub Actions CI (via Env-Variable) aber weiterhin voll durch. .gitignore und .flake8 sind ebenfalls sauber aufgeräumt.

[Schrolli91]

LGTM