test.h 6.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164
  1. /* Copyright (c) 2001-2003, Roger Dingledine.
  2. * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
  3. * Copyright (c) 2007-2015, The Tor Project, Inc. */
  4. /* See LICENSE for licensing information */
  5. #ifndef TOR_TEST_H
  6. #define TOR_TEST_H
  7. /**
  8. * \file test.h
  9. * \brief Macros and functions used by unit tests.
  10. */
  11. #include "compat.h"
  12. #include "tinytest.h"
  13. #define TT_EXIT_TEST_FUNCTION STMT_BEGIN goto done; STMT_END
  14. #include "tinytest_macros.h"
  15. #ifdef __GNUC__
  16. #define PRETTY_FUNCTION __PRETTY_FUNCTION__
  17. #else
  18. #define PRETTY_FUNCTION ""
  19. #endif
  20. /* As test_mem_op, but decodes 'hex' before comparing. There must be a
  21. * local char* variable called mem_op_hex_tmp for this to work. */
  22. #define test_mem_op_hex(expr1, op, hex) \
  23. STMT_BEGIN \
  24. size_t length = strlen(hex); \
  25. tor_free(mem_op_hex_tmp); \
  26. mem_op_hex_tmp = tor_malloc(length/2); \
  27. tor_assert((length&1)==0); \
  28. base16_decode(mem_op_hex_tmp, length/2, hex, length); \
  29. tt_mem_op(expr1, op, mem_op_hex_tmp, length/2); \
  30. STMT_END
  31. #define test_memeq_hex(expr1, hex) test_mem_op_hex(expr1, OP_EQ, hex)
  32. #define tt_double_op(a,op,b) \
  33. tt_assert_test_type(a,b,#a" "#op" "#b,double,(val1_ op val2_),"%g", \
  34. TT_EXIT_TEST_FUNCTION)
  35. #ifdef _MSC_VER
  36. #define U64_PRINTF_TYPE uint64_t
  37. #define I64_PRINTF_TYPE int64_t
  38. #else
  39. #define U64_PRINTF_TYPE unsigned long long
  40. #define I64_PRINTF_TYPE long long
  41. #endif
  42. #define tt_size_op(a,op,b) \
  43. tt_assert_test_fmt_type(a,b,#a" "#op" "#b,size_t,(val1_ op val2_), \
  44. U64_PRINTF_TYPE, U64_FORMAT, \
  45. {print_ = (U64_PRINTF_TYPE) value_;}, {}, TT_EXIT_TEST_FUNCTION)
  46. #define tt_u64_op(a,op,b) \
  47. tt_assert_test_fmt_type(a,b,#a" "#op" "#b,uint64_t,(val1_ op val2_), \
  48. U64_PRINTF_TYPE, U64_FORMAT, \
  49. {print_ = (U64_PRINTF_TYPE) value_;}, {}, TT_EXIT_TEST_FUNCTION)
  50. #define tt_i64_op(a,op,b) \
  51. tt_assert_test_fmt_type(a,b,#a" "#op" "#b,int64_t,(val1_ op val2_), \
  52. I64_PRINTF_TYPE, I64_FORMAT, \
  53. {print_ = (I64_PRINTF_TYPE) value_;}, {}, TT_EXIT_TEST_FUNCTION)
  54. const char *get_fname(const char *name);
  55. crypto_pk_t *pk_generate(int idx);
  56. #define US2_CONCAT_2__(a, b) a ## __ ## b
  57. #define US_CONCAT_2__(a, b) a ## _ ## b
  58. #define US_CONCAT_3__(a, b, c) a ## _ ## b ## _ ## c
  59. #define US_CONCAT_2_(a, b) US_CONCAT_2__(a, b)
  60. #define US_CONCAT_3_(a, b, c) US_CONCAT_3__(a, b, c)
  61. /*
  62. * These macros are helpful for streamlining the authorship of several test
  63. * cases that use mocks.
  64. *
  65. * The pattern is as follows.
  66. * * Declare a top level namespace:
  67. * #define NS_MODULE foo
  68. *
  69. * * For each test case you want to write, create a new submodule in the
  70. * namespace. All mocks and other information should belong to a single
  71. * submodule to avoid interference with other test cases.
  72. * You can simply name the submodule after the function in the module you
  73. * are testing:
  74. * #define NS_SUBMODULE some_function
  75. * or, if you're wanting to write several tests against the same function,
  76. * ie., you are testing an aspect of that function, you can use:
  77. * #define NS_SUBMODULE ASPECT(some_function, behavior)
  78. *
  79. * * Declare all the mocks you will use. The NS_DECL macro serves to declare
  80. * the mock in the current namespace (defined by NS_MODULE and NS_SUBMODULE).
  81. * It behaves like MOCK_DECL:
  82. * NS_DECL(int, dependent_function, (void *));
  83. * Here, dependent_function must be declared and implemented with the
  84. * MOCK_DECL and MOCK_IMPL macros. The NS_DECL macro also defines an integer
  85. * global for use for tracking how many times a mock was called, and can be
  86. * accessed by CALLED(mock_name). For example, you might put
  87. * CALLED(dependent_function)++;
  88. * in your mock body.
  89. *
  90. * * Define a function called NS(main) that will contain the body of the
  91. * test case. The NS macro can be used to reference a name in the current
  92. * namespace.
  93. *
  94. * * In NS(main), indicate that a mock function in the current namespace,
  95. * declared with NS_DECL is to override that in the global namespace,
  96. * with the NS_MOCK macro:
  97. * NS_MOCK(dependent_function)
  98. * Unmock with:
  99. * NS_UNMOCK(dependent_function)
  100. *
  101. * * Define the mocks with the NS macro, eg.,
  102. * int
  103. * NS(dependent_function)(void *)
  104. * {
  105. * CALLED(dependent_function)++;
  106. * }
  107. *
  108. * * In the struct testcase_t array, you can use the TEST_CASE and
  109. * TEST_CASE_ASPECT macros to define the cases without having to do so
  110. * explicitly nor without having to reset NS_SUBMODULE, eg.,
  111. * struct testcase_t foo_tests[] = {
  112. * TEST_CASE_ASPECT(some_function, behavior),
  113. * ...
  114. * END_OF_TESTCASES
  115. * which will define a test case named "some_function__behavior".
  116. */
  117. #define NAME_TEST_(name) #name
  118. #define NAME_TEST(name) NAME_TEST_(name)
  119. #define ASPECT(test_module, test_name) US2_CONCAT_2__(test_module, test_name)
  120. #define TEST_CASE(function) \
  121. { \
  122. NAME_TEST(function), \
  123. NS_FULL(NS_MODULE, function, test_main), \
  124. TT_FORK, \
  125. NULL, \
  126. NULL, \
  127. }
  128. #define TEST_CASE_ASPECT(function, aspect) \
  129. { \
  130. NAME_TEST(ASPECT(function, aspect)), \
  131. NS_FULL(NS_MODULE, ASPECT(function, aspect), test_main), \
  132. TT_FORK, \
  133. NULL, \
  134. NULL, \
  135. }
  136. #define NS(name) US_CONCAT_3_(NS_MODULE, NS_SUBMODULE, name)
  137. #define NS_FULL(module, submodule, name) US_CONCAT_3_(module, submodule, name)
  138. #define CALLED(mock_name) US_CONCAT_2_(NS(mock_name), called)
  139. #define NS_DECL(retval, mock_fn, args) \
  140. static retval NS(mock_fn) args; int CALLED(mock_fn) = 0
  141. #define NS_MOCK(name) MOCK(name, NS(name))
  142. #define NS_UNMOCK(name) UNMOCK(name)
  143. extern const struct testcase_setup_t passthrough_setup;
  144. #endif