From 55b30862a7cc49ad7ba718624cbc814f185b30e6 Mon Sep 17 00:00:00 2001
From: René den Hertog
Date: Sun, 1 Oct 2017 23:49:45 +0200
Subject: Improve the 'System Under Test (SUT) Description' section of the
 'Test Plan'.

---
 assignments/assignment1.tex | 44 ++++++++++++++++++++------------------------
 1 file changed, 20 insertions(+), 24 deletions(-)

(limited to 'assignments/assignment1.tex')

diff --git a/assignments/assignment1.tex b/assignments/assignment1.tex
index 3f89f19..c9002c6 100644
--- a/assignments/assignment1.tex
+++ b/assignments/assignment1.tex
@@ -30,30 +30,7 @@
 
 \maketitle
 
-\section{SUT Description}
-\begin{enumerate}
-	\item
-		\begin{description}
-			\item[Name] Chess.hs
-			\item[Software Environment] Linux, and any other environment supported by Haskell
-			\item[Hardware Platform] Desktop PC, and any other platform supported by Haskell
-			\item[Latest Version Number] 0.2.1
-		\end{description}
-
-	\item
-		Starting the SUT requires being able to compile haskell, typically through the GHC, and having the Chess.hs dependency installed.
-		Installing Chess.hs can be done through cabal, using the \mintinline{bash}{cabal install chesshs} command.
-		Compiling and running is then done through \mintinline{bash}{make run}.
-
-	\item
-		\begin{enumerate}[a)]
-			\item The SUT needs to be provided with a PGN file via stdin.
-			\item Either the result of the game is output to stdout or the SUT outputs an error.
-		\end{enumerate}
-
-	\item
-		The SUT does have a decent chance of containing faults, but the risk is near zero due to the low impact of the of these faults.
-\end{enumerate}
+\section{Test Plan}
 
 \section{Test goals}
 \begin{enumerate}
@@ -73,6 +50,17 @@
 	\item
 		Functionality and Reliability.
 \end{enumerate}
+\subsection*{System Under Test (SUT) Description}
+
+The chosen SUT is the {\tt chesshs} Haskell package. \cite{SUT} It should be able to run in any software environment and hardware platform which supports Haskell. The latest version of the SUT, since the 13\textsuperscript{th} of March 2015, is {\tt 0.2.1}.
+
+\paragraph{Executing/Running the SUT} \label{P:ERSUT}
+
+It is required to be able to compile Haskell, typically through the Glasgow Haskell Compiler (GHC), and having the {\tt chesshs} package installed, normally through Cabal via the \mintinline{bash}{cabal install chesshs} command. \cite{GHC, C} Both the GHC and Cabal are part of the Haskell Platform. \cite{HP} Under our computer systems, compiling and starting the SUT is done with the \mintinline{bash}{make} and \mintinline{bash}{./runchess} commands, respectively.
+
+The SUT is used by providing it with, via the standard input, a text file containing a game of Chess in the Portable Game Notation (PGN). \cite{PGN} After computation, via the standard output, some general information about the Chess match is displayed, including the end result. Followed by the state of the board after each move. In any other case, an error message is displayed. \\
+
+As is common with everything software, the SUT is likely to contain faults. However, the risks surrounding the program are near zero due to the very low impact of the program faulting. As of our expectation, the most ``risky" scenario for the SUT is at a notable Chess competition. In the case the program does not behave as intended, it is almost certain that a human referee would take over its place. Furthermore, we expect such a system to be used as a supporting tool for match officials and not as a replacement for regulation.
 
 \section{Test method}
 \begin{enumerate}
@@ -120,6 +108,14 @@
 	\caption{The basic wrapper.\label{lst:wrapper}}
 \end{listing}
 
+\begin{thebibliography}{8}
+	\bibitem[C]    {C}    \url{http://haskell.org/cabal}
+	\bibitem[GHC]  {GHC}  \url{http://haskell.org/ghc}
+	\bibitem[HP]   {HP}   \url{http://haskell.org/platform}
+	\bibitem[PGN]  {PGN}  \url{http://saremba.de/chessgml/standards/pgn/pgn-complete.htm}
+	\bibitem[SUT]  {SUT}  \url{http://hackage.haskell.org/package/chesshs}
+\end{thebibliography}
+
 \section{Test Environment}
 \begin{enumerate}
 	\setcounter{enumi}{10}
-- 
cgit v1.2.3

