Add an exception class for tossing resource error.
[m6w6/libmemcached] / libtest / test.cc
index 63cf9cbc8a7a0256b0af14fd2e51de1187948ea3..92c1226b24ffca5e7b686926b99753c20051200c 100644 (file)
@@ -1,38 +1,22 @@
 /*  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
  * 
- *  uTest, libtest
+ *  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:
+ *  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
  */
 
 #include <libtest/common.h>
@@ -51,8 +35,9 @@
 
 #include <signal.h>
 
-#include <libtest/stats.h>
-#include <libtest/signal.h>
+#if defined(HAVE_CURL_CURL_H) && HAVE_CURL_CURL_H
+#include <curl/curl.h>
+#endif
 
 #ifndef __INTEL_COMPILER
 #pragma GCC diagnostic ignored "-Wold-style-cast"
 
 using namespace libtest;
 
-static in_port_t global_port= 0;
-static char global_socket[1024];
-
-in_port_t default_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)
+static void stats_print(Stats *stats)
 {
-  if (socket)
+  if (stats->collection_failed == 0 and stats->collection_success == 0)
   {
-    strncpy(global_socket, socket, strlen(socket));
+    return;
   }
-}
 
-static void stats_print(Stats *stats)
-{
-  Log << "\tTotal Collections\t\t\t\t" << stats->collection_total;
-  Log << "\tFailed Collections\t\t\t\t" << stats->collection_failed;
-  Log << "\tSkipped Collections\t\t\t\t" << stats->collection_skipped;
-  Log << "\tSucceeded Collections\t\t\t\t" << stats->collection_success;
-  Logn();
-  Log << "Total\t\t\t\t" << stats->total;
-  Log << "\tFailed\t\t\t" << stats->failed;
-  Log << "\tSkipped\t\t\t" << stats->skipped;
-  Log << "\tSucceeded\t\t" << stats->success;
+  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)
@@ -116,268 +74,400 @@ static long int timedif(struct timeval a, struct timeval b)
   return s + us;
 }
 
-const char *test_strerror(test_return_t code)
+static void cleanup_curl(void)
 {
-  switch (code) {
-  case TEST_SUCCESS:
-    return "ok";
-
-  case TEST_FAILURE:
-    return "failed";
+#if defined(HAVE_CURL_CURL_H) && HAVE_CURL_CURL_H
+  curl_global_cleanup();
+#endif
+}
 
-  case TEST_MEMORY_ALLOCATION_FAILURE:
-    return "memory allocation";
+#include <getopt.h>
+#include <unistd.h>
 
-  case TEST_SKIPPED:
-    return "skipped";
+int main(int argc, char *argv[])
+{
+#if defined(HAVE_CURL_CURL_H) && HAVE_CURL_CURL_H
+  if (curl_global_init(CURL_GLOBAL_ALL))
+  {
+    Error << "curl_global_init(CURL_GLOBAL_ALL) failed";
+    return EXIT_FAILURE;
+  }
+#endif
 
-  case TEST_FATAL:
-    break;
+  if (atexit(cleanup_curl))
+  {
+    Error << "atexit() failed";
+    return EXIT_FAILURE;
   }
 
-  return "failed";
-}
+  bool opt_repeat= false;
+  std::string collection_to_run;
 
-void create_core(void)
-{
-  if (getenv("LIBMEMCACHED_NO_COREDUMP") == NULL)
+  // Options parsing
   {
-    pid_t pid= fork();
+    enum long_option_t {
+      OPT_LIBYATL_VERSION,
+      OPT_LIBYATL_MATCH_COLLECTION,
+      OPT_LIBYATL_REPEAT
+    };
 
-    if (pid == 0)
+    static struct option long_options[]=
     {
-      abort();
-    }
-    else
+      {"repeat", no_argument, NULL, OPT_LIBYATL_REPEAT},
+      {"collection", required_argument, NULL, OPT_LIBYATL_MATCH_COLLECTION},
+      {0, 0, 0, 0}
+    };
+
+    int option_index= 0;
+    while (1)
     {
-      while (waitpid(pid, NULL, 0) != pid) {};
-    }
-  }
-}
+      int option_rv= getopt_long(argc, argv, "", long_options, &option_index);
+      if (option_rv == -1)
+      {
+        break;
+      }
 
-static Framework *world= NULL;
-int main(int argc, char *argv[])
-{
-  srandom((unsigned int)time(NULL));
+      switch (option_rv)
+      {
+      case OPT_LIBYATL_VERSION:
+        break;
 
-  world= new Framework();
+      case OPT_LIBYATL_REPEAT:
+        opt_repeat= true;
+        break;
 
-  if (not world)
-  {
-    return EXIT_FAILURE;
-  }
+      case OPT_LIBYATL_MATCH_COLLECTION:
+        collection_to_run= optarg;
+        break;
 
-  setup_signals();
+      case '?':
+        /* getopt_long already printed an error message. */
+        Error << "unknown option to getopt_long()";
+        exit(EXIT_FAILURE);
 
-  Stats stats;
+      default:
+        break;
+      }
+    }
+  }
 
-  get_world(world);
+  srandom((unsigned int)time(NULL));
 
-  test_return_t error;
-  void *creators_ptr= world->create(error);
-  if (test_failed(error))
+  if (getenv("LIBTEST_QUIET") and strcmp(getenv("LIBTEST_QUIET"), "0") == 0)
   {
-    Error << "create() failed";
-    delete world;
-    return EXIT_FAILURE;
+    close(STDOUT_FILENO);
+  }
+  else if (getenv("JENKINS_URL"))
+  {
+    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)
   {
-    Log << "Only testing " <<  collection_to_run;
+    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 (not is_shutdown()); 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= new Framework();
 
-    stats.collection_total++;
+      if (world == NULL)
+      {
+        Error << "Failed to create Framework()";
+        return EXIT_FAILURE;
+      }
 
-    collection_rc= world->startup(creators_ptr);
+      assert(sigignore(SIGPIPE) == 0);
 
-    if (collection_rc == TEST_SUCCESS and next->pre)
-    {
-      collection_rc= world->runner()->pre(next->pre, creators_ptr);
-    }
+      libtest::SignalThread signal;
+      if (not signal.setup())
+      {
+        Error << "Failed to setup signals";
+        return EXIT_FAILURE;
+      }
 
-    switch (collection_rc)
-    {
-    case TEST_SUCCESS:
-      break;
-
-    case TEST_FATAL:
-    case TEST_FAILURE:
-      Error << next->name << " [ failed ]";
-      failed= true;
-      set_shutdown(SHUTDOWN_GRACEFUL);
-      goto cleanup;
-
-    case TEST_SKIPPED:
-      Log << next->name << " [ skipping ]";
-      skipped= true;
-      goto cleanup;
-
-    case TEST_MEMORY_ALLOCATION_FAILURE:
-      test_assert(0, "Allocation failure, or unknown return");
-    }
+      Stats stats;
 
-    Log << "Collection: " << next->name;
+      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;
+
+      case TEST_SKIPPED:
+        Out << "SKIP " << argv[0];
+        delete world;
+        return EXIT_SUCCESS;
+
+      case TEST_FATAL:
+      case TEST_FAILURE:
+      case TEST_MEMORY_ALLOCATION_FAILURE:
+        delete world;
+        return EXIT_FAILURE;
       }
 
-      test_return_t return_code;
-      if (test_success(return_code= world->item.startup(creators_ptr)))
+      if (getenv("TEST_COLLECTION"))
       {
-        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);
-              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 if (return_code == TEST_SKIPPED)
-        { }
-        else if (return_code == TEST_FAILURE)
+        if (strlen(getenv("TEST_COLLECTION")))
         {
-          Error << " item.flush(failure)";
-          set_shutdown(SHUTDOWN_GRACEFUL);
+          collection_to_run= getenv("TEST_COLLECTION");
         }
       }
-      else if (return_code == TEST_SKIPPED)
-      { }
-      else if (return_code == TEST_FAILURE)
+
+      if (collection_to_run.empty() == false)
       {
-        Error << " item.startup(failure)";
-        set_shutdown(SHUTDOWN_GRACEFUL);
+        Out << "Only testing " <<  collection_to_run;
       }
 
-      stats.total++;
+      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:
-        Log << "\tTesting " << run->name <<  "\t\t\t\t\t" << load_time / 1000 << "." << load_time % 1000 << "[ " << test_strerror(return_code) << " ]";
-        stats.success++;
-        break;
+        bool failed= false;
+        bool skipped= false;
 
-      case TEST_FATAL:
-      case TEST_FAILURE:
-        stats.failed++;
-        failed= true;
-        Log << "\tTesting " << run->name <<  "\t\t\t\t\t" << "[ " << test_strerror(return_code) << " ]";
-        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;
-        Log << "\tTesting " << run->name <<  "\t\t\t\t\t" << "[ " << test_strerror(return_code) << " ]";
-        break;
+        stats.collection_total++;
 
-      case TEST_MEMORY_ALLOCATION_FAILURE:
-        test_assert(0, "Memory Allocation Error");
-      }
+        test_return_t collection_rc= world->startup(creators_ptr);
 
-      if (test_failed(world->on_error(return_code, creators_ptr)))
-      {
-        Error << "Failed while running on_error()";
-        set_shutdown(SHUTDOWN_GRACEFUL);
-        break;
-      }
-    }
+        if (collection_rc == TEST_SUCCESS and next->pre)
+        {
+          collection_rc= world->runner()->pre(next->pre, creators_ptr);
+        }
+
+        switch (collection_rc)
+        {
+        case TEST_SUCCESS:
+          break;
+
+        case TEST_FATAL:
+        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;
+
+        case TEST_MEMORY_ALLOCATION_FAILURE:
+          test_assert(0, "Allocation failure, or unknown return");
+        }
+
+        Out << "Collection: " << next->name;
 
-    (void) world->runner()->post(next->post, creators_ptr);
+        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 (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_FATAL:
+          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;
+
+          case TEST_MEMORY_ALLOCATION_FAILURE:
+            test_assert(0, "Memory Allocation Error");
+          }
+
+          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);
 
 cleanup:
-    if (failed == false and skipped == false)
-    {
-      stats.collection_success++;
-    }
+        if (failed == false and skipped == false)
+        {
+          stats.collection_success++;
+        }
 
-    if (failed)
-    {
-      stats.collection_failed++;
-    }
+        if (failed)
+        {
+          stats.collection_failed++;
+        }
 
-    if (skipped)
-    {
-      stats.collection_skipped++;
-    }
+        if (skipped)
+        {
+          stats.collection_skipped++;
+        }
 
-    world->shutdown(creators_ptr);
-    Logn();
-  }
+        world->shutdown(creators_ptr);
+        Outn();
+      }
 
-  if (not is_shutdown())
-  {
-    set_shutdown(SHUTDOWN_GRACEFUL);
-  }
+      if (not signal.is_shutdown())
+      {
+        signal.set_shutdown(SHUTDOWN_GRACEFUL);
+      }
 
-  int exit_code= EXIT_SUCCESS;
-  shutdown_t status= get_shutdown();
-  if (status == SHUTDOWN_FORCED)
-  {
-    Log << "Tests were aborted.";
-    exit_code= EXIT_FAILURE;
-  }
-  else if (stats.collection_failed)
-  {
-    Log << "Some test failed.";
-    exit_code= EXIT_FAILURE;
+      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);
+
+      delete world;
+
+      Outn(); // Generate a blank to break up the messages if make check/test has been run
+    } while (exit_code == EXIT_SUCCESS and opt_repeat);
   }
-  else if (stats.collection_skipped)
+  catch (libtest::fatal& e)
   {
-    Log << "Some tests were skipped.";
+    std::cerr << e.what() << std::endl;
   }
-  else
+  catch (...)
   {
-    Log << "All tests completed successfully.";
+    std::cerr << "Unknown exception halted execution" << std::endl;
   }
 
-  stats_print(&stats);
-
-  delete world;
-
-  Logn(); // Generate a blank to break up the messages if make check/test has been run
-
   return exit_code;
 }