tinytest.h 3.8 KB

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