Projektwissen: Git-Vorgaben, Ticketzugriff, Tests und Einstieg
Erster Stand des Repositories AG_QGIS/Projektwissen (bisher Arbeitstitel "Workspace", ADR 0006). Der lokale Ordner heisst weiter AG_QGIS, weil darin auch die Plugin-Klone liegen. Git verbindlich (ADR 0007), aus dem bisherigen Wiki-Konzept entwickelt: - docs/leitfaden/05_git_arbeitsweise.md mit Kanal-Kette, Branch-Namen und Gitea-Branch-Schutz. - Der Einstiegspunkt eines Fixes richtet sich nach dem Kanal, in dem der Fehler sitzt; ein Fix an testing oder stable ist erst mit der Rueckfuehrung nach unten abgeschlossen. Das fehlte bisher. - Der stabile Kanal heisst stable, nicht main: der Release-Workflow in Repository:hidden/workflows fuehrt git checkout "$CHANNEL" aus, der Branchname muss also dem Kanalnamen entsprechen. Er existiert in keinem Plugin-Repo und ist vom Maintainer anzulegen. - Der Mensch drueckt ab: .claude/settings.json sperrt push, merge, tag. - scripts/hallo.py und /hallo holen den Stand aller Klone, per Fast-Forward wo gefahrlos; nie mergen, stashen oder verwerfen. Ticketzugriff: - scripts/gitea.py liest Issues, Kommentare und PRs ueber die oeffentliche API, ohne Token, nur GET. Schreibendes nur als Entwurf in entwuerfe/. - Skill sn-ticket. Tests (ADR 0009): - docs/leitfaden/06_tests.md: Testebenen, Testpflicht, und wie eine Fachperson beurteilt, ob Tests fachlich sinnvoll sind. - scripts/testkatalog.py erzeugt docs/tests/testkatalog.md per ast-Parsing, ohne Import und ohne QGIS. Befund: nur 100 von 332 Tests haben einen Docstring, sn_basis keinen einzigen von 87. - Vorlage und erste Testkonzept-Seite mit Mermaid. Dabei gefunden und gegen origin geprueft: _ermittle_gebietstyp_aus_fbschl hat keinen Test, obwohl PR #44/#45 genau diese Funktion tolerant gemacht hat. - docs/konzept/07_qgis_tests_plan.md: Stufenplan fuer Tests gegen echtes QGIS. Dabei aufgefallen: QGIS 3.40 ist seit Januar 2026 End of Life, qgis_min steht aber noch darauf. Werkzeuge (ADR 0008): - 04_werkzeuge_einrichten.md nur noch Claude Code als CLI und in VS Code. - .vscode/ entfernt, brauchbare Einstellungen als persoenliche Vorlage. Ausserdem: README als Einstieg neu aufgebaut, Mermaid-Diagramm in schnittstellen.md repariert (unmaskierte Klammern, rendert seither nicht). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This commit is contained in:
Claude Sonnet 5
@@ -0,0 +1,84 @@
|
||||
---
|
||||
name: sn-tests
|
||||
description: Tests der LNO-Plugins ausführen, deuten, neu schreiben und dokumentieren - Mock-Modus ohne QGIS über scripts/run_tests.py mit Baseline-Vergleich, Testkatalog erzeugen, Testkonzept-Seiten pflegen, Hinweise für Tests in echter QGIS-Umgebung. Verwenden bei "Tests ausführen", "sind die Tests grün", "Test schlägt fehl", "Baseline", "schreib einen Test", "Testabdeckung".
|
||||
---
|
||||
|
||||
# Tests ausführen, schreiben und dokumentieren
|
||||
|
||||
Ausführliche Fassung für Menschen: `docs/leitfaden/06_tests.md`.
|
||||
|
||||
## Ausführen (Mock-Modus, ohne QGIS)
|
||||
```bash
|
||||
python scripts/run_tests.py # alle Pakete mit Tests
|
||||
python scripts/run_tests.py sn_verfahrensgebiet --baseline # ein Paket, Vergleich mit Baseline
|
||||
python scripts/run_tests.py sn_plan41 --verbose # volle unittest-Ausgabe (nur zum Verstehen eines Fehlers)
|
||||
```
|
||||
- Das Skript verlinkt die Repos unter ihren Paketnamen (`sn_basis`, …) in ein temporäres Verzeichnis und startet
|
||||
`python -m unittest discover`. Voraussetzung: Python ≥ 3.11, `openpyxl` installiert, Repos vorhanden
|
||||
(`scripts/setup_workspace.py`).
|
||||
- Ausgabe je Paket: `GRÜN`/`ROT`, Zähler, mit `--baseline` zusätzlich `NEU ROT` (verboten) und `neu grün`.
|
||||
- Exit-Code 0 = in Ordnung. `gesamt = 0` bedeutet Import-Fehler → `--verbose`.
|
||||
|
||||
## Einen neuen Test schreiben
|
||||
Pflicht bei jeder neuen Funktionalität – ein Test je neuem beobachtbarem Verhalten, nicht je Funktion.
|
||||
Bei einem Bugfix zuerst der Test, der den Fehler zeigt.
|
||||
|
||||
```python
|
||||
def test_fbschl_mit_punkt_wird_erkannt(self):
|
||||
"""Prüft, dass der Shape-Import auch das Feld 'FBSchl.' mit Punkt akzeptiert.
|
||||
|
||||
Manche DAVID-Exporte liefern den Feldnamen mit Punkt, andere ohne.
|
||||
"""
|
||||
layer = self._layer_mit_feldern({"FBSchl.": "901/10110F"})
|
||||
self.assertEqual(_ermittle_gebietstyp_aus_fbschl(layer), "Verfahrensgebiet")
|
||||
```
|
||||
|
||||
Drei Anforderungen, alle verbindlich:
|
||||
1. Deutscher, fachlich sprechender Name – nicht `test_case_3`.
|
||||
2. **Docstring, erste Zeile `Prüft, dass …`.** Sie landet im Testkatalog und ist für die meisten Leser der
|
||||
einzige Kontakt mit dem Test.
|
||||
3. Ein Verhalten je Test. Steht im Namen ein „und", sind es zwei Tests.
|
||||
|
||||
Weiter: `unittest`, Datei `tests/test_<modul>.py`, kein Netzwerk, keine echten Verfahrensdaten, keine
|
||||
Abhängigkeit von der Testreihenfolge. Muster: vorhandene Tests des Pakets.
|
||||
Dialoge: `Pruefmanager(ui_modus="test")` liefert Standardantworten; `dialog_wrapper`-Funktionen mit
|
||||
`unittest.mock.patch` ersetzen.
|
||||
|
||||
## Testkatalog
|
||||
```bash
|
||||
python scripts/testkatalog.py # erzeugt docs/tests/testkatalog.md
|
||||
python scripts/testkatalog.py --pruefen # Exit 1, wenn die Datei veraltet ist
|
||||
```
|
||||
Wird aus den Testdateien per `ast` erzeugt (kein Import, läuft ohne QGIS). **Nicht von Hand bearbeiten.**
|
||||
Nach jeder Änderung an Tests neu erzeugen und mitcommitten. Der Abschnitt „Lücken" listet Tests ohne
|
||||
Docstring – Stand 04.09.2026 haben nur 100 von 332 Tests einen, `sn_basis` keinen einzigen.
|
||||
|
||||
## Testkonzept-Seiten
|
||||
Für fachlich wichtige Abläufe liegt in `docs/tests/<ablauf>.md` eine Seite nach `docs/vorlagen/testkonzept.md`:
|
||||
Mermaid-Diagramm des fachlichen Ablaufs, Tabelle Schritt → deckender Test → bewusst nicht getestet mit
|
||||
Begründung, bekannte Lücken. Sie ermöglicht Fachleuten die Beurteilung, ob die Tests das Richtige prüfen.
|
||||
Wird ein dokumentierter Ablauf geändert, wird die Seite mit nachgezogen.
|
||||
|
||||
## Fehler deuten
|
||||
- `ModuleNotFoundError: sn_basis` → nicht über das Skript gestartet oder Repo fehlt.
|
||||
- Mock-Klassen ohne Methode (`AttributeError: _MockQgs… has no attribute`) → Mock im Wrapper ergänzen,
|
||||
nicht den Test umgehen.
|
||||
- Test erwartet alte Signatur (Einzeldatei statt Liste, ein Layer statt zwei) → veralteter Test nach Umbau auf
|
||||
Mehrfachauswahl; prüfen, ob das neue Verhalten gewollt ist (Issue/Changelog), dann Test anpassen und im PR begründen.
|
||||
- Test hängt oder braucht Netz → der Test ist falsch gebaut, Dienstantwort nachstellen.
|
||||
|
||||
**Niemals** einen roten Test durch Löschen, `@unittest.skip` oder Anpassen der Erwartung grün machen – außer das
|
||||
Verhalten wurde bewusst geändert und der PR begründet es.
|
||||
|
||||
## Baseline
|
||||
- Datei `docs/status/testbaseline.json`; wird nur von Maintainern mit
|
||||
`python scripts/run_tests.py --update-baseline` verändert. Ein Agent fasst sie nicht an.
|
||||
- Regel: keine neuen roten Tests; bekannte rote Tests werden über eigene Issues grün gemacht.
|
||||
|
||||
## In echter QGIS-Umgebung (Windows, OSGeo4W)
|
||||
- Plugins ohne Release in ein QGIS-Profil bringen: `python scripts/link_qgis_profile.py --profil dev`
|
||||
(verknüpft die Klone unter ihren Paketnamen; danach in QGIS experimentelle Plugins anzeigen, `sn_basis` zuerst aktivieren).
|
||||
- Heute nur manuell bzw. über die repo-eigenen `tests\test_qgis.bat` (enthalten fest verdrahtete Pfade).
|
||||
Der Ausbau zu automatisierten QGIS-Tests ist geplant: `docs/konzept/07_qgis_tests_plan.md`.
|
||||
- Pflicht bei: Layer-Operationen, WFS/REST, Drucklayouts, Signalen/Docks. Ergebnis im PR unter „Wie geprüft".
|
||||
- Agenten ohne QGIS: Test als offenen Punkt im PR benennen, **nicht** als erledigt ausgeben.
|
||||
Reference in New Issue
Block a user