/*
* Cppcheck - A tool for static C/C++ code analysis
* Copyright (C) 2007-2010 Daniel Marjamäki and Cppcheck team.
*
* 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/>.
*/
// The preprocessor that Cppcheck uses is a bit special. Instead of generating
// the code for a known configuration, it generates the code for each configuration.
#include "cppcheck.h"
#include "testsuite.h"
#include <algorithm>
#include <map>
#include <string>
#include <stdexcept>
// use tinyxml with STL
#include "tinyxml/tinyxml.h"
extern std::ostringstream errout;
extern std::ostringstream output;
class TestCppcheck : public TestFixture
{
public:
TestCppcheck() : TestFixture("TestCppcheck")
{ }
private:
void check(const std::string &data)
{
errout.str("");
output.str("");
CppCheck cppCheck(*this);
cppCheck.addFile("file.cpp", data);
cppCheck.check();
}
void run()
{
TEST_CASE(linenumbers);
// TEST_CASE(linenumbers2);
TEST_CASE(xml);
TEST_CASE(include);
TEST_CASE(templateFormat);
TEST_CASE(getErrorMessages);
TEST_CASE(parseOutputtingArgs);
TEST_CASE(parseOutputtingInvalidArgs);
TEST_CASE(parseArgsAndCheck);
TEST_CASE(parseArgsAndCheckSettings);
TEST_CASE(userdefines);
}
bool argCheck(int argc, const char *argv[])
{
errout.str("");
output.str("");
CppCheck cppCheck(*this);
return cppCheck.parseFromArgs(argc, argv);
}
bool argCheckWithCoutCerrRedirect(int argc, const char * argv[])
{
// redirect cout and cerr
std::stringstream out, err;
std::streambuf* oldCout, *oldCerr;
// flush all old output
std::cout.flush();
std::cerr.flush();
oldCout = std::cout.rdbuf(); // back up cout's streambuf
oldCerr = std::cerr.rdbuf(); // back up cerr's streambuf
std::cout.rdbuf(out.rdbuf()); // assign streambuf to cout
std::cerr.rdbuf(err.rdbuf()); // assign streambuf to cerr
bool result = argCheck(argc, argv);
std::cout.rdbuf(oldCout); // restore cout's original streambuf
std::cerr.rdbuf(oldCerr); // restore cerrs's original streambuf
errout << err.str();
output << out.str();
return result;
}
bool argCheckWithCheck(int argc, const char *argv[], const std::string &data)
{
errout.str("");
output.str("");
CppCheck cppCheck(*this);
cppCheck.addFile("file.cpp", data);
bool result = cppCheck.parseFromArgs(argc, argv);
if (result)
cppCheck.check();
return result;
}
bool argCheckReturnSettings(int argc, const char *argv[], Settings &settings)
{
errout.str("");
output.str("");
CppCheck cppCheck(*this);
cppCheck.addFile("file.cpp", "void foo(){}");
bool result = cppCheck.parseFromArgs(argc, argv);
if (result)
settings = cppCheck.settings();
return result;
}
void parseArgsAndCheckSettings()
{
{
const char *argv[] = {"cppcheck", "--template", "gcc"};
Settings settings;
ASSERT_EQUALS(true, argCheckReturnSettings(3, argv, settings));
ASSERT_EQUALS("{file}:{line}: {severity}: {message}", settings._outputFormat);
ASSERT_EQUALS("", errout.str());
ASSERT_EQUALS("", output.str());
}
{
const char *argv[] = {"cppcheck", "--template", "vs"};
Settings settings;
ASSERT_EQUALS(true, argCheckReturnSettings(3, argv, settings));
ASSERT_EQUALS("{file}({line}): {severity}: {message}", settings._outputFormat);
ASSERT_EQUALS("", errout.str());
ASSERT_EQUALS("", output.str());
}
{
const char *argv[] = {"cppcheck", "--template", "{file}<->{line}"};
Settings settings;
ASSERT_EQUALS(true, argCheckReturnSettings(3, argv, settings));
ASSERT_EQUALS("{file}<->{line}", settings._outputFormat);
ASSERT_EQUALS("", errout.str());
ASSERT_EQUALS("", output.str());
}
{
const char *argv[] = {"cppcheck", "--template"};
Settings settings;
ASSERT_EQUALS(false, argCheckReturnSettings(2, argv, settings));
ASSERT_EQUALS("", errout.str());
ASSERT_EQUALS("cppcheck: argument to '--template' is missing\n", output.str());
}
}
void parseArgsAndCheck()
{
{
const char *argv[] = {"cppcheck", "--showtime=top5"};
const char *data = "void foo(){}";
ASSERT_EQUALS(true, argCheckWithCheck(2, argv, data));
ASSERT_EQUALS("", errout.str());
// ASSERT_EQUALS(true, output.str().find("Overall time:") != std::string::npos);
}
}
void parseErrorList(const char* xmlData)
{
TiXmlDocument doc;
doc.Parse(xmlData);
// parsing must be successfull
ASSERT_EQUALS(false, doc.Error());
// root element must be "results"
TiXmlElement* root = doc.FirstChildElement();
ASSERT_EQUALS("results", root->Value());
TiXmlElement* error = root->FirstChildElement();
std::list<std::string> idList;
while (error)
{
// only childs of type "error"
ASSERT_EQUALS("error", error->Value());
// attributes id, msg, severity
ASSERT_EQUALS(error->Attribute("msg") == NULL, false);
ASSERT_EQUALS(error->Attribute("severity") == NULL, false);
const char* id = error->Attribute("id");
ASSERT_EQUALS(id == NULL, false);
// no duplicate ids
std::stringstream msg;
msg << "Duplicate id " << id;
ASSERT_EQUALS_MSG(idList.end() == std::find(idList.begin(), idList.end(), id), true, msg.str());
idList.push_back(id);
error = error->NextSiblingElement();
}
}
void parseOutputtingArgs()
{
{
const char *argv[] = { "cppcheck", "--errorlist" };
ASSERT_EQUALS(true, argCheckWithCoutCerrRedirect(2, argv));
ASSERT_EQUALS("", errout.str());
parseErrorList(output.str().c_str());
}
{
const char *argv[] = {"cppcheck", "--help"};
ASSERT_EQUALS(true, argCheck(2, argv));
ASSERT_EQUALS("", errout.str());
ASSERT_EQUALS(true, output.str().find("Example usage") != std::string::npos);
}
{
const char *argv[] = {"cppcheck", "-h"};
ASSERT_EQUALS(true, argCheck(2, argv));
ASSERT_EQUALS("", errout.str());
ASSERT_EQUALS(true, output.str().find("Example usage") != std::string::npos);
}
{
const char *argv[] = {"cppcheck"};
ASSERT_EQUALS(true, argCheck(1, argv));
ASSERT_EQUALS("", errout.str());
ASSERT_EQUALS(true, output.str().find("Example usage") != std::string::npos);
}
{
const char *argv[] = {"cppcheck", "--version"};
ASSERT_EQUALS(true, argCheck(2, argv));
ASSERT_EQUALS("", errout.str());
ASSERT_EQUALS(std::string("Cppcheck ") + CppCheck::version() + "\n", output.str());
}
{
const char *argv[] = {"cppcheck", "--doc"};
ASSERT_EQUALS(true, argCheck(2, argv));
ASSERT_EQUALS("", errout.str());
ASSERT_EQUALS(true, output.str().find("===Bounds checking===") != std::string::npos);
ASSERT_EQUALS(true, output.str().find("===Unused functions===") != std::string::npos);
}
}
void parseOutputtingInvalidArgs()
{
{
const char *argv[] = {"cppcheck", "--invalidArg"};
ASSERT_EQUALS(false, argCheck(2, argv));
ASSERT_EQUALS("", errout.str());
ASSERT_EQUALS("cppcheck: error: unrecognized command line option \"--invalidArg\"\n", output.str());
}
{
const char *argv[] = {"cppcheck", "--suppressions"};
ASSERT_EQUALS(false, argCheck(2, argv));
ASSERT_EQUALS("", errout.str());
ASSERT_EQUALS("cppcheck: No file specified for the --suppressions option\n", output.str());
}
{
const char *argv[] = {"cppcheck", "--exitcode-suppressions"};
ASSERT_EQUALS(false, argCheck(2, argv));
ASSERT_EQUALS("", errout.str());
ASSERT_EQUALS("cppcheck: No file specified for the --exitcode-suppressions option\n", output.str());
}
{
const char *argv[] = {"cppcheck", "--enable"};
ASSERT_EQUALS(false, argCheck(2, argv));
ASSERT_EQUALS("", errout.str());
ASSERT_EQUALS("cppcheck: error: unrecognized command line option \"--enable\"\n", output.str());
}
{
const char *argv[] = {"cppcheck", "--append"};
ASSERT_EQUALS(false, argCheck(2, argv));
ASSERT_EQUALS("", errout.str());
ASSERT_EQUALS("cppcheck: error: unrecognized command line option \"--append\"\n", output.str());
}
{
const char *argv[] = {"cppcheck", "--error-exitcode"};
ASSERT_EQUALS(false, argCheck(2, argv));
ASSERT_EQUALS("", errout.str());
ASSERT_EQUALS("cppcheck: error: unrecognized command line option \"--error-exitcode\"\n", output.str());
}
{
const char *argv[] = {"cppcheck", "--file-list"};
ASSERT_EQUALS(false, argCheck(2, argv));
ASSERT_EQUALS("", errout.str());
ASSERT_EQUALS("cppcheck: error: unrecognized command line option \"--file-list\"\n", output.str());
}
{
const char *argv[] = {"cppcheck", "--showtime"};
ASSERT_EQUALS(false, argCheck(2, argv));
ASSERT_EQUALS("", errout.str());
ASSERT_EQUALS("cppcheck: error: unrecognized command line option \"--showtime\"\n", output.str());
}
{
const char *argv[] = {"cppcheck", "-I"};
ASSERT_EQUALS(false, argCheck(2, argv));
ASSERT_EQUALS("", errout.str());
ASSERT_EQUALS("cppcheck: argument to '-I' is missing\n", output.str());
}
{
const char *argv[] = {"cppcheck", "-j"};
ASSERT_EQUALS(false, argCheck(2, argv));
ASSERT_EQUALS("", errout.str());
ASSERT_EQUALS("cppcheck: argument to '-j' is missing\n", output.str());
}
{
const char *argv[] = {"cppcheck", "--template"};
ASSERT_EQUALS(false, argCheck(2, argv));
ASSERT_EQUALS("", errout.str());
ASSERT_EQUALS("cppcheck: argument to '--template' is missing\n", output.str());
}
}
void linenumbers()
{
const char filedata[] = "void f()\n"
"{\n"
" char *foo = new char[10];\n"
" delete [] foo;\n"
" foo[3] = 0;\n"
"}\n";
check(filedata);
// Compare results..
ASSERT_EQUALS("Checking file.cpp...\n", output.str());
ASSERT_EQUALS("[file.cpp:5]: (error) Dereferencing 'foo' after it is deallocated / released\n", errout.str());
}
void linenumbers2()
{
const char filedata[] = "void f()\n"
"{\n"
" char *string;\n"
" string = new char[20];\n"
" string = new char[30];\n"
" delete [] string;\n"
"}\n";
check(filedata);
// Compare results..
ASSERT_EQUALS("[file.cpp:5]: (error) Memory leak: string\n", errout.str());
}
void xml()
{
// Test the errorlogger..
ErrorLogger::ErrorMessage errorMessage;
errorMessage._msg = "ab<cd>ef";
ASSERT_EQUALS("<error id=\"\" severity=\"\" msg=\"ab<cd>ef\"/>", errorMessage.toXML());
}
void include()
{
ErrorLogger::ErrorMessage errorMessage;
ErrorLogger::ErrorMessage::FileLocation loc;
loc.file = "ab/cd/../ef.h";
errorMessage._callStack.push_back(loc);
ASSERT_EQUALS("<error file=\"ab/ef.h\" line=\"0\" id=\"\" severity=\"\" msg=\"\"/>", errorMessage.toXML());
ASSERT_EQUALS("[ab/ef.h:0]: ", errorMessage.toText());
}
void templateFormat()
{
ErrorLogger::ErrorMessage errorMessage;
ErrorLogger::ErrorMessage::FileLocation loc;
loc.file = "some/{file}file.cpp";
loc.line = 10;
errorMessage._callStack.push_back(loc);
errorMessage._id = "testId";
errorMessage._severity = "testSeverity";
errorMessage._msg = "long testMessage";
ASSERT_EQUALS("<error file=\"some/{file}file.cpp\" line=\"10\" id=\"testId\" severity=\"testSeverity\" msg=\"long testMessage\"/>", errorMessage.toXML());
ASSERT_EQUALS("[some/{file}file.cpp:10]: (testSeverity) long testMessage", errorMessage.toText());
ASSERT_EQUALS("testId-some/{file}file.cpp,testSeverity.10?{long testMessage}", errorMessage.toText("{id}-{file},{severity}.{line}?{{message}}"));
}
void getErrorMessages()
{
errout.str("");
CppCheck cppCheck(*this);
cppCheck.getErrorMessages();
}
void userdefines()
{
{
const char *argv[] = {"cppcheck", "-DA", "-DB"};
Settings settings;
ASSERT_EQUALS(true, argCheckReturnSettings(3, argv, settings));
ASSERT_EQUALS("A;B", settings.userDefines);
ASSERT_EQUALS("", errout.str());
ASSERT_EQUALS("", output.str());
}
}
};
REGISTER_TEST(TestCppcheck)
