TestTool/Dokumentation: Unterschied zwischen den Versionen

Aus Foxwiki
K Dirkwagner verschob die Seite TestTool:Dokumentation nach TestTool/Dokumentation, ohne dabei eine Weiterleitung anzulegen: Textersetzung - „:“ durch „/“
 
(30 dazwischenliegende Versionen von 2 Benutzern werden nicht angezeigt)
Zeile 13: Zeile 13:
==Startphase==
==Startphase==
===Ist-Zustand===
===Ist-Zustand===
*Derzeit müssen alle Prüfungen händisch erstellt werden
*Ergebnisse müssen manuell ermittelt und geprüft werden, was Zeit dauert
*Vorbild: Ein portabler LPIC-Simulator aus XML und JavaScript-Dateien, der jedoch nur eingeschränkt nützlich ist
**Keine Kategorisierung möglich
**Neue Fragen und Antworten müssen in '''eine''' XML-Datei eingetragen sein. Kenntnisse in XML müssen also vorhanden sein.
**Keine personalisierte Prüfungen möglich
===Wirtschaftlichkeitsanalyse===
===Wirtschaftlichkeitsanalyse===
===Anwendungsfälle===
===Anwendungsfälle===
*Grundgedanken
**''Prüfer'' und ''Prüfling''
**Prüfer muss Fragen, Antworten, neue Prüflinge, neue Fachgebiete und Themen, neue Prüfungen erstellen können
**Prüfer kann Ergebnisse von Prüflingen einsichten
**Prüfling muss Prüfung ablegen können
**Anwendung muss Ergebnis dem Prüfling präsentieren
===Lastenheft===
===Lastenheft===
* Beschreibung des Lastenhefts(Nicht das Lastenheft selber! Auszugsweise im Anhang!)
* Beschreibung des Lastenhefts(Nicht das Lastenheft selber! Auszugsweise im Anhang!)
Zeile 22: Zeile 36:


===Datenbank===
===Datenbank===
*Grundgedanken
**Drei Blöcke: ''Fragen-Antworten''-Block, ''Prüfung''-Block und ''Teilnehmer''-Block
**Eine Frage hat mehrere Antworten(mind. 1-2 je nach Frageart); Eine Antwort gehört zu einer Frage
**Eine Prüfung hat mehrere Teilnehmer und ein Teilnehmer belegt mehrere Prüfungen.
**Eine Frage kommt in mehreren Prüfungen vor, eine Prüfung hat mehrere Fragen.
**Ein Benutzer/Teilnehmer gehört zu einer Gruppe(Team) und hat eine bestimmte Rolle in der Anwendung(Admin, Editor, Prüfling).
[[Datei:tabellenmodell_testtool.png|1200px]]
[[Datei:tabellenmodell_testtool.png|1200px]]
*Damit keine Redundanzen entstehen bei den Fragen, wird auf fg_fragetext ein UNIQUE KEY gesetzt.
*Damit keine Redundanzen entstehen bei den Fragen, wird auf fg_fragetext ein UNIQUE KEY gesetzt.
Zeile 36: Zeile 56:


===Benutzeroberfläche===
===Benutzeroberfläche===
*Realisiert mithilfe des Frameworks ''Bootstrap''
*HTML/CSS größtenteils


===Funktionen===
===Funktionen===
*Funktionen sollen die [[TestTool:Use-Case-Szenarien|Anwendungsfälle]] realisieren können
*Zusätzliche Funktionen
**Filterung
**Sortierung
**Import von Fragen
**Benutzerinformationen ändern bzgl. Gruppe, Rolle, Benutzernamen etc.
*Für das Erstellen neuer Benutzer gilt folgendes:
**Passwort muss verschlüsselt auf der Datenbank liegen
**Realisierung erfolgt durch SHA512 (Umwandlung des Passworts durch eine Hash-Funktion)
**Zur Erhöhung der Sicherheit wird zusätzlich ein SALT verwendet


===Pflichtenheft===
===Pflichtenheft===
Zeile 52: Zeile 84:
Fragentabelle erstellen mit Primärschlüssel und NOT NULL auf Fragetext.
Fragentabelle erstellen mit Primärschlüssel und NOT NULL auf Fragetext.


  CREATE TABLE fragen (fr_id INT AUTO_INCREMENT PRIMARY KEY, fr_fragetext TEXT NOT NULL, fr_th_id INT, fr_sc_id INT, fr_fa_id INT, fr_delete BOOLEAN);
  CREATE TABLE fragen  
(fr_id INT PRIMARY KEY AUTO_INCREMENT,  
fr_fragetext VARCHAR(255) NOT NULL,  
fr_th_id INT,  
fr_sc_id INT,  
fr_fa_id INT,  
fr_delete BOOLEAN);


Antworttabelle erstellen mit Primärschlüssel und UNIQUE-Index auf Antworttext.
Antworttabelle erstellen mit Primärschlüssel und UNIQUE-Index auf Antworttext.


  CREATE TABLE antworten (an_id INT AUTO_INCREMENT PRIMARY KEY, an_antworttext TEXT UNIQUE, an_fr_id int, an_richtig boolean, an_delete boolean);
  CREATE TABLE antworten  
(an_id INT PRIMARY KEY AUTO_INCREMENT,  
an_antworttext TEXT UNIQUE,
an_fr_id int,  
an_richtig boolean,  
an_delete boolean);
 
Thementabelle erstellen mit Primärschlüssel und UNIQUE-Index auf Thema.
CREATE TABLE themen
(th_id INT PRIMARY KEY AUTO_INCREMENT,
th_thema varchar(40) UNIQUE,
th_fa_id INT,
th_delete boolean);
 
Tabelle mit Fachgebieten erstellen mit Primärschlüssel und UNIQUE-Index auf Fachgebiet.
 
CREATE TABLE fachgebiete
(fa_id INT PRIMARY KEY AUTO_INCREMENT,
fa_fachgebiet varchar(40) UNIQUE,
fa_delete boolean);


Im Nachhinein Beziehung aufsetzen zwischen Antworten und Fragen. Jede Frage hat mehrere Antworten, jede Antwort gehört zu einer Frage. Einsetzen der Lösch- und Änderungsweitergabe.
Im Nachhinein Beziehung aufsetzen zwischen Antworten und Fragen. Jede Frage hat mehrere Antworten, jede Antwort gehört zu einer Frage. Einsetzen der Lösch- und Änderungsweitergabe.


  ALTER TABLE antworten ADD FOREIGN KEY(an_fr_id) REFERENCES fragen(fr_id) ON DELETE CASCADE ON UPDATE CASCADE;
  ALTER TABLE antworten  
ADD FOREIGN KEY(an_fr_id)  
REFERENCES fragen(fr_id)  
ON DELETE CASCADE ON UPDATE CASCADE;


Im Nachhinein einen UNIQUE-KEY aufsetzen auf ''fr_fragetext'' in ''Fragen''
Tabelle mit Benutzer/Teilnehmer erstellen mit UNIQUE-KEY auf ''tn_username''


  ALTER TABLE fragen ADD UNIQUE KEY(fr_fragetext);
  CREATE TABLE teilnehmer
(tn_id INT PRIMARY KEY AUTO_INCREMENT,
tn_vorname VARCHAR(40) NOT NULL,
tn_nachname VARCHAR(40) NOT NULL,
tn_ro_id INT NOT NULL,
tn_gr_id INT NOT NULL,
tn_username VARCHAR(40)UNIQUE NOT NULL,
tn_passwort VARCHAR(255) NOT NULL,
tn_delete BOOLEAN);


Leider führt dies zu einem Fehler:
Prüfungstabelle erstellen mit Standardwert 90 für ''pr_dauer''


  ERROR 1170:BLOB/TEXT column 'fr_fragetext' used in key specification without a key length
  CREATE TABLE pruefung
(pr_id INT PRIMARY KEY AUTO_INCREMENT,
pr_titel VARCHAR(40) NOT NULL,
pr_datum DATE NOT NULL,
pr_dauer INT NOT NULL DEFAULT 90,
pr_wiederholbar BOOLEAN,
pr_delete BOOLEAN);


Grund: MySQL indiziert nur eine bestimmte, feste Anzahl an Zeichen
Zuordnungstabelle ''Prüfungsfragen'' erstellen
 
CREATE TABLE pruefungsfragen
(pf_fr_id INT,
pf_pr_id INT);


===Implementierung der Entitäten===
===Implementierung der Entitäten===
===Implementierung der Programmierlogik===
===Implementierung der Programmierlogik===
====Import-Funktion====
====Ermitteln und Berechnen des Ergebnisses====
===Testphase===
===Testphase===
Während der Testphase wurden folgenden Fehler entdeckt:
*SQL-Injections möglich im Sucheingabefeld
**Lösung: Benutzen der php-Funktion ''bindParam''
*Unauthorisierter Zugriff, wenn beim Browser auf den Zurück-Knopf klickt.
**Lösung: Prüfen, ob der Benutzer Zugriff darauf hat.
==Abschlussphase==
==Abschlussphase==


Zeile 82: Zeile 172:


===Dokumentation===
===Dokumentation===
*Es wird neben der Projektdokumentation eine [[TestTool:Benutzerdoku|Benutzerdokumenation]] verfasst.


==Fazit==
==Fazit==


===Soll/Ist-Vergleich===
===Ist/Soll-Vergleich===


===Ausblick/Verbesserungen===
===Ausblick/Verbesserungen===
*Einfügen von Bildern
*Einfügen neuer Fragetypen(Zuordnungsfragen, Bildbeschreibungsfragen)
*Bessere Programmierung, Modularisierung


==Quellen==
==Quellen==


=Anhang=
=Anhang=
#Auszug aus dem Lastenheft
*Auszug aus dem Lastenheft
#Auszug aus dem Pflichtenheft
*Auszug aus dem Pflichtenheft
#ER-Modell
*ER-Modell
[[Datei:er-modell_testtool.png|750px]]
[[Datei:er-modell_testtool.png|750px]]
#Tabellenmodell
*Tabellenmodell
[[Datei:tabellenmodell_testtool.png|750px]]
[[Datei:tabellenmodell_testtool.png|750px]]
#Use-Case-Szenarien
*Use-Case-Szenarien
#Use-Case-Diagramm
*Use-Case-Diagramm
#Aktivitätsdiagramm
*Aktivitätsdiagramm
#Auszug aus der Funktion "Bewerten einer Prüfung"
*Auszug aus der Funktion "Bewerten einer Prüfung"


== Formalien ==
== Formalien ==
Zeile 119: Zeile 213:




[[Category:Projekt:TestTool]]
[[Kategorie:TestTool]]

Aktuelle Version vom 29. März 2023, 13:58 Uhr

Projektdokumentation zur Webanwendung

Einleitung

In dieser Projektdokumentation wird der Ablauf des Abschlussprojektes erläutert, das der Autor im Rahmen seiner Abschlussprüfung zum Fachinformatiker für Anwendungsentwicklung durchführt.

Projektbeschreibung

Für die Dirk Wagner Berlin soll eine Webanwendung mit HTML und PHP entwickelt werden. Diese Webanwendung soll bestimmte Anforderungen erfüllen, die das Erstellen von Prüfungen erleichtern sollen.

Projektziel

Das Ziel dieses Projektes ist die erfolgreiche Umsetzung einer Webanwendung, die alle Prüfungen von Prüfern verwaltet. Die Prüfer sollen Fragen und mögliche Antworten eintragen können. Die Prüfungen sollen von Prüflingen durchgeführt werden und anschließend ein Ergebnis der Prüfung präsentiert.


Phasen des Projekts

Startphase

Ist-Zustand

  • Derzeit müssen alle Prüfungen händisch erstellt werden
  • Ergebnisse müssen manuell ermittelt und geprüft werden, was Zeit dauert
  • Vorbild: Ein portabler LPIC-Simulator aus XML und JavaScript-Dateien, der jedoch nur eingeschränkt nützlich ist
    • Keine Kategorisierung möglich
    • Neue Fragen und Antworten müssen in eine XML-Datei eingetragen sein. Kenntnisse in XML müssen also vorhanden sein.
    • Keine personalisierte Prüfungen möglich

Wirtschaftlichkeitsanalyse

Anwendungsfälle

  • Grundgedanken
    • Prüfer und Prüfling
    • Prüfer muss Fragen, Antworten, neue Prüflinge, neue Fachgebiete und Themen, neue Prüfungen erstellen können
    • Prüfer kann Ergebnisse von Prüflingen einsichten
    • Prüfling muss Prüfung ablegen können
    • Anwendung muss Ergebnis dem Prüfling präsentieren

Lastenheft

  • Beschreibung des Lastenhefts(Nicht das Lastenheft selber! Auszugsweise im Anhang!)
  • Soll nach der MoSCoW-Methode(Must, Should, Could, Won´t) formuliert werden.

Entwurf

Datenbank

  • Grundgedanken
    • Drei Blöcke: Fragen-Antworten-Block, Prüfung-Block und Teilnehmer-Block
    • Eine Frage hat mehrere Antworten(mind. 1-2 je nach Frageart); Eine Antwort gehört zu einer Frage
    • Eine Prüfung hat mehrere Teilnehmer und ein Teilnehmer belegt mehrere Prüfungen.
    • Eine Frage kommt in mehreren Prüfungen vor, eine Prüfung hat mehrere Fragen.
    • Ein Benutzer/Teilnehmer gehört zu einer Gruppe(Team) und hat eine bestimmte Rolle in der Anwendung(Admin, Editor, Prüfling).

  • Damit keine Redundanzen entstehen bei den Fragen, wird auf fg_fragetext ein UNIQUE KEY gesetzt.
  • Hilft nicht 100%, da ähnliche Fragen trotzdem in die Datenbank geschrieben werden können.
  • Macht keinen Unterschied, ob die Frage Groß- oder kleingeschrieben ist. Ist die Frage identisch, wird sie verworfen.
  • Ebenfalls UNIQUE KEY gesetzt:
    • fg_fachgebiet
    • pr_titel
    • tn_username
    • ro_rolle
    • gr_gruppe
    • sc_level
    • fa_frageart

Benutzeroberfläche

  • Realisiert mithilfe des Frameworks Bootstrap
  • HTML/CSS größtenteils

Funktionen

  • Funktionen sollen die Anwendungsfälle realisieren können
  • Zusätzliche Funktionen
    • Filterung
    • Sortierung
    • Import von Fragen
    • Benutzerinformationen ändern bzgl. Gruppe, Rolle, Benutzernamen etc.
  • Für das Erstellen neuer Benutzer gilt folgendes:
    • Passwort muss verschlüsselt auf der Datenbank liegen
    • Realisierung erfolgt durch SHA512 (Umwandlung des Passworts durch eine Hash-Funktion)
    • Zur Erhöhung der Sicherheit wird zusätzlich ein SALT verwendet

Pflichtenheft

Implementierungsphase

Erstellung der Datenbank

CREATE DATABASE c8testtool;
USE c8testtool;

Fragentabelle erstellen mit Primärschlüssel und NOT NULL auf Fragetext.

CREATE TABLE fragen 
(fr_id INT PRIMARY KEY AUTO_INCREMENT, 
fr_fragetext VARCHAR(255) NOT NULL, 
fr_th_id INT, 
fr_sc_id INT, 
fr_fa_id INT, 
fr_delete BOOLEAN);

Antworttabelle erstellen mit Primärschlüssel und UNIQUE-Index auf Antworttext.

CREATE TABLE antworten 
(an_id INT PRIMARY KEY AUTO_INCREMENT, 
an_antworttext TEXT UNIQUE,
an_fr_id int, 
an_richtig boolean, 
an_delete boolean);

Thementabelle erstellen mit Primärschlüssel und UNIQUE-Index auf Thema.

CREATE TABLE themen
(th_id INT PRIMARY KEY AUTO_INCREMENT,
th_thema varchar(40) UNIQUE,
th_fa_id INT,
th_delete boolean);

Tabelle mit Fachgebieten erstellen mit Primärschlüssel und UNIQUE-Index auf Fachgebiet.

CREATE TABLE fachgebiete
(fa_id INT PRIMARY KEY AUTO_INCREMENT,
fa_fachgebiet varchar(40) UNIQUE,
fa_delete boolean);

Im Nachhinein Beziehung aufsetzen zwischen Antworten und Fragen. Jede Frage hat mehrere Antworten, jede Antwort gehört zu einer Frage. Einsetzen der Lösch- und Änderungsweitergabe.

ALTER TABLE antworten 
ADD FOREIGN KEY(an_fr_id) 
REFERENCES fragen(fr_id) 
ON DELETE CASCADE ON UPDATE CASCADE;

Tabelle mit Benutzer/Teilnehmer erstellen mit UNIQUE-KEY auf tn_username

CREATE TABLE teilnehmer 
(tn_id INT PRIMARY KEY AUTO_INCREMENT,
tn_vorname VARCHAR(40) NOT NULL,
tn_nachname VARCHAR(40) NOT NULL,
tn_ro_id INT NOT NULL,
tn_gr_id INT NOT NULL,
tn_username VARCHAR(40)UNIQUE NOT NULL, 
tn_passwort VARCHAR(255) NOT NULL,
tn_delete BOOLEAN);

Prüfungstabelle erstellen mit Standardwert 90 für pr_dauer

CREATE TABLE pruefung
(pr_id INT PRIMARY KEY AUTO_INCREMENT,
pr_titel VARCHAR(40) NOT NULL,
pr_datum DATE NOT NULL,
pr_dauer INT NOT NULL DEFAULT 90,
pr_wiederholbar BOOLEAN,
pr_delete BOOLEAN);

Zuordnungstabelle Prüfungsfragen erstellen

CREATE TABLE pruefungsfragen
(pf_fr_id INT,
pf_pr_id INT);

Implementierung der Entitäten

Implementierung der Programmierlogik

Import-Funktion

Ermitteln und Berechnen des Ergebnisses

Testphase

Während der Testphase wurden folgenden Fehler entdeckt:

  • SQL-Injections möglich im Sucheingabefeld
    • Lösung: Benutzen der php-Funktion bindParam
  • Unauthorisierter Zugriff, wenn beim Browser auf den Zurück-Knopf klickt.
    • Lösung: Prüfen, ob der Benutzer Zugriff darauf hat.

Abschlussphase

Abnahme

Einführung

Dokumentation

Fazit

Ist/Soll-Vergleich

Ausblick/Verbesserungen

  • Einfügen von Bildern
  • Einfügen neuer Fragetypen(Zuordnungsfragen, Bildbeschreibungsfragen)
  • Bessere Programmierung, Modularisierung

Quellen

Anhang

  • Auszug aus dem Lastenheft
  • Auszug aus dem Pflichtenheft
  • ER-Modell

  • Tabellenmodell

  • Use-Case-Szenarien
  • Use-Case-Diagramm
  • Aktivitätsdiagramm
  • Auszug aus der Funktion "Bewerten einer Prüfung"

Formalien

Deckblatt

  • Projektbezeichnung: Datenbankbasierte Webanwendung zur Verwaltung und Durchführung von Prüfungen
  • Namen und Vornamen: Rogers, Alexander
  • Prüfungsausschuss
  • Ausbildungsberuf: Fachinformatiker Anwendungsentwicklung
  • Ausbildungsstätte bzw. Praktikumsbetrieb: itw gGmbH, Groninger Straße 25, 13347 Berlin bzw. Dirk Wagner Berlin, Carstennstraße 6, 12205 Berlin

Eidesstattliche Erklärung

TODO

Abkürzungsverzeichnis

TODO