Merge branch 'master' of https://github.com/dopefishh/tt2015
[tt2015.git] / a2 / 1cases.tex
index 5d8fd81..6241596 100644 (file)
 \subsection{Preflight checklist}
-
 Before actual certification is commenced we perform a manual test using a 
 checklist.
 If any of the checks fail we immediately reject the product.
+The checklist is given in the table below. All commands in \texttt{monospace}
+are to be run in a terminal. Commands prefixed with a \texttt{\#} should be run
+with root permissions. Commands prefixed with a \texttt{\$} should be run with
+user permissions.
 
-\begin{enumerate}
-       \item Is the product complete?
-       \item Does the product come with a manual or quick start guide?
-       \item Is it possible to get the product in a usable state?
-       \item Can we use the product to initiate a connection in a corruption
-       free environment?
-\end{enumerate}
-
-\textbf{DIT MOET VERANDERD WORDEN, HET PRODUCT ZOU AFGEKEURD WORDEN!}
+\begin{longtable}{|l|rp{.8\linewidth}|}
+       \hline
+       Check 1 & \multicolumn{2}{l|}{Get the SUT in a workable state.}\\
+       \hline
+       \multirow{3}{*}{Course of action} 
+               & 1. & Import the VirtualBox image into VirtualBox.\\
+               & 2. & Boot the vm.\\
+               & 3. & Verify the SUT booted successfully and the network modules are
+               loaded.\\
+       \hline
+       Passed & \multicolumn{2}{l|}{\textit{Yes/No}}\\
+       \hline\hline
+       Check 2 & \multicolumn{2}{l|}{Verify the SUT is complete.}\\
+       \hline
+       \multirow{5}{*}{Course of action}
+               & 1. & Boot the SUT as in \emph{Check 1}.\\
+               & 2. & Verify the loopback device exists by running 
+                        \texttt{\$ ifconfig}.\\
+               & 3. & Verify the \emph{echo-server} is present on the system by running
+                       \texttt{\$ file code/server/Main.java}\\
+               & 4. & Verify \emph{Scapy} is present on the system by running
+                       \texttt{\$ scapy}.\\
+               & 5. & Verify all scripts used for testing are present on the system.\\
+       \hline
+       Passed & \multicolumn{2}{l|}{\textit{Yes/No}}\\
+       \hline\hline
+       Check 3 & \multicolumn{2}{l|}{Initialize the testing environment..}\\
+       \hline
+       \multirow{5}{*}{Course of action}
+               & 1. & Boot the SUT as in \emph{Check 1}.\\
+               & 2. & Setup iptables by executing
+                       \texttt{\# code/iptables.sh}~\footnote{The IPTables script ensures
+                       that the OS does not drop packets due to an the unknown source.}\\
+               & 3. & Navigate to the working directory by running
+                       \texttt{\$ cd /home/student/tt2015}\\
+               & 4. & Compile the echo server by running 
+                       \texttt{\# cd code/server \&\& make \&\& cd -}\\
+               & 5. & Start the echo server by running
+                       \texttt{\# cd code/server \&\& java Main}\\
+       \hline
+       Passed & \multicolumn{2}{l|}{\textit{Yes/No}}\\
+       \hline\hline
+       Check 4 & \multicolumn{2}{l|}{Test the tool environment.}\\
+       \hline
+       \multirow{3}{*}{Course of action}
+               & 1. & Initialize the SUT as in \emph{Check 3}\\
+               & 2. & Execute the test script by running
+                       \texttt{\# code/client/helloworld.py}\\
+               & 3. & Verify the console displays a success message.\\
+       \hline
+       Passed & \multicolumn{2}{l|}{\textit{Yes/No}}\\
+       \hline\hline
+       Check 5 & \multicolumn{2}{l|}{All test inputs and scripts are present.}\\
+       \hline
+       \multirow{2}{*}{Course of action}
+               & 1. & Boot the SUT as in \emph{Check 1}.\\
+               & 2. & Verify that the test generation script is present by running
+                       \texttt{\$ file code/client/test.py}\\
+       \hline
+       Passed & \multicolumn{2}{l|}{\textit{Yes/No}}\\
+       \hline
+       \caption{Preflight checklist\label{tbl:preflight}}
+\end{longtable}
 
 \subsection{Testing of SUT}
-
-The SUT is a series of services for other computer programs with no end-user 
-facing
-interface. Therefore the SUT will be tested solely by calling it's services
-through various automated scripts. An automated test suite will be available
-which executes all these automated scripts and aggregates their results to
-asses whether or not the SUT has passed the test. 
+The SUT is a series of services for other computer programs with no end-user
+facing interface. Therefore the SUT will be tested solely by calling it's
+services through various automated scripts. An automated test suite will be
+available which executes all these automated scripts and aggregates their
+results to asses whether or not the SUT has passed the test. 
 
 The implementation of the SUT is tested using black box testing techniques. A
 series of tests asses the correctness of the implementation with regards to the
 TCP specification. These tests are specified in Table~\textbf{referentie naar
-tests-tabel}. The test cases aim to cover the most interesting parts of the
-TCP specification. 
+tests-tabel}. The test cases aim to cover the most interesting parts of the TCP
+specification. 
 
 To cover the TCP specification as complete as possible while still maintaining
 a feasible test suite the tests are divided into equivalence partitions. Below
 these partitions are given.
 
 \begin{enumerate}
-       \item \emph{Number of packets} in request\footnotemark
-               \footnotetext{A request is considered establishing a connection 
-               (handshake) and any n number of payloadpackts}
+       \item \emph{Number of segments} in request~\footnote{A request is
+               considered establishing a connection (handshake) and a number of
+               payload segments}
                \begin{enumerate}
-                       \item 0 payload packets
-                       \item 1 payload packet
-                       \item n=small payload packets
-                       \item n=big payload packets
+                       \item 0 payload segments
+                       \item 1 payload segments
+                       \item n=small payload segments
+                       \item n=big payload segments
                \end{enumerate}
-       \item Correct or Incorrect \emph{source port}
-       \item Correct or Incorrect \emph{Destination port}
-       \item Bits flipped in \emph{Payload}
+       \item \emph{source port}
+               \begin{enumerate}
+                       \item Correct
+                       \item Incorrect
+               \end{enumerate}
+       \item \emph{destination port}
+               \begin{enumerate}
+                       \item Correct
+                       \item Incorrect
+               \end{enumerate}
+       \item Bit errors in \emph{payload}
                \begin{enumerate}
                        \item Correct payload
-                       \item Payload with even number of bits flipped
-                       \item Payload with odd number of bits flipped
+                       \item Payload with bit flips that do not show in checksum
+                       \item Payload with bit flips that do show in checksum
+               \end{enumerate}
+       \item \emph{checksum}
+               \begin{enumerate}
+                       \item Correct
+                       \item Incorrect
+               \end{enumerate}
+       \item \emph{Packet order}
+               \begin{enumerate}
+                       \item Correct
+                       \item Out of order
+                       \item Missing packets
                \end{enumerate}
-       \item Correct or Incorrect \emph{checksum}
-       \item Packets received in or out of order, or missing packets
 \end{enumerate}
 
-\textbf{hier iets over waarom deze partities relevant zijn!}
+These partitions were chosen since they correspond to key parts of the TCP
+specification. 
+
+TCP segments are send over a TCP connection from a \emph{source} to a \emph{destination port}. Therefore segments which are received that have a 
+source or destination port set to an incorrect value should not be regarded
+as segments belonging to the connection by the SUT. 
+
+TCP uses a \emph{checksum} to catch any error introduced in headers, when this
+checksum does not match the actual computed checksum the SUT should
+disregard the received segment.
+
+The TCP checksum is also an inherently weak one, as it is simply the 
+bitwise negation of the addition, in ones complement arithmetic, 
+of all 16 bit words in the header and data of the segment (excluding the
+checksum itself). Therefore any \emph{bit error} where the ones complement value
+of one word
+increases by one, and the value of another decreases by one, is undetected. 
+The SUT should exhibit the same behavior and accept packets where these type
+of bit errors occur.
+
+TCP guarantees that segments are delivered \emph{in order}
+,even when they are received
+out of order and that missing segments are resend. The SUT should
+exhibit the same behavior. If segments are received out of order it should
+either reassemble them when the missing packet has arrived or request them to
+be resend when the  Missing segments should be re-requested (by ACK-ing
+the correct sequence number).  
+
+\bigskip
 
 Partitions 2 to 6 are tested using pairwise testing to keep the number of test
 cases feasible. The pairs are then all *except some where it does not make sense
 to do so) tested with the different request sizes of partition 1.
 
-This is expressed in the table below.
+This is expressed in Table~\ref{table:testpairs}.
 
-\vspace{3mm}
-\textbf{Hier daadwerkelijke decision tabel}
-\vspace{3mm}
+\newcounter{TCC}
+\setcounter{TCC}{1}
+\newcommand{\doTCC}{\theTCC \stepcounter{TCC}}
+\begin{table}[H]
+       \centering
+       \begin{tabular}{|l|l|l|l|l|l|l|l|l|l|l|}
+               \hline
+               & \multicolumn{10}{c|}{\textbf{Partition}}\\
+               \hline
+               & \# & 4 & 5 & 3 & 6 & 2 & 1a & 1b & 1c & 1d\\
+               \hline\hline
+               \multirow{9}{*}{Instance} 
+               & 1 & a & a & a & a & a & \doTCC & \doTCC & \doTCC & \doTCC\\
+               & 2 & a & b & b & c & b & \xmark & \xmark & \doTCC & \doTCC\\
+               & 3 & c & a & b & a & b & \xmark & \xmark & \doTCC & \doTCC\\
+               & 4 & c & b & a & c & a & \xmark & \xmark & \doTCC & \doTCC\\
+               & 5 & b & a & b & c & a & \xmark & \xmark & \doTCC & \doTCC\\
+               & 6 & b & b & a & b & b & \xmark & \xmark & \doTCC & \doTCC\\
+               & 7 & c & b & b & a & b & \doTCC & \doTCC & \doTCC & \doTCC\\
+               & 8 & b & b & b & a & b & \doTCC & \doTCC & \doTCC & \doTCC\\
+               & 9 & a & b & b & b & a & \xmark & \xmark & \doTCC & \doTCC\\
+               \hline
+\end{tabular}
+\caption{Combinations of test cases}
+\label{table:testpairs}
+\end{table}
 
 \subsection{Quality, completeness and coverage of tests}
 
@@ -95,7 +218,7 @@ to ensure a test suite.
 
 To further decrease the number of tests needed test cases are divided into
 equivalence partitions and the combination of cases as described in 
-Table~(\textbf{referentie naar decision table}) ensures that all partitions are
+Table~\ref{table:testpairs} ensures that all partitions are
 covered and the number of individual tests is still feasible. 
 
 
@@ -103,50 +226,107 @@ covered and the number of individual tests is still feasible.
 % wat ik ook probeer ik krijg de eerste collum
 % zijn tekst niet verticaal gecentered
 %
-\begin{table}
 
 
 \subsection{Test cases}
 
-\begin{tabularx}{\linewidth}{| l | X|}
-\hline
-Nr & 1 \\\hline
-Title & Single valid request. \\\hline
-Input & Pcap file with prerecorded valid packets. \\\hline
-Expected output & Pcap file with valid response to request. \\\hline
-Course of action & \begin{enumerate}
-       \item Load input pcap file.
-       \item Replay pcap file using ...
-       \item Record SUT response using...
-       \item Save recorded packets as a pcap file.
-       \item Analyze packets in resulting file.
-\end{enumerate} \\\hline
-Valid trace & \begin{enumerate}
-       \item \textbf{Hier packets benoemen?}
-\end{enumerate} \\\hline
-\end{tabularx}
-
-\begin{tabularx}{\linewidth}{| l | X|}
+Before every test case use the following steps to initialize the testing environment.
+
+\begin{enumerate}
+       \item Boot the vm using VirtualBox.
+       \item Setup iptables by executing \texttt{\# code/iptables.sh}
+       \item Navigate to the working directory by running \texttt{\$ cd /home/student/tt2015}
+       \item Start the echo server by running \texttt{\# cd code/server \&\& java Main}
+\end{enumerate}
+
+\begin{longtable}{|p{.2\linewidth}|p{.8\linewidth}|}
        \hline
+       Nr & 1 \\\hline
+       Title & Single valid request with 1byte payload. \\\hline
+       Input & Generated packets. \\\hline
+       Expected output & Packets echoed back by Echo-Server. \\\hline
+       \multirow{2}{*}{Course of action}
+ & 1. Use the steps listed above in order to start the SUT. \\
+ & 2. Execute the script by running \texttt{\# code/client/tests/1.py} \\\hline
+       Valid trace & Verify that the script prints 'Success'. \\\hline
+       \hline
+       
        Nr & 2 \\\hline
-       Title & Single request with corrupted checksum. \\\hline
-       Input & Pcap file used as \emph{test-case 1} input. \\\hline
-       Expected output & No response from SUT, logs with rejected packets. \\\hline
-       Course of action & \begin{enumerate}
-               \item Load input pcap file into ....
-               \item Corrupt checksum of loaded packets.
-               \item Save resulting packets as pcap file.
-               \item Load new pcap file into ...
-               \item Replay new pcap file.
-               \item Record SUT response using...
-               \item Extract log with rejected packets.
-               \item Save recorded packets as a pcap file.
-               \item Analyze packets in resulting file.
-       \end{enumerate} \\\hline
-       Valid trace & \begin{enumerate}
-               \item \textbf{Aangeven welke packets corrupted zijn?}
-       \end{enumerate} \\\hline
-\end{tabularx}
-\end{table}
+       Title & Single valid request with 65495bytes payload. \\\hline
+       Input & Generated packets. \\\hline
+       Expected output & Packets echoed back by Echo-Server. \\\hline
+       \multirow{2}{*}{Course of action}
+       & 1. Use the steps listed above in order to start the SUT. \\
+       & 2. Execute the script by running \texttt{\# code/client/tests/2.py} \\\hline
+       Valid trace & Verify that the script prints 'Success'. \\\hline
+       \hline
+       
+       Nr & 3 \\\hline
+       Title & 5 valid requests with 1byte payload. \\\hline
+       Input & Generated packets. \\\hline
+       Expected output & Packets echoed back by Echo-Server, in the same order as the client sent them. \\\hline
+       \multirow{2}{*}{Course of action}
+       & 1. Use the steps listed above in order to start the SUT. \\
+       & 2. Execute the script by running \texttt{\# code/client/tests/3.py} \\\hline
+       Valid trace & Verify that the script prints 'Success'. \\\hline
+       \hline
+       
+       Nr & 4 \\\hline
+       Title & 5 valid requests with 65495bytes payload. \\\hline
+       Input & Generated packets with 65495bytes payload. \\\hline
+       Expected output & Packets echoed back by Echo-Server, in the same order as the client sent them. \\\hline
+       \multirow{2}{*}{Course of action}
+       & 1. Use the steps listed above in order to start the SUT. \\
+       & 2. Execute the script by running \texttt{\# code/client/tests/4.py} \\\hline
+       Valid trace & Verify that the script prints 'Success'. \\\hline
+       \hline
+       
+       Nr & 5 \\\hline
+       Title & 5 valid requests with 1byte payload sent out of order. \\\hline
+       Input & Generated packets with 1byte payload, two packets are swapped in position. \\\hline
+       Expected output & All requests sent up to and including
+        the swapped packet with the lowest sequence number, the remaining packets are dropped. \\\hline
+       \multirow{2}{*}{Course of action}
+       & 1. Use the steps listed above in order to start the SUT. \\
+       & 2. Execute the script by running \texttt{\# code/client/tests/5.py} \\\hline
+       Valid trace & Verify that the script prints 'Success'. \\\hline
+       \hline
+\end{longtable}
 
-\newpage
+%\begin{tabularx}{\linewidth}{| l | X|}
+%\hline
+%Nr & 1 \\\hline
+%Title & Single valid request. \\\hline
+%Input & Pcap file with prerecorded valid packets. \\\hline
+%Expected output & Pcap file with valid response to request. \\\hline
+%Course of action & \begin{enumerate}
+%      \item Execute \emph{./scripts/tests/case1-single-valid.sh}
+%      \item Load \emph{output/case1.pcap} with ...
+%\end{enumerate} \\\hline
+%Valid trace & \begin{enumerate}
+%      \item \textbf{Hier packets benoemen?}
+%\end{enumerate} \\\hline
+%\end{tabularx}
+%
+%\begin{tabularx}{\linewidth}{| l | X|}
+%      \hline
+%      Nr & 2 \\\hline
+%Title & Single request with corrupted checksum. \\\hline
+%      Input & Pcap file used as \emph{test-case 1} input. \\\hline
+%      Expected output & No response from SUT, logs with rejected packets. \\\hline
+%      Course of action & \begin{enumerate}
+%              \item Load input pcap file into ....
+%              \item Corrupt checksum of loaded packets.
+%              \item Save resulting packets as pcap file.
+%              \item Load new pcap file into ...
+%              \item Replay new pcap file.
+%              \item Record SUT response using...
+%              \item Extract log with rejected packets.
+%              \item Save recorded packets as a pcap file.
+%              \item Analyze packets in resulting file.
+%      \end{enumerate} \\\hline
+%      Valid trace & \begin{enumerate}
+%              \item \textbf{Aangeven welke packets corrupted zijn?}
+%      \end{enumerate} \\\hline
+%\end{tabularx}
+%\end{table}