Trintel

• Trintel
  • Login Daten
  • Deployment
    • Docker Image bauen
    • Docker Image ausführen
    • Starten mit Docker-Compose
    • Lokal testen ohne Docker
    • Konfiguration
• Implementierte Funktionen
  • Allgemein
    • Erweiterbarer Sprachsupport
    • Login und Registrierung
  • Administrator
    • Transaktionen
    • PDF-Export
    • Admin Panel
    • Unternehmensverwaltung
    • Schülerverwaltung
    • Admin Statistik
  • Schüler
    • Transaktionen
    • PDF-Export
    • Eigenes Unternehmen einsehen
    • Schüler Statistik
• Anwendungsfälle im Pflichtenheft
• Automatische Tests
  • CompanyTests
  • TransactionTests
  • BackUpTests
  • DatabaseTests
  • HomeTest
  • StatistikTests
  • UserTests

Login Daten

Beim start des Programms werden zwei URLs in den logs ausgegeben. Diese URLs können genutzt werden, um um sich zu registrieren.

2023-02-07 10:58:57.989  INFO 1 --- [           main] sopro.TrintelApplication                 : The registration URL for ADMINS is: /signup/3e60eb52-f2c0-4f3d-9d50-ce63e578714b
2023-02-07 10:58:57.991  INFO 1 --- [           main] sopro.TrintelApplication                 : The registration URL for STUDENTS is: /signup/3bb82933-55b8-4975-b631-3ef322e39dc9

Als Administrator kann man dann im Admin Panel die Registrierungs-URL einsehen, mit der sich neue Schüler anmelden können (Achtung! Diese URL ist nicht persistent, gilt also nur für die aktuelle Laufzeit). Zudem wird in der Konsole ein Link für den Registrierung für Admins geprintet, um dem Spiel weitere Admins hinzu zu fügen.

Deployment

Docker Image bauen

In der Deploy-Pipeline wird ein Docker Image erstellt und nach Docker-Hub gepusht, das wir verwenden können. Man kann das Image auch lokal bauen mit dem Befehl:

docker build -t trintel:1.0.0

Wichtig ist, dass die jars vorhanden sind. Das Projekt muss vorher also einmal mit Gradle gebaut werden. Das Docker File ist so geschrieben, dass das gesamte /build Verzeichnis ins Image kopiert wird. Der Entrypoint ist aber Fest auf /build/libs/trintel-0.0.1-SNAPSHOT.jar gesetzt. Dies ist wichtig, falls die Version in der build.gradle angepasst wird. (Versionierung haben wir über Docker gemanaged und nicht über Gradle)

Docker Image ausführen

Wir laden das Docker Image und führen es aus. Dieses Vorgehen wird hier im Folgenden erklärt.

Nun müssen die folgenden Commands ausgeführt werden:

docker pull b3zz/trintel
docker run -d -p 8080:8080 --name trintel-container b3zz/trintel

Jetzt läuft die App im Container und ist über den Port 8080 erreichbar.

Starten mit Docker-Compose

Für den produktiven Deploy nutzen wir docker-compose. Außerdem nutzen wir für die Loganalyse den Elastic Stack. Dieser besteht in unserer Konfiguration aus zwei Teilen.

• Filebeat läuft parallel zu der Trintel Instanz/ den Instanzen und sammelt alle logs der Docker Container ein. Diese werden dann an einen anderen Server geschickt. Dies ist Konfiguriert in der elastic-stack/filebeat.yml.
• Logstash läuft dann auf einem anderen Server, welcher die Logs empfängt, parsed und in einer ES-DB speichert. Dieser Teil kann mit der elastic-stack/docker-compose.yml gestartet werden.

Achtung!: Viele Pfade sind relativ angegeben. Daher sollte docker-compose immer aus dem Ordner, in welchem die docker-compose.yml liegt aufgerufen werden.

docker-compose up -d

Lokal testen ohne Docker

Hier ist es am einfachsten, das Repository zu clonen und die App mit ./gradlew bootRun zu starten. Hier als Hinweis: Wir nutzen die Java openjdk 11.

Zum einfacheren Testen haben wir eine spezielle Init Methode für die Datenbank geschrieben, welche die Datenbank initial mit ein paar Dummy Daten befüllt. Dies passiert, wenn das Spring Profile "dev" gesetzt ist.

./gradlew bootRun --args='--spring.profiles.active=dev'

Eine bestehende Datenbank wird bei erneutem Start des Programms nicht überschrieben.

Wichtig sind hier vor allem die Konfiguration der Mailserver, da das Programm ansonsten nicht Kompiliert.

spring.mail.host=mailin.informatik.uni-kiel.de
spring.mail.port=587
spring.mail.username= #stu-Kennung
spring.mail.password= #stu-Passwort
spring.mail.properties.mail.smtp.auth=true
spring.mail.properties.mail.smtp.starttls.enable=true

Konfiguration

Alle Werte in den .properties Dateien sind im Prinzip nur Defaults und können durch das setzen von Umgebungsvariablen überschrieben werden. Dies nutzen wir mit Docker bzw. docker-compose aus.

Insbesondere die Konfiguration des Mail-Servers passiert erst in der docker-compose.yml. Zum lokalen testen ohne Docker sollten die entsprechenden Werte in der application-dev.properties gesetzt werden.

Implementierte Funktionen

Allgemein

Erweiterbarer Sprachsupport

• zur Zeit: Deutsch und Englisch

• festgelegt durch Sprache im Browser und Aufenthaltsort

Login und Registrierung

• Registrierung über einen Registrierungslink

  • eigene Links jeweils für Schüler und Administratoren
  • Registrierungsbestätigung über einen Link, der per E-Mail an den Nutzer geschickt wird

Administrator

Transaktionen

Menüreiter "Transaktionen"

• Übersicht aller Transaktionen in der Datenbank

  • Angaben: Status, Käufer, Verkäufer, Produkt und letztes Update

• Einsicht in den Verlauf jeder einzelnen Transaktion in der Datenbank

  • Angaben für jede zugehörige Aktion: Aktionstyp, auslösendes Unternehmen, auslösender Schüler, Datum, Zeit, Menge, Preis und Nachricht

PDF-Export

• für den ganzen Transaktionsverlauf

• für einzelne Aktionen

Admin Panel

Menüreiter “Admin Panel”

• Einladungslink für Schüler*innen einsehen

  • Abschnitt “Einladungslink”

• Spiel exportieren

  Als Admin die folgende URL aufrufen: localhost:8080/backup/export. Die Export Datei ist dann im Docker Container im top Directory zu finden.

• Spiel importieren

  Hier muss die zu importierende Datei im top Directory des Docker Containers sein. Dann ein POST request mit path Feld wie im Folgenden als Beispiel gezeigt:

  curl -X POST -F 'path=export.json' http://localhost:8080/backup/import
  

• Aktionen einsehen

  • Abschnitt “Aktionen”

• Aktion bearbeiten

  • auf “Bearbeiten” bei der jeweiligen Aktion klicken (nicht möglich bei Standardaktionen) ⇒ neue Seite öffnet sich
  • Name bearbeiten
  • Beschreibung bearbeiten
  • Initiator bearbeiten

• Neue Aktion hinzufügen

  • auf “Neue Aktion hinzufügen” klicken ⇒ neue Seite öffnet sich
  • Name eingeben
  • Beschreibung eingeben
  • Initiator auswählen

Unternehmensverwaltung

Menüreiter “Unternehmen”

• Liste der Unternehmen einsehen

• Neues Unternehmen hinzufügen

  • auf “Unternehmen registrieren” klicken ⇒ neue Seite öffnet sich

  • Unternehmensnamen eingeben

• Unternehmen löschen

  • auf “Löschen” beim jeweiligen Unternehmen klicken ⇒ Löschen bestätigen

• Unternehmensdetails einsehen

  • auf den Unternehmensnamen oder den nach rechts zeigenden Pfeil klicken

• Unternehmen bearbeiten

  • Unternehmensdetails einsehen und auf “Bearbeiten” klicken
  • Logo hochladen
  • Name bearbeiten
  • Signatur bearbeiten

Schülerverwaltung

Menüreiter “Schüler*innen”

• Liste der Schüler einsehen

• Schüler suchen

  • Namen in Suchfeld eingeben
  • auf die Lupe klicken

• Schüler neu zuordnen

  • auf “Neu zuordnen” bei der jeweiligen Person klicken ⇒ neue Seite öffnet sich
  • Unternehmen auswählen

• Schülerunternehmen einsehen

  • auf Unternehmen unterhalb des Personennamens klicken

Admin Statistik

Menüreiter "Statistik"

• Gesamtübersicht
• sortierbar durch Klick auf Kategorie
• mehr Details durch Klick auf Unternehmen

Schüler

Transaktionen

Menüreiter "Transaktionen"

• Erstellung neuer Transaktionen als Käufer

  • mit Auswahl eines Unternehmens als Handelspartner (Verkäufer)

• grundlegender Ablauf einer erfolgreich abgeschlossenen Transaktion

  • Anfrage (durch Käufer)
  • Angebot (durch Verkäufer)
  • Annahme (durch Käufer)
  • Lieferung/Rechnungsstellung (durch Verkäufer)
  • Als bezahlt markieren (durch Verkäufer)

• Verhandlungen

  • gegenseitiges Versenden von Angeboten von beiden Seiten
  • Annahme des aktuellsten Angebots durch Handelspartner

• Berichtigungen von fehlerhaften Angeboten (bei z.B. Tippfehlern bei Menge oder Preis)

  • Versenden eines neuen Angebots durch das selbe Unternehmen möglich

• Nutzung der vom Administrator erstellten Freitext-Spezialaktionen

  • Auswahl verfügbar durch Button "Spezialaktionen"
  • jederzeit im Transaktionablauf möglich

• Abbruch einer Transaktion

  • durch Käufer: nach Stellen einer Anfrage (bei z.B. falsch ausgewähltem Unternehmen) oder endgültiges Ablehnen von Angeboten
  • durch Verkäufer: nach Eingang einer Anfrage (falls Produkt nicht angeboten wird oder nicht mehr vorrätig) oder edngültiges Ablehnen von Angeboten

• Übersicht aller Transaktionen, an denen das eigene Unternehmen beteiligt ist

  • Angaben: Status, Käufer, Verkäufer, Produkt und letztes Update

• Einsicht in den Verlauf jeder einzelnen Transaktion in der Datenbank

  • Angaben für jede zugehörige Aktion: Aktionstyp, auslösendes Unternehmen, Datum, Zeit, Menge, Preis und Nachricht

PDF-Export

• für den ganzen Transaktionsverlauf

• für einzelne Aktionen

Eigenes Unternehmen einsehen

Menüreiter “Mein Unternehmen”

• Unternehmen bearbeiten

  • auf “Bearbeiten” klicken
  • Logo hochladen
  • Name bearbeiten
  • Signatur bearbeiten

Schüler Statistik

Menüreiter "Statistik"

• Unternehmensstatistiken
• Tabelle sortierbar durch Klick auf Kategorie

---

Anwendungsfälle im Pflichtenheft

• Gesamtstatistik einsehen (Administrator): Implementiert
• Unternehmen erstellen (Administrator): Implementiert
• Registrierung (Administrator/Schüler): Implementiert
• Spiel exportieren (Administrator): Implementiert
• Spiel importieren (Administrator): Implementiert
• Transaktion durchführen (Schüler): Implementiert
• PDF zu Transaktionen generieren (Administrator/Schüler): Implementiert

---

Automatische Tests

Einzelne Beschreibungen der Tests entnehmen Sie bitte aus den Javadoc Kommentaren. Zum Ausführen der Tests: ./gradlew test

CompanyTests

Beschreibung: Testet die Funktionen des Company Controller aus Studenten und Admin Sicht. Dabei wird geprüft, ob die Mapping entsprechend der Rechtevergabe erreichbar sind und Aktionen ausgeführt werden können. Dafür sind auch Intergrationstest, die die Datenbank mit einbeziehen, beinhaltet.

• companiesReachable()
• listCompaniesTestAdmin()
• listCompaniesTestStudent()
• addCompanieTestAdmin()
• addCompanieTestStudent()
• saveCompanieTestAdmin()
• saveCompanieTestStudent()
• listAllStudentsTestAdmin()
• listAllStudentsTestStudent()
• editReassignStudentTestAdmin()
• editReassignStudentTestStudent()
• moveToCompanyTestAdmin()
• moveToCompanyTestStudent()
• companySelectTestAdmin()
• companySelectTestAssignedStudent()
• companySelectTestStudent()
• companySelectIdTestAdmin()
• companySelectIdTestStudent()
• joinCompany2TestAdmin()
• joinCompany2TestStudent()
• editOwnCompanyTestAdmin()
• editOwnCompanyStudentTest()
• saveOwnCompanyTestAdmin()
• saveOwnCompanyTestStudent()
• adminAddCompany()
• adminDeleteCompany()

TransactionTests

Beschreibung: Testet die Funktionen des Transaction und Action Type Controller aus Studenten und Admin Sicht. Dabei wird geprüft, ob die Mapping entsprechend der Rechtevergabe erreichbar sind und Aktionen ausgeführt werden können. Dafür sind auch Intergrationstest, die die Datenbank mit einbeziehen, beinhaltet.

• listTransactionsTestAdmin()
• listTransactionsTestStudent()
• createTransactionsTestAdmin()
• createTransactionsTestStudent1()
• createTransactionsTestStudent2()
• saveTransactionsTestStudent()
• saveTransactionsTestAdmin()
• transactionDetailTestStudent()
• transactionDetailTestAdmin()
• createActionTestStudent()
• createActionTestAdmin()
• addActionTypeTestStudent()
• addActionTypeTestAdmin()
• saveActionTypeTestStudent()
• editExistingActionTypeTestStudent()
• editExistingActionTypeTestAdmin()
• editNewActionTypeTestStudent()
• editNewActionTypeTestAdmin()
• saveEditActionTypeTestStudent()

BackUpTests

Beschreibung: Testet die Funktionen des Backup Controller. Es wird überprüft ob ein Export und Import durchgeführt werden kann.

• importExportTestAdmin()

DatabaseTests

Beschreibung: Testet, ob Objekte, die erstellt und in der Datenbank gespeichert werden, auch tatsächlich gesichert werden und abrufbar sind.

• isUserInDatabase()
• isUserInCompany()
• isCompanyInDatabase()
• isTransactionInDatabase()
• isTransactionInDatabaseRelated()
• isConfirmedSetInDatabase()
• isPaidSetInDatabase()
• isShippedSetInDatabase()
• isActionTypeSavedInDatabase()HomeTest
• isActionSavedInDatabase()

HomeTest

Beschreibung: Testet, ob der HomeController existiert.

• contextLoads()

StatistikTests

Beschreibung: Es wird getestet, ob die Statistik für Admin und User abrufbar sind.

• listStatistikTestAdmin()
• listStatistikTestStudent1()
• listStatistikTestStudent2()
• listAdminStatistikTestAdmin()
• listAdminStatistikTestStudent()

UserTests

Beschreibung: Es wird getestet, ob sich Admins und User registrieren können, sowie nicht registrierte Nutzer ohne InviteLink keinen Zugriff haben. Außerdem, ob die Login/ Logout Feature funktioniert.

• signUpRedirectTestStudent()
• signUpRedirectTestAdmin()
• signUpRedirectTestFalseString()
• loginAvailableForAll()
• adminLogout()
• studentLogout()
• testInvalidLoginDenied()
• testRedirectToLogin()