[TASK] developement of document structure
This commit is contained in:
mlabusch
parent
fac0aab790
commit
ea15b36a52
Binary file not shown.
|
After Width: | Height: | Size: 6.4 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 65 KiB |
|
|
@ -0,0 +1,61 @@
|
|||
\relax
|
||||
\providecommand\hyper@newdestlabel[2]{}
|
||||
\catcode `"\active
|
||||
\providecommand\HyperFirstAtBeginDocument{\AtBeginDocument}
|
||||
\HyperFirstAtBeginDocument{\ifx\hyper@anchor\@undefined
|
||||
\global\let\oldcontentsline\contentsline
|
||||
\gdef\contentsline#1#2#3#4{\oldcontentsline{#1}{#2}{#3}}
|
||||
\global\let\oldnewlabel\newlabel
|
||||
\gdef\newlabel#1#2{\newlabelxx{#1}#2}
|
||||
\gdef\newlabelxx#1#2#3#4#5#6{\oldnewlabel{#1}{{#2}{#3}}}
|
||||
\AtEndDocument{\ifx\hyper@anchor\@undefined
|
||||
\let\contentsline\oldcontentsline
|
||||
\let\newlabel\oldnewlabel
|
||||
\fi}
|
||||
\fi}
|
||||
\global\let\hyper@last\relax
|
||||
\gdef\HyperFirstAtBeginDocument#1{#1}
|
||||
\providecommand\HyField@AuxAddToFields[1]{}
|
||||
\providecommand\HyField@AuxAddToCoFields[2]{}
|
||||
\select@language{ngerman}
|
||||
\@writefile{toc}{\select@language{ngerman}}
|
||||
\@writefile{lof}{\select@language{ngerman}}
|
||||
\@writefile{lot}{\select@language{ngerman}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {1}Microservice-Steckbrief}{I}{section.1}}
|
||||
\newlabel{sec: Microservice-Steckbrief}{{1}{I}{Microservice-Steckbrief}{section.1}{}}
|
||||
\@writefile{lof}{\contentsline {figure}{\numberline {1}{\ignorespaces Microservice Warenwirtschaft}}{I}{figure.1}}
|
||||
\newlabel{pic: Microservice Warenwirtschaft}{{1}{I}{Microservice Warenwirtschaft}{figure.1}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {2}Dokumentationsstruktur}{1}{section.2}}
|
||||
\newlabel{sec: Dokumentationsstruktur}{{2}{1}{Dokumentationsstruktur}{section.2}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {3}Definition der Anforderungen}{2}{section.3}}
|
||||
\newlabel{sec: Definition der Anforderungen}{{3}{2}{Definition der Anforderungen}{section.3}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {4}Struktur des Microservice}{3}{section.4}}
|
||||
\newlabel{sec: Struktur des Microservice}{{4}{3}{Struktur des Microservice}{section.4}{}}
|
||||
\@writefile{lof}{\contentsline {figure}{\numberline {2}{\ignorespaces Struktur des Microservice}}{3}{figure.2}}
|
||||
\newlabel{pic:Struktur des Microservice}{{2}{3}{Struktur des Microservice}{figure.2}{}}
|
||||
\@writefile{toc}{\contentsline {subsection}{\numberline {4.1}Presentation Layer}{3}{subsection.4.1}}
|
||||
\newlabel{subsec: Presentation Layer}{{4.1}{3}{Presentation Layer}{subsection.4.1}{}}
|
||||
\@writefile{toc}{\contentsline {subsection}{\numberline {4.2}Application Layer}{3}{subsection.4.2}}
|
||||
\newlabel{subsec: Application Layer}{{4.2}{3}{Application Layer}{subsection.4.2}{}}
|
||||
\@writefile{toc}{\contentsline {subsection}{\numberline {4.3}Persistant Layer}{3}{subsection.4.3}}
|
||||
\newlabel{subsec: Persistant Layer}{{4.3}{3}{Persistant Layer}{subsection.4.3}{}}
|
||||
\@writefile{toc}{\contentsline {subsection}{\numberline {4.4}Integrierte Tests}{3}{subsection.4.4}}
|
||||
\newlabel{subsec: Integrierte Tests}{{4.4}{3}{Integrierte Tests}{subsection.4.4}{}}
|
||||
\@writefile{toc}{\contentsline {subsection}{\numberline {4.5}Admin-Frontend}{3}{subsection.4.5}}
|
||||
\newlabel{subsec: Admin-Frontend}{{4.5}{3}{Admin-Frontend}{subsection.4.5}{}}
|
||||
\@writefile{toc}{\contentsline {subsection}{\numberline {4.6}Anpassung des Monolithen}{3}{subsection.4.6}}
|
||||
\newlabel{subsec: Anpassung des Monolithen}{{4.6}{3}{Anpassung des Monolithen}{subsection.4.6}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {5}Backbox-Testf\IeC {\"a}lle}{4}{section.5}}
|
||||
\newlabel{sec: Blackbox-Testfaelle}{{5}{4}{Backbox-Testfälle}{section.5}{}}
|
||||
\@writefile{lot}{\contentsline {table}{\numberline {1}{\ignorespaces Blackbox-Testf\IeC {\"a}lle}}{4}{table.1}}
|
||||
\newlabel{tabl:Backbox-Testfaelle}{{1}{4}{Blackbox-Testfälle}{table.1}{}}
|
||||
\@writefile{toc}{\contentsline {section}{Anhang}{5}{section*.1}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {A}Handout zum Admin-Frontend}{5}{appendix.A}}
|
||||
\newlabel{sec: Handout zum Admin-Frontend}{{A}{5}{Handout zum Admin-Frontend}{appendix.A}{}}
|
||||
\@writefile{lof}{\contentsline {figure}{\numberline {3}{\ignorespaces Handout zum Admin-Frontend}}{5}{figure.3}}
|
||||
\newlabel{pic: Handout zum Admin-Frontend}{{3}{5}{Handout zum Admin-Frontend}{figure.3}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {B}Testprotokoll vom XX.06.2017}{6}{appendix.B}}
|
||||
\newlabel{sec: Testprotokoll vom XX.06.2017}{{B}{6}{Testprotokoll vom XX.06.2017}{appendix.B}{}}
|
||||
\@writefile{lot}{\contentsline {table}{\numberline {2}{\ignorespaces Testprotokoll vom XX.06.2017}}{6}{table.2}}
|
||||
\newlabel{tabl:Testprotokoll vom XX.06.2017}{{2}{6}{Testprotokoll vom XX.06.2017}{table.2}{}}
|
||||
\ttl@finishall
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
This is BibTeX, Version 0.99dThe top-level auxiliary file: Doku_Microservice_Warenwirtschaft_MLabusch_MMuller.aux
|
||||
I found no \citation commands---while reading file Doku_Microservice_Warenwirtschaft_MLabusch_MMuller.aux
|
||||
I found no \bibdata command---while reading file Doku_Microservice_Warenwirtschaft_MLabusch_MMuller.aux
|
||||
I found no \bibstyle command---while reading file Doku_Microservice_Warenwirtschaft_MLabusch_MMuller.aux
|
||||
(There were 3 error messages)
|
||||
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,14 @@
|
|||
\BOOKMARK [1][-]{section.1}{Microservice-Steckbrief}{}% 1
|
||||
\BOOKMARK [1][-]{section.2}{Dokumentationsstruktur}{}% 2
|
||||
\BOOKMARK [1][-]{section.3}{Definition der Anforderungen}{}% 3
|
||||
\BOOKMARK [1][-]{section.4}{Struktur des Microservice}{}% 4
|
||||
\BOOKMARK [2][-]{subsection.4.1}{Presentation Layer}{section.4}% 5
|
||||
\BOOKMARK [2][-]{subsection.4.2}{Application Layer}{section.4}% 6
|
||||
\BOOKMARK [2][-]{subsection.4.3}{Persistant Layer}{section.4}% 7
|
||||
\BOOKMARK [2][-]{subsection.4.4}{Integrierte Tests}{section.4}% 8
|
||||
\BOOKMARK [2][-]{subsection.4.5}{Admin-Frontend}{section.4}% 9
|
||||
\BOOKMARK [2][-]{subsection.4.6}{Anpassung des Monolithen}{section.4}% 10
|
||||
\BOOKMARK [1][-]{section.5}{Backbox-Testf\344lle}{}% 11
|
||||
\BOOKMARK [1][-]{section*.1}{Anhang}{}% 12
|
||||
\BOOKMARK [1][-]{appendix.A}{Handout zum Admin-Frontend}{}% 13
|
||||
\BOOKMARK [1][-]{appendix.B}{Testprotokoll vom XX.06.2017}{}% 14
|
||||
Binary file not shown.
Binary file not shown.
|
|
@ -0,0 +1,42 @@
|
|||
%------------------------------------------------------------------------------------------------------------
|
||||
%------------------------------------------------------------------------------------------------------------
|
||||
% ---- Merle Labusch
|
||||
% ---- Komplexe Softwaresysteme (M.Sc.)
|
||||
% ---- Hochschule Bremen
|
||||
%------------------------------------------------------------------------------------------------------------
|
||||
%------------------------------------------------------------------------------------------------------------
|
||||
|
||||
|
||||
\input{./Kapitel/Header}
|
||||
|
||||
|
||||
\begin{document}
|
||||
\pagenumbering{gobble}
|
||||
\pagenumbering{Roman}
|
||||
|
||||
\input{./Kapitel/Titelseite}\clearpage \newpage
|
||||
\input{./Kapitel/Steckbrief} \newpage
|
||||
|
||||
{
|
||||
\setlength{\parskip}{0pt}
|
||||
\linespread{1.2}
|
||||
\tableofcontents
|
||||
}
|
||||
\newpage
|
||||
|
||||
\pagenumbering{arabic}
|
||||
|
||||
\input{./Kapitel/DokStruktur} \newpage
|
||||
\input{./Kapitel/Anforderungen} \newpage
|
||||
\input{./Kapitel/Struktur} \newpage
|
||||
\input{./Kapitel/Testfalle} \newpage
|
||||
|
||||
|
||||
\clearpage
|
||||
\appendix
|
||||
\phantomsection
|
||||
\addcontentsline{toc}{section}{\appendixname}
|
||||
\input{./Kapitel/Handout} \newpage
|
||||
\input{./Kapitel/Testprotokoll}
|
||||
|
||||
\end{document}
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
\select@language {ngerman}
|
||||
\contentsline {section}{\numberline {1}Microservice-Steckbrief}{I}{section.1}
|
||||
\contentsline {section}{\numberline {2}Dokumentationsstruktur}{1}{section.2}
|
||||
\contentsline {section}{\numberline {3}Definition der Anforderungen}{2}{section.3}
|
||||
\contentsline {section}{\numberline {4}Struktur des Microservice}{3}{section.4}
|
||||
\contentsline {subsection}{\numberline {4.1}Presentation Layer}{3}{subsection.4.1}
|
||||
\contentsline {subsection}{\numberline {4.2}Application Layer}{3}{subsection.4.2}
|
||||
\contentsline {subsection}{\numberline {4.3}Persistant Layer}{3}{subsection.4.3}
|
||||
\contentsline {subsection}{\numberline {4.4}Integrierte Tests}{3}{subsection.4.4}
|
||||
\contentsline {subsection}{\numberline {4.5}Admin-Frontend}{3}{subsection.4.5}
|
||||
\contentsline {subsection}{\numberline {4.6}Anpassung des Monolithen}{3}{subsection.4.6}
|
||||
\contentsline {section}{\numberline {5}Backbox-Testf\IeC {\"a}lle}{4}{section.5}
|
||||
\contentsline {section}{Anhang}{5}{section*.1}
|
||||
\contentsline {section}{\numberline {A}Handout zum Admin-Frontend}{5}{appendix.A}
|
||||
\contentsline {section}{\numberline {B}Testprotokoll vom XX.06.2017}{6}{appendix.B}
|
||||
\contentsfinish
|
||||
|
|
@ -0,0 +1,25 @@
|
|||
\section{Definition der Anforderungen}
|
||||
\label{sec: Definition der Anforderungen}
|
||||
|
||||
Der Microservice Warenwirtschaft dient der Verwaltung der einzelnen Waren pro Produkt für den Webshop Mosh, sodass zum Beispiel neue Waren erfasst und keine Waren verkauft werden können, die sich nicht mehr im Lagerbestand befinden. Dieser Microservice basiert auf den nachfolgend aufgeführten Anforderungen. Mit dem Begriff Produkt werden im Folgenden die über Mosh angebotenen Früchtearten, zum Beispiel Kiwis bezeichnet, während mit dem Begriff Ware die einzelnen Positionen pro Fruchtart im Lagerbestand bezeichnet werden.
|
||||
|
||||
\begin{itemize}
|
||||
\item Speicherung der Waren pro Produkt mit einem Zeitstempel, wann sie erfasst wurden sowie ihrem Lagerort
|
||||
\item Admin-Frontend
|
||||
\begin{itemize}
|
||||
\item Hinzufügen neuer Waren zum Bestand
|
||||
\item Manuelles Entfernen von Waren aus dem Bestand, zum Beispiel wenn der Bestand verdorben ist
|
||||
\item Entfernen von Waren aus dem Bestand, wenn diese an einen Kunden versendet werden
|
||||
\item Blockieren von Waren in dem Bestand, wenn ein Kunde sie in seinen Warenkorb gelegt hat
|
||||
\item Automatische Freigaben von blockierten Waren, wenn diese nach 30 Minuten nicht an den Versand überstellt wurden
|
||||
\end{itemize}
|
||||
\item Kunden-Frontend
|
||||
\begin{itemize}
|
||||
\item Anzeige der Produktverfügbarkeit über ein Ampelsystem, mehr als zehn Waren entsprechen grün, fünf bis zehn Waren entsprechen gelb und weniger als fünf Waren entsprechen rot
|
||||
\end{itemize}
|
||||
\item Optionale Zusatz-Funktionen
|
||||
\begin{itemize}
|
||||
\item Ausgabe einer Statistik, wie viele Waren im letzten Monat aus dem Bestand versandt und wie viele manuell entfernt wurden im Admin-Fontend
|
||||
\item Ampeldarstellung pro Waren, die Anzeigt ab die Ware bereits überaltert ist, im Admin-Frontend
|
||||
\end{itemize}
|
||||
\end{itemize}
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
\section{Dokumentationsstruktur}
|
||||
\label{sec: Dokumentationsstruktur}
|
||||
|
||||
Für die Dokumentation des Microservice Warenwirtschaft wurden eine Kombination aus zwei Dokumenten gewählt. Zum einen beschreibt ein Handout auf einer Seite die Funktionen des Admin-Frontends für den Benutzer. Diese sehr kurze Dokumentenform wurde gewählt, da Benutzer häufig nicht gewillt sind, umfangreiche Anleitungen zu lesen um eine Anwendung nutzen zu können. Vielmehr wollen sie schnell einen Überblick der Kernfunktionalitäten erhalten. Zu diesem Zweck arbeitet das Handout mit einem aufbereiteten Screenshot des Admin-Frontends und einer Beschreibung der Funktionen in Stichpunkten. \par
|
||||
Auf der anderen Seite muss der Microservie auch für Entwickler dokumentiert sein, hierfür wurde diese Dokumentation angelegt. Sie beginn anstelle eines Abstract mit einem Steckbrief des Microservice, der dessen grundlegende Struktur und Funktionalität kurz beschreibt. In dem eigentlichen Dokument werden dann zunächst die Anforderungen an den Microservice beschrieben, da ihre Umsetzung das primäre Ziel der Entwicklung ist. Weiter werden der Microservice und seine Code-Struktur detaillierter beschrieben sowie die gewählten Blackbox-Testfälle dokumentiert. Der Anhang dieser Dokumentation umfasst das Handout des Admin-Frontends sowie ein beispielhaftes Testprotokoll. Auf Details wir ein Abkürzungs- oder Literaturverzeichnis wurde in dieser Dokumention bewusst verzichtet, um sie kurz zu halten. Zitate und Verweise werden hier in Form von Fußnoten integriert.
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
|
||||
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
\section{Handout zum Admin-Frontend}
|
||||
\label{sec: Handout zum Admin-Frontend}
|
||||
|
||||
|
||||
\begin{figure}[H]
|
||||
\begin{center}
|
||||
\includegraphics[width=0.65 \textwidth]{./Bilder/dummy.png}
|
||||
\end{center}
|
||||
\caption{Handout zum Admin-Frontend}
|
||||
\label{pic: Handout zum Admin-Frontend}
|
||||
\end{figure}
|
||||
|
||||
|
|
@ -0,0 +1,137 @@
|
|||
|
||||
\documentclass[11pt, a4paper]{article}
|
||||
|
||||
\usepackage[ngerman]{babel} % Deutsches Wörterbuch und Zeilenumbrüche
|
||||
\usepackage{blindtext} % Testtext
|
||||
\usepackage[T1]{fontenc} % Ausgabe encoding
|
||||
\usepackage[utf8]{inputenc} % Eingabe encoding
|
||||
\usepackage[colorinlistoftodos]{todonotes}
|
||||
\usepackage{xcolor} % Farben
|
||||
\usepackage{framed, color} % Hintergrundfarben für Boxen
|
||||
\usepackage{textcomp} % Sonderzeichen
|
||||
\usepackage{amsmath}
|
||||
\usepackage[automark,headsepline]{scrpage2} % Kopf- und Fußzeilen
|
||||
\usepackage{amsmath,amsfonts,amssymb} % Mathematik
|
||||
\usepackage{graphicx} % Bilder einfügen
|
||||
\usepackage{wrapfig} % Bilder von Text umfließen lassen
|
||||
\usepackage{float} % Floatobjekte (u.a. figures und tables)
|
||||
\usepackage{placeins} % FloatBarrier
|
||||
\usepackage[hyper]{listings} % Schöne Listings
|
||||
\usepackage[hidelinks]{hyperref} % Hyperlinks
|
||||
\usepackage{prettyref} % Schönere Hyperlinks
|
||||
\usepackage{multicol} % Mehrspaltige Ausrichtung
|
||||
\usepackage{titlesec} % Aussehen der Überschriften
|
||||
\usepackage{titletoc} % Aussehen der Überschriften
|
||||
\usepackage{geometry} % Außenränder
|
||||
\usepackage[scaled]{helvet} % Schriftart Helvetica
|
||||
\usepackage{courier} % Schriftart Courier
|
||||
\usepackage{enumerate} % Nummerierung
|
||||
\usepackage{enumitem} % Nummerierung
|
||||
\usepackage{tabularx} % Tabellen
|
||||
|
||||
|
||||
% ---- Farben -----------------------------------------------------------------------------------------------
|
||||
\definecolor{listings}{RGB}{226,226,226}
|
||||
|
||||
\definecolor{hs-blau}{RGB}{10,85,140}
|
||||
\definecolor{hs-tuerkis}{RGB}{50,180,200}
|
||||
\definecolor{hs-rot}{RGB}{195,5,50}
|
||||
|
||||
|
||||
% ---- Geometrie und Schrift --------------------------------------------------------------------------------
|
||||
\geometry{verbose,a4paper,tmargin=2.5cm,bmargin=2cm,lmargin=2.5cm,rmargin=2.5cm,headsep=1.5cm}
|
||||
|
||||
\renewcommand*\familydefault{ppl}
|
||||
\linespread{1.2}
|
||||
|
||||
|
||||
\titleformat*{\section}{\LARGE}
|
||||
\titleformat*{\subsection}{\Large}
|
||||
\titleformat*{\subsubsection}{\large}
|
||||
|
||||
\setlength{\abovecaptionskip}{1pt}
|
||||
\setlength{\belowcaptionskip}{1pt}
|
||||
\setlength{\parindent}{0pt}
|
||||
\setlength{\parskip}{5.5pt}
|
||||
|
||||
|
||||
% ---- 1. Kapitelebene ---------------------------------------------------------------------------------------
|
||||
\titleclass{\subsubsubsection}{straight}[\subsection]
|
||||
|
||||
\newcounter{subsubsubsection}[subsubsection]
|
||||
\renewcommand\thesubsubsubsection{\thesubsubsection.\arabic{subsubsubsection}}
|
||||
|
||||
\titleformat{\subsubsubsection} {\large}{\thesubsubsubsection}{1em}{}
|
||||
\titlespacing*{\subsubsubsection}{0pt}{15pt}{6pt}
|
||||
|
||||
\makeatletter
|
||||
|
||||
\def\toclevel@subsubsubsection{4}
|
||||
\def\toclevel@paragraph{5}
|
||||
\def\toclevel@paragraph{6}
|
||||
\def\l@subsubsubsection{\@dottedtocline{4}{7em}{4em}}
|
||||
\def\l@paragraph{\@dottedtocline{5}{10em}{5em}}
|
||||
\def\l@subparagraph{\@dottedtocline{6}{14em}{6em}}
|
||||
|
||||
\makeatother
|
||||
|
||||
\setcounter{secnumdepth}{4}
|
||||
\setcounter{tocdepth}{4}
|
||||
|
||||
|
||||
% ---- Listings ----------------------------------------------------------------------------------------------
|
||||
\lstset{
|
||||
basicstyle=\ttfamily\color{black}\small,
|
||||
backgroundcolor=\color{veryverylightgray},
|
||||
keywordstyle=\color{black},
|
||||
identifierstyle=\color{black},
|
||||
commentstyle=\color{black},
|
||||
showspaces=false,
|
||||
showtabs=false,
|
||||
breaklines=true,
|
||||
xleftmargin=0pt,
|
||||
xrightmargin=0pt,
|
||||
}
|
||||
|
||||
|
||||
% ---- Tabellen, Abbildungen und Aufzählungen -------------------------------------------------------------------------------
|
||||
\newcolumntype{L}[1]{>{\raggedright\arraybackslash}p{#1}} % Blocksatz linksbündig
|
||||
\newcolumntype{C}[1]{>{\centering\arraybackslash}p{#1}} % Blocksatz zentriert
|
||||
\newcolumntype{R}[1]{>{\raggedleft\arraybackslash}p{#1}} % Blocksatz rechtsbündig
|
||||
|
||||
|
||||
\setlist[itemize]{leftmargin=*}
|
||||
\renewcommand*\labelitemi{$-$}
|
||||
\setlist[1]{itemsep=-0.5pt}
|
||||
% \hyphenation{} Eigene Worttrennung
|
||||
|
||||
|
||||
%------------------------------------------------------------------------------------------------------------
|
||||
% ---- Definitionen -----------------------------------------------------------------------------------------
|
||||
%------------------------------------------------------------------------------------------------------------
|
||||
\title{KSS - Nachhaltige Softwarearchitektur komplexer Websites}
|
||||
\author{Merle Labusch, Martin Müller}
|
||||
|
||||
|
||||
|
||||
|
||||
% ---- Kopf- Fußzeile -----------------------------------------------------------------------------------------
|
||||
|
||||
%i - innen, c - mitte, o - außen
|
||||
\ihead{ \normalfont \headmark}
|
||||
\chead{}
|
||||
\ohead{\includegraphics[width=3cm]{./Bilder/hs-logo.png}}
|
||||
|
||||
\ifoot{\normalfont M.Labusch, M.Müller}
|
||||
\cfoot{}
|
||||
\ofoot{\normalfont \pagemark}
|
||||
|
||||
\pagestyle{scrheadings} % eigener Stil für alle Seiten
|
||||
|
||||
% ---- PDF-Eigenschaften ----------------------------------------------------------------------------------------
|
||||
\hypersetup{
|
||||
pdftitle = {Dokumentation - Microservice Warenwirtschaft},
|
||||
pdfsubject = {Nachhaltige Softwarearchitektur komplexer Websites},
|
||||
pdfauthor = {Merle Labusch, Martin Müller},
|
||||
pdfkeywords = {Hochschule Bremen, Masterstudiengang Komplexe Softwaresysteme, Softwarearchitektur, Nachhaltigkeit, Docker, Go}
|
||||
}
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
\section{Microservice-Steckbrief}
|
||||
\label{sec: Microservice-Steckbrief}
|
||||
|
||||
\begin{figure}[H]
|
||||
\begin{center}
|
||||
\includegraphics[width=0.65 \textwidth]{./Bilder/dummy.png}
|
||||
\end{center}
|
||||
\caption{Microservice Warenwirtschaft}
|
||||
\label{pic: Microservice Warenwirtschaft}
|
||||
\end{figure}
|
||||
|
||||
|
||||
\begin{itemize}
|
||||
\item \textcolor{red}{ToDo: kurze Beschreibung}
|
||||
\end{itemize}
|
||||
|
|
@ -0,0 +1,34 @@
|
|||
\section{Struktur des Microservice}
|
||||
\label{sec: Struktur des Microservice}
|
||||
|
||||
\begin{figure}[H]
|
||||
\begin{center}
|
||||
\includegraphics[width=0.65 \textwidth]{./Bilder/dummy.png}
|
||||
\end{center}
|
||||
\caption{Struktur des Microservice}
|
||||
\label{pic:Struktur des Microservice}
|
||||
\end{figure}
|
||||
|
||||
|
||||
\begin{itemize}
|
||||
\item Der Microservice wurde in der Programmiersprache Go\footnote{https:\//golang.org\/doc\/} entwickelt.
|
||||
\item \textcolor{red}{ToDo: kurze Beschreibung der Programmstruktur und genauere Beschreibung der Einzelteile in Unterkapiteln}
|
||||
\end{itemize}
|
||||
|
||||
\subsection{Presentation Layer}
|
||||
\label{subsec: Presentation Layer}
|
||||
|
||||
\subsection{Application Layer}
|
||||
\label{subsec: Application Layer}
|
||||
|
||||
\subsection{Persistant Layer}
|
||||
\label{subsec: Persistant Layer}
|
||||
|
||||
\subsection{Integrierte Tests}
|
||||
\label{subsec: Integrierte Tests}
|
||||
|
||||
\subsection{Admin-Frontend}
|
||||
\label{subsec: Admin-Frontend}
|
||||
|
||||
\subsection{Anpassung des Monolithen}
|
||||
\label{subsec: Anpassung des Monolithen}
|
||||
|
|
@ -0,0 +1,71 @@
|
|||
\section{Backbox-Testfälle}
|
||||
\label{sec: Blackbox-Testfaelle}
|
||||
|
||||
Die in den Microservice integrierten Tests, prüfen ob jedes Stück Code auch wirklich ausgeführt wird (Code Coverage) und die Anforderungen funktionell erfüllt werden. Da diese Tests mit der Kenntnis des Codes beschrieben wurden, nennt man sie auch Whitebox-Tests. Neben der Sicht des Entwicklers sollte beim Test aber auch die Sicht des Benutzers nicht außer Acht gelassen und ein sogenannter Blackbox-Test, ohne Kenntnis des Codes durchgeführt werden. Dies ermöglicht die Prüfung, ob die Anforderungen auch aus der Sicht des Benutzers, der weder den Code noch die internen Abläufe innerhalb des Microservice kennt, erfüllt werden. Zu diesem Zweck wurden die folgenden Testfälle anhand der Anforderungen erstellt. Sie definieren zunächst das Vorgehen bei der Testdurchführung und anschließend den erwarteten Soll- sowie den eingetretenen Ist-Zustand. Das Protokoll eines durchgeführten Blackbox-Tests findet sich unter Anhang \ref{sec: Testprotokoll vom XX.06.2017}.
|
||||
|
||||
|
||||
\begin{table}[H]
|
||||
\begin{small}
|
||||
\begin{center}
|
||||
\caption{Blackbox-Testfälle}
|
||||
\renewcommand{\arraystretch}{1.2}
|
||||
\begin{tabularx}{\textwidth}{|X|X|L{2cm}|}
|
||||
|
||||
\hline
|
||||
|
||||
\textbf{Vorgehen} & \textbf{Soll} & \textbf{Ist} \\ \hline
|
||||
|
||||
Aufruf der URL \texttt{XXX} &
|
||||
Anzeige des Login-Feldes für das Admin-Frontend &
|
||||
\\ \hline
|
||||
|
||||
Anmeldung mit dem Benutzernamen X und dem Passwort Y &
|
||||
Erfolgreicher Login, Anzeige des Warenwirtschaft-Frontend &
|
||||
\\ \hline
|
||||
|
||||
- &
|
||||
Das Frontend zeigt eine Liste der Waren pro Produkt mit ihrem Zeitstempel &
|
||||
\\ \hline
|
||||
|
||||
- &
|
||||
Es wird angezeigt, dass keine Kirschen mehr vorhanden sind &
|
||||
\\ \hline
|
||||
|
||||
Hinzufügen von 5 Kiwis über den Button \texttt{+} &
|
||||
Es werden 5 Kiwis mit der aktuellen Zeit zu dem Bestand hinzugefügt &
|
||||
\\ \hline
|
||||
|
||||
Entfernen von 2 Tomaten über den Button \texttt{-} &
|
||||
Es werden die angegeben 2 Tomanten aus dem Bestand entfernt &
|
||||
\\ \hline
|
||||
|
||||
Aufruf der URL \texttt{XXX} &
|
||||
Anzeige des Kunden-Frontend für Kirschen,
|
||||
Anzeige der Verfügbarkeit mit einer roten Ampel &
|
||||
\\ \hline
|
||||
|
||||
Aufruf der URL \texttt{XXX} &
|
||||
Anzeige des Kunden-Frontend für Tomaten,
|
||||
Anzeige der Verfügbarkeit mit einer gelben Ampel &
|
||||
\\ \hline
|
||||
|
||||
Aufruf der URL \texttt{XXX} &
|
||||
Anzeige des Kunden-Frontend für Kiwis,
|
||||
Anzeige der Verfügbarkeit mit einer grünen Ampel &
|
||||
\\ \hline
|
||||
|
||||
Bestellen von 2 Kiwis &
|
||||
Im Admin-Frontend werden 2 Kiwis als blockiert angezeigt &
|
||||
\\ \hline
|
||||
|
||||
Transportbestätigung für die 2 Kiwis &
|
||||
Im Admin-Frontend werden die 2 Kiwis automatisch aus dem Bestand gelöscht &
|
||||
\\ \hline
|
||||
|
||||
\end{tabularx}
|
||||
\label{tabl:Backbox-Testfaelle}
|
||||
\end{center}
|
||||
\end{small}
|
||||
\end{table}
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,67 @@
|
|||
\section{Testprotokoll vom XX.06.2017}
|
||||
\label{sec: Testprotokoll vom XX.06.2017}
|
||||
|
||||
\begin{table}[H]
|
||||
\begin{small}
|
||||
\begin{center}
|
||||
\caption{Testprotokoll vom XX.06.2017}
|
||||
\renewcommand{\arraystretch}{1.2}
|
||||
\begin{tabularx}{\textwidth}{|X|X|L{2cm}|}
|
||||
\hline
|
||||
|
||||
\textbf{Vorgehen} & \textbf{Soll} & \textbf{Ist} \\ \hline
|
||||
|
||||
Aufruf der URL \texttt{XXX} &
|
||||
Anzeige des Login-Feldes für das Admin-Frontend &
|
||||
\\ \hline
|
||||
|
||||
Anmeldung mit dem Benutzernamen X und dem Passwort Y &
|
||||
Erfolgreicher Login, Anzeige des Warenwirtschaft-Frontend &
|
||||
\\ \hline
|
||||
|
||||
- &
|
||||
Das Frontend zeigt eine Liste der Waren pro Produkt mit ihrem Zeitstempel &
|
||||
\\ \hline
|
||||
|
||||
- &
|
||||
Es wird angezeigt, dass keine Kirschen mehr vorhanden sind &
|
||||
\\ \hline
|
||||
|
||||
Hinzufügen von 5 Kiwis über den Button \texttt{+} &
|
||||
Es werden 5 Kiwis mit der aktuellen Zeit zu dem Bestand hinzugefügt &
|
||||
\\ \hline
|
||||
|
||||
Entfernen von 2 Tomaten über den Button \texttt{-} &
|
||||
Es werden die angegeben 2 Tomanten aus dem Bestand entfernt &
|
||||
\\ \hline
|
||||
|
||||
Aufruf der URL \texttt{XXX} &
|
||||
Anzeige des Kunden-Frontend für Kirschen,
|
||||
Anzeige der Verfügbarkeit mit einer roten Ampel &
|
||||
\\ \hline
|
||||
|
||||
Aufruf der URL \texttt{XXX} &
|
||||
Anzeige des Kunden-Frontend für Tomaten,
|
||||
Anzeige der Verfügbarkeit mit einer gelben Ampel &
|
||||
\\ \hline
|
||||
|
||||
Aufruf der URL \texttt{XXX} &
|
||||
Anzeige des Kunden-Frontend für Kiwis,
|
||||
Anzeige der Verfügbarkeit mit einer grünen Ampel &
|
||||
\\ \hline
|
||||
|
||||
Bestellen von 2 Kiwis &
|
||||
Im Admin-Frontend werden 2 Kiwis als blockiert angezeigt &
|
||||
\\ \hline
|
||||
|
||||
Transportbestätigung für die 2 Kiwis &
|
||||
Im Admin-Frontend werden die 2 Kiwis automatisch aus dem Bestand gelöscht &
|
||||
\\ \hline
|
||||
|
||||
\end{tabularx}
|
||||
\label{tabl:Testprotokoll vom XX.06.2017}
|
||||
\end{center}
|
||||
\end{small}
|
||||
\end{table}
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,65 @@
|
|||
%--------------------------------------------------------
|
||||
% ---------------------- TITELSEITE ----------------------
|
||||
%--------------------------------------------------------
|
||||
\begin{titlepage}
|
||||
\begin{center}
|
||||
|
||||
{
|
||||
\setlength{\parskip}{0pt}
|
||||
|
||||
\vspace{5cm}
|
||||
|
||||
\includegraphics[width=0.50\textwidth]{./Bilder/hs-logo.png}
|
||||
|
||||
\vspace{3cm}
|
||||
|
||||
|
||||
Dokumentation
|
||||
|
||||
|
||||
\vspace{0.75cm}
|
||||
|
||||
|
||||
{\hrule height 1pt}
|
||||
|
||||
|
||||
\vspace{0.5cm}
|
||||
|
||||
|
||||
{\large{\textsc{Microservice Warenwirtschaft}}}
|
||||
|
||||
|
||||
\vspace{0.5cm}
|
||||
|
||||
|
||||
{\hrule height 1pt}
|
||||
|
||||
|
||||
\vspace{0.75cm}
|
||||
|
||||
|
||||
Hochschule Bremen -- Fakultät für Elektrotechnik und Informatik \\
|
||||
Studiengang Komplexe Softwaresysteme (M.Sc.)
|
||||
|
||||
\vspace{3cm}
|
||||
|
||||
|
||||
Eingereicht von\\
|
||||
\textsc{Merle Labusch} und \textsc{Martin Müller}\\
|
||||
|
||||
\vspace{1cm}
|
||||
|
||||
Dozenten\\
|
||||
\textsc{Matthias Stock, Renzo Kottmann}\\
|
||||
|
||||
\vspace{3cm}
|
||||
|
||||
Bremen, 30.06.2017
|
||||
|
||||
|
||||
|
||||
|
||||
}
|
||||
|
||||
\end{center}
|
||||
\end{titlepage}
|
||||
|
|
@ -0,0 +1,25 @@
|
|||
\relax
|
||||
\providecommand\hyper@newdestlabel[2]{}
|
||||
\catcode `"\active
|
||||
\providecommand\HyperFirstAtBeginDocument{\AtBeginDocument}
|
||||
\HyperFirstAtBeginDocument{\ifx\hyper@anchor\@undefined
|
||||
\global\let\oldcontentsline\contentsline
|
||||
\gdef\contentsline#1#2#3#4{\oldcontentsline{#1}{#2}{#3}}
|
||||
\global\let\oldnewlabel\newlabel
|
||||
\gdef\newlabel#1#2{\newlabelxx{#1}#2}
|
||||
\gdef\newlabelxx#1#2#3#4#5#6{\oldnewlabel{#1}{{#2}{#3}}}
|
||||
\AtEndDocument{\ifx\hyper@anchor\@undefined
|
||||
\let\contentsline\oldcontentsline
|
||||
\let\newlabel\oldnewlabel
|
||||
\fi}
|
||||
\fi}
|
||||
\global\let\hyper@last\relax
|
||||
\gdef\HyperFirstAtBeginDocument#1{#1}
|
||||
\providecommand\HyField@AuxAddToFields[1]{}
|
||||
\providecommand\HyField@AuxAddToCoFields[2]{}
|
||||
\select@language{ngerman}
|
||||
\@writefile{toc}{\select@language{ngerman}}
|
||||
\@writefile{lof}{\select@language{ngerman}}
|
||||
\@writefile{lot}{\select@language{ngerman}}
|
||||
\@writefile{lof}{\contentsline {figure}{\numberline {1}{\ignorespaces \IeC {\"U}bersicht des Admin-Frontends}}{1}{figure.1}}
|
||||
\ttl@finishall
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
This is BibTeX, Version 0.99dThe top-level auxiliary file: Handout_Frontend_Warenwirtschaft_MLabusch_MMuller.aux
|
||||
I found no \citation commands---while reading file Handout_Frontend_Warenwirtschaft_MLabusch_MMuller.aux
|
||||
I found no \bibdata command---while reading file Handout_Frontend_Warenwirtschaft_MLabusch_MMuller.aux
|
||||
I found no \bibstyle command---while reading file Handout_Frontend_Warenwirtschaft_MLabusch_MMuller.aux
|
||||
(There were 3 error messages)
|
||||
File diff suppressed because it is too large
Load Diff
Binary file not shown.
Binary file not shown.
|
|
@ -0,0 +1,33 @@
|
|||
%------------------------------------------------------------------------------------------------------------
|
||||
%------------------------------------------------------------------------------------------------------------
|
||||
% ---- Merle Labusch
|
||||
% ---- Komplexe Softwaresysteme (M.Sc.)
|
||||
% ---- Hochschule Bremen
|
||||
%------------------------------------------------------------------------------------------------------------
|
||||
%------------------------------------------------------------------------------------------------------------
|
||||
|
||||
|
||||
\input{./Header}
|
||||
|
||||
|
||||
\begin{document}
|
||||
|
||||
|
||||
\section*{Handout Admin-Frontend Warenwirtschaft}
|
||||
|
||||
|
||||
\begin{itemize}
|
||||
\item \textcolor{red}{ToDo: kurze Beschreibung}
|
||||
\end{itemize}
|
||||
|
||||
|
||||
\begin{figure}[H]
|
||||
\begin{center}
|
||||
\includegraphics[width=0.65 \textwidth]{./dummy.png}
|
||||
\end{center}
|
||||
\caption{Übersicht des Admin-Frontends}
|
||||
\end{figure}
|
||||
|
||||
|
||||
|
||||
\end{document}
|
||||
|
|
@ -0,0 +1,137 @@
|
|||
|
||||
\documentclass[11pt, a4paper]{article}
|
||||
|
||||
\usepackage[ngerman]{babel} % Deutsches Wörterbuch und Zeilenumbrüche
|
||||
\usepackage{blindtext} % Testtext
|
||||
\usepackage[T1]{fontenc} % Ausgabe encoding
|
||||
\usepackage[utf8]{inputenc} % Eingabe encoding
|
||||
\usepackage[colorinlistoftodos]{todonotes}
|
||||
\usepackage{xcolor} % Farben
|
||||
\usepackage{framed, color} % Hintergrundfarben für Boxen
|
||||
\usepackage{textcomp} % Sonderzeichen
|
||||
\usepackage{amsmath}
|
||||
\usepackage[automark,headsepline]{scrpage2} % Kopf- und Fußzeilen
|
||||
\usepackage{amsmath,amsfonts,amssymb} % Mathematik
|
||||
\usepackage{graphicx} % Bilder einfügen
|
||||
\usepackage{wrapfig} % Bilder von Text umfließen lassen
|
||||
\usepackage{float} % Floatobjekte (u.a. figures und tables)
|
||||
\usepackage{placeins} % FloatBarrier
|
||||
\usepackage[hyper]{listings} % Schöne Listings
|
||||
\usepackage[hidelinks]{hyperref} % Hyperlinks
|
||||
\usepackage{prettyref} % Schönere Hyperlinks
|
||||
\usepackage{multicol} % Mehrspaltige Ausrichtung
|
||||
\usepackage{titlesec} % Aussehen der Überschriften
|
||||
\usepackage{titletoc} % Aussehen der Überschriften
|
||||
\usepackage{geometry} % Außenränder
|
||||
\usepackage[scaled]{helvet} % Schriftart Helvetica
|
||||
\usepackage{courier} % Schriftart Courier
|
||||
\usepackage{enumerate} % Nummerierung
|
||||
\usepackage{enumitem} % Nummerierung
|
||||
\usepackage{tabularx} % Tabellen
|
||||
|
||||
|
||||
% ---- Farben -----------------------------------------------------------------------------------------------
|
||||
\definecolor{listings}{RGB}{226,226,226}
|
||||
|
||||
\definecolor{hs-blau}{RGB}{10,85,140}
|
||||
\definecolor{hs-tuerkis}{RGB}{50,180,200}
|
||||
\definecolor{hs-rot}{RGB}{195,5,50}
|
||||
|
||||
|
||||
% ---- Geometrie und Schrift --------------------------------------------------------------------------------
|
||||
\geometry{verbose,a4paper,tmargin=2.5cm,bmargin=2cm,lmargin=2.5cm,rmargin=2.5cm,headsep=1.5cm}
|
||||
|
||||
\renewcommand*\familydefault{ppl}
|
||||
\linespread{1.2}
|
||||
|
||||
|
||||
\titleformat*{\section}{\LARGE}
|
||||
\titleformat*{\subsection}{\Large}
|
||||
\titleformat*{\subsubsection}{\large}
|
||||
|
||||
\setlength{\abovecaptionskip}{1pt}
|
||||
\setlength{\belowcaptionskip}{1pt}
|
||||
\setlength{\parindent}{0pt}
|
||||
\setlength{\parskip}{5.5pt}
|
||||
|
||||
|
||||
% ---- 1. Kapitelebene ---------------------------------------------------------------------------------------
|
||||
\titleclass{\subsubsubsection}{straight}[\subsection]
|
||||
|
||||
\newcounter{subsubsubsection}[subsubsection]
|
||||
\renewcommand\thesubsubsubsection{\thesubsubsection.\arabic{subsubsubsection}}
|
||||
|
||||
\titleformat{\subsubsubsection} {\large}{\thesubsubsubsection}{1em}{}
|
||||
\titlespacing*{\subsubsubsection}{0pt}{15pt}{6pt}
|
||||
|
||||
\makeatletter
|
||||
|
||||
\def\toclevel@subsubsubsection{4}
|
||||
\def\toclevel@paragraph{5}
|
||||
\def\toclevel@paragraph{6}
|
||||
\def\l@subsubsubsection{\@dottedtocline{4}{7em}{4em}}
|
||||
\def\l@paragraph{\@dottedtocline{5}{10em}{5em}}
|
||||
\def\l@subparagraph{\@dottedtocline{6}{14em}{6em}}
|
||||
|
||||
\makeatother
|
||||
|
||||
\setcounter{secnumdepth}{4}
|
||||
\setcounter{tocdepth}{4}
|
||||
|
||||
|
||||
% ---- Listings ----------------------------------------------------------------------------------------------
|
||||
\lstset{
|
||||
basicstyle=\ttfamily\color{black}\small,
|
||||
backgroundcolor=\color{veryverylightgray},
|
||||
keywordstyle=\color{black},
|
||||
identifierstyle=\color{black},
|
||||
commentstyle=\color{black},
|
||||
showspaces=false,
|
||||
showtabs=false,
|
||||
breaklines=true,
|
||||
xleftmargin=0pt,
|
||||
xrightmargin=0pt,
|
||||
}
|
||||
|
||||
|
||||
% ---- Tabellen, Abbildungen und Aufzählungen -------------------------------------------------------------------------------
|
||||
\newcolumntype{L}[1]{>{\raggedright\arraybackslash}p{#1}} % Blocksatz linksbündig
|
||||
\newcolumntype{C}[1]{>{\centering\arraybackslash}p{#1}} % Blocksatz zentriert
|
||||
\newcolumntype{R}[1]{>{\raggedleft\arraybackslash}p{#1}} % Blocksatz rechtsbündig
|
||||
|
||||
|
||||
\setlist[itemize]{leftmargin=*}
|
||||
\renewcommand*\labelitemi{$-$}
|
||||
\setlist[1]{itemsep=-0.5pt}
|
||||
% \hyphenation{} Eigene Worttrennung
|
||||
|
||||
|
||||
%------------------------------------------------------------------------------------------------------------
|
||||
% ---- Definitionen -----------------------------------------------------------------------------------------
|
||||
%------------------------------------------------------------------------------------------------------------
|
||||
\title{KSS - Nachhaltige Softwarearchitektur komplexer Websites}
|
||||
\author{Merle Labusch, Martin Müller}
|
||||
|
||||
|
||||
|
||||
|
||||
% ---- Kopf- Fußzeile -----------------------------------------------------------------------------------------
|
||||
|
||||
%i - innen, c - mitte, o - außen
|
||||
\ihead{ \normalfont Admin-Frontend Warenwitschaft}
|
||||
\chead{}
|
||||
\ohead{\includegraphics[width=3cm]{./hs-logo.png}}
|
||||
|
||||
\ifoot{\normalfont M.Labusch, M.Müller}
|
||||
\cfoot{}
|
||||
\ofoot{\normalfont 1/1}
|
||||
|
||||
\pagestyle{scrheadings} % eigener Stil für alle Seiten
|
||||
|
||||
% ---- PDF-Eigenschaften ----------------------------------------------------------------------------------------
|
||||
\hypersetup{
|
||||
pdftitle = {Dokumentation - Microservice Warenwirtschaft},
|
||||
pdfsubject = {Nachhaltige Softwarearchitektur komplexer Websites},
|
||||
pdfauthor = {Merle Labusch, Martin Müller},
|
||||
pdfkeywords = {Hochschule Bremen, Masterstudiengang Komplexe Softwaresysteme, Softwarearchitektur, Nachhaltigkeit, Docker, Go}
|
||||
}
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 6.4 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 65 KiB |
Reference in New Issue