[D2G] Ergebnispräsentation für Studierende

[AKirsch1]

Bei der Ausgabe für Studierende wird unterschieden zwischen einer einfachen Ausgabe über die Konsole der GH-Action und einer webbasierten Ergebnispräsentation.

Einfache Ergebnisausgabe für Studis

Als erste Präsentation der Ergebnisse soll eine einfache Ausgabe auf der Konsole des Workflows herhalten. Dazu gehört die Präsentation der Fehler, für die Punkte abgezogen wurden und am Ende eine Übersicht über die erreichte Punktzahl.

Die Ausgabe von Fehlern sieht folgendermaßen aus:

[TESTKLASSE (ABZUG)] KURZE_BESCHREIBUNG_DES_FEHLERS

Beispiel:

[JUnit (-1 Punkt)] Test `testSetVelocityNegative()` fehlgeschlagen.

Anmerkung: Eine detailliertere Ausgabe der Fehler soll durch eine lokale Ausführung mit gradle möglich sein.

Die Zusammenfassung sieht dann folgendermaßen aus:

Aufgabenblatt: NAME
Abgabedatum: DATUM
Beteiligte Studis: LIST_STUDIS
Erreichte Gesamtpunktzahl: P/ALL

|-----------|--------|
|  Aufgabe  | Punkte |
|-----------|--------|
| Aufgabe 1 |     19 |
| Aufgabe 2 |     10 |
|    ...    |      . |
|-----------|--------|

Erklärungen:

• NAME: Name des Aufgabenblattes
• DATUM: Abgabedatum
• LIST_STUDIS: Liste der Studierenden, die mindestens einmal für diese Abgabe committed haben
• P: Erreichte Punktzahl
• ALL: Maximal erreichbare Punktzahl

Anmerkung: Die Formatierung der Tabelle kann in der finalen Implementierung anders ausehen.

Webbasierte Ergebnispräsentation für Studis (Optional)

Da bei der konsolenbasierten Ausgabe die Übersicht wahrscheinlich nicht wirklich gut sein wird, ist eine zweite Ausgabevariante sinnvoll, die insbesondere bei der Ausgabe der einzelnen Fehler hilfreicher sein soll. Im Allgemeinen ist die Idee vergleichbar zu der Übersicht von JPlag. Auf einer über GitHub.io gehosteten Webseite können Studierende ihre Ergebnisse in Form eines zip-Archivs hochgeladen. Dieses Archiv wird in Frontend verarbeitet und die Informationen daraus dargestellt.

Das zip-Archiv wird von der GH-Action als Artefakt (GH-Action) zur Verfügung gestellt und kann von GitHub heruntergeladen und auf die Webseite hochgeladen werden. Es enthält eine Zusammenfassung der Ergebnisse sowie die Aufgaben- und Aufgabenblattdefinitionen und die Ausgaben der einzelnen Tests (JUnit, Checkstyle, ...).