This add AES support.
[m6w6/libmemcached] / libtest / test.h
index 0493f3106b1b4b657aefb312d6195fb49a141af5..d349e54ae0ee3603b6f1cc1f101b4168409de13d 100644 (file)
 /*  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
  * 
- *  Gearmand client and server library.
+ *  libtest
  *
  *  Copyright (C) 2011 Data Differential, http://datadifferential.com/
- *  Copyright (C) 2006-2010 Brian Aker
- *  All rights reserved.
  *
- *  Redistribution and use in source and binary forms, with or without
- *  modification, are permitted provided that the following conditions are
- *  met:
+ *  This library is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU Lesser General Public
+ *  License as published by the Free Software Foundation; either
+ *  version 3 of the License, or (at your option) any later version.
  *
- *      * Redistributions of source code must retain the above copyright
- *  notice, this list of conditions and the following disclaimer.
- *
- *      * Redistributions in binary form must reproduce the above
- *  copyright notice, this list of conditions and the following disclaimer
- *  in the documentation and/or other materials provided with the
- *  distribution.
- *
- *      * The names of its contributors may not be used to endorse or
- *  promote products derived from this software without specific prior
- *  written permission.
- *
- *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
- *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *  This library 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
+ *  Lesser General Public License for more details.
  *
+ *  You should have received a copy of the GNU Lesser General Public
+ *  License along with this library; if not, write to the Free Software
+ *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  */
 
-#pragma once
-
-#include <libtest/visibility.h>
 
-/*
-  Structures for generic tests.
-*/
-
-#include <stdio.h>
-#include <stdlib.h>
-#include <stdint.h>
+#pragma once
 
-#if !defined(__cplusplus)
-# include <stdbool.h>
+#ifndef __INTEL_COMPILER
+#pragma GCC diagnostic ignored "-Wold-style-cast"
 #endif
 
-typedef struct world_st world_st;
-typedef struct collection_st collection_st;
-typedef struct test_st test_st;
-
-typedef enum {
-  TEST_SUCCESS= 0, /* Backwards compatibility */
-  TEST_FAILURE,
-  TEST_MEMORY_ALLOCATION_FAILURE,
-  TEST_SKIPPED,
-  TEST_MAXIMUM_RETURN /* Always add new error code before */
-} test_return_t;
-
-typedef void *(*test_callback_create_fn)(test_return_t *error);
-typedef test_return_t (*test_callback_fn)(void *);
-typedef test_return_t (*test_callback_runner_fn)(test_callback_fn, void *);
-typedef test_return_t (*test_callback_error_fn)(test_return_t, void *);
-
 /**
   A structure describing the test case.
 */
 struct test_st {
   const char *name;
   bool requires_flush;
-  test_callback_fn test_fn;
-};
-
-
-/**
-  A structure which describes a collection of test cases.
-*/
-struct collection_st {
-  const char *name;
-  test_callback_fn pre;
-  test_callback_fn post;
-  test_st *tests;
+  test_callback_fn *test_fn;
 };
 
+#define test_assert_errno(A) \
+do \
+{ \
+  if ((A)) { \
+    fprintf(stderr, "\n%s:%d: Assertion failed for %s: ", __FILE__, __LINE__, __func__);\
+    perror(#A); \
+    fprintf(stderr, "\n"); \
+    libtest::create_core(); \
+    assert((A)); \
+  } \
+} while (0)
 
-/**
-  Structure which houses the actual callers for the test cases contained in
-  the collections.
-*/
-typedef struct {
-  test_callback_runner_fn pre;
-  test_callback_runner_fn run;
-  test_callback_runner_fn post;
-} world_runner_st;
-
-
-/**
-  world_st is the structure which is passed to the test implementation to be filled.
-  This must be implemented in order for the test framework to load the tests. We call
-  get_world() in order to fill this structure.
-*/
-
-struct world_st {
-  collection_st *collections;
-
-  /* These methods are called outside of any collection call. */
-  test_callback_create_fn create;
-  test_callback_fn destroy;
-
-  struct {
-    /* This is called a the beginning of any test run. */
-    test_callback_fn startup;
-
-    /* This called on a test if the test requires a flush call (the bool is from test_st) */
-    test_callback_fn flush;
-
-    /**
-      These are run before/after the test. If implemented. Their execution is not controlled
-      by the test.
-    */
-    test_callback_fn pre_run;
-    test_callback_fn post_run;
-
-    /**
-      If an error occurs during the test, this is called.
-    */
-    test_callback_error_fn on_error;
-  } test;
-
-  struct {
-    /* This is called a the beginning of any collection run. */
-    test_callback_fn startup;
-
-    /* This is called at the end of any collection run. */
-    test_callback_fn shutdown;
-  } collection;
-
-
-  /**
-    Runner represents the callers for the tests. If not implemented we will use
-    a set of default implementations.
-  */
-  world_runner_st *runner;
-};
-
-
-
-/**
-  @note world_stats_st is a simple structure for tracking test successes.
-*/
-typedef struct {
-  uint32_t collection_success;
-  uint32_t collection_skipped;
-  uint32_t collection_failed;
-  uint32_t collection_total;
-  uint32_t success;
-  uint32_t skipped;
-  uint32_t failed;
-  uint32_t total;
-} world_stats_st;
+#define test_assert(A, B) \
+do \
+{ \
+  if ((A)) { \
+    fprintf(stderr, "\n%s:%d: Assertion failed %s, with message %s, in %s", __FILE__, __LINE__, (B), #A, __func__ );\
+    fprintf(stderr, "\n"); \
+    libtest::create_core(); \
+    assert((A)); \
+  } \
+} while (0)
 
-#ifdef __cplusplus
-extern "C" {
-#endif
+#define test_truth(A) \
+do \
+{ \
+  if (! (A)) { \
+    fprintf(stderr, "\n%s:%d: Assertion \"%s\" failed, in %s\n", __FILE__, __LINE__, #A, __func__);\
+    libtest::create_core(); \
+    return TEST_FAILURE; \
+  } \
+} while (0)
 
-/* Help function for use with gettimeofday() */
-LIBTEST_API
-long int timedif(struct timeval a, struct timeval b);
+#define test_true(A) \
+do \
+{ \
+  if (! (A)) { \
+    fprintf(stderr, "\n%s:%d: Assertion \"%s\" failed, in %s\n", __FILE__, __LINE__, #A, __func__);\
+    libtest::create_core(); \
+    return TEST_FAILURE; \
+  } \
+} while (0)
 
-/* How we make all of this work :) */
-LIBTEST_API
-void get_world(world_st *world);
+#define test_true_got(__expected, __hint) \
+do \
+{ \
+  if (not libtest::_compare_truth_hint(__FILE__, __LINE__, __func__, ((__expected)), #__expected, ((__hint)))) \
+  { \
+    libtest::create_core(); \
+    return TEST_FAILURE; \
+  } \
+} while (0)
+#define test_true_hint test_true_got
 
-LIBTEST_INTERNAL_API
-void create_core(void);
+#define test_skip(__expected, __actual) \
+do \
+{ \
+  if (libtest::_compare(__FILE__, __LINE__, __func__, ((__expected)), ((__actual)), false) == false) \
+  { \
+    return TEST_SKIPPED; \
+  } \
+} while (0)
 
-/**
-  @note Friendly print function for errors.
-*/
-LIBTEST_API
-const char *test_strerror(test_return_t code);
+#define test_skip_valgrind() \
+do \
+{ \
+  if (libtest::_in_valgrind(__FILE__, __LINE__, __func__)) \
+  { \
+    return TEST_SKIPPED; \
+  } \
+} while (0)
 
 #define test_fail(A) \
 do \
 { \
   if (1) { \
-    fprintf(stderr, "\nFailed at %s:%d: %s\n", __FILE__, __LINE__, #A);\
-    create_core(); \
+    fprintf(stderr, "\n%s:%d: Failed with %s, in %s\n", __FILE__, __LINE__, #A, __func__);\
+    libtest::create_core(); \
     return TEST_FAILURE; \
   } \
 } while (0)
 
-#define test_true(A) \
+
+#define test_false(A) \
 do \
 { \
-  if ((A)) { \
-    fprintf(stderr, "\nAssertion failed at %s:%d: %s\n", __FILE__, __LINE__, #A);\
-    create_core(); \
+  if ((A)) { \
+    fprintf(stderr, "\n%s:%d: Assertion failed %s, in %s\n", __FILE__, __LINE__, #A, __func__);\
+    libtest::create_core(); \
     return TEST_FAILURE; \
   } \
 } while (0)
 
-#define test_true_got(A,B) \
+#define test_false_with(A,B) \
 do \
 { \
-  if ((A)) { \
-    fprintf(stderr, "\nAssertion failed at %s:%d: \"%s\" received \"%s\"\n", __FILE__, __LINE__, #A, (B));\
-    create_core(); \
+  if ((A)) { \
+    fprintf(stderr, "\n%s:%d: Assertion failed %s with %s\n", __FILE__, __LINE__, #A, (B));\
+    libtest::create_core(); \
     return TEST_FAILURE; \
   } \
 } while (0)
 
-#define test_compare(A,B) \
+#define test_ne_compare(__expected, __actual) \
 do \
 { \
-  if ((A) != (B)) \
+  if (libtest::_ne_compare_hint(__FILE__, __LINE__, __func__, ((__expected)), ((__actual)), true) == false) \
   { \
-    fprintf(stderr, "\n%s:%d: Expected %s, got %lu\n", __FILE__, __LINE__, #A, (unsigned long)(B)); \
-    create_core(); \
+    libtest::create_core(); \
     return TEST_FAILURE; \
   } \
 } while (0)
 
-#define test_compare_got(A,B,C) \
+#define test_compare(__expected, __actual) \
 do \
 { \
-  if ((A) != (B)) \
+  if (libtest::_compare(__FILE__, __LINE__, __func__, ((__expected)), ((__actual)), true) == false) \
   { \
-    fprintf(stderr, "\n%s:%d: Expected %s, got %s\n", __FILE__, __LINE__, #A, (C)); \
-    create_core(); \
+    libtest::create_core(); \
     return TEST_FAILURE; \
   } \
 } while (0)
 
-#define test_false(A) \
+#define test_zero(__actual) \
 do \
 { \
-  if ((A)) { \
-    fprintf(stderr, "\nAssertion failed at %s:%d: %s\n", __FILE__, __LINE__, #A);\
-    create_core(); \
+  if (not libtest::_compare_zero(__FILE__, __LINE__, __func__, ((__actual)))) \
+  \
+    libtest::create_core(); \
     return TEST_FAILURE; \
   } \
 } while (0)
 
-#define test_false_with(A,B) \
+#define test_null test_zero
+
+#define test_compare_got(__expected, __actual, __hint) \
 do \
 { \
-  if ((A)) { \
-    fprintf(stderr, "\nAssertion failed at %s:%d: %s with %s\n", __FILE__, __LINE__, #A, (B));\
-    create_core(); \
+  if (not libtest::_compare_hint(__FILE__, __LINE__, __func__, (__expected), (__actual), (__hint))) \
+  \
+    libtest::create_core(); \
     return TEST_FAILURE; \
   } \
 } while (0)
 
+#define test_compare_hint test_compare_got
+
+#define test_compare_warn(__expected, __actual) \
+do \
+{ \
+  void(libtest::_compare(__FILE__, __LINE__, __func__, (__expected), (__actual)), true); \
+} while (0)
+
+#define test_compare_warn_hint(__expected, __actual, __hint) \
+do \
+{ \
+  libtest::_compare_hint(__FILE__, __LINE__, __func__, (__expected), (__actual), (__hint)); \
+} while (0)
+
+#define test_warn(__truth) \
+do \
+{ \
+  void(libtest::_truth(__FILE__, __LINE__, __func__, (__truth))); \
+} while (0)
+
+#define test_warn_hint(__truth, __hint) \
+do \
+{ \
+  void(libtest::_compare_truth_hint(__FILE__, __LINE__, __func__, (__truth), #__truth, (__hint))); \
+} while (0)
+
+
 #define test_strcmp(A,B) \
 do \
 { \
-  if (strcmp((A), (B))) \
+  if ((A) == NULL or (B) == NULL or strcmp((A), (B))) \
   { \
-    fprintf(stderr, "\n%s:%d: `%s` -> `%s`\n", __FILE__, __LINE__, (A), (B)); \
-    create_core(); \
+    if ((B) == NULL) fprintf(stderr, "\n%s:%d: Expected %s, got <null>\n", __FILE__, __LINE__, (A)); \
+    else fprintf(stderr, "\n%s:%d: Expected %s, got \"%s\"\n", __FILE__, __LINE__, (A), (B)); \
+    libtest::create_core(); \
     return TEST_FAILURE; \
   } \
 } while (0)
@@ -273,30 +222,31 @@ do \
 #define test_memcmp(A,B,C) \
 do \
 { \
-  if (memcmp((A), (B), (C))) \
+  if ((A) == NULL or (B) == NULL or memcmp((A), (B), (C))) \
   { \
     fprintf(stderr, "\n%s:%d: %.*s -> %.*s\n", __FILE__, __LINE__, (int)(C), (char *)(A), (int)(C), (char *)(B)); \
-    create_core(); \
+    libtest::create_core(); \
     return TEST_FAILURE; \
   } \
 } while (0)
 
-#define STRINGIFY(x) #x
-#define TOSTRING(x) STRINGIFY(x)
-#define AT __FILE__ ":" TOSTRING(__LINE__)
-
-#ifdef __cplusplus
-#define STRING_WITH_LEN(X) (X), (static_cast<size_t>((sizeof(X) - 1)))
-#else
-#define STRING_WITH_LEN(X) (X), ((size_t)((sizeof(X) - 1)))
-#endif
+#define test_memcmp_hint(A,B,C,__hint) \
+do \
+{ \
+  if ((A) == NULL or (B) == NULL or memcmp((A), (B), (C))) \
+  { \
+    fprintf(stderr, "\n%s:%d: (hint:%s) %.*s -> %.*s\n", __FILE__, __LINE__, __hint, (int)(C), (char *)(A), (int)(C), (char *)(B)); \
+    libtest::create_core(); \
+    return TEST_FAILURE; \
+  } \
+} while (0)
 
-#ifdef __cplusplus
-#define STRING_PARAM_WITH_LEN(X) X, static_cast<size_t>(sizeof(X) - 1)
-#else
-#define STRING_PARAM_WITH_LEN(X) X, (size_t)((sizeof(X) - 1))
-#endif
+#define test_return_if(__test_return_t) \
+do \
+{ \
+  if ((__test_return_t) != TEST_SUCCESS) \
+  { \
+    return __test_return_t; \
+  } \
+} while (0)
 
-#ifdef __cplusplus
-}
-#endif