programs/charon/testing/linked_list_test.h

   1 /**
   2  * @file linked_list_test.h
   3  *
   4  * @brief Tests for the linked_list_t class.
   5  *
   6  */
   7
   8 /*
   9  * Copyright (C) 2005 Jan Hutter, Martin Willi
  10  * Hochschule fuer Technik Rapperswil
  11  *
  12  * This program is free software; you can redistribute it and/or modify it
  13  * under the terms of the GNU General Public License as published by the
  14  * Free Software Foundation; either version 2 of the License, or (at your
  15  * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
  16  *
  17  * This program is distributed in the hope that it will be useful, but
  18  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  19  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  20  * for more details.
  21  */
  22
  23 #ifndef LINKED_LIST_TEST_H_
  24 #define LINKED_LIST_TEST_H_
  25
  26 #include <utils/tester.h>
  27
  28 /**
  29  * @brief Test function for the type linked_list_t.
  30  *
  31  * Performs different kinds of assertions to check the functionality
  32  * of the linked_list_t in a Single-Threaded environment.
  33  *
  34  * @warning To be usable in multi-threaded software
  35  * this list has to get protected with locks.
  36  *
  37  * @param tester        tester object
  38  *
  39  * @ingroup testcases
  40  */
  41 void test_linked_list(protected_tester_t *tester);
  42
  43 /**
  44  * @brief Test function for the type linked_list_t and its iterator.
  45  *
  46  * Performs different kinds of assertions to check the functionality
  47  * of the linked_list_t and its iterator in a Single-Threaded environment.
  48  *
  49  * @warning To be usable in multi-threaded software
  50  * this list has to get protected with locks.
  51  *
  52  * @param tester        tester object
  53  *
  54  * @ingroup testcases
  55  */
  56 void test_linked_list_iterator(protected_tester_t *tester);
  57
  58 /**
  59  * @brief Test function for the type linked_list_t and its insert and remove
  60  *                functions.
  61  *
  62  * Performs different kinds of assertions to check the functionality
  63  * of the linked_list_t and its insert and remove functions
  64  *
  65  * @warning To be usable in multi-threaded software
  66  * this list has to get protected with locks.
  67  *
  68  * @param tester        tester object
  69  *
  70  * @ingroup testcases
  71  */
  72 void test_linked_list_insert_and_remove(protected_tester_t *tester);
  73
  74 #endif /*LINKED_LIST_TEST_H_*/