external/bsd/libevent/dist/test/tinytest.h

   1 /*      $NetBSD: tinytest.h,v 1.1.1.1 2013/04/11 16:43:32 christos Exp $        */
   2 /* tinytest.h -- Copyright 2009-2012 Nick Mathewson
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  * 3. The name of the author may not be used to endorse or promote products
  13  *    derived from this software without specific prior written permission.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  */
  26
  27 #ifndef _TINYTEST_H
  28 #define _TINYTEST_H
  29
  30 /** Flag for a test that needs to run in a subprocess. */
  31 #define TT_FORK  (1<<0)
  32 /** Runtime flag for a test we've decided to skip. */
  33 #define TT_SKIP  (1<<1)
  34 /** Internal runtime flag for a test we've decided to run. */
  35 #define _TT_ENABLED  (1<<2)
  36 /** If you add your own flags, make them start at this point. */
  37 #define TT_FIRST_USER_FLAG (1<<3)
  38
  39 typedef void (*testcase_fn)(void *);
  40
  41 struct testcase_t;
  42
  43 /** Functions to initialize/teardown a structure for a testcase. */
  44 struct testcase_setup_t {
  45         /** Return a new structure for use by a given testcase. */
  46         void *(*setup_fn)(const struct testcase_t *);
  47         /** Clean/free a structure from setup_fn. Return 1 if ok, 0 on err. */
  48         int (*cleanup_fn)(const struct testcase_t *, void *);
  49 };
  50
  51 /** A single test-case that you can run. */
  52 struct testcase_t {
  53         const char *name; /**< An identifier for this case. */
  54         testcase_fn fn; /**< The function to run to implement this case. */
  55         unsigned long flags; /**< Bitfield of TT_* flags. */
  56         const struct testcase_setup_t *setup; /**< Optional setup/cleanup fns*/
  57         void *setup_data; /**< Extra data usable by setup function */
  58 };
  59 #define END_OF_TESTCASES { NULL, NULL, 0, NULL, NULL }
  60
  61 /** A group of tests that are selectable together. */
  62 struct testgroup_t {
  63         const char *prefix; /**< Prefix to prepend to testnames. */
  64         struct testcase_t *cases; /** Array, ending with END_OF_TESTCASES */
  65 };
  66 #define END_OF_GROUPS { NULL, NULL}
  67
  68 /** Implementation: called from a test to indicate failure, before logging. */
  69 void _tinytest_set_test_failed(void);
  70 /** Implementation: called from a test to indicate that we're skipping. */
  71 void _tinytest_set_test_skipped(void);
  72 /** Implementation: return 0 for quiet, 1 for normal, 2 for loud. */
  73 int _tinytest_get_verbosity(void);
  74 /** Implementation: Set a flag on tests matching a name; returns number
  75  * of tests that matched. */
  76 int _tinytest_set_flag(struct testgroup_t *, const char *, unsigned long);
  77
  78 /** Set all tests in 'groups' matching the name 'named' to be skipped. */
  79 #define tinytest_skip(groups, named) \
  80         _tinytest_set_flag(groups, named, TT_SKIP)
  81
  82 /** Run a single testcase in a single group. */
  83 int testcase_run_one(const struct testgroup_t *,const struct testcase_t *);
  84 /** Run a set of testcases from an END_OF_GROUPS-terminated array of groups,
  85     as selected from the command line. */
  86 int tinytest_main(int argc, const char **argv, struct testgroup_t *groups);
  87
  88 #endif