git.m6w6.name Git - m6w6/libmemcached/blob - libtest/main.cc

   1 /*  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
   2  *
   3  *  Data Differential YATL (i.e. libtest)  library
   4  *
   5  *  Copyright (C) 2012 Data Differential, http://datadifferential.com/
   6  *
   7  *  Redistribution and use in source and binary forms, with or without
   8  *  modification, are permitted provided that the following conditions are
   9  *  met:
  10  *
  11  *      * Redistributions of source code must retain the above copyright
  12  *  notice, this list of conditions and the following disclaimer.
  13  *
  14  *      * Redistributions in binary form must reproduce the above
  15  *  copyright notice, this list of conditions and the following disclaimer
  16  *  in the documentation and/or other materials provided with the
  17  *  distribution.
  18  *
  19  *      * The names of its contributors may not be used to endorse or
  20  *  promote products derived from this software without specific prior
  21  *  written permission.
  22  *
  23  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  24  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  25  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  26  *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  27  *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  28  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  29  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  30  *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  31  *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  32  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  33  *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  34  *
  35  */
  36
  37 #include "libtest/yatlcon.h"
  38 #include <libtest/common.h>
  39
  40 #include <cassert>
  41 #include <cstdlib>
  42 #include <cstring>
  43 #include <ctime>
  44 #include <fnmatch.h>
  45 #include <iostream>
  46 #include <fstream>
  47 #include <memory>
  48 #include <sys/stat.h>
  49 #include <sys/time.h>
  50 #include <sys/types.h>
  51 #include <sys/wait.h>
  52 #include <unistd.h>
  53
  54 #include <signal.h>
  55
  56 #ifndef __INTEL_COMPILER
  57 #pragma GCC diagnostic ignored "-Wold-style-cast"
  58 #endif
  59
  60 using namespace libtest;
  61
  62 static void stats_print(libtest::Framework *frame)
  63 {
  64   if (frame->failed() == 0 and frame->success() == 0)
  65   {
  66     return;
  67   }
  68
  69   Outn();
  70   Out << "Collections\t\t\t\t\t" << frame->total();
  71   Out << "\tFailed\t\t\t\t\t" << frame->failed();
  72   Out << "\tSkipped\t\t\t\t\t" << frame->skipped();
  73   Out << "\tSucceeded\t\t\t\t" << frame->success();
  74   Outn();
  75   Out << "Tests\t\t\t\t\t" << frame->sum_total();
  76   Out << "\tFailed\t\t\t\t" << frame->sum_failed();
  77   Out << "\tSkipped\t\t\t\t" << frame->sum_skipped();
  78   Out << "\tSucceeded\t\t\t" << frame->sum_success();
  79 }
  80
  81 #include <getopt.h>
  82 #include <unistd.h>
  83
  84 int main(int argc, char *argv[])
  85 {
  86   bool opt_massive= false;
  87   unsigned long int opt_repeat= 1; // Run all tests once
  88   bool opt_quiet= false;
  89   std::string collection_to_run;
  90   std::string wildcard;
  91   std::string binary_name;
  92
  93   const char *just_filename= rindex(argv[0], '/');
  94   if (just_filename)
  95   {
  96     just_filename++;
  97   }
  98   else
  99   {
 100     just_filename= argv[0];
 101   }
 102
 103   if (just_filename[0] == 'l' and just_filename[1] == 't' and  just_filename[2] == '-')
 104   {
 105     just_filename+= 3;
 106   }
 107   binary_name.append(just_filename);
 108
 109   /*
 110     Valgrind does not currently work reliably, or sometimes at all, on OSX
 111     - Fri Jun 15 11:24:07 EDT 2012
 112   */
 113 #if defined(__APPLE__) && __APPLE__
 114   if (valgrind_is_caller())
 115   {
 116     return EXIT_SKIP;
 117   }
 118 #endif
 119
 120   // Options parsing
 121   {
 122     enum long_option_t {
 123       OPT_LIBYATL_VERSION,
 124       OPT_LIBYATL_MATCH_COLLECTION,
 125       OPT_LIBYATL_MASSIVE,
 126       OPT_LIBYATL_QUIET,
 127       OPT_LIBYATL_MATCH_WILDCARD,
 128       OPT_LIBYATL_REPEAT
 129     };
 130
 131     static struct option long_options[]=
 132     {
 133       { "version", no_argument, NULL, OPT_LIBYATL_VERSION },
 134       { "quiet", no_argument, NULL, OPT_LIBYATL_QUIET },
 135       { "repeat", required_argument, NULL, OPT_LIBYATL_REPEAT },
 136       { "collection", required_argument, NULL, OPT_LIBYATL_MATCH_COLLECTION },
 137       { "wildcard", required_argument, NULL, OPT_LIBYATL_MATCH_WILDCARD },
 138       { "massive", no_argument, NULL, OPT_LIBYATL_MASSIVE },
 139       { 0, 0, 0, 0 }
 140     };
 141
 142     int option_index= 0;
 143     while (1)
 144     {
 145       int option_rv= getopt_long(argc, argv, "", long_options, &option_index);
 146       if (option_rv == -1)
 147       {
 148         break;
 149       }
 150
 151       switch (option_rv)
 152       {
 153       case OPT_LIBYATL_VERSION:
 154         break;
 155
 156       case OPT_LIBYATL_QUIET:
 157         opt_quiet= true;
 158         break;
 159
 160       case OPT_LIBYATL_REPEAT:
 161         errno= 0;
 162         opt_repeat= strtoul(optarg, (char **) NULL, 10);
 163         if (errno != 0)
 164         {
 165           Error << "unknown value passed to --repeat: `" << optarg << "`";
 166           exit(EXIT_FAILURE);
 167         }
 168         break;
 169
 170       case OPT_LIBYATL_MATCH_COLLECTION:
 171         collection_to_run= optarg;
 172         break;
 173
 174       case OPT_LIBYATL_MATCH_WILDCARD:
 175         wildcard= optarg;
 176         break;
 177
 178       case OPT_LIBYATL_MASSIVE:
 179         opt_massive= true;
 180         break;
 181
 182       case '?':
 183         /* getopt_long already printed an error message. */
 184         Error << "unknown option to getopt_long()";
 185         exit(EXIT_FAILURE);
 186
 187       default:
 188         break;
 189       }
 190     }
 191   }
 192
 193   srandom((unsigned int)time(NULL));
 194
 195   errno= 0;
 196   if (bool(getenv("YATL_REPEAT")))
 197   {
 198     errno= 0;
 199     opt_repeat= strtoul(getenv("YATL_REPEAT"), (char **) NULL, 10);
 200     if (errno != 0)
 201     {
 202       Error << "ENV YATL_REPEAT passed an invalid value: `" << getenv("YATL_REPEAT") << "`";
 203       exit(EXIT_FAILURE);
 204     }
 205   }
 206
 207   if ((bool(getenv("YATL_QUIET")) and (strcmp(getenv("YATL_QUIET"), "0") == 0)) or opt_quiet)
 208   {
 209     opt_quiet= true;
 210   }
 211   else if (getenv("JENKINS_URL"))
 212   {
 213     if (bool(getenv("YATL_QUIET")) and (strcmp(getenv("YATL_QUIET"), "1") == 0))
 214     { }
 215     else
 216     {
 217       opt_quiet= true;
 218     }
 219   }
 220
 221   if ((bool(getenv("YATL_RUN_MASSIVE_TESTS"))) or opt_massive)
 222   {
 223     opt_massive= true;
 224   }
 225
 226   if (opt_quiet)
 227   {
 228     close(STDOUT_FILENO);
 229   }
 230
 231   if (opt_massive)
 232   {
 233     is_massive(opt_massive);
 234   }
 235
 236   libtest::vchar_t tmp_directory;
 237   tmp_directory.resize(1024);
 238   if (getenv("LIBTEST_TMP"))
 239   {
 240     snprintf(&tmp_directory[0], tmp_directory.size(), "%s", getenv("LIBTEST_TMP"));
 241   }
 242   else
 243   {
 244     snprintf(&tmp_directory[0], tmp_directory.size(), "%s", LIBTEST_TEMP);
 245   }
 246
 247   if (chdir(&tmp_directory[0]) == -1)
 248   {
 249     libtest::vchar_t getcwd_buffer;
 250     getcwd_buffer.resize(1024);
 251     char *dir= getcwd(&getcwd_buffer[0], getcwd_buffer.size());
 252
 253     Error << "Unable to chdir() from " << dir << " to " << &tmp_directory[0] << " errno:" << strerror(errno);
 254     return EXIT_FAILURE;
 255   }
 256
 257   if (libtest::libtool() == NULL)
 258   {
 259     Error << "Failed to locate libtool";
 260     return EXIT_FAILURE;
 261   }
 262
 263   if (getenv("YATL_COLLECTION_TO_RUN"))
 264   {
 265     if (strlen(getenv("YATL_COLLECTION_TO_RUN")))
 266     {
 267       collection_to_run= getenv("YATL_COLLECTION_TO_RUN");
 268     }
 269   }
 270
 271   if (collection_to_run.compare("none") == 0)
 272   {
 273     return EXIT_SUCCESS;
 274   }
 275
 276   if (collection_to_run.empty() == false)
 277   {
 278     Out << "Only testing " <<  collection_to_run;
 279   }
 280
 281   int exit_code;
 282
 283   try
 284   {
 285     do
 286     {
 287       exit_code= EXIT_SUCCESS;
 288       fatal_assert(sigignore(SIGPIPE) == 0);
 289
 290       libtest::SignalThread signal;
 291       if (signal.setup() == false)
 292       {
 293         Error << "Failed to setup signals";
 294         return EXIT_FAILURE;
 295       }
 296
 297       std::auto_ptr<libtest::Framework> frame(new libtest::Framework(signal, binary_name, collection_to_run, wildcard));
 298
 299       // Run create(), bail on error.
 300       {
 301         switch (frame->create())
 302         {
 303         case TEST_SUCCESS:
 304           break;
 305
 306         case TEST_SKIPPED:
 307           SKIP("SKIP was returned from framework create()");
 308           break;
 309
 310         case TEST_FAILURE:
 311           std::cerr << "Could not call frame->create()" << std::endl;
 312           return EXIT_FAILURE;
 313         }
 314       }
 315
 316       frame->exec();
 317
 318       if (signal.is_shutdown() == false)
 319       {
 320         signal.set_shutdown(SHUTDOWN_GRACEFUL);
 321       }
 322
 323       shutdown_t status= signal.get_shutdown();
 324       if (status == SHUTDOWN_FORCED)
 325       {
 326         Out << "Tests were aborted.";
 327         exit_code= EXIT_FAILURE;
 328       }
 329       else if (frame->failed())
 330       {
 331         Out << "Some test failed.";
 332         exit_code= EXIT_FAILURE;
 333       }
 334       else if (frame->skipped() and frame->failed() and frame->success())
 335       {
 336         Out << "Some tests were skipped.";
 337       }
 338       else if (frame->success() and (frame->failed() == 0))
 339       {
 340         Out;
 341         Out << "All tests completed successfully.";
 342       }
 343
 344       stats_print(frame.get());
 345
 346       std::ofstream xml_file;
 347       std::string file_name;
 348       file_name.append(&tmp_directory[0]);
 349       file_name.append(frame->name());
 350       file_name.append(".xml");
 351       xml_file.open(file_name.c_str(), std::ios::trunc);
 352       libtest::Formatter::xml(*frame, xml_file);
 353
 354       Outn(); // Generate a blank to break up the messages if make check/test has been run
 355     } while (exit_code == EXIT_SUCCESS and --opt_repeat);
 356   }
 357   catch (const libtest::__skipped& e)
 358   {
 359     return EXIT_SKIP;
 360   }
 361   catch (const libtest::__failure& e)
 362   {
 363     libtest::stream::make_cout(e.file(), e.line(), e.func()) << e.what();
 364     exit_code= EXIT_FAILURE;
 365   }
 366   catch (const libtest::fatal& e)
 367   {
 368     std::cerr << "FATAL:" << e.what() << std::endl;
 369     exit_code= EXIT_FAILURE;
 370   }
 371   catch (const libtest::disconnected& e)
 372   {
 373     std::cerr << "Unhandled disconnection occurred:" << e.what() << std::endl;
 374     exit_code= EXIT_FAILURE;
 375   }
 376   catch (const std::exception& e)
 377   {
 378     std::cerr << "std::exception:" << e.what() << std::endl;
 379     exit_code= EXIT_FAILURE;
 380   }
 381   catch (char const* s)
 382   {
 383     std::cerr << "Exception:" << s << std::endl;
 384     exit_code= EXIT_FAILURE;
 385   }
 386   catch (...)
 387   {
 388     std::cerr << "Unknown exception halted execution." << std::endl;
 389     exit_code= EXIT_FAILURE;
 390   }
 391
 392   return exit_code;
 393 }