gdbsupport/selftest.cc

   1 /* GDB self-testing.
   2    Copyright (C) 2016-2022 Free Software Foundation, Inc.
   3
   4    This file is part of GDB.
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  18
  19 #include "common-defs.h"
  20 #include "common-exceptions.h"
  21 #include "common-debug.h"
  22 #include "selftest.h"
  23 #include <map>
  24 #include <functional>
  25
  26 namespace selftests
  27 {
  28 /* All the tests that have been registered.  Using an std::map allows keeping
  29    the order of tests stable and easily looking up whether a test name
  30    exists.  */
  31
  32 static std::map<std::string, std::function<void(void)>> tests;
  33
  34 /* See selftest.h.  */
  35
  36 void
  37 register_test (const std::string &name,
  38                std::function<void(void)> function)
  39 {
  40   /* Check that no test with this name already exist.  */
  41   gdb_assert (tests.find (name) == tests.end ());
  42
  43   tests[name] = function;
  44 }
  45
  46 /* See selftest.h.  */
  47
  48 static bool run_verbose_ = false;
  49
  50 /* See selftest.h.  */
  51
  52 bool
  53 run_verbose ()
  54 {
  55   return run_verbose_;
  56 }
  57
  58 /* See selftest.h.  */
  59
  60 void
  61 run_tests (gdb::array_view<const char *const> filters, bool verbose)
  62 {
  63   int ran = 0, failed = 0;
  64   run_verbose_ = verbose;
  65
  66   for (const auto &pair : tests)
  67     {
  68       const std::string &name = pair.first;
  69       const auto &test = pair.second;
  70       bool run = false;
  71
  72       if (filters.empty ())
  73         run = true;
  74       else
  75         {
  76           for (const char *filter : filters)
  77             {
  78               if (name.find (filter) != std::string::npos)
  79                 run = true;
  80             }
  81         }
  82
  83       if (!run)
  84         continue;
  85
  86       try
  87         {
  88           debug_printf (_("Running selftest %s.\n"), name.c_str ());
  89           ++ran;
  90           test ();
  91         }
  92       catch (const gdb_exception_error &ex)
  93         {
  94           ++failed;
  95           debug_printf ("Self test failed: %s\n", ex.what ());
  96         }
  97
  98       reset ();
  99     }
 100
 101   debug_printf (_("Ran %d unit tests, %d failed\n"),
 102                 ran, failed);
 103 }
 104
 105 /* See selftest.h.  */
 106
 107 void for_each_selftest (for_each_selftest_ftype func)
 108 {
 109   for (const auto &pair : tests)
 110     func (pair.first);
 111 }
 112
 113 } // namespace selftests