Merge trunk for LP
[awesomized/libmemcached] / libtest / test.cc
index 2c57d206430ec460f4f794ea9f170e4bfca8961d..8beef356610b788bf4b5fc8bf825c7bb9ea8c6ed 100644 (file)
@@ -1,35 +1,96 @@
-/* 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:
+ * 
+ *  uTest, libtest
+ *
+ *  Copyright (C) 2011 Data Differential, http://datadifferential.com/
+ *  Copyright (C) 2006-2009 Brian Aker
+ *
+ *  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.
  */
 
 
-#include <config.h>
 
-#include <stdint.h>
-#include <assert.h>
-#include <stdlib.h>
-#include <string.h>
+
+#include <libtest/common.h>
+
+#include <cassert>
+#include <cstdlib>
+#include <cstring>
 #include <sys/time.h>
 #include <sys/types.h>
 #include <sys/stat.h>
 #include <sys/wait.h>
 #include <unistd.h>
-#include <time.h>
+#include <ctime>
 #include <fnmatch.h>
 #include <iostream>
 
-#include <libtest/test.h>
+#include <signal.h>
+
+#include <libtest/stats.h>
 
 #ifndef __INTEL_COMPILER
 #pragma GCC diagnostic ignored "-Wold-style-cast"
 #endif
 
-static void world_stats_print(world_stats_st *stats)
+static in_port_t global_port= 0;
+static char global_socket[1024];
+
+in_port_t default_port()
+{
+  assert(global_port);
+  return global_port;
+}
+void set_default_port(in_port_t port)
+{
+  global_port= port;
+}
+
+const char *default_socket()
+{
+  assert(global_socket[0]);
+  return global_socket;
+}
+
+bool test_is_local()
+{
+  return (getenv("LIBTEST_LOCAL"));
+}
+
+void set_default_socket(const char *socket)
+{
+  strncpy(global_socket, socket, strlen(socket));
+}
+
+static void stats_print(Stats *stats)
 {
   std::cout << "\tTotal Collections\t\t\t\t" << stats->collection_total << std::endl;
   std::cout << "\tFailed Collections\t\t\t\t" << stats->collection_failed << std::endl;
@@ -58,19 +119,21 @@ const char *test_strerror(test_return_t code)
   switch (code) {
   case TEST_SUCCESS:
     return "ok";
+
   case TEST_FAILURE:
     return "failed";
-  case TEST_FATAL:
-    return "failed";
+
   case TEST_MEMORY_ALLOCATION_FAILURE:
     return "memory allocation";
+
   case TEST_SKIPPED:
     return "skipped";
-  case TEST_MAXIMUM_RETURN:
-  default:
-     std::cerr << "Unknown return value." << std::endl;
-    abort();
+
+  case TEST_FATAL:
+    break;
   }
+
+  return "failed";
 }
 
 void create_core(void)
@@ -90,73 +153,110 @@ void create_core(void)
   }
 }
 
+enum shutdown_t {
+  SHUTDOWN_RUNNING,
+  SHUTDOWN_GRACEFUL,
+  SHUTDOWN_FORCED
+};
+
+static Framework *world= NULL;
+static volatile shutdown_t __shutdown= SHUTDOWN_RUNNING;
+pthread_mutex_t shutdown_mutex= PTHREAD_MUTEX_INITIALIZER;
 
-static test_return_t _runner_default(test_callback_fn func, void *p)
+static bool is_shutdown()
 {
-  if (func)
-    return func(p);
+  bool ret;
+  pthread_mutex_lock(&shutdown_mutex);
+  ret= bool(__shutdown != SHUTDOWN_RUNNING);
+  pthread_mutex_unlock(&shutdown_mutex);
 
-  return TEST_SUCCESS;
+  return ret;
 }
 
-static world_runner_st defualt_runners= {
-  _runner_default,
-  _runner_default,
-  _runner_default
-};
-
-static test_return_t _default_callback(void *p)
+static void set_shutdown(shutdown_t arg)
 {
-  (void)p;
-
-  return TEST_SUCCESS;
+  pthread_mutex_lock(&shutdown_mutex);
+  __shutdown= arg;
+  pthread_mutex_unlock(&shutdown_mutex);
 }
 
-static collection_st *init_world(world_st *world)
-{
-  if (world->runner == NULL)
+static void *sig_thread(void *arg)
+{   
+  sigset_t *set= (sigset_t *) arg;
+
+  while (is_shutdown())
   {
-    world->runner= &defualt_runners;
-  }
+    int sig;
+    int error;
+    while ((error= sigwait(set, &sig)) == EINTR) ;
 
-  if (world->collection_startup == NULL)
-    world->collection_startup= _default_callback;
+    switch (sig)
+    {
+    case SIGSEGV:
+    case SIGINT:
+    case SIGABRT:
+      Error << "Signal handling thread got signal " <<  strsignal(sig);
+      set_shutdown(SHUTDOWN_FORCED);
+      break;
 
-  if (world->collection_shutdown == NULL)
-    world->collection_shutdown= _default_callback;
+    default:
+      Error << "Signal handling thread got unexpected signal " <<  strsignal(sig);
+    case SIGUSR1:
+      break;
+    }
+  }
 
-  return world->collections;
+  return NULL;
 }
 
 
-int main(int argc, char *argv[])
+static void setup_signals(pthread_t& thread)
 {
-  world_st world;
-  void *world_ptr;
+  sigset_t set;
 
-  world_stats_st stats;
+  sigemptyset(&set);
+  sigaddset(&set, SIGSEGV);
+  sigaddset(&set, SIGABRT);
+  sigaddset(&set, SIGINT);
+  sigaddset(&set, SIGUSR1);
 
-  get_world(&world);
+  int error;
+  if ((error= pthread_sigmask(SIG_BLOCK, &set, NULL)) != 0)
+  {
+    Error << " died during pthread_sigmask(" << strerror(error) << ")";
+    exit(EXIT_FAILURE);
+  }
 
-  if (not world.runner)
+  if ((error= pthread_create(&thread, NULL, &sig_thread, (void *) &set)) != 0)
   {
-    world.runner= &defualt_runners;
+    Error << " died during pthread_create(" << strerror(error) << ")";
+    exit(EXIT_FAILURE);
   }
+}
+
 
-  collection_st *collection= init_world(&world);
+int main(int argc, char *argv[])
+{
+  world= new Framework();
 
-  if (world.create)
+  if (not world)
   {
-    test_return_t error;
-    world_ptr= world.create(&error);
-    if (error != TEST_SUCCESS)
-    {
-      return EXIT_FAILURE;
-    }
+    return EXIT_FAILURE;
   }
-  else
+
+  pthread_t thread;
+  setup_signals(thread);
+
+  Stats stats;
+
+  get_world(world);
+
+  test_return_t error;
+  void *creators_ptr= world->create(error);
+  if (test_failed(error))
   {
-    world_ptr= NULL;
+    Error << "create() failed";
+    return EXIT_FAILURE;
   }
 
   char *collection_to_run= NULL;
@@ -180,7 +280,7 @@ int main(int argc, char *argv[])
     wildcard= argv[2];
   }
 
-  for (collection_st *next= collection; next->name; next++)
+  for (collection_st *next= world->collections; next->name and (not is_shutdown()); next++)
   {
     test_return_t collection_rc= TEST_SUCCESS;
     bool failed= false;
@@ -191,37 +291,35 @@ int main(int argc, char *argv[])
 
     stats.collection_total++;
 
-    collection_rc= world.collection_startup(world_ptr);
+    collection_rc= world->startup(creators_ptr);
 
     if (collection_rc == TEST_SUCCESS and next->pre)
     {
-      collection_rc= world.runner->pre(next->pre, world_ptr);
+      collection_rc= world->runner->pre(next->pre, creators_ptr);
     }
 
     switch (collection_rc)
     {
     case TEST_SUCCESS:
-      std::cerr << std::endl << next->name << std::endl << std::endl;
       break;
 
     case TEST_FATAL:
     case TEST_FAILURE:
-      std::cerr << std::endl << next->name << " [ failed ]" << std::endl << std::endl;
+      Error << next->name << " [ failed ]";
       stats.collection_failed++;
       goto cleanup;
 
     case TEST_SKIPPED:
-      std::cerr << std::endl << next->name << " [ skipping ]" << std::endl << std::endl;
+      Log << next->name << " [ skipping ]";
       stats.collection_skipped++;
       goto cleanup;
 
     case TEST_MEMORY_ALLOCATION_FAILURE:
-    case TEST_MAXIMUM_RETURN:
-    default:
-      assert(0);
-      break;
+      test_assert(0, "Allocation failure, or unknown return");
     }
 
+    Log << "Collection: " << next->name;
+
     for (test_st *run= next->tests; run->name; run++)
     {
       struct timeval start_time, end_time;
@@ -229,103 +327,76 @@ int main(int argc, char *argv[])
 
       if (wildcard && fnmatch(wildcard, run->name, 0))
       {
-       continue;
-      }
-
-      std::cerr << "\tTesting " << run->name;
-
-      if (world.run_startup)
-      {
-       world.run_startup(world_ptr);
-      }
-
-      if (run->requires_flush && world.flush)
-      {
-       world.flush(world_ptr);
+        continue;
       }
 
-      if (world.pre_run)
-      {
-       world.pre_run(world_ptr);
-      }
-
-
       test_return_t return_code;
-      { // Runner Code
-#if 0
-       if (next->pre and world.runner->pre)
-       {
-         return_code= world.runner->pre(next->pre, world_ptr);
-
-         if (return_code != TEST_SUCCESS)
-         {
-           goto error;
-         }
-       }
-#endif
-
-       gettimeofday(&start_time, NULL);
-       return_code= world.runner->run(run->test_fn, world_ptr);
-       gettimeofday(&end_time, NULL);
-       load_time= timedif(end_time, start_time);
-
-#if 0
-       if (next->post && world.runner->post)
-       {
-         (void) world.runner->post(next->post, world_ptr);
-       }
-#endif
+      if (test_success(return_code= world->item.startup(creators_ptr)))
+      {
+        if (test_success(return_code= world->item.flush(creators_ptr, run)))
+        {
+          // @note pre will fail is SKIPPED is returned
+          if (test_success(return_code= world->item.pre(creators_ptr)))
+          {
+            { // Runner Code
+              gettimeofday(&start_time, NULL);
+              return_code= world->runner->run(run->test_fn, creators_ptr);
+              gettimeofday(&end_time, NULL);
+              load_time= timedif(end_time, start_time);
+            }
+          }
+
+          // @todo do something if post fails
+          (void)world->item.post(creators_ptr);
+        }
+        else
+        {
+          Error << " item.flush(failure)";
+        }
       }
-
-      if (world.post_run)
+      else
       {
-       world.post_run(world_ptr);
+        Error << " item.startup(failure)";
       }
 
       stats.total++;
 
-      std::cerr << "\t\t\t\t\t";
-
       switch (return_code)
       {
       case TEST_SUCCESS:
-       std::cerr << load_time / 1000 << "." << load_time % 1000;
-       stats.success++;
-       break;
+        Log << "\tTesting " << run->name <<  "\t\t\t\t\t" << load_time / 1000 << "." << load_time % 1000 << "[ " << test_strerror(return_code) << " ]";
+        stats.success++;
+        break;
 
       case TEST_FATAL:
       case TEST_FAILURE:
-       stats.failed++;
-       failed= true;
-       break;
+        stats.failed++;
+        failed= true;
+        Error << "\tTesting " << run->name <<  "\t\t\t\t\t" << "[ " << test_strerror(return_code) << " ]";
+        break;
 
       case TEST_SKIPPED:
-       stats.skipped++;
-       skipped= true;
-       break;
+        stats.skipped++;
+        skipped= true;
+        Log << "\tTesting " << run->name <<  "\t\t\t\t\t" << "[ " << test_strerror(return_code) << " ]";
+        break;
 
       case TEST_MEMORY_ALLOCATION_FAILURE:
-      case TEST_MAXIMUM_RETURN:
-      default:
-       break;
-       abort();
+        test_assert(0, "Memory Allocation Error");
       }
 
-      std::cerr << "[ " << test_strerror(return_code) << " ]" << std::endl;
-
-      if (world.on_error)
+      if (test_failed(world->on_error(return_code, creators_ptr)))
       {
-       test_return_t rc= world.on_error(return_code, world_ptr);
-
-       if (rc != TEST_SUCCESS)
-         break;
+        Error << "Failed while running on_error()";
+        break;
       }
 
+      Logn();
     }
 
-    if (next->post && world.runner->post)
+    if (next->post and world->runner->post)
     {
-      (void) world.runner->post(next->post, world_ptr);
+      (void) world->runner->post(next->post, creators_ptr);
     }
 
     if (failed == 0 and skipped == 0)
@@ -334,36 +405,34 @@ int main(int argc, char *argv[])
     }
 cleanup:
 
-    if (world.collection_shutdown)
-    {
-      world.collection_shutdown(world_ptr);
-    }
+    world->shutdown(creators_ptr);
   }
 
-  if (stats.collection_failed || stats.collection_skipped)
+  if (not is_shutdown())
   {
-    std::cerr << std::endl << std::endl <<  "Some test failures and/or skipped test occurred." << std::endl << std::endl;
-#if 0
-    print_failed_test();
-#endif
+    set_shutdown(SHUTDOWN_GRACEFUL);
+    pthread_kill(thread, SIGUSR1);
+  }
+
+  if (__shutdown == SHUTDOWN_FORCED)
+  {
+    Error << "Tests were aborted.";
+  }
+  else if (stats.collection_failed or stats.collection_skipped)
+  {
+    Error << "Some test failures and/or skipped test occurred.";
   }
   else
   {
-    std::cout << std::endl << std::endl <<  "All tests completed successfully." << std::endl << std::endl;
+    Log << "All tests completed successfully.";
   }
 
-  if (world.destroy)
-  {
-    test_return_t error= world.destroy(world_ptr);
+  stats_print(&stats);
 
-    if (error != TEST_SUCCESS)
-    {
-      std::cerr << "Failure during shutdown." << std::endl;
-      stats.failed++; // We do this to make our exit code return EXIT_FAILURE
-    }
-  }
+  void *retval;
+  pthread_join(thread, &retval);
 
-  world_stats_print(&stats);
+  delete world;
 
-  return stats.failed == 0 ? 0 : 1;
+  return stats.failed == 0 and __shutdown == SHUTDOWN_GRACEFUL ? EXIT_SUCCESS : EXIT_FAILURE;
 }