aboutsummaryrefslogtreecommitdiffstats
path: root/Source/testing/linked_list_test.h
blob: a9773f8f0eefd8e743a4e2712f1d893f15f7dfd2 (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
/**
 * @file linked_list_test.h
 * 
 * @brief Tests for the linked_list_t class.
 * 
 */

/*
 * Copyright (C) 2005 Jan Hutter, Martin Willi
 * Hochschule fuer Technik Rapperswil
 *
 * 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.  See <http://www.fsf.org/copyleft/gpl.txt>.
 *
 * 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.
 */

#ifndef LINKED_LIST_TEST_H_
#define LINKED_LIST_TEST_H_

#include <utils/tester.h>

/**
 * @brief Test function for the type linked_list_t.
 *
 * Performs different kinds of assertions to check the functionality
 * of the linked_list_t in a Single-Threaded environment. 
 * 
 * @warning To be usable in multi-threaded software 
 * this list has to get protected with locks.
 *  
 * @param tester 	tester object
 * 
 * @ingroup testcases
 */
void test_linked_list(protected_tester_t *tester);

/**
 * @brief Test function for the type linked_list_t and its iterator.
 *
 * Performs different kinds of assertions to check the functionality
 * of the linked_list_t and its iterator in a Single-Threaded environment. 
 * 
 * @warning To be usable in multi-threaded software 
 * this list has to get protected with locks.
 *  
 * @param tester 	tester object
 * 
 * @ingroup testcases
 */
void test_linked_list_iterator(protected_tester_t *tester);

/**
 * @brief Test function for the type linked_list_t and its insert and remove
 * 		  functions.
 *
 * Performs different kinds of assertions to check the functionality
 * of the linked_list_t and its insert and remove functions
 * 
 * @warning To be usable in multi-threaded software 
 * this list has to get protected with locks.
 *  
 * @param tester 	tester object
 * 
 * @ingroup testcases
 */
void test_linked_list_insert_and_remove(protected_tester_t *tester);

#endif /*LINKED_LIST_TEST_H_*/