cppcheck/test/fixture.cpp

444 lines
15 KiB
C++
Raw Normal View History

2008-12-18 22:28:57 +01:00
/*
* Cppcheck - A tool for static C/C++ code analysis
2023-01-28 10:16:34 +01:00
* Copyright (C) 2007-2023 Cppcheck team.
2008-12-18 22:28:57 +01:00
*
* 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/>.
2008-12-18 22:28:57 +01:00
*/
#include "fixture.h"
2017-05-27 04:33:47 +02:00
#include "errortypes.h"
#include "options.h"
#include "redirect.h"
2008-12-18 22:28:57 +01:00
#include <cstdio>
#include <cctype>
#include <exception>
2008-12-18 22:28:57 +01:00
#include <iostream>
#include <set>
#include <sstream>
2017-05-27 04:33:47 +02:00
#include <string>
2008-12-18 22:28:57 +01:00
#include <tinyxml2.h>
2008-12-18 22:28:57 +01:00
std::ostringstream errout;
std::ostringstream output;
2008-12-18 22:28:57 +01:00
/**
* TestRegistry
**/
2021-02-27 04:33:16 +01:00
namespace {
struct CompareFixtures {
bool operator()(const TestFixture* lhs, const TestFixture* rhs) const {
return lhs->classname < rhs->classname;
}
};
2021-02-27 04:33:16 +01:00
}
using TestSet = std::set<TestFixture*, CompareFixtures>;
class TestRegistry {
TestSet _tests;
2008-12-18 22:28:57 +01:00
public:
2014-11-20 14:20:09 +01:00
static TestRegistry &theInstance() {
2008-12-18 22:28:57 +01:00
static TestRegistry testreg;
return testreg;
}
2014-11-20 14:20:09 +01:00
void addTest(TestFixture *t) {
_tests.insert(t);
2008-12-18 22:28:57 +01:00
}
const TestSet &tests() const {
2008-12-18 22:28:57 +01:00
return _tests;
}
};
/**
* TestFixture
**/
std::ostringstream TestFixture::errmsg;
2021-08-07 20:51:18 +02:00
unsigned int TestFixture::countTests;
2008-12-18 22:28:57 +01:00
std::size_t TestFixture::fails_counter = 0;
std::size_t TestFixture::todos_counter = 0;
std::size_t TestFixture::succeeded_todos_counter = 0;
TestFixture::TestFixture(const char * const _name)
: classname(_name)
2008-12-18 22:28:57 +01:00
{
TestRegistry::theInstance().addTest(this);
}
bool TestFixture::prepareTest(const char testname[])
{
mVerbose = false;
mTemplateFormat.clear();
mTemplateLocation.clear();
prepareTestInternal();
// Check if tests should be executed
2011-10-13 20:53:06 +02:00
if (testToRun.empty() || testToRun == testname) {
// Tests will be executed - prepare them
mTestname = testname;
2009-01-01 23:22:28 +01:00
++countTests;
2011-10-13 20:53:06 +02:00
if (quiet_tests) {
std::putchar('.'); // Use putchar to write through redirection of std::cout/cerr
std::fflush(stdout);
2011-10-13 20:53:06 +02:00
} else {
std::cout << classname << "::" << mTestname << std::endl;
}
return true;
2008-12-18 22:28:57 +01:00
}
return false;
2008-12-18 22:28:57 +01:00
}
std::string TestFixture::getLocationStr(const char * const filename, const unsigned int linenr) const
{
2021-02-27 04:33:16 +01:00
return std::string(filename) + ':' + std::to_string(linenr) + '(' + classname + "::" + mTestname + ')';
}
static std::string writestr(const std::string &str, bool gccStyle = false)
2008-12-18 22:28:57 +01:00
{
std::ostringstream ostr;
if (gccStyle)
ostr << '\"';
for (std::string::const_iterator i = str.cbegin(); i != str.cend(); ++i) {
if (*i == '\n') {
2008-12-18 22:28:57 +01:00
ostr << "\\n";
if ((i+1) != str.end() && !gccStyle)
ostr << std::endl;
} else if (*i == '\t')
2008-12-18 22:28:57 +01:00
ostr << "\\t";
else if (*i == '\"')
2008-12-18 22:28:57 +01:00
ostr << "\\\"";
else if (std::isprint(static_cast<unsigned char>(*i)))
ostr << *i;
else
ostr << "\\x" << std::hex << short{*i};
2008-12-18 22:28:57 +01:00
}
if (!str.empty() && !gccStyle)
ostr << std::endl;
else if (gccStyle)
ostr << '\"';
2008-12-18 22:28:57 +01:00
return ostr.str();
}
bool TestFixture::assert_(const char * const filename, const unsigned int linenr, const bool condition) const
{
2011-10-13 20:53:06 +02:00
if (!condition) {
++fails_counter;
errmsg << getLocationStr(filename, linenr) << ": Assertion failed." << std::endl << "_____" << std::endl;
}
return condition;
}
2021-02-23 08:19:05 +01:00
void TestFixture::assertEqualsFailed(const char* const filename, const unsigned int linenr, const std::string& expected, const std::string& actual, const std::string& msg) const
{
++fails_counter;
errmsg << getLocationStr(filename, linenr) << ": Assertion failed. " << std::endl
2021-02-24 21:47:16 +01:00
<< "Expected: " << std::endl
<< writestr(expected) << std::endl
<< "Actual: " << std::endl
<< writestr(actual) << std::endl;
2021-02-23 08:19:05 +01:00
if (!msg.empty())
errmsg << "Hint:" << std::endl << msg << std::endl;
errmsg << "_____" << std::endl;
}
bool TestFixture::assertEquals(const char * const filename, const unsigned int linenr, const std::string &expected, const std::string &actual, const std::string &msg) const
2008-12-18 22:28:57 +01:00
{
2011-10-13 20:53:06 +02:00
if (expected != actual) {
2021-02-23 08:19:05 +01:00
assertEqualsFailed(filename, linenr, expected, actual, msg);
2008-12-18 22:28:57 +01:00
}
return expected == actual;
2008-12-18 22:28:57 +01:00
}
std::string TestFixture::deleteLineNumber(const std::string &message)
{
std::string result(message);
// delete line number in "...:NUMBER:..."
std::string::size_type pos = 0;
while ((pos = result.find(':', pos)) != std::string::npos) {
// get number
if (pos + 1 == result.find_first_of("0123456789", pos + 1)) {
const std::string::size_type after = result.find_first_not_of("0123456789", pos + 1);
if (after != std::string::npos
2017-10-05 23:01:42 +02:00
&& result.at(after) == ':') {
// erase NUMBER
result.erase(pos + 1, after - pos - 1);
pos = after;
} else {
++pos;
}
} else {
++pos;
}
}
return result;
}
void TestFixture::assertEqualsWithoutLineNumbers(const char * const filename, const unsigned int linenr, const std::string &expected, const std::string &actual, const std::string &msg) const
{
2017-10-10 23:43:50 +02:00
assertEquals(filename, linenr, deleteLineNumber(expected), deleteLineNumber(actual), msg);
}
bool TestFixture::assertEquals(const char * const filename, const unsigned int linenr, const char expected[], const std::string& actual, const std::string &msg) const
{
return assertEquals(filename, linenr, std::string(expected), actual, msg);
}
bool TestFixture::assertEquals(const char * const filename, const unsigned int linenr, const char expected[], const char actual[], const std::string &msg) const
{
return assertEquals(filename, linenr, std::string(expected), std::string(actual), msg);
}
bool TestFixture::assertEquals(const char * const filename, const unsigned int linenr, const std::string& expected, const char actual[], const std::string &msg) const
{
return assertEquals(filename, linenr, expected, std::string(actual), msg);
}
bool TestFixture::assertEquals(const char * const filename, const unsigned int linenr, const long long expected, const long long actual, const std::string &msg) const
{
2017-03-08 15:16:19 +01:00
if (expected != actual) {
assertEquals(filename, linenr, std::to_string(expected), std::to_string(actual), msg);
2017-03-08 15:16:19 +01:00
}
return expected == actual;
}
void TestFixture::assertEqualsDouble(const char * const filename, const unsigned int linenr, const double expected, const double actual, const double tolerance, const std::string &msg) const
2008-12-18 22:28:57 +01:00
{
if (expected < (actual - tolerance) || expected > (actual + tolerance)) {
2017-03-08 15:16:19 +01:00
std::ostringstream ostr1;
ostr1 << expected;
std::ostringstream ostr2;
ostr2 << actual;
assertEquals(filename, linenr, ostr1.str(), ostr2.str(), msg);
}
2008-12-18 22:28:57 +01:00
}
void TestFixture::todoAssertEquals(const char * const filename, const unsigned int linenr,
const std::string &wanted,
const std::string &current,
const std::string &actual) const
{
2011-10-13 20:53:06 +02:00
if (wanted == actual) {
errmsg << getLocationStr(filename, linenr) << ": Assertion succeeded unexpectedly. "
<< "Result: " << writestr(wanted, true) << std::endl << "_____" << std::endl;
++succeeded_todos_counter;
2011-10-13 20:53:06 +02:00
} else {
assertEquals(filename, linenr, current, actual);
++todos_counter;
}
}
void TestFixture::todoAssertEquals(const char* const filename, const unsigned int linenr,
const char wanted[],
const char current[],
const std::string& actual) const
{
todoAssertEquals(filename, linenr, std::string(wanted), std::string(current), actual);
}
void TestFixture::todoAssertEquals(const char * const filename, const unsigned int linenr, const long long wanted, const long long current, const long long actual) const
{
todoAssertEquals(filename, linenr, std::to_string(wanted), std::to_string(current), std::to_string(actual));
}
void TestFixture::assertThrow(const char * const filename, const unsigned int linenr) const
{
++fails_counter;
errmsg << getLocationStr(filename, linenr) << ": Assertion succeeded. "
<< "The expected exception was thrown" << std::endl << "_____" << std::endl;
}
void TestFixture::assertThrowFail(const char * const filename, const unsigned int linenr) const
{
++fails_counter;
errmsg << getLocationStr(filename, linenr) << ": Assertion failed. "
<< "The expected exception was not thrown" << std::endl << "_____" << std::endl;
}
void TestFixture::assertNoThrowFail(const char * const filename, const unsigned int linenr) const
{
++fails_counter;
errmsg << getLocationStr(filename, linenr) << ": Assertion failed. "
<< "Unexpected exception was thrown" << std::endl << "_____" << std::endl;
}
void TestFixture::printHelp()
{
std::cout << "Testrunner - run Cppcheck tests\n"
2021-08-07 20:51:18 +02:00
"\n"
"Syntax:\n"
" testrunner [OPTIONS] [TestClass::TestCase...]\n"
" run all test cases:\n"
" testrunner\n"
" run all test cases in TestClass:\n"
" testrunner TestClass\n"
" run TestClass::TestCase:\n"
" testrunner TestClass::TestCase\n"
" run all test cases in TestClass1 and TestClass2::TestCase:\n"
" testrunner TestClass1 TestClass2::TestCase\n"
"\n"
"Options:\n"
" -q Do not print the test cases that have run.\n"
" -h, --help Print this help.\n";
}
void TestFixture::run(const std::string &str)
{
testToRun = str;
try {
if (quiet_tests) {
std::cout << '\n' << classname << ':';
SUPPRESS;
run();
}
else
run();
}
catch (const InternalError& e) {
++fails_counter;
errmsg << classname << "::" << mTestname << " - InternalError: " << e.errorMessage << std::endl;
}
catch (const std::exception& error) {
++fails_counter;
errmsg << classname << "::" << mTestname << " - Exception: " << error.what() << std::endl;
}
catch (...) {
++fails_counter;
errmsg << classname << "::" << mTestname << " - Unknown exception" << std::endl;
}
}
2008-12-18 22:28:57 +01:00
void TestFixture::processOptions(const options& args)
{
quiet_tests = args.quiet();
2021-07-08 21:21:35 +02:00
exename = args.exe();
}
std::size_t TestFixture::runTests(const options& args)
2008-12-18 22:28:57 +01:00
{
countTests = 0;
errmsg.str("");
2019-04-30 21:01:18 +02:00
for (std::string classname : args.which_test()) {
std::string testname;
if (classname.find("::") != std::string::npos) {
testname = classname.substr(classname.find("::") + 2);
classname.erase(classname.find("::"));
}
2008-12-18 22:28:57 +01:00
2019-04-30 21:01:18 +02:00
for (TestFixture * test : TestRegistry::theInstance().tests()) {
if (classname.empty() || test->classname == classname) {
test->processOptions(args);
test->run(testname);
}
2008-12-18 22:28:57 +01:00
}
}
std::cout << "\n\nTesting Complete\nNumber of tests: " << countTests << std::endl;
std::cout << "Number of todos: " << todos_counter;
if (succeeded_todos_counter > 0)
std::cout << " (" << succeeded_todos_counter << " succeeded)";
std::cout << std::endl;
// calling flush here, to do all output before the error messages (in case the output is buffered)
std::cout.flush();
2008-12-18 22:28:57 +01:00
std::cerr << "Tests failed: " << fails_counter << std::endl << std::endl;
2008-12-18 22:28:57 +01:00
std::cerr << errmsg.str();
std::cerr.flush();
return fails_counter + succeeded_todos_counter;
2008-12-18 22:28:57 +01:00
}
void TestFixture::reportOut(const std::string & outmsg, Color /*c*/)
2008-12-18 22:28:57 +01:00
{
output << outmsg << std::endl;
2008-12-18 22:28:57 +01:00
}
2009-02-01 19:00:47 +01:00
2020-05-23 07:16:49 +02:00
void TestFixture::reportErr(const ErrorMessage &msg)
2009-02-01 19:00:47 +01:00
{
if (msg.severity == Severity::none && msg.id == "logChecker")
return;
const std::string errormessage(msg.toString(mVerbose, mTemplateFormat, mTemplateLocation));
if (errout.str().find(errormessage) == std::string::npos)
errout << errormessage << std::endl;
2009-02-01 19:00:47 +01:00
}
void TestFixture::setTemplateFormat(const std::string &templateFormat)
{
if (templateFormat == "multiline") {
mTemplateFormat = "{file}:{line}:{severity}:{message}";
mTemplateLocation = "{file}:{line}:note:{info}";
}
else if (templateFormat == "simple") {
mTemplateFormat = "{file}:{line}:{column}: {severity}:{inconclusive:inconclusive:} {message} [{id}]";
mTemplateLocation = "";
}
else {
mTemplateFormat = templateFormat;
mTemplateLocation = "";
}
}
TestFixture::SettingsBuilder& TestFixture::SettingsBuilder::library(const char lib[]) {
if (REDUNDANT_CHECK && std::find(settings.libraries.cbegin(), settings.libraries.cend(), lib) != settings.libraries.cend())
throw std::runtime_error("redundant setting: libraries (" + std::string(lib) + ")");
// TODO: exename is not yet set
LOAD_LIB_2_EXE(settings.library, lib, fixture.exename.c_str());
// strip extension
std::string lib_s(lib);
const std::string ext(".cfg");
const auto pos = lib_s.find(ext);
if (pos != std::string::npos)
lib_s.erase(pos, ext.size());
settings.libraries.emplace_back(lib_s);
return *this;
}
TestFixture::SettingsBuilder& TestFixture::SettingsBuilder::platform(cppcheck::Platform::Type type)
{
const std::string platformStr = cppcheck::Platform::toString(type);
// TODO: the default platform differs between Windows and Linux
//if (REDUNDANT_CHECK && settings.platform.type == type)
// throw std::runtime_error("redundant setting: platform (" + platformStr + ")");
std::string errstr;
// TODO: exename is not yet set
if (!settings.platform.set(platformStr, errstr, {fixture.exename}))
throw std::runtime_error("platform '" + platformStr + "' not found");
return *this;
}
TestFixture::SettingsBuilder& TestFixture::SettingsBuilder::libraryxml(const char xmldata[], std::size_t len)
{
tinyxml2::XMLDocument doc;
if (tinyxml2::XML_SUCCESS != doc.Parse(xmldata, len))
throw std::runtime_error("loading XML data failed");
if (settings.library.load(doc).errorcode != Library::ErrorCode::OK)
throw std::runtime_error("loading library XML failed");
return *this;
}