1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
|
%%%%%%%%%%%
% SETUP %
%%%%%%%%%%%
\documentclass[a4paper]{article}
\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
\usepackage[usenames,x11names,table]{xcolor}
\usepackage{listings}
\usepackage{enumitem}
\usepackage{graphicx}
\usepackage{framed}
\usepackage{calc}
\usepackage{ifthenx}
\usepackage{tabularx}
\usepackage{soul}
%%% -------------------------------------------------------
%%% universal formatting
%%% -------------------------------------------------------
\parindent 0pt
\frenchspacing
\pagestyle{empty}
\setlength{\oddsidemargin}{0in}
\setlength{\evensidemargin}{0in}
\setlength{\marginparsep}{0in}
\setlength{\marginparwidth}{0in}
\setlength{\textwidth}{6.5in}
\setlength{\topmargin}{0in}
\setlength{\headsep}{0in}
\setlength{\headheight}{0in}
\setlength{\textheight}{9in}
%%% -------------------------------------------------------
%%% custom commands
%%% -------------------------------------------------------
% a horizontal box with coloured background
\newcommand{\myheading}[1]{
{
\definecolor{shadecolor}{named}{Azure4}
\begin{snugshade*}
\centering\large
\textcolor{white}{\textbf{-- #1 --}\vphantom{p\^{E}}}
\end{snugshade*}
}
}
\newcommand{\myhl}[1]{
{
\color{Snow1}
\sethlcolor{Red1}
\hl{#1}
}
}
\newcommand{\mymacrow}[2]{
\footnotesize\textcolor{DarkOrchid3}{\textbf{#1}}: & \small #2 \\[8pt]
}
\newcommand{\mytermrow}[2]{
\tt\bf\small #1 & \tt\small #2 \\
}
\begin{document}
% setup
\frenchspacing
% C styling
\lstdefinestyle{customc}{
language=C,
basicstyle=\small\ttfamily,
breaklines=true,
keepspaces=true,
xleftmargin=\parindent,
% colours
commentstyle=\color{DodgerBlue2},
identifierstyle=\color{Red1},
keywordstyle=\color{Purple3},
stringstyle=\color{SpringGreen4},
numbers=left,
showstringspaces=false,
}
\myheading{usage}
Your tests should be written as a single .c file separate from
the body of text containing your functionality to be tested.
A simple example might look something like this: \\
\hrule
\lstset{style=customc}
\lstinputlisting{a_simple_example.c}
\hrule
\pagebreak
If both tests above succeed, the output will look like this:\\
\hrule
\vspace{8pt}
% successful output
\begin{tabular*}{\textwidth}{r@{\ \tt\bf :: }l}
\mytermrow{1}{\color{Yellow4}description of the first test}
\mytermrow{2}{\color{Yellow4}this is the second test}
\mytermrow{ }{\color{DodgerBlue2}grabbing heap string...}
\mytermrow{ }{\color{SpringGreen4}success!}
\end{tabular*}
\vspace{8pt}
\hrule
\vspace{20pt}
If the first test fails, it will look something like this:\\
\hrule
\vspace{8pt}
% failed output
\begin{tabular*}{\textwidth}{r@{\ \tt\bf :: }l}
\mytermrow{1}{\color{Yellow4}description of the first test}
\mytermrow{ }{\color{Red1}FAIL: error message shown on failing}
\mytermrow{ }{\textcolor{SpringGreen4}{\textbf{\ \ expected:}}6}
\mytermrow{ }{\textcolor{Red1}{\textbf{\ \ \ \ actual:}}0}
\end{tabular*}
\vspace{8pt}
\hrule
\pagebreak
\myheading{defined macros}
\begin{tabularx}{\textwidth}{r@{\ }X}
\mymacrow{BEGIN\_TEST}{
must appear before all tests and
after all global variable declarations
}
\mymacrow{END\_TEST}{
must appear at the end of your test
program
}
\mymacrow{CLEANUP(statements)}{
this defines a list of statements to run
when the test exits, either successfully or
on a failure. it isn't necessary for a test
to run, but, if it does appear, it must be
after the declaration of all variables to
which it makes reference.
}
\mymacrow{RETURN()}{
place at the end of a test which uses
CLEANUP to ensure it is called before the
test exits. i couldn't find any way around
this without using more than just one
header file, so i hope it isn't too annoying.
}
\mymacrow{STATE(description)}{
show a prettily-formatted description of the
program's state during a test. takes printf-style
arguments.
}
\mymacrow{EXPECT\_ZERO(summary, arg)}{
fail if \texttt{arg} does not resolve to 0
}
\mymacrow{EXPECT\_ONE(summary, arg)}{
fail if \texttt{arg} does not resolve to 1
}
\mymacrow{EXPECT\_GREATER\_THAN\_ZERO(summary, arg)}{
fail if \texttt{arg} does not resolve to a value
greater than 0. this will be replaced with more
generic integer comparisons soon.
}
\mymacrow{EXPECT\_INT(summary, arg1, arg2)}{
fail if \texttt{arg2} does not match the
expected integer value \texttt{arg1}
}
\mymacrow{EXPECT\_EQUAL\_INT(summary, arg1, arg2)}{
fail if \texttt{arg1} and \texttt{arg2} are
not equal
}
\mymacrow{EXPECT\_UNEQUAL\_INT(summary, arg1, arg2)}{
fail if \texttt{arg1} and \texttt{arg2} are
equal
}
\mymacrow{EXPECT\_STR(summary, arg1, arg2)}{
fail if string \texttt{arg2} does not match the
expected string value \texttt{arg1}
}
\mymacrow{EXPECT\_EQUAL\_STR(summary, arg1, arg2)}{
fail if \texttt{arg1} and \texttt{arg2} are
not equivalent strings
}
\mymacrow{EXPECT\_UNEQUAL\_STR(summary, arg1, arg2)}{
fail if \texttt{arg1} and \texttt{arg2} are
equivalent strings
}
\end{tabularx}
\end{document}
|
