Import/Merge of libtest latest.
[m6w6/libmemcached] / libtest / test.h
index d6d7d787c616d9386db6fbea19f15e22aa2144ff..5c449ab02f9e3c0341b4c1638f3f70f83c93fa3d 100644 (file)
@@ -1,44 +1,43 @@
-/* uTest
- * Copyright (C) 2011 Data Differential, http://datadifferential.com/
- * Copyright (C) 2006-2009 Brian Aker
- * All rights reserved.
+/*  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
+ *
+ *  Data Differential YATL (i.e. libtest)  library
+ *
+ *  Copyright (C) 2012 Data Differential, http://datadifferential.com/
+ *
+ *  Redistribution and use in source and binary forms, with or without
+ *  modification, are permitted provided that the following conditions are
+ *  met:
+ *
+ *      * 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.
  *
- * Use and distribution licensed under the BSD license.  See
- * the COPYING file in the parent directory for full text.
  */
 
-/*
-  Structures for generic tests.
-*/
-
-#include <stdio.h>
-#include <stdlib.h>
-#include <stdbool.h>
-#include <stdint.h>
-#include <libtest/visibility.h>
-
 #pragma once
 
-enum test_return_t {
-  TEST_SUCCESS= 0, /* Backwards compatibility */
-  TEST_FAILURE,
-  TEST_MEMORY_ALLOCATION_FAILURE,
-  TEST_SKIPPED,
-  TEST_FATAL, // Collection should not be continued
-  TEST_MAXIMUM_RETURN /* Always add new error code before */
-};
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-typedef void* (test_callback_create_fn)(enum test_return_t*);
-typedef enum test_return_t (test_callback_fn)(void *);
-typedef enum test_return_t (test_callback_runner_fn)(test_callback_fn*, void *);
-typedef enum test_return_t (test_callback_error_fn)(const enum test_return_t, void *);
-
-#ifdef __cplusplus
-}
+#ifndef __INTEL_COMPILER
+#pragma GCC diagnostic ignored "-Wold-style-cast"
 #endif
 
 /**
@@ -50,151 +49,25 @@ struct test_st {
   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;
-  struct test_st *tests;
-};
-
-
-/**
-  Structure which houses the actual callers for the test cases contained in
-  the collections.
-*/
-struct world_runner_st {
-  test_callback_runner_fn *pre;
-  test_callback_runner_fn *run;
-  test_callback_runner_fn *post;
-};
-
-
-/**
-  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;
-
-  /* This is called a the beginning of any collection run. */
-  test_callback_fn *collection_startup;
-
-  /* This is called a the end of any collection run. */
-  test_callback_fn *collection_shutdown;
-
-  /* This is called a the beginning of any run. */
-  test_callback_fn *run_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;
-
-  /**
-    Runner represents the callers for the tests. If not implemented we will use
-    a set of default implementations.
-  */
-  world_runner_st *runner;
-
-  world_st() :
-    collections(NULL),
-    create(NULL),
-    destroy(NULL),
-    collection_startup(NULL),
-    collection_shutdown(NULL),
-    run_startup(NULL),
-    flush(NULL),
-    pre_run(NULL),
-    post_run(NULL),
-    on_error(NULL),
-    runner(NULL)
-  { }
-
-  virtual ~world_st()
-  { }
-
-private:
-  world_st(const world_st&);
-  world_st& operator=(const world_st&);
-};
-
-
-
-/**
-  @note world_stats_st is a simple structure for tracking test successes.
-*/
-struct world_stats_st {
-  int32_t collection_success;
-  int32_t collection_skipped;
-  int32_t collection_failed;
-  int32_t collection_total;
-
-  uint32_t success;
-  uint32_t skipped;
-  uint32_t failed;
-  uint32_t total;
-
-  world_stats_st() :
-    collection_success(0),
-    collection_skipped(0),
-    collection_failed(0),
-    collection_total(0),
-    success(0),
-    skipped(0),
-    failed(0),
-    total(0)
-  { }
-};
-
-#define TEST_STRINGIFY(x) #x
-#define TEST_TOSTRING(x) TEST_STRINGIFY(x)
-#define TEST_AT __FILE__ ":" TEST_TOSTRING(__LINE__)
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-/* How we make all of this work :) */
-LIBTEST_API
-void get_world(world_st *world);
-
-LIBTEST_INTERNAL_API
-void create_core(void);
-
-/**
-  @note Friendly print function for errors.
-*/
-LIBTEST_INTERNAL_API
-const char *test_strerror(test_return_t code);
-
 #define test_assert_errno(A) \
 do \
 { \
   if ((A)) { \
-    fprintf(stderr, "\nAssertion failed at %s:%d: ", __FILE__, __LINE__);\
+    fprintf(stderr, "\n%s:%d: Assertion failed for %s: ", __FILE__, __LINE__, __func__);\
     perror(#A); \
     fprintf(stderr, "\n"); \
-    create_core(); \
+    libtest::create_core(); \
+    assert((A)); \
+  } \
+} while (0)
+
+#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)
@@ -203,8 +76,8 @@ do \
 do \
 { \
   if (! (A)) { \
-    fprintf(stderr, "\nAssertion failed at %s:%d: %s\n", __FILE__, __LINE__, #A);\
-    create_core(); \
+    fprintf(stderr, "\n%s:%d: Assertion \"%s\" failed, in %s\n", __FILE__, __LINE__, #A, __func__);\
+    libtest::create_core(); \
     return TEST_FAILURE; \
   } \
 } while (0)
@@ -213,26 +86,31 @@ do \
 do \
 { \
   if (! (A)) { \
-    fprintf(stderr, "\nAssertion failed at %s:%d: %s\n", __FILE__, __LINE__, #A);\
-    create_core(); \
+    fprintf(stderr, "\n%s:%d: Assertion \"%s\" failed, in %s\n", __FILE__, __LINE__, #A, __func__);\
+    libtest::create_core(); \
     return TEST_FAILURE; \
   } \
 } while (0)
 
-#define test_true_got(A,B) \
+#define test_true_got(A, B) test_true(A);
+#define test_true_hint(A, B) test_true(A);
+
+#define test_compare_hint(A, B, C) test_compare(A, B);
+#define test_compare_got(A, B, C) test_compare(A, B);
+
+#define test_skip(__expected, __actual) \
 do \
 { \
-  if (! (A)) { \
-    fprintf(stderr, "\nAssertion failed at %s:%d: \"%s\" received \"%s\"\n", __FILE__, __LINE__, #A, (B));\
-    create_core(); \
-    return TEST_FAILURE; \
+  if (libtest::_compare(__FILE__, __LINE__, __func__, ((__expected)), ((__actual)), false) == false) \
+  { \
+    return TEST_SKIPPED; \
   } \
 } while (0)
 
-#define test_skip(A,B) \
+#define test_skip_valgrind() \
 do \
 { \
-  if ((A) != (B)) \
+  if (libtest::_in_valgrind(__FILE__, __LINE__, __func__)) \
   { \
     return TEST_SKIPPED; \
   } \
@@ -242,8 +120,8 @@ do \
 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)
@@ -253,8 +131,8 @@ do \
 do \
 { \
   if ((A)) { \
-    fprintf(stderr, "\nAssertion failed in %s:%d: %s\n", __FILE__, __LINE__, #A);\
-    create_core(); \
+    fprintf(stderr, "\n%s:%d: Assertion failed %s, in %s\n", __FILE__, __LINE__, #A, __func__);\
+    libtest::create_core(); \
     return TEST_FAILURE; \
   } \
 } while (0)
@@ -263,66 +141,79 @@ do \
 do \
 { \
   if ((A)) { \
-    fprintf(stderr, "\nAssertion failed at %s:%d: %s with %s\n", __FILE__, __LINE__, #A, (B));\
-    create_core(); \
+    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(__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_strcmp(A,B) \
+#define test_zero(__actual) \
 do \
 { \
-  if (strcmp((A), (B))) \
+  if (not libtest::_compare_zero(__FILE__, __LINE__, __func__, ((__actual)))) \
   { \
-    fprintf(stderr, "\n%s:%d: Expected %s, got %s\n", __FILE__, __LINE__, (A), (B)); \
-    create_core(); \
+    libtest::create_core(); \
     return TEST_FAILURE; \
   } \
 } while (0)
 
+#define test_null test_zero
+
+#define test_compare_warn(__expected, __actual) \
+do \
+{ \
+  void(libtest::_compare(__FILE__, __LINE__, __func__, (__expected), (__actual)), true); \
+} while (0)
+
+#define test_warn(__truth, __explain) \
+do \
+{ \
+  void(libtest::_assert_truth(__FILE__, __LINE__, __func__, bool((__truth)), #__truth, __explain)); \
+} while (0)
+
+#define test_strcmp(__expected, __actual) \
+do \
+{ \
+  void(libtest::_compare_strcmp(__FILE__, __LINE__, __func__, (__expected), (__actual))); \
+} while (0)
+
 #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)
 
-#ifdef __cplusplus
-}
-#endif
-
-#ifdef __cplusplus
-#define test_literal_param(X) (X), (static_cast<size_t>((sizeof(X) - 1)))
-#else
-#define test_literal_param(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)
 
-#define test_string_make_from_cstr(X) (X), ((X) ? strlen(X) : 0)