diff --git a/README.md b/README.md
index cb98011..b001e40 100644
--- a/README.md
+++ b/README.md
@@ -7,13 +7,13 @@ For documentation see https://makes-hacks-hip.github.io/RepApp/.
## Setup for development
- Clone repo
-- python -m venv venv
-- source venv/bin/activate
-- cd rc_hip
-- python manage.py makemigrations
-- python manage.py migrate
-- python manage.py createsuperuser
-- python manage.py runserver
+- `python -m venv venv`
+- `source venv/bin/activate`
+- `cd rc_hip`
+- `python manage.py makemigrations`
+- `python manage.py migrate`
+- `python manage.py createsuperuser`
+- `python manage.py runserver`
## Build Docker image
@@ -30,3 +30,13 @@ docker run --rm -d \
repapp`
```
- Open `http://127.0.0.1:8020/` in your browser
+
+## Run tests
+
+### Unit tests
+
+Run `python manage.py test`
+
+### LiveServer Tests
+
+Run `python manage.py test repapp.live_tests.WorkflowTests`
diff --git a/docs/index.md b/docs/index.md
index 3f03358..43b553f 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -4,6 +4,8 @@ RepApp ist eine Web App um Reparaturen im Rahmen eines Repair-Cafés zu organisi
## Benutzer
+RepApp unterscheidet zwischen den folgenden Benutzer-Typen:
+
### Gast
Ein Gast ist ein Gerätebesitzer der ein oder mehrere Geräte zur Reparatur anmelden möchte.
@@ -18,30 +20,38 @@ Ein Organisator ist Mitglied des Repair-Cafés das die Termine mit den Gästen o
## Anwendungsfälle
+Die Anwendungsfälle sind in Meilensteine unterteilt.
+Zu Meilenstein 1 (M1) gehören alle Anwendungsfälle die notwendig sind um RepApp "produktiv" für die Anmeldung von Geräten zu verwenden.
+
### Gast
- [x] M1: Als Gast möchte ich einen Termin für eine Reparatur vereinbaren. (A1)
- [x] M1: Als Gast möchte ich eine Bestätigung für eine Reparaturanfrage bekommen. (A2)
- [ ] M1: Als Gast möchte ich eine Terminbenachrichtigung oder eine Absage bekommen. (A3)
-- [ ] Als Gast möchte ich mein angemeldetes Gerät und dessen Status einsehen können. (A4)
- [ ] M1: Als Gast möchte ich Rückfragen zum Gerät empfangen und diese beantworten können. (A5)
- [ ] M1: Als Gast möchte ich Fragen ans Repair-Café stellen können. (A26)
+- [ ] M1: Als Gast möchte ich ausschließlich per eMail mit dem System interagieren können. (A30)
+- [ ] M1: Als Gast möchte per eMail Fragen ans Team stellen können. (A33)
+- [ ] M1: Als Gast möchte ich per eMail auf Rückfragen antworten können. (A34)
+- [ ] M1: Als Gast möchte ich eine Termineinladung per eMail bestätigen können. (A35)
+
+- [ ] Als Gast möchte ich mein angemeldetes Gerät und dessen Status einsehen können. (A4)
- [ ] Als Gast möchte ich ein Gerät für eine Folgereparatur anmelden können. (A6)
- [ ] Als Gast möchte ich meine Daten ansehen können. (A21)
- [ ] Als Gast möchte ich meine Daten löschen können. (A22)
- [ ] Als Gast möchte ich eine Geräteanmeldung löschen können. (A23)
-- [ ] M1: Als Gast möchte ausschließlich per eMail mit dem System interagieren können. (A30)
### Reparateur
- [ ] M1: Als Reparateur möchte ich die angemeldeten Geräte ansehen können. (A7)
- [ ] M1: Als Reparateur möchte ich mir ein angemeldetes Gerät zuordnen können. (A8)
-- [ ] Als Reparateur möchte ich ein angemeldetes Gerät ablehnen können. (A9)
- [ ] M1: Als Reparateur möchte ich Rückfragen zum Gerät stellen können. (A10)
- [ ] M1: Als Reparateur möchte ich eine Benachrichtigung bekommen wenn eine Rückfrage beantwortet wird. (A11)
- [ ] M1: Als Reparateur möchte ich eine Benachrichtigung bekommen wenn mir ein Gerät zugeordnet wird. (A12)
- [ ] M1: Als Reparateur möchte ich mich für ein Repair-Café anmelden können. (A13)
- [ ] M1: Als Reparateur möchte ich mich für ein Repair-Café abmelden können. (A14)
+
+- [ ] Als Reparateur möchte ich ein angemeldetes Gerät ablehnen können. (A9)
- [ ] Als Reparateur möchte ich benachrichtigt werden wenn ein Gast eine mir zugeordnete Geräteanmeldung löscht. (A25)
### Organisator
@@ -55,21 +65,27 @@ Ein Organisator ist Mitglied des Repair-Cafés das die Termine mit den Gästen o
- [ ] M1: Als Organisator möchte ich einen Reparateur zu einem Termin zuordnen können. (A20)
- [ ] M1: Als Organisator möchte ich ein Gerät bearbeiten können. (A28)
- [ ] M1: Als Organisator möchte ich ein Gerät absagen können, wenn der Gast mich informiert hat dass er nicht kommt. (A29)
+
- [ ] Als Organisator möchte ich benachrichtigt werden wenn ein Gast eine Geräteanmeldung löscht. (A24)
- [ ] Als Organisator möchte ich alle Daten exportieren können. (A31)
- [ ] Als Organisator möchte ich Geräte auf ein späteres Repair-Café verschieben können. (A32)
## Daten
+
+### Benutzer
+
+Ein Repapp-Benutzer erweitert den Standard-Benutzer um eine eindeutige eMail-Adresse, um diese als Identifikationsmerkmal verwenden zu können.
+
### Cafe
Ein Cafe ist ein Repair-Café Termin.
Attribute:
-- Datum: Datum der Veranstaltung
- Ort: Beschreibung wo das Repair-Café stattfindet
- Adresse: Adresse an der das Repair-Café stattfindet
+- Datum: Datum der Veranstaltung
Annahmen:
@@ -113,6 +129,7 @@ Attribute:
Technische Attribute:
- Identifier: SHA256 Hash aus Name + Wohnort + Timestamp
+- Benutzer: Referenz zum Benutzer der für diesen Gast erstellt wurde.
### Gerät
@@ -120,6 +137,7 @@ Ein Gerät ist ein defekter Gegenstand der im Rahmen eines Repair-Cafés reparie
Attribute:
+- Erstellungsdatum: Datum an dem diese Gerät angemeldet wurde.
- Gerät: Bezeichnung des Geräts
- Hersteller: Hersteller des Geräts
- Fehler: Beschreibung des Defekts
@@ -158,7 +176,7 @@ Attribute:
- Frage: Frage zum Gerät oder Defekt
- Antwort: Antwort des Gastes
-- Datum: Datum der Erstellung der Rückfrage
+- Erstellungsdatum: Datum der Erstellung der Rückfrage
Technische Attribute:
@@ -179,6 +197,52 @@ Technische Attribute:
- Cafe: Referenz zum Cafe
- Gerät: Referenz zum Gerät
+### Einmal-Login
+
+Ein Einmal-Login ist ein Geheimnis das es einem Gast erlaubt sich einmalig damit anzumelden.
+
+- Geheimnis: Geheimnis um den Gast zu identifizieren.
+- URL: URL die nach der Anmeldung angezeigt werden soll.
+- Erstellungsdatum: Datum an dem der Einmal-Login angelegt wurde.
+- Login benutzt?: Boolesches Flag. True wenn der Einmal-Login bereits benutzt wurde.
+- Login Datum: Datum an dem der Einmal-Login benutzt wurde, oder Datum der Erstellung, da das Feld aus technischen Gründen nicht leer sein kann.
+
+Technische Attribute:
+
+- Benutzer: Referenz zum Benutzer
+
+### Nachricht
+
+Eine Nachricht ist eine Anfrage von einem Gast.
+
+- Nachricht: Anfrage des Gastes.
+- Antwort: Antwort an den Gast.
+- Erstellungsdatum: Datum an dem die Anfrage erstellt wurde.
+
+Technische Attribute:
+
+- Gast: Referenz zum Gast
+
+## Anmelde Konzept
+
+RepApp unterstützt pro Benutzer-Gruppe verschiedenen Anmelde-Konzepte.
+
+## Gäste
+
+Für Gäste wird automatsch ein Benutzerkonto angelegt, mit einem generierten, sicheren Passwort. Mit der eMail Adresse und dem Passwort kann ein Gast sich in der RepApp anmelden um seine Daten sehen und bearbeiten zu können.
+
+### Einmal-Login
+
+Für Gäste gibt es Einmal-Logins als Alternative. Ein Einmal-Login ist ein Geheimnis und eine Ziel-URL, das dem Gast in From eines Anmelde-Links in einer eMail mitgeteilt wird. Mit diesem Link kann der Gast sich einmalig anmelden, da das Geheimnis danach potentiell Dritten bekannt ist, z.B. über die Browser History.
+
+Nach dem erfolgreichen Login wird der Gast automatisch zu der hinterlegten URL weitergeleitet. Dieser Mechanismus erlaubt es einem Gast "per Klick" Zugriff auf geschützte Daten zu geben.
+
+Wenn ein Gast versucht den Einmal-Link nochmals zu verwenden, schlägt dies Fehl, und dem Gast wird automatisch ein neuer Einmal-Link per eMail mitgeteilt. Dies wird dem Gast auch über entsprechende Nachrichten mitgeteilt.
+
+## Mitarbeiter
+
+Der Login für Mitarbeiter ist nur über das Single-Sign-On der Repair-Cafés erlaubt (Keycloak), das mittels OIDC angebunden ist. Alle Mitarbeiter im Repair-Café haben dort bereits einen Benutzer, was zum einen sicherstellt dass es sich um einen Mitarbeiter handelt, und zum anderen auch die Veraltung der Benutzer in RepApp vereinfacht.
+
## Ansichten
### Landing Page: Repair-Cafés (S1)
@@ -187,12 +251,10 @@ URL: /
Name: index
+Sicherheit: Die Seite ist ohne Zugangsbeschränkung oder Anmeldung erreichbar.
+
Diese Seite zeigt eine Liste der zukünftigen Repair-Café Termine.
-Sie enthält pro Repair-Café einen Knopf um ein Gerät für dieses Repair-Café anzumelden.
-
-#### Sicherheit
-
-Die Seite ist ohne Zugangsbeschränkung oder Anmeldung erreichbar.
+Sie enthält pro Repair-Café einen Link um ein Gerät für dieses Repair-Café anzumelden.
### Gerät anmelden (S2)
@@ -200,16 +262,14 @@ URL: cafe/int:cafe/
Name: register_device
+Sicherheit: Die Seite ist ohne Zugangsbeschränkung oder Anmeldung erreichbar.
+
Diese Seite zeigt das Formular zum anmelden der Geräte.
Das Formular hat die Felder `eMail-Adresse`, `Art des Geräts`, `Hersteller & Modell/Typ`, `Fehlerbeschreibung`, `Foto vom Gerät`, `Foto vom Typenschild`, ein Kontrollkästchen `Folgetermin`, ein Kontrollkästchen `Informationen zur Reparaturabwicklung`, ein Kontrollkästchen `Datenschutz` und einen Knopf `Absenden` zum senden des Formulars.
Das Repair-Café zu dem die Anmeldung gehört ist über eine ID in der URL der Seite festgelegt.
-Die eMail-Benachrichtigung and die Organisatoren und die Bestätigung an den Gast wird beim absenden des Formulars gesendet, falls die eMail Adresse zu einem bekannten Gast gehört.
-
-#### Sicherheit
-
-Die Seite ist ohne Zugangsbeschränkung oder Anmeldung erreichbar.
+Falls die eMail Adresse zu einem bekannten Gast gehört, wird beim absenden des Formulars eine eMail-Benachrichtigung and die Organisatoren und Bestätigung an den Gast gesendet.
### Gast anmelden (S3)
@@ -217,16 +277,14 @@ URL: cafe/int:cafe/device/str:device_identifier/mail/str:mail/
Name: register_guest
+Sicherheit: Die Seite ist ohne Zugangsbeschränkung oder Anmeldung erreichbar.
+
Diese Seite zeigt das Formular zum anmelden eines neuen Gastes.
Das Formular hat die Felder `Name`, `Telefon`, `Wohnort` und einen Knopf `Absenden` zum senden des Formulars.
Die eMail-Adresse und das Gerät zu dem die Gast-Kontaktdaten gehören ist über IDs in der URL der Seite festgelegt.
-Die eMail-Benachrichtigung and die Organisatoren und die Bestätigung an den Gast wird beim absenden des Formulars gesendet.
-
-#### Sicherheit
-
-Die Seite ist ohne Zugangsbeschränkung oder Anmeldung erreichbar.
+Beim absenden des Formulars eine eMail-Benachrichtigung and die Organisatoren und Bestätigung an den Gast gesendet.
### Anmeldung bestätigt (S7)
@@ -234,45 +292,43 @@ URL: cafe/int:cafe/device/str:device_identifier/confirm/
Name: register_device_final
+Sicherheit: Die Seite ist ohne Zugangsbeschränkung oder Anmeldung erreichbar.
+
Die Seite Anmeldung bestätigt zeigt einen Hinweis dass die Anmeldung des Gerätes erfolgreich abgeschlossen wurde.
Die Geräte ID ist in der URL der Seite festgelegt.
-#### Sicherheit
-
-Die Seite ist ohne Zugangsbeschränkung oder Anmeldung erreichbar.
-
### Geräte Detailseite (S5)
URL: device/str:device_identifier/
Name: view_device
+Sicherheit: Diese Seite ist für alle Mitarbeiter und den Gast der das Gerät angemeldet hat erreichbar.
+
Die Geräte Detailseite zeigt die Informationen `Art des Geräts`, `Hersteller & Modell/Typ`, `Fehlerbeschreibung`, `Foto vom Gerät`, `Foto vom Typenschild` und `Folgetermin` an.
Das Gerät ist über IDs in der URL der Seite festgelegt.
-#### Sicherheit
-
-Die Seite ist ohne Zugangsbeschränkung oder Anmeldung erreichbar.
-
### Gast Detailseite (S6)
+URL: guest/profile/
+
+Name: guest_profile
+
+Sicherheit: Die Seite enthält persönliche Daten und ist nur für den Gast zu dem sie gehört erreichbar.
+
Die Gast Detailseite hat die Felder `Name`, `eMail`, `Telefon` und `Wohnort` die mit den Angaben des Gastes ausgefüllt sind.
Weiter enthält die Seite einen Knopf `Aktualisieren` der das Formular absendet.
Die Ansicht enthält auch eine Liste mit Links zu allen Geräten die der Gast angemeldet hat.
-Der Gast ist über IDs in der URL der Seite festgelegt.
-
-#### Sicherheit
-
-Die Seite enthält persönliche Daten und ist nur nach Anmeldung erreichbar.
+Der Gast ist über den angemeldeten Benutzer festgelegt.
## Abläufe
### Anmeldung eines defekten Gerätes
-#### Variante: Neuer Gast
+#### Variante: Neuer Gast (F1)
Als neuer Gast der ein defekten Geräte anmelden möchte,
@@ -282,7 +338,7 @@ Als neuer Gast der ein defekten Geräte anmelden möchte,
- Die nächste Seite (S5) bestätigt mir die Anmeldung meines Gerätes.
- In meinem eMail Posteingang finde ich ebenfalls eine Bestätigung der Geräteanmeldung.
-#### Variante: Bekannter Gast (existierende eMail Adresse)
+#### Variante: Bekannter Gast (existierende eMail Adresse) (F2)
Als bekannter Gast der ein defekten Geräte anmelden möchte,
@@ -293,29 +349,32 @@ Als bekannter Gast der ein defekten Geräte anmelden möchte,
## Konfigurationsparameter
-- DJANGO_SECRET_KEY
-- DJANGO_DEBUG
-- DJANGO_EMAIL_HOST
-- DJANGO_EMAIL_PORT
-- DJANGO_EMAIL_HOST_USER
-- DJANGO_EMAIL_HOST_PASSWORD
-- DJANGO_EMAIL_USE_TLS
-- OIDC_RP_CLIENT_SECRET
+- DJANGO_SECRET_KEY: Secret Key für das Django Framework.
+- DJANGO_DEBUG: Debug-Modus verwenden? Standard ist True.
+
+- DJANGO_EMAIL_HOST: eMail Server
+- DJANGO_EMAIL_PORT: eMail Server Port
+- DJANGO_EMAIL_HOST_USER: Benutzername für den eMail Server
+- DJANGO_EMAIL_HOST_PASSWORD: Passwort für den eMail Server
+- DJANGO_EMAIL_USE_TLS: TLS verwenden? Standard ist True.
+
+- OIDC_RP_CLIENT_SECRET: Secret für den OIDC Prozess. Ist auch im Keycloak konfiguriert.
### Feste Konfiguration
-- ALLOWED_HOSTS
-- LANGUAGE_CODE
-- TIME_ZONE
-- CSRF_TRUSTED_ORIGINS
-- AUTH_USER_MODEL
-- AUTHENTICATION_BACKENDS
-- LOGIN_REDIRECT_URL
-- OIDC_RP_CLIENT_ID
-- OIDC_RP_SIGN_ALGO
-- OIDC_OP_JWKS_ENDPOINT
-- OIDC_OP_AUTHORIZATION_ENDPOINT
-- OIDC_OP_TOKEN_ENDPOINT
-- OIDC_OP_USER_ENDPOINT
-- LOGIN_REDIRECT_URL
-- LOGOUT_REDIRECT_URL
+- ALLOWED_HOSTS: Erlaubte Domainnamen. ("127.0.0.1", "localhost", "repapp.rc-hip.de", "anmeldung.repaircafe-hilpoltstein.de")
+- LANGUAGE_CODE: de
+- TIME_ZONE: Europe/Berlin
+- CSRF_TRUSTED_ORIGINS: Siehe ALLOWED_HOSTS.
+- AUTH_USER_MODEL: CustomUser in RepApp Models definiert.
+- AUTHENTICATION_BACKENDS: Standard + Backends aus RepApp Backends.
+
+- OIDC_RP_CLIENT_ID: OIDC Client ID, im Keycloak konfiguriert.
+- OIDC_RP_SIGN_ALGO: RS256
+- OIDC_OP_JWKS_ENDPOINT: Keycloak URL
+- OIDC_OP_AUTHORIZATION_ENDPOINT: Keycloak URL
+- OIDC_OP_TOKEN_ENDPOINT: Keycloak URL
+- OIDC_OP_USER_ENDPOINT: Keycloak URL
+
+- LOGIN_REDIRECT_URL: Debug: 127.0.0.1:8000, sonst https://anmeldung.repaircafe-hilpoltstein.de/
+- LOGOUT_REDIRECT_URL: Siehe LOGIN_REDIRECT_URL
diff --git a/rc_hip/rc_hip/settings.py b/rc_hip/rc_hip/settings.py
index 61bbc36..5f216bf 100644
--- a/rc_hip/rc_hip/settings.py
+++ b/rc_hip/rc_hip/settings.py
@@ -163,7 +163,6 @@ AUTH_USER_MODEL = "repapp.CustomUser"
AUTHENTICATION_BACKENDS = [
"repapp.backends.EmailBackend",
"django.contrib.auth.backends.ModelBackend",
- # "mozilla_django_oidc.auth.OIDCAuthenticationBackend",
"repapp.backends.KeycloakOIDCAB",
"repapp.backends.OneTimeLoginBackend",
]
@@ -184,5 +183,24 @@ if DEBUG:
LOGIN_REDIRECT_URL = "http://127.0.0.1:8000/"
LOGOUT_REDIRECT_URL = "http://127.0.0.1:8000/"
else:
- LOGIN_REDIRECT_URL = "https://repapp.rc-hip.de/"
- LOGOUT_REDIRECT_URL = "https://repapp.rc-hip.de/"
+ LOGIN_REDIRECT_URL = "https://anmeldung.repaircafe-hilpoltstein.de/"
+ LOGOUT_REDIRECT_URL = "https://anmeldung.repaircafe-hilpoltstein.de/"
+
+
+LOG_LEVEL = "INFO"
+if DEBUG:
+ LOG_LEVEL = "DEBUG"
+
+LOGGING = {
+ "version": 1,
+ "disable_existing_loggers": False,
+ "handlers": {
+ "console": {
+ "class": "logging.StreamHandler",
+ },
+ },
+ "root": {
+ "handlers": ["console"],
+ "level": LOG_LEVEL,
+ },
+}
diff --git a/rc_hip/repapp/admin.py b/rc_hip/repapp/admin.py
index 6f24f09..7eb2f34 100644
--- a/rc_hip/repapp/admin.py
+++ b/rc_hip/repapp/admin.py
@@ -5,7 +5,22 @@ from django.contrib import admin
from import_export.admin import ImportExportModelAdmin, ExportActionMixin
from import_export import resources
from .models import (Organisator, Cafe, Question, Device, CustomUser,
- Reparateur, Appointment, Guest, Candidate, OneTimeLogin)
+ Reparateur, Appointment, Guest, Candidate, OneTimeLogin, Message)
+
+
+class CafeResource(resources.ModelResource):
+ """
+ Resource wrapper for Cafe model.
+ """
+ class Meta:
+ """
+ Meta data for resource model.
+ """
+ model = Cafe
+
+ @staticmethod
+ def get_display_name():
+ return "Repair-Café"
class GuestResource(resources.ModelResource):
@@ -93,16 +108,20 @@ class ExportAdmin(ImportExportModelAdmin, ExportActionMixin):
QuestionResource,
AppointmentResource,
CandidateResource,
+ CafeResource,
]
+# Register all models of RepApp for the admin interface.
admin.site.register(Organisator)
-admin.site.register(Cafe)
+admin.site.register(Reparateur)
+admin.site.register(CustomUser)
+admin.site.register(OneTimeLogin)
+admin.site.register(Message)
+# Make the "data" models exportable.
+admin.site.register(Cafe, ExportAdmin)
admin.site.register(Question, ExportAdmin)
admin.site.register(Guest, ExportAdmin)
admin.site.register(Device, ExportAdmin)
-admin.site.register(Reparateur)
admin.site.register(Appointment, ExportAdmin)
admin.site.register(Candidate, ExportAdmin)
-admin.site.register(CustomUser)
-admin.site.register(OneTimeLogin)
diff --git a/rc_hip/repapp/backends.py b/rc_hip/repapp/backends.py
index 126dcf8..ac8e454 100644
--- a/rc_hip/repapp/backends.py
+++ b/rc_hip/repapp/backends.py
@@ -1,11 +1,39 @@
"""
Authentication backends for RepApp.
"""
+import unicodedata
+import logging
from django.contrib.auth import get_user_model
from django.contrib.auth.backends import ModelBackend
from mozilla_django_oidc.auth import OIDCAuthenticationBackend
-from .utils import generate_username, create_repapp_user
-from .models import OneTimeLogin
+from .models import OneTimeLogin, Organisator, Reparateur
+
+logger = logging.getLogger(__name__)
+
+
+def generate_username(email):
+ # Using Python 3 and Django 1.11+, usernames can contain alphanumeric
+ # (ascii and unicode), _, @, +, . and - characters. So we normalize
+ # it and slice at 150 characters.
+ return unicodedata.normalize('NFKC', email)[:150]
+
+
+def create_repapp_user(user):
+ organisator = Organisator.objects.filter(mail=user.email).first()
+ if not organisator:
+ reparateur = Reparateur.objects.filter(mail=user.email).first()
+ if not reparateur:
+ reparateur = Reparateur(
+ name=user.username,
+ mail=user.email,
+ )
+ reparateur.save()
+ else:
+ reparateur.name = user.username
+ reparateur.save()
+ else:
+ organisator.name = user.username
+ organisator.save()
class OneTimeLoginBackend(ModelBackend):
@@ -14,7 +42,6 @@ class OneTimeLoginBackend(ModelBackend):
"""
def authenticate(self, request, username=None, password=None, **kwargs):
- print(f'authenticate {username}')
login = OneTimeLogin.objects.filter(secret=username).first()
if login:
return login.user
@@ -28,10 +55,10 @@ class EmailBackend(ModelBackend):
"""
def authenticate(self, request, username=None, password=None, **kwargs):
- userModel = get_user_model()
+ user_model = get_user_model()
try:
- user = userModel.objects.get(email=username)
- except userModel.DoesNotExist:
+ user = user_model.objects.get(email=username)
+ except user_model.DoesNotExist:
return None
else:
if user.check_password(password):
@@ -41,24 +68,37 @@ class EmailBackend(ModelBackend):
class KeycloakOIDCAB(OIDCAuthenticationBackend):
"""
- KeycloakOIDCAB allows a login using Open ID Connect (with the Repair-Café Keycloak Single Sign On server)
+ KeycloakOIDCAB allows a login using Open ID Connect
+ (with the Repair-Café Keycloak Single Sign On server)
"""
def create_user(self, claims):
user = super(KeycloakOIDCAB, self).create_user(claims)
+ logger.debug(f'Create user {user.email}')
- user.username = claims.get(
- 'preferred_username', generate_username(user.email))
- user.save()
+ try:
+ user.username = claims.get(
+ 'preferred_username', generate_username(user.email))
+ user.save()
+ except Exception as exception:
+ logger.error(exception)
+ user.username = generate_username(user.email)
+ user.save()
+
+ logger.debug(f'Updated username {user.username}')
create_repapp_user(user)
return user
def update_user(self, user, claims):
- user.username = claims.get(
- 'preferred_username', generate_username(user.email))
- user.save()
+ logger.debug(f'Update user {user.email} ({user.username})')
+ try:
+ user.username = claims.get(
+ 'preferred_username', generate_username(user.email))
+ user.save()
+ except Exception as exception:
+ logger.error(exception)
create_repapp_user(user)
diff --git a/rc_hip/repapp/fixtures/Hummingbird.jpg b/rc_hip/repapp/fixtures/Hummingbird.jpg
new file mode 100644
index 0000000..8cdf460
Binary files /dev/null and b/rc_hip/repapp/fixtures/Hummingbird.jpg differ
diff --git a/rc_hip/repapp/fixtures/Nut.jpg b/rc_hip/repapp/fixtures/Nut.jpg
new file mode 100644
index 0000000..7308ecf
Binary files /dev/null and b/rc_hip/repapp/fixtures/Nut.jpg differ
diff --git a/rc_hip/repapp/fixtures/cafe-data.json b/rc_hip/repapp/fixtures/cafe-data.json
new file mode 100644
index 0000000..05a5e96
--- /dev/null
+++ b/rc_hip/repapp/fixtures/cafe-data.json
@@ -0,0 +1,11 @@
+[
+ {
+ "model": "repapp.cafe",
+ "pk": 1,
+ "fields": {
+ "location": "Haus Einstein' (beim Gymnasium)",
+ "address": "Patersholzer Weg 19, Hilpoltstein",
+ "event_date": "2023-05-13"
+ }
+ }
+]
\ No newline at end of file
diff --git a/rc_hip/repapp/forms.py b/rc_hip/repapp/forms.py
index 9193c73..c96e21f 100644
--- a/rc_hip/repapp/forms.py
+++ b/rc_hip/repapp/forms.py
@@ -6,6 +6,9 @@ from django.core.exceptions import ValidationError
class HoneypotField(forms.BooleanField):
+ """
+ Simple honeypot field.
+ """
default_widget = forms.CheckboxInput(
{'style': 'display:none !important;', 'tabindex': '-1', 'autocomplete': 'off'})
@@ -22,6 +25,9 @@ class HoneypotField(forms.BooleanField):
class RegisterDevice(forms.Form):
+ """
+ Form for registering a device for a repair cafe.
+ """
mail = forms.EmailField(
label="eMail Adresse",
help_text="Diese eMail-Adresse wird für Aktualisierungen"
@@ -49,7 +55,8 @@ class RegisterDevice(forms.Form):
)
follow_up = forms.BooleanField(
label="Folgetermin",
- help_text="Kreuzen Sie diese Kästchen an wenn sie mit diesem Gerät bereits bei einem Repair-Café Termin waren.",
+ help_text="Kreuzen Sie diese Kästchen an wenn sie mit diesem Gerät "
+ "bereits bei einem Repair-Café Termin waren.",
required=False
)
confirm_repair = forms.BooleanField(
@@ -72,6 +79,9 @@ class RegisterDevice(forms.Form):
class RegisterGuest(forms.Form):
+ """
+ Form for registering new guests.
+ """
name = forms.CharField(
label="Name",
max_length=200
diff --git a/rc_hip/repapp/live_tests.py b/rc_hip/repapp/live_tests.py
new file mode 100644
index 0000000..1a3e0a3
--- /dev/null
+++ b/rc_hip/repapp/live_tests.py
@@ -0,0 +1,112 @@
+import time
+import os
+from pathlib import Path
+from django.contrib.staticfiles.testing import StaticLiveServerTestCase
+from selenium.webdriver.common.by import By
+from selenium.webdriver.firefox.webdriver import WebDriver
+
+
+class WorkflowTests(StaticLiveServerTestCase):
+ fixtures = ["cafe-data.json"]
+
+ @classmethod
+ def setUpClass(cls):
+ super().setUpClass()
+ cls.selenium = WebDriver()
+ cls.selenium.implicitly_wait(10)
+
+ @classmethod
+ def tearDownClass(cls):
+ cls.selenium.quit()
+ super().tearDownClass()
+
+ def test_register_device(self):
+ # Open landing page
+ self.selenium.get(f"{self.live_server_url}/")
+ # Click on a register link
+ self.selenium.find_element(By.CLASS_NAME, "register_link").click()
+ time.sleep(1)
+ # Enter new device
+ # Enter guest mail address
+ mail = self.selenium.find_element(By.NAME, "mail")
+ mail.send_keys("guest@example.com")
+ # Enter device
+ device = self.selenium.find_element(By.NAME, "device")
+ device.send_keys("A Test Device")
+ # Enter manufacturer
+ manufacturer = self.selenium.find_element(By.NAME, "manufacturer")
+ manufacturer.send_keys("A Test Manufacturer")
+ # Enter a error description
+ error = self.selenium.find_element(By.NAME, "error")
+ error.send_keys("A description of the issue\nof the device.")
+ # Skip device picture and device type plate
+ # No follow up repair
+ # Accept repair conditions
+ self.selenium.find_element(By.NAME, "confirm_repair").click()
+ # Accept data protection notice
+ self.selenium.find_element(By.NAME, "confirm_data").click()
+ time.sleep(1)
+ # Send form
+ self.selenium.find_element(By.CLASS_NAME, 'submit_button').click()
+ time.sleep(1)
+ # Register new guest
+ # Enter guest name
+ name = self.selenium.find_element(By.NAME, "name")
+ name.send_keys("A Guest")
+ # Enter guest phone
+ phone = self.selenium.find_element(By.NAME, "phone")
+ phone.send_keys("0911 123 456")
+ # Enter guest residence
+ residence = self.selenium.find_element(By.NAME, "residence")
+ residence.send_keys("Musterstadt")
+ time.sleep(1)
+ # Send form
+ self.selenium.find_element(By.CLASS_NAME, 'submit_button').click()
+ time.sleep(1)
+ self.assertTrue("confirm" in self.selenium.current_url)
+ self.assertTrue("Anmeldung erfolgreich!" in self.selenium.page_source)
+ # Register second device
+ # Open landing page again
+ self.selenium.get(f"{self.live_server_url}/")
+ # Click on a register link
+ self.selenium.find_element(By.CLASS_NAME, "register_link").click()
+ time.sleep(1)
+ # Enter new device
+ # Enter guest mail address
+ mail = self.selenium.find_element(By.NAME, "mail")
+ mail.send_keys("guest@example.com")
+ # Enter device
+ device = self.selenium.find_element(By.NAME, "device")
+ device.send_keys("Another Test Device")
+ # Enter manufacturer
+ manufacturer = self.selenium.find_element(By.NAME, "manufacturer")
+ manufacturer.send_keys("Another Test Manufacturer")
+ # Enter a error description
+ error = self.selenium.find_element(By.NAME, "error")
+ error.send_keys("Another issue description.")
+ # Add device picture
+ test_script_folder = Path(__file__).resolve().parent
+ fixtures_folder = os.path.join(test_script_folder, "fixtures")
+ device_picture_file = os.path.join(fixtures_folder, "Hummingbird.jpg")
+ device_picture = self.selenium.find_element(By.NAME, "device_picture")
+ device_picture.send_keys(device_picture_file)
+ print(f"Using device picture {device_picture_file}")
+ # Add type plate picture
+ type_plate_picture_file = os.path.join(fixtures_folder, "Nut.jpg")
+ type_plate_picture = self.selenium.find_element(
+ By.NAME, "type_plate_picture")
+ type_plate_picture.send_keys(type_plate_picture_file)
+ print(f"Using type plate picture {type_plate_picture_file}")
+ # Select as follow up repair
+ self.selenium.find_element(By.NAME, "follow_up").click()
+ # Accept repair conditions
+ self.selenium.find_element(By.NAME, "confirm_repair").click()
+ # Accept data protection notice
+ self.selenium.find_element(By.NAME, "confirm_data").click()
+ time.sleep(1)
+ # Send form
+ self.selenium.find_element(By.CLASS_NAME, 'submit_button').click()
+ time.sleep(1)
+ # Guest is known, no guest registration needed.
+ self.assertTrue("confirm" in self.selenium.current_url)
+ self.assertTrue("Anmeldung erfolgreich!" in self.selenium.page_source)
diff --git a/rc_hip/repapp/migrations/0003_guest_user.py b/rc_hip/repapp/migrations/0003_guest_user.py
new file mode 100644
index 0000000..805a450
--- /dev/null
+++ b/rc_hip/repapp/migrations/0003_guest_user.py
@@ -0,0 +1,20 @@
+# Generated by Django 4.2 on 2023-04-25 07:05
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ('repapp', '0002_message'),
+ ]
+
+ operations = [
+ migrations.AddField(
+ model_name='guest',
+ name='user',
+ field=models.ForeignKey(null=True, on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL, verbose_name='Benutzer'),
+ ),
+ ]
diff --git a/rc_hip/repapp/migrations/0004_alter_onetimelogin_secret.py b/rc_hip/repapp/migrations/0004_alter_onetimelogin_secret.py
new file mode 100644
index 0000000..ce8607b
--- /dev/null
+++ b/rc_hip/repapp/migrations/0004_alter_onetimelogin_secret.py
@@ -0,0 +1,18 @@
+# Generated by Django 4.2 on 2023-04-25 12:08
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ('repapp', '0003_guest_user'),
+ ]
+
+ operations = [
+ migrations.AlterField(
+ model_name='onetimelogin',
+ name='secret',
+ field=models.CharField(max_length=200, unique=True, verbose_name='Geheimnis'),
+ ),
+ ]
diff --git a/rc_hip/repapp/models.py b/rc_hip/repapp/models.py
index 833c08b..b78fce5 100644
--- a/rc_hip/repapp/models.py
+++ b/rc_hip/repapp/models.py
@@ -7,6 +7,27 @@ from django.utils.translation import gettext_lazy as _
from django.contrib.auth.models import AbstractUser
+def device_directory_path(instance, filename):
+ """
+ device_directory_path generates a device-specific storage path for file uploads.
+ """
+ return f'device_{instance.identifier}/{filename}'
+
+
+class CustomUser(AbstractUser):
+ """
+ Custom user object with unique email.
+ """
+ email = models.EmailField(unique=True, verbose_name=_("eMail Adresse"))
+
+ class Meta:
+ verbose_name = _('Benutzer')
+ verbose_name_plural = _('Benutzer')
+
+ def __str__(self):
+ return f'{self.email}'
+
+
class Cafe(models.Model):
"""
A Cafe is a "Repair-Café event.
@@ -64,6 +85,8 @@ class Guest(models.Model):
phone = models.CharField(max_length=200, verbose_name=_("Telefonnummer"))
residence = models.CharField(max_length=200, verbose_name=_("Wohnort"))
mail = models.CharField(max_length=200, verbose_name=_("eMail"))
+ user = models.ForeignKey(
+ CustomUser, on_delete=models.CASCADE, null=True, verbose_name=_("Benutzer"))
class Meta:
verbose_name = _('Gast')
@@ -73,18 +96,13 @@ class Guest(models.Model):
return f'Gast {self.name} (eMail: {self.mail})'
-def device_directory_path(instance, filename):
- """
- device_directory_path generates a device-specific storage path for file uploads.
- """
- return f'device_{instance.identifier}/{filename}'
-
-
class Device(models.Model):
"""
A Device is a broken device owned by a guest which shall be repaired during a Repair-Café.
"""
identifier = models.CharField(max_length=200, verbose_name=_("ID"))
+ date = models.DateField(verbose_name=_(
+ "Erstellungsdatum"), default=django.utils.timezone.now)
device = models.CharField(max_length=200, verbose_name=_("Art des Geräts"))
manufacturer = models.CharField(
max_length=200, verbose_name=_("Hersteller & Modell/Typ"))
@@ -94,13 +112,11 @@ class Device(models.Model):
upload_to=device_directory_path, null=True, verbose_name=_("Foto vom Gerät"))
type_plate_picture = models.FileField(
upload_to=device_directory_path, null=True, verbose_name=_("Foto vom Typenschild"))
+ confirmed = models.BooleanField(verbose_name=_("Bestätigung gesendet?"))
guest = models.ForeignKey(
Guest, on_delete=models.CASCADE, null=True, verbose_name=_("Gast"))
cafe = models.ForeignKey(
Cafe, on_delete=models.CASCADE, null=False, verbose_name=_("Repair-Café"))
- confirmed = models.BooleanField(verbose_name=_("Bestätigung gesendet?"))
- date = models.DateField(verbose_name=_(
- "Erstellungsdatum"), default=django.utils.timezone.now)
class Meta:
verbose_name = _('Gerät')
@@ -174,25 +190,12 @@ class Candidate(models.Model):
return f'Kandidat {self.cafe.event_date} für Gerät {self.device.device}'
-class CustomUser(AbstractUser):
- email = models.EmailField(unique=True, verbose_name=_("eMail Adresse"))
-
- class Meta:
- verbose_name = _('Benutzer')
- verbose_name_plural = _('Benutzer')
-
- def __str__(self):
- return f'{self.email}'
-
-
class OneTimeLogin(models.Model):
"""
A OneTimeLogin is a secret which can be used once to login a user.
"""
secret = models.CharField(max_length=200, verbose_name=_(
- "secret"), unique=True, null=False)
- user = models.ForeignKey(
- CustomUser, on_delete=models.CASCADE, null=False, verbose_name=_("Benutzer"))
+ "Geheimnis"), unique=True, null=False)
url = models.CharField(max_length=200, verbose_name=_("URL"))
created = models.DateField(verbose_name=_(
"Erstellungsdatum"), default=django.utils.timezone.now)
@@ -200,6 +203,8 @@ class OneTimeLogin(models.Model):
verbose_name=_("Login benutzt?"), default=False)
login_date = models.DateField(verbose_name=_(
"Login Datum"), null=True)
+ user = models.ForeignKey(
+ CustomUser, on_delete=models.CASCADE, null=False, verbose_name=_("Benutzer"))
class Meta:
verbose_name = _('Einmal-Login')
diff --git a/rc_hip/repapp/templates/repapp/index.html b/rc_hip/repapp/templates/repapp/index.html
index 07d63d7..44bf095 100644
--- a/rc_hip/repapp/templates/repapp/index.html
+++ b/rc_hip/repapp/templates/repapp/index.html
@@ -1,9 +1,9 @@
{% extends "repapp/base.html" %}
{% block title %}
- - Repair-Cafés
+ - Repair-Cafés
{% endblock title %}
{% block head %}
-
+
{% endblock head %}
{% block content %}
-