binutils-gdb/gdbsupport/selftest.cc
Simon Marchi ece5bc8ac3 gdb: allow specifying multiple filters when running selftests
I found myself wanting to run a few specific selftests while developing.
I thought it would be nice to be able to provide multiple test names
when running `maintenant selftests`.  The arguments to that command is
currently interpreted as a single filter (not split by spaces), it now
becomes a list a filters, split by spaces.  A test is executed when it
matches at least one filter.

Here's an example of the result in GDB:

    (gdb) maintenance selftest xml
    Running selftest xml_escape_text.
    Running selftest xml_escape_text_append.
    Ran 2 unit tests, 0 failed
    (gdb) maintenance selftest xml unord
    Running selftest unordered_remove.
    Running selftest xml_escape_text.
    Running selftest xml_escape_text_append.
    Ran 3 unit tests, 0 failed
    (gdb) maintenance selftest xml unord foobar
    Running selftest unordered_remove.
    Running selftest xml_escape_text.
    Running selftest xml_escape_text_append.
    Ran 3 unit tests, 0 failed

Since the selftest machinery is also shared with gdbserver, I also
adapted gdbserver.  It accepts a `--selftest` switch, which accepts an
optional filter argument.  I made it so you can now pass `--selftest`
multiple time to add filters.

It's not so useful right now though: there's only a single selftest
right now in GDB and it's for an architecture I can't compile.  So I
tested by adding dummy tests, here's an example of the result:

    $ ./gdbserver --selftest=foo
    Running selftest foo.
    foo
    Running selftest foobar.
    foobar
    Ran 2 unit tests, 0 failed
    $ ./gdbserver --selftest=foo --selftest=bar
    Running selftest bar.
    bar
    Running selftest foo.
    foo
    Running selftest foobar.
    foobar
    Ran 3 unit tests, 0 failed

gdbsupport/ChangeLog:

	* selftest.h (run_tests): Change parameter to array_view.
	* selftest.c (run_tests): Change parameter to array_view and use
	it.

gdb/ChangeLog:

	* maint.c (maintenance_selftest): Split args and pass array_view
	to run_tests.

gdbserver/ChangeLog:

	* server.cc (captured_main): Accept multiple `--selftest=`
	options.  Pass all `--selftest=` arguments to run_tests.

Change-Id: I422bd49f08ea8095ae174c5d66a2dd502a59613a
2020-08-13 07:55:48 -04:00

123 lines
2.7 KiB
C++

/* GDB self-testing.
Copyright (C) 2016-2020 Free Software Foundation, Inc.
This file is part of GDB.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program 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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>. */
#include "common-defs.h"
#include "common-exceptions.h"
#include "common-debug.h"
#include "selftest.h"
#include <map>
namespace selftests
{
/* All the tests that have been registered. Using an std::map allows keeping
the order of tests stable and easily looking up whether a test name
exists. */
static std::map<std::string, std::unique_ptr<selftest>> tests;
/* A selftest that calls the test function without arguments. */
struct simple_selftest : public selftest
{
simple_selftest (self_test_function *function_)
: function (function_)
{}
void operator() () const override
{
function ();
}
self_test_function *function;
};
/* See selftest.h. */
void
register_test (const std::string &name, selftest *test)
{
/* Check that no test with this name already exist. */
gdb_assert (tests.find (name) == tests.end ());
tests[name] = std::unique_ptr<selftest> (test);
}
/* See selftest.h. */
void
register_test (const std::string &name, self_test_function *function)
{
register_test (name, new simple_selftest (function));
}
/* See selftest.h. */
void
run_tests (gdb::array_view<const char *const> filters)
{
int ran = 0, failed = 0;
for (const auto &pair : tests)
{
const std::string &name = pair.first;
const std::unique_ptr<selftest> &test = pair.second;
bool run = false;
if (filters.empty ())
run = true;
else
{
for (const char *filter : filters)
{
if (name.find (filter) != std::string::npos)
run = true;
}
}
if (!run)
continue;
try
{
debug_printf (_("Running selftest %s.\n"), name.c_str ());
++ran;
(*test) ();
}
catch (const gdb_exception_error &ex)
{
++failed;
debug_printf ("Self test failed: %s\n", ex.what ());
}
reset ();
}
debug_printf (_("Ran %d unit tests, %d failed\n"),
ran, failed);
}
/* See selftest.h. */
void for_each_selftest (for_each_selftest_ftype func)
{
for (const auto &pair : tests)
func (pair.first);
}
} // namespace selftests