Update from OSX
[m6w6/libmemcached] / libtest / test.cc
index 29c26ca447fa3698913f923b9813ee8c1dd54ac7..ef10028c5800160dabb687448ec433b0bc0ba321 100644 (file)
@@ -1,13 +1,25 @@
-/* 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:
+ * 
+ *  libtest
  *
- * Use and distribution licensed under the BSD license.  See
- * the COPYING file in the parent directory for full text.
+ *  Copyright (C) 2011 Data Differential, http://datadifferential.com/
+ *
+ *  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.
+ *
+ *  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
  */
 
-
+#include <config.h>
 #include <libtest/common.h>
 
 #include <cassert>
 #include <ctime>
 #include <fnmatch.h>
 #include <iostream>
-#include <cerrno>
 
 #include <signal.h>
 
-#include <libtest/stats.h>
-
 #ifndef __INTEL_COMPILER
 #pragma GCC diagnostic ignored "-Wold-style-cast"
 #endif
 
-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;
-}
-void set_default_socket(const char *socket)
-{
-  strncpy(global_socket, socket, strlen(socket));
-}
+using namespace libtest;
 
 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;
-  std::cout << "\tSkipped Collections\t\t\t\t" << stats->collection_skipped << std::endl;
-  std::cout << "\tSucceeded Collections\t\t\t\t" << stats->collection_success << std::endl;
-  std::cout << std::endl;
-  std::cout << "Total\t\t\t\t" << stats->total << std::endl;
-  std::cout << "\tFailed\t\t\t" << stats->failed << std::endl;
-  std::cout << "\tSkipped\t\t\t" << stats->skipped << std::endl;
-  std::cout << "\tSucceeded\t\t" << stats->success << std::endl;
+  if (stats->collection_failed == 0 and stats->collection_success == 0)
+  {
+    return;
+  }
+
+  Out << "\tTotal Collections\t\t\t\t" << stats->collection_total;
+  Out << "\tFailed Collections\t\t\t\t" << stats->collection_failed;
+  Out << "\tSkipped Collections\t\t\t\t" << stats->collection_skipped;
+  Out << "\tSucceeded Collections\t\t\t\t" << stats->collection_success;
+  Outn();
+  Out << "Total\t\t\t\t" << stats->total;
+  Out << "\tFailed\t\t\t" << stats->failed;
+  Out << "\tSkipped\t\t\t" << stats->skipped;
+  Out << "\tSucceeded\t\t" << stats->success;
 }
 
 static long int timedif(struct timeval a, struct timeval b)
@@ -80,307 +71,409 @@ static long int timedif(struct timeval a, struct timeval b)
   return s + us;
 }
 
-const char *test_strerror(test_return_t code)
-{
-  switch (code) {
-  case TEST_SUCCESS:
-    return "ok";
-
-  case TEST_FAILURE:
-    return "failed";
-
-  case TEST_MEMORY_ALLOCATION_FAILURE:
-    return "memory allocation";
-
-  case TEST_SKIPPED:
-    return "skipped";
-
-  case TEST_FATAL:
-    break;
-  }
-
-  return "failed";
-}
+#include <getopt.h>
+#include <unistd.h>
 
-void create_core(void)
+int main(int argc, char *argv[])
 {
-  if (getenv("LIBMEMCACHED_NO_COREDUMP") == NULL)
-  {
-    pid_t pid= fork();
+  bool opt_massive= false;
+  unsigned long int opt_repeat= 1; // Run all tests once
+  bool opt_quiet= false;
+  std::string collection_to_run;
 
-    if (pid == 0)
+  // Options parsing
+  {
+    enum long_option_t {
+      OPT_LIBYATL_VERSION,
+      OPT_LIBYATL_MATCH_COLLECTION,
+      OPT_LIBYATL_MASSIVE,
+      OPT_LIBYATL_QUIET,
+      OPT_LIBYATL_REPEAT
+    };
+
+    static struct option long_options[]=
     {
-      abort();
-    }
-    else
+      { "version", no_argument, NULL, OPT_LIBYATL_VERSION },
+      { "quiet", no_argument, NULL, OPT_LIBYATL_QUIET },
+      { "repeat", no_argument, NULL, OPT_LIBYATL_REPEAT },
+      { "collection", required_argument, NULL, OPT_LIBYATL_MATCH_COLLECTION },
+      { "massive", no_argument, NULL, OPT_LIBYATL_MASSIVE },
+      { 0, 0, 0, 0 }
+    };
+
+    int option_index= 0;
+    while (1)
     {
-      while (waitpid(pid, NULL, 0) != pid) {};
-    }
-  }
-}
-
-enum shutdown_t {
-  SHUTDOWN_RUNNING,
-  SHUTDOWN_GRACEFUL,
-  SHUTDOWN_FORCED
-};
+      int option_rv= getopt_long(argc, argv, "", long_options, &option_index);
+      if (option_rv == -1)
+      {
+        break;
+      }
 
-static Framework *world= NULL;
-static volatile shutdown_t __shutdown= SHUTDOWN_RUNNING;
+      switch (option_rv)
+      {
+      case OPT_LIBYATL_VERSION:
+        break;
 
-static void *sig_thread(void *arg)
-{   
-  sigset_t *set= (sigset_t *) arg;
+      case OPT_LIBYATL_QUIET:
+        opt_quiet= true;
+        break;
 
-  for (;__shutdown == SHUTDOWN_RUNNING;)
-  {
-    int sig;
-    int error;
-    while ((error= sigwait(set, &sig)) == EINTR) ;
+      case OPT_LIBYATL_REPEAT:
+        opt_repeat= strtoul(optarg, (char **) NULL, 10);
+        break;
 
-    switch (sig)
-    {
-    case SIGSEGV:
-    case SIGINT:
-    case SIGABRT:
-      std::cerr << std::endl << "Signal handling thread got signal " <<  strsignal(sig) << std::endl;
-      __shutdown= SHUTDOWN_FORCED;
-      break;
-
-    default:
-      std::cerr << std::endl << "Signal handling thread got unexpected signal " <<  strsignal(sig) << std::endl;
-    case SIGUSR1:
-      break;
-    }
-  }
+      case OPT_LIBYATL_MATCH_COLLECTION:
+        collection_to_run= optarg;
+        break;
 
-  return NULL;
-}
+      case OPT_LIBYATL_MASSIVE:
+        opt_massive= true;
+        break;
 
+      case '?':
+        /* getopt_long already printed an error message. */
+        Error << "unknown option to getopt_long()";
+        exit(EXIT_FAILURE);
 
-static void setup_signals(pthread_t& thread)
-{
-  sigset_t set;
+      default:
+        break;
+      }
+    }
+  }
 
-  sigemptyset(&set);
-  sigaddset(&set, SIGSEGV);
-  sigaddset(&set, SIGABRT);
-  sigaddset(&set, SIGINT);
-  sigaddset(&set, SIGUSR1);
+  srandom((unsigned int)time(NULL));
 
-  int error;
-  if ((error= pthread_sigmask(SIG_BLOCK, &set, NULL)) != 0)
+  if (bool(getenv("YATL_REPEAT")) and (strtoul(getenv("YATL_REPEAT"), (char **) NULL, 10) > 1))
   {
-    std::cerr << __FILE__ << ":" << __LINE__ << " died during pthread_sigmask(" << strerror(error) << ")" << std::endl;
-    exit(EXIT_FAILURE);
+    opt_repeat= strtoul(getenv("YATL_REPEAT"), (char **) NULL, 10);
   }
 
-  if ((error= pthread_create(&thread, NULL, &sig_thread, (void *) &set)) != 0)
+  if ((bool(getenv("YATL_QUIET")) and (strcmp(getenv("YATL_QUIET"), "0") == 0)) or opt_quiet)
   {
-    std::cerr << __FILE__ << ":" << __LINE__ << " died during pthread_create(" << strerror(error) << ")" << std::endl;
-    exit(EXIT_FAILURE);
+    opt_quiet= true;
   }
-}
-
-
-int main(int argc, char *argv[])
-{
-  world= new Framework();
-
-  if (not world)
+  else if (getenv("JENKINS_URL"))
   {
-    return EXIT_FAILURE;
+    if (bool(getenv("YATL_QUIET")) and (strcmp(getenv("YATL_QUIET"), "1") == 0))
+    { }
+    else
+    {
+      opt_quiet= true;
+    }
   }
 
-  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))
+  if (opt_quiet)
   {
-    std::cerr << "create() failed" << std::endl;
-    return EXIT_FAILURE;
+    close(STDOUT_FILENO);
   }
 
-  char *collection_to_run= NULL;
-  if (argc > 1)
+  char buffer[1024];
+  if (getenv("LIBTEST_TMP"))
   {
-    collection_to_run= argv[1];
+    snprintf(buffer, sizeof(buffer), "%s", getenv("LIBTEST_TMP"));
   }
-  else if (getenv("TEST_COLLECTION"))
+  else
   {
-    collection_to_run= getenv("TEST_COLLECTION");
+    snprintf(buffer, sizeof(buffer), "%s", LIBTEST_TEMP);
   }
 
-  if (collection_to_run)
+  if (chdir(buffer) == -1)
   {
-    std::cout << "Only testing " <<  collection_to_run << std::endl;
+    char getcwd_buffer[1024];
+    char *dir= getcwd(getcwd_buffer, sizeof(getcwd_buffer));
+
+    Error << "Unable to chdir() from " << dir << " to " << buffer << " errno:" << strerror(errno);
+    return EXIT_FAILURE;
   }
 
-  char *wildcard= NULL;
-  if (argc == 3)
+  if (libtest::libtool() == NULL)
   {
-    wildcard= argv[2];
+    Error << "Failed to locate libtool";
+    return EXIT_FAILURE;
   }
 
-  for (collection_st *next= world->collections; next->name and __shutdown == SHUTDOWN_RUNNING; next++)
-  {
-    test_return_t collection_rc= TEST_SUCCESS;
-    bool failed= false;
-    bool skipped= false;
+  int exit_code;
 
-    if (collection_to_run && fnmatch(collection_to_run, next->name, 0))
-      continue;
+  try {
+    do {
+      exit_code= EXIT_SUCCESS;
+      Framework world;
 
-    stats.collection_total++;
+      fatal_assert(sigignore(SIGPIPE) == 0);
 
-    collection_rc= world->startup(creators_ptr);
+      libtest::SignalThread signal;
+      if (signal.setup() == false)
+      {
+        Error << "Failed to setup signals";
+        return EXIT_FAILURE;
+      }
 
-    if (collection_rc == TEST_SUCCESS and next->pre)
-    {
-      collection_rc= world->runner->pre(next->pre, creators_ptr);
-    }
+      Stats stats;
 
-    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;
-      stats.collection_failed++;
-      goto cleanup;
-
-    case TEST_SKIPPED:
-      std::cerr << std::endl << next->name << " [ skipping ]" << std::endl << std::endl;
-      stats.collection_skipped++;
-      goto cleanup;
-
-    case TEST_MEMORY_ALLOCATION_FAILURE:
-      test_assert(0, "Allocation failure, or unknown return");
-    }
+      get_world(&world);
 
-    for (test_st *run= next->tests; run->name; run++)
-    {
-      struct timeval start_time, end_time;
-      long int load_time= 0;
+      test_return_t error;
+      void *creators_ptr= world.create(error);
 
-      if (wildcard && fnmatch(wildcard, run->name, 0))
+      switch (error)
       {
-       continue;
-      }
+      case TEST_SUCCESS:
+        break;
 
-      std::cerr << "\tTesting " << run->name;
+      case TEST_SKIPPED:
+        Out << "SKIP " << argv[0];
+        return EXIT_SUCCESS;
 
-      test_return_t return_code;
-      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);
-            }
-          }
+      case TEST_FAILURE:
+        return EXIT_FAILURE;
+      }
 
-          // @todo do something if post fails
-          (void)world->item.post(creators_ptr);
-        }
-        else
+      if (getenv("YATL_COLLECTION_TO_RUN"))
+      {
+        if (strlen(getenv("YATL_COLLECTION_TO_RUN")))
         {
-          std::cerr << __FILE__ << ":" << __LINE__ << " item.flush(failure)" << std::endl;
+          collection_to_run= getenv("YATL_COLLECTION_TO_RUN");
         }
       }
-      else
+
+      if (collection_to_run.compare("none") == 0)
       {
-        std::cerr << __FILE__ << ":" << __LINE__ << " item.startup(failure)" << std::endl;
+        return EXIT_SUCCESS;
       }
 
-      stats.total++;
+      if (collection_to_run.empty() == false)
+      {
+        Out << "Only testing " <<  collection_to_run;
+      }
 
-      std::cerr << "\t\t\t\t\t";
+      char *wildcard= NULL;
+      if (argc == 3)
+      {
+        wildcard= argv[2];
+      }
 
-      switch (return_code)
+      for (collection_st *next= world.collections; next and next->name and (not signal.is_shutdown()); next++)
       {
-      case TEST_SUCCESS:
-       std::cerr << load_time / 1000 << "." << load_time % 1000;
-       stats.success++;
-       break;
+        bool failed= false;
+        bool skipped= false;
 
-      case TEST_FATAL:
-      case TEST_FAILURE:
-       stats.failed++;
-       failed= true;
-       break;
+        if (collection_to_run.empty() == false and fnmatch(collection_to_run.c_str(), next->name, 0))
+        {
+          continue;
+        }
 
-      case TEST_SKIPPED:
-       stats.skipped++;
-       skipped= true;
-       break;
+        stats.collection_total++;
 
-      case TEST_MEMORY_ALLOCATION_FAILURE:
-       test_assert(0, "Memory Allocation Error");
-      }
+        test_return_t collection_rc= world.startup(creators_ptr);
 
-      std::cerr << "[ " << test_strerror(return_code) << " ]" << std::endl;
+        if (collection_rc == TEST_SUCCESS and next->pre)
+        {
+          collection_rc= world.runner()->pre(next->pre, creators_ptr);
+        }
 
-      if (test_failed(world->on_error(return_code, creators_ptr)))
-      {
-        break;
-      }
-    }
+        switch (collection_rc)
+        {
+        case TEST_SUCCESS:
+          break;
+
+        case TEST_FAILURE:
+          Out << next->name << " [ failed ]";
+          failed= true;
+          signal.set_shutdown(SHUTDOWN_GRACEFUL);
+          goto cleanup;
+
+        case TEST_SKIPPED:
+          Out << next->name << " [ skipping ]";
+          skipped= true;
+          goto cleanup;
+
+        default:
+          fatal_message("invalid return code");
+        }
 
-    if (next->post and world->runner->post)
-    {
-      (void) world->runner->post(next->post, creators_ptr);
-    }
+        Out << "Collection: " << next->name;
+
+        for (test_st *run= next->tests; run->name; run++)
+        {
+          struct timeval start_time, end_time;
+          long int load_time= 0;
+
+          if (wildcard && fnmatch(wildcard, run->name, 0))
+          {
+            continue;
+          }
+
+          test_return_t return_code;
+          try {
+            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);
+                    assert(world.runner());
+                    assert(run->test_fn);
+                    try 
+                    {
+                      return_code= world.runner()->run(run->test_fn, creators_ptr);
+                    }
+                    // Special case where check for the testing of the exception
+                    // system.
+                    catch (libtest::fatal &e)
+                    {
+                      if (fatal::is_disabled())
+                      {
+                        fatal::increment_disabled_counter();
+                        return_code= TEST_SUCCESS;
+                      }
+                      else
+                      {
+                        throw;
+                      }
+                    }
+
+                    gettimeofday(&end_time, NULL);
+                    load_time= timedif(end_time, start_time);
+                  }
+                }
+
+                // @todo do something if post fails
+                (void)world.item.post(creators_ptr);
+              }
+              else if (return_code == TEST_SKIPPED)
+              { }
+              else if (return_code == TEST_FAILURE)
+              {
+                Error << " item.flush(failure)";
+                signal.set_shutdown(SHUTDOWN_GRACEFUL);
+              }
+            }
+            else if (return_code == TEST_SKIPPED)
+            { }
+            else if (return_code == TEST_FAILURE)
+            {
+              Error << " item.startup(failure)";
+              signal.set_shutdown(SHUTDOWN_GRACEFUL);
+            }
+          }
+
+          catch (libtest::fatal &e)
+          {
+            Error << "Fatal exception was thrown: " << e.what();
+            return_code= TEST_FAILURE;
+          }
+          catch (std::exception &e)
+          {
+            Error << "Exception was thrown: " << e.what();
+            return_code= TEST_FAILURE;
+          }
+          catch (...)
+          {
+            Error << "Unknown exception occurred";
+            return_code= TEST_FAILURE;
+          }
+
+          stats.total++;
+
+          switch (return_code)
+          {
+          case TEST_SUCCESS:
+            Out << "\tTesting " << run->name <<  "\t\t\t\t\t" << load_time / 1000 << "." << load_time % 1000 << "[ " << test_strerror(return_code) << " ]";
+            stats.success++;
+            break;
+
+          case TEST_FAILURE:
+            stats.failed++;
+            failed= true;
+            Out << "\tTesting " << run->name <<  "\t\t\t\t\t" << "[ " << test_strerror(return_code) << " ]";
+            break;
+
+          case TEST_SKIPPED:
+            stats.skipped++;
+            skipped= true;
+            Out << "\tTesting " << run->name <<  "\t\t\t\t\t" << "[ " << test_strerror(return_code) << " ]";
+            break;
+
+          default:
+            fatal_message("invalid return code");
+          }
+
+          if (test_failed(world.on_error(return_code, creators_ptr)))
+          {
+            Error << "Failed while running on_error()";
+            signal.set_shutdown(SHUTDOWN_GRACEFUL);
+            break;
+          }
+        }
+
+        (void) world.runner()->post(next->post, creators_ptr);
 
-    if (failed == 0 and skipped == 0)
-    {
-      stats.collection_success++;
-    }
 cleanup:
+        if (failed == false and skipped == false)
+        {
+          stats.collection_success++;
+        }
 
-    world->shutdown(creators_ptr);
-  }
+        if (failed)
+        {
+          stats.collection_failed++;
+        }
 
-  if (__shutdown == SHUTDOWN_RUNNING)
-  {
-    __shutdown= SHUTDOWN_GRACEFUL;
-  }
+        if (skipped)
+        {
+          stats.collection_skipped++;
+        }
+
+        world.shutdown(creators_ptr);
+        Outn();
+      }
+
+      if (not signal.is_shutdown())
+      {
+        signal.set_shutdown(SHUTDOWN_GRACEFUL);
+      }
 
-  if (__shutdown == SHUTDOWN_FORCED)
+      shutdown_t status= signal.get_shutdown();
+      if (status == SHUTDOWN_FORCED)
+      {
+        Out << "Tests were aborted.";
+        exit_code= EXIT_FAILURE;
+      }
+      else if (stats.collection_failed)
+      {
+        Out << "Some test failed.";
+        exit_code= EXIT_FAILURE;
+      }
+      else if (stats.collection_skipped and stats.collection_failed and stats.collection_success)
+      {
+        Out << "Some tests were skipped.";
+      }
+      else if (stats.collection_success and stats.collection_failed == 0)
+      {
+        Out << "All tests completed successfully.";
+      }
+
+      stats_print(&stats);
+
+      Outn(); // Generate a blank to break up the messages if make check/test has been run
+    } while (exit_code == EXIT_SUCCESS and --opt_repeat);
+  }
+  catch (libtest::fatal& e)
   {
-    std::cerr << std::endl << std::endl <<  "Tests were aborted." << std::endl << std::endl;
+    std::cerr << e.what() << std::endl;
   }
-  else if (stats.collection_failed or stats.collection_skipped)
+  catch (std::exception& e)
   {
-    std::cerr << std::endl << std::endl <<  "Some test failures and/or skipped test occurred." << std::endl << std::endl;
+    std::cerr << e.what() << std::endl;
   }
-  else
+  catch (...)
   {
-    std::cout << std::endl << std::endl <<  "All tests completed successfully." << std::endl << std::endl;
+    std::cerr << "Unknown exception halted execution." << std::endl;
   }
 
-  stats_print(&stats);
-
-  void *retval;
-  pthread_kill(thread, SIGUSR1);
-  pthread_join(thread, &retval);
-
-  delete world;
-
-  return stats.failed == 0 and __shutdown == SHUTDOWN_GRACEFUL ? EXIT_SUCCESS : EXIT_FAILURE;
+  return exit_code;
 }