Skip to content

[CODINGSTANDARD] Status- und Konfigurationswerte durch benannte Konstanten oder Enums ersetzen #542

Description

@ralferlebach

Problem

Mehrere Stellen verwenden rohe Strings und Zahlen wie active, accessible, completed, Optionswerte und Kontextlevel direkt. Dies erhöht Tippfehler- und Divergenzrisiko zwischen den Plugins.

Ursache

Gemeinsame fachliche Werte sind nicht zentral typisiert beziehungsweise dokumentiert.

Lösung

  • Komponentenübergreifend benötigte Statuswerte in einer stabilen API von local_adele definieren.
  • Konfigurationen früh normalisieren.
  • Magic Numbers durch Moodle- oder eigene Konstanten ersetzen.
  • DB-Werte und JSON-Schema dokumentieren.

Manuelles Testverfahren

Testschritte

  1. Alle Statusübergänge und Enrolmentoptionen durchlaufen.
  2. Ungültige Werte gezielt einspeisen.

Aktuelles Ist-Verhalten

Mehrere Stellen verwenden rohe Strings und Zahlen wie active, accessible, completed, Optionswerte und Kontextlevel direkt. Dies erhöht Tippfehler- und Divergenzrisiko zwischen den Plugins.

Erwartetes Soll-Verhalten

Statuswerte besitzen eine zentrale Definition.

Automatisierte Tests

  • Unit-Tests für Parsing und ungültige Werte.
  • Statischer Scan für bekannte Magic Values.

Akzeptanzkriterien

  • Statuswerte besitzen eine zentrale Definition.
  • Ungültige Konfiguration wird abgewiesen.
  • Alle drei Plugins interpretieren Werte identisch.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions