aboutsummaryrefslogtreecommitdiff
path: root/src/tests/linebuf_test.c
blob: 0dd486e9d4a2727c3de2fefb2182c634d3b53867 (plain)
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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
/*
 * Copyright (C) 2015 Michael Brown <mbrown@fensystems.co.uk>.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA.
 *
 * You can also choose to distribute this program under the terms of
 * the Unmodified Binary Distribution Licence (as given in the file
 * COPYING.UBDL), provided that you have satisfied its requirements.
 */

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );

/** @file
 *
 * Line buffer self-tests
 *
 */

/* Forcibly enable assertions */
#undef NDEBUG

#include <string.h>
#include <assert.h>
#include <ipxe/linebuf.h>
#include <ipxe/test.h>

/** Define inline raw data */
#define DATA(...) { __VA_ARGS__ }

/** Define inline lines */
#define LINES(...) { __VA_ARGS__ }

/** A line buffer test */
struct linebuf_test {
	/** Raw data */
	const void *data;
	/** Length of raw data */
	size_t len;
	/** Expected sequence of lines */
	const char **lines;
	/** Number of expected lines */
	unsigned int count;
};

/** Line buffer test expected failure indicator */
static const char linebuf_failure[1];

/**
 * Define a line buffer test
 *
 * @v name		Test name
 * @v DATA		Raw data
 * @v LINES		Expected sequence of lines
 * @ret test		Line buffer test
 */
#define LINEBUF_TEST( name, DATA, LINES )				\
	static const char name ## _data[] = DATA;			\
	static const char * name ## _lines[] = LINES;			\
	static struct linebuf_test name = {				\
		.data = name ## _data,					\
		.len = ( sizeof ( name ## _data ) - 1 /* NUL */ ),	\
		.lines = name ## _lines,				\
		.count = ( sizeof ( name ## _lines ) /			\
			   sizeof ( name ## _lines[0] ) ),		\
	}

/** Simple line buffer test */
LINEBUF_TEST ( simple,
	       ( "HTTP/1.1 200 OK\r\n"
		 "Content-Length: 123\r\n"
		 "Content-Type: text/plain\r\n"
		 "\r\n" ),
	       LINES ( "HTTP/1.1 200 OK",
		       "Content-Length: 123",
		       "Content-Type: text/plain",
		       "" ) );

/** Mixed line terminators */
LINEBUF_TEST ( mixed,
	       ( "LF only\n" "CRLF\r\n" "\n" "\n" "\r\n" "\r\n" "CR only\r" ),
	       LINES ( "LF only", "CRLF", "", "", "", "",
		       NULL /* \r should not be treated as a terminator */ ) );

/** Split consumption: part 1 */
LINEBUF_TEST ( split_1,
	       ( "This line was" ),
	       LINES ( NULL ) );

/** Split consumption: part 2 */
LINEBUF_TEST ( split_2,
	       ( " split across" ),
	       LINES ( NULL ) );

/** Split consumption: part 3 */
LINEBUF_TEST ( split_3,
	       ( " multiple calls\r\nand so was this one\r" ),
	       LINES ( "This line was split across multiple calls", NULL ) );

/** Split consumption: part 4 */
LINEBUF_TEST ( split_4,
	       ( "\nbut not this one\r\n" ),
	       LINES ( "and so was this one", "but not this one" ) );

/** Split consumption: part 5 */
LINEBUF_TEST ( split_5,
	       ( "" ),
	       LINES ( NULL ) );

/** Split consumption: part 6 */
LINEBUF_TEST ( split_6,
	       ( "This line came after a zero-length call\r\n" ),
	       LINES ( "This line came after a zero-length call" ) );

/** Embedded NULs */
LINEBUF_TEST ( embedded_nuls,
	       ( "This\r\ntest\r\nincludes\r\n\r\nsome\0binary\0data\r\n" ),
	       LINES ( "This", "test", "includes", "", linebuf_failure ) );

/**
 * Report line buffer initialisation test result
 *
 * @v linebuf		Line buffer
 * @v file		Test code file
 * @v line		Test code line
 */
static void linebuf_init_okx ( struct line_buffer *linebuf,
				const char *file, unsigned int line ) {

	/* Initialise line buffer */
	memset ( linebuf, 0, sizeof ( *linebuf ) );
	okx ( buffered_line ( linebuf ) == NULL, file, line );
}
#define linebuf_init_ok( linebuf ) \
	linebuf_init_okx ( linebuf, __FILE__, __LINE__ )

/**
 * Report line buffer consumption test result
 *
 * @v test		Line buffer test
 * @v linebuf		Line buffer
 * @v file		Test code file
 * @v line		Test code line
 */
static void linebuf_consume_okx ( struct linebuf_test *test,
				  struct line_buffer *linebuf,
				  const char *file, unsigned int line ) {
	const char *data = test->data;
	size_t remaining = test->len;
	int len;
	unsigned int i;
	const char *expected;
	char *actual;
	int rc;

	DBGC ( test, "LINEBUF %p:\n", test );
	DBGC_HDA ( test, 0, data, remaining );

	/* Consume data one line at a time */
	for ( i = 0 ; i < test->count ; i++ ) {

		/* Add data to line buffer */
		len = line_buffer ( linebuf, data, remaining );

		/* Get buffered line, if any */
		actual = buffered_line ( linebuf );
		if ( len < 0 ) {
			rc = len;
			DBGC ( test, "LINEBUF %p %s\n", test, strerror ( rc ) );
		} else if ( actual != NULL ) {
			DBGC ( test, "LINEBUF %p \"%s\" (consumed %d)\n",
			       test, actual, len );
		} else {
			DBGC ( test, "LINEBUF %p unterminated (consumed %d)\n",
			       test, len );
		}

		/* Check for success/failure */
		expected = test->lines[i];
		if ( expected == linebuf_failure ) {
			rc = len;
			okx ( rc < 0, file, line );
			okx ( remaining > 0, file, line );
			return;
		}
		okx ( len >= 0, file, line );
		okx ( ( ( size_t ) len ) <= remaining, file, line );

		/* Check expected result */
		if ( expected == NULL ) {
			okx ( actual == NULL, file, line );
		} else {
			okx ( actual != NULL, file, line );
			okx ( strcmp ( actual, expected ) == 0, file, line );
		}

		/* Consume data */
		data += len;
		remaining -= len;
	}

	/* Check that all data was consumed */
	okx ( remaining == 0, file, line );
}
#define linebuf_consume_ok( test, linebuf ) \
	linebuf_consume_okx ( test, linebuf, __FILE__, __LINE__ )

/**
 * Report line buffer accumulation test result
 *
 * @v test		Line buffer test
 * @v linebuf		Line buffer
 * @v file		Test code file
 * @v line		Test code line
 */
static void linebuf_accumulated_okx ( struct linebuf_test *test,
				      struct line_buffer *linebuf,
				      const char *file, unsigned int line ) {
	const char *actual;
	const char *expected;
	unsigned int i;

	/* Check each accumulated line */
	actual = linebuf->data;
	for ( i = 0 ; i < test->count ; i++ ) {

		/* Check accumulated line */
		okx ( actual != NULL, file, line );
		okx ( actual >= linebuf->data, file, line );
		expected = test->lines[i];
		if ( ( expected == NULL ) || ( expected == linebuf_failure ) )
			return;
		okx ( strcmp ( actual, expected ) == 0, file, line );

		/* Move to next line */
		actual += ( strlen ( actual ) + 1 /* NUL */ );
		okx ( actual <= ( linebuf->data + linebuf->len ), file, line );
	}
}
#define linebuf_accumulated_ok( test, linebuf ) \
	linebuf_accumulated_okx ( test, linebuf, __FILE__, __LINE__ )

/**
 * Report line buffer emptying test result
 *
 * @v linebuf		Line buffer
 * @v file		Test code file
 * @v line		Test code line
 */
static void linebuf_empty_okx ( struct line_buffer *linebuf,
				const char *file, unsigned int line ) {

	/* Empty line buffer */
	empty_line_buffer ( linebuf );
	okx ( buffered_line ( linebuf ) == NULL, file, line );
}
#define linebuf_empty_ok( linebuf ) \
	linebuf_empty_okx ( linebuf, __FILE__, __LINE__ )

/**
 * Report line buffer combined test result
 *
 * @v test		Line buffer test
 * @v file		Test code file
 * @v line		Test code line
 */
static void linebuf_okx ( struct linebuf_test *test, const char *file,
			  unsigned int line ) {
	struct line_buffer linebuf;

	linebuf_init_okx ( &linebuf, file, line );
	linebuf_consume_okx ( test, &linebuf, file, line );
	linebuf_accumulated_okx ( test, &linebuf, file, line );
	linebuf_empty_okx ( &linebuf, file, line );
}
#define linebuf_ok( test ) \
	linebuf_okx ( test, __FILE__, __LINE__ )

/**
 * Perform line buffer self-tests
 *
 */
static void linebuf_test_exec ( void ) {
	struct line_buffer linebuf;

	/* Basic tests */
	linebuf_ok ( &simple );
	linebuf_ok ( &mixed );

	/* Split consumption test */
	linebuf_init_ok ( &linebuf );
	linebuf_consume_ok ( &split_1, &linebuf );
	linebuf_consume_ok ( &split_2, &linebuf );
	linebuf_consume_ok ( &split_3, &linebuf );
	linebuf_consume_ok ( &split_4, &linebuf );
	linebuf_consume_ok ( &split_5, &linebuf );
	linebuf_consume_ok ( &split_6, &linebuf );
	linebuf_empty_ok ( &linebuf );

	/* Embedded NULs */
	linebuf_ok ( &embedded_nuls );
}

/** Line buffer self-test */
struct self_test linebuf_test __self_test = {
	.name = "linebuf",
	.exec = linebuf_test_exec,
};