/*
* Cppcheck - A tool for static C/C++ code analysis
* Copyright (C) 2007-2023 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 .
*/
#include "config.h"
#include "cppcheck.h"
#include "errorlogger.h"
#include "errortypes.h"
#include "fixture.h"
#include
#include
#include
class TestErrorLogger : public TestFixture {
public:
TestErrorLogger() : TestFixture("TestErrorLogger") {}
private:
const ErrorMessage::FileLocation fooCpp5{"foo.cpp", 5, 1};
const ErrorMessage::FileLocation barCpp8{"bar.cpp", 8, 1};
void run() override {
TEST_CASE(PatternSearchReplace);
TEST_CASE(FileLocationDefaults);
TEST_CASE(FileLocationSetFile);
TEST_CASE(ErrorMessageConstruct);
TEST_CASE(ErrorMessageConstructLocations);
TEST_CASE(ErrorMessageVerbose);
TEST_CASE(ErrorMessageVerboseLocations);
TEST_CASE(ErrorMessageFromInternalError);
TEST_CASE(CustomFormat);
TEST_CASE(CustomFormat2);
TEST_CASE(CustomFormatLocations);
TEST_CASE(ToXmlV2);
TEST_CASE(ToXmlV2Locations);
TEST_CASE(ToXmlV2Encoding);
TEST_CASE(FromXmlV2);
// Inconclusive results in xml reports..
TEST_CASE(InconclusiveXml);
// Serialize / Deserialize inconclusive message
TEST_CASE(SerializeInconclusiveMessage);
TEST_CASE(DeserializeInvalidInput);
TEST_CASE(SerializeSanitize);
TEST_CASE(SerializeFileLocation);
TEST_CASE(substituteTemplateFormatStatic);
TEST_CASE(substituteTemplateLocationStatic);
}
void TestPatternSearchReplace(const std::string& idPlaceholder, const std::string& id) const {
const std::string plainText = "text";
ErrorMessage message;
message.id = id;
std::string serialized = message.toString(true, idPlaceholder + plainText + idPlaceholder);
ASSERT_EQUALS(id + plainText + id, serialized);
serialized = message.toString(true, idPlaceholder + idPlaceholder);
ASSERT_EQUALS(id + id, serialized);
serialized = message.toString(true, plainText + idPlaceholder + plainText);
ASSERT_EQUALS(plainText + id + plainText, serialized);
}
void PatternSearchReplace() const {
const std::string idPlaceholder = "{id}";
const std::string empty;
TestPatternSearchReplace(idPlaceholder, empty);
const std::string shortIdValue = "ID";
ASSERT_EQUALS(true, shortIdValue.length() < idPlaceholder.length());
TestPatternSearchReplace(idPlaceholder, shortIdValue);
const std::string mediumIdValue = "_ID_";
ASSERT_EQUALS(mediumIdValue.length(), idPlaceholder.length());
TestPatternSearchReplace(idPlaceholder, mediumIdValue);
const std::string longIdValue = "longId";
ASSERT_EQUALS(true, longIdValue.length() > idPlaceholder.length());
TestPatternSearchReplace(idPlaceholder, longIdValue);
}
void FileLocationDefaults() const {
ErrorMessage::FileLocation loc;
ASSERT_EQUALS("", loc.getfile());
ASSERT_EQUALS(0, loc.line);
}
void FileLocationSetFile() const {
ErrorMessage::FileLocation loc;
loc.setfile("foo.cpp");
ASSERT_EQUALS("foo.cpp", loc.getfile());
ASSERT_EQUALS(0, loc.line);
}
void ErrorMessageConstruct() const {
std::list locs(1, fooCpp5);
ErrorMessage msg(locs, emptyString, Severity::error, "Programming error.", "errorId", Certainty::normal);
ASSERT_EQUALS(1, msg.callStack.size());
ASSERT_EQUALS("Programming error.", msg.shortMessage());
ASSERT_EQUALS("Programming error.", msg.verboseMessage());
ASSERT_EQUALS("[foo.cpp:5]: (error) Programming error.", msg.toString(false));
ASSERT_EQUALS("[foo.cpp:5]: (error) Programming error.", msg.toString(true));
}
void ErrorMessageConstructLocations() const {
std::list locs = { fooCpp5, barCpp8 };
ErrorMessage msg(locs, emptyString, Severity::error, "Programming error.", "errorId", Certainty::normal);
ASSERT_EQUALS(2, msg.callStack.size());
ASSERT_EQUALS("Programming error.", msg.shortMessage());
ASSERT_EQUALS("Programming error.", msg.verboseMessage());
ASSERT_EQUALS("[foo.cpp:5] -> [bar.cpp:8]: (error) Programming error.", msg.toString(false));
ASSERT_EQUALS("[foo.cpp:5] -> [bar.cpp:8]: (error) Programming error.", msg.toString(true));
}
void ErrorMessageVerbose() const {
std::list locs(1, fooCpp5);
ErrorMessage msg(locs, emptyString, Severity::error, "Programming error.\nVerbose error", "errorId", Certainty::normal);
ASSERT_EQUALS(1, msg.callStack.size());
ASSERT_EQUALS("Programming error.", msg.shortMessage());
ASSERT_EQUALS("Verbose error", msg.verboseMessage());
ASSERT_EQUALS("[foo.cpp:5]: (error) Programming error.", msg.toString(false));
ASSERT_EQUALS("[foo.cpp:5]: (error) Verbose error", msg.toString(true));
}
void ErrorMessageVerboseLocations() const {
std::list locs = { fooCpp5, barCpp8 };
ErrorMessage msg(locs, emptyString, Severity::error, "Programming error.\nVerbose error", "errorId", Certainty::normal);
ASSERT_EQUALS(2, msg.callStack.size());
ASSERT_EQUALS("Programming error.", msg.shortMessage());
ASSERT_EQUALS("Verbose error", msg.verboseMessage());
ASSERT_EQUALS("[foo.cpp:5] -> [bar.cpp:8]: (error) Programming error.", msg.toString(false));
ASSERT_EQUALS("[foo.cpp:5] -> [bar.cpp:8]: (error) Verbose error", msg.toString(true));
}
void ErrorMessageFromInternalError() const {
// TODO: test with token
{
InternalError internalError(nullptr, "message", InternalError::INTERNAL);
const auto msg = ErrorMessage::fromInternalError(internalError, nullptr, "file.c");
ASSERT_EQUALS(1, msg.callStack.size());
const auto &loc = *msg.callStack.cbegin();
ASSERT_EQUALS(0, loc.fileIndex);
ASSERT_EQUALS(0, loc.line);
ASSERT_EQUALS(0, loc.column);
ASSERT_EQUALS("message", msg.shortMessage());
ASSERT_EQUALS("message", msg.verboseMessage());
ASSERT_EQUALS("[file.c:0]: (error) message", msg.toString(false));
ASSERT_EQUALS("[file.c:0]: (error) message", msg.toString(true));
}
{
InternalError internalError(nullptr, "message", "details", InternalError::INTERNAL);
const auto msg = ErrorMessage::fromInternalError(internalError, nullptr, "file.cpp", "msg");
ASSERT_EQUALS(1, msg.callStack.size());
const auto &loc = *msg.callStack.cbegin();
ASSERT_EQUALS(0, loc.fileIndex);
ASSERT_EQUALS(0, loc.line);
ASSERT_EQUALS(0, loc.column);
ASSERT_EQUALS("msg: message", msg.shortMessage());
ASSERT_EQUALS("msg: message: details", msg.verboseMessage());
ASSERT_EQUALS("[file.cpp:0]: (error) msg: message", msg.toString(false));
ASSERT_EQUALS("[file.cpp:0]: (error) msg: message: details", msg.toString(true));
}
}
void CustomFormat() const {
std::list locs(1, fooCpp5);
ErrorMessage msg(locs, emptyString, Severity::error, "Programming error.\nVerbose error", "errorId", Certainty::normal);
ASSERT_EQUALS(1, msg.callStack.size());
ASSERT_EQUALS("Programming error.", msg.shortMessage());
ASSERT_EQUALS("Verbose error", msg.verboseMessage());
ASSERT_EQUALS("foo.cpp:5,error,errorId,Programming error.", msg.toString(false, "{file}:{line},{severity},{id},{message}"));
ASSERT_EQUALS("foo.cpp:5,error,errorId,Verbose error", msg.toString(true, "{file}:{line},{severity},{id},{message}"));
}
void CustomFormat2() const {
std::list locs(1, fooCpp5);
ErrorMessage msg(locs, emptyString, Severity::error, "Programming error.\nVerbose error", "errorId", Certainty::normal);
ASSERT_EQUALS(1, msg.callStack.size());
ASSERT_EQUALS("Programming error.", msg.shortMessage());
ASSERT_EQUALS("Verbose error", msg.verboseMessage());
ASSERT_EQUALS("Programming error. - foo.cpp(5):(error,errorId)", msg.toString(false, "{message} - {file}({line}):({severity},{id})"));
ASSERT_EQUALS("Verbose error - foo.cpp(5):(error,errorId)", msg.toString(true, "{message} - {file}({line}):({severity},{id})"));
}
void CustomFormatLocations() const {
// Check that first location from location stack is used in template
std::list locs = { fooCpp5, barCpp8 };
ErrorMessage msg(locs, emptyString, Severity::error, "Programming error.\nVerbose error", "errorId", Certainty::normal);
ASSERT_EQUALS(2, msg.callStack.size());
ASSERT_EQUALS("Programming error.", msg.shortMessage());
ASSERT_EQUALS("Verbose error", msg.verboseMessage());
ASSERT_EQUALS("Programming error. - bar.cpp(8):(error,errorId)", msg.toString(false, "{message} - {file}({line}):({severity},{id})"));
ASSERT_EQUALS("Verbose error - bar.cpp(8):(error,errorId)", msg.toString(true, "{message} - {file}({line}):({severity},{id})"));
}
void ToXmlV2() const {
std::list locs(1, fooCpp5);
ErrorMessage msg(locs, emptyString, Severity::error, "Programming error.\nVerbose error", "errorId", Certainty::normal);
std::string header("\n\n");
header += " \n ";
ASSERT_EQUALS(header, ErrorMessage::getXMLHeader(""));
ASSERT_EQUALS(" \n", ErrorMessage::getXMLFooter());
std::string message(" \n";
message += " \n ";
ASSERT_EQUALS(message, msg.toXML());
}
void ToXmlV2Locations() const {
std::list locs = { fooCpp5, barCpp8 };
locs.back().setinfo("ä");
ErrorMessage msg(locs, emptyString, Severity::error, "Programming error.\nVerbose error", "errorId", Certainty::normal);
std::string header("\n\n");
header += " \n ";
ASSERT_EQUALS(header, ErrorMessage::getXMLHeader(""));
ASSERT_EQUALS(" \n", ErrorMessage::getXMLFooter());
std::string message(" \n";
message += " \n";
message += " \n ";
ASSERT_EQUALS(message, msg.toXML());
}
void ToXmlV2Encoding() const {
{
std::list locs;
ErrorMessage msg(locs, emptyString, Severity::error, "Programming error.\nComparing \"\203\" with \"\003\"", "errorId", Certainty::normal);
const std::string expected(" ");
ASSERT_EQUALS(expected, msg.toXML());
}
{
const char code1[]="äöü";
const char code2[]="\x12\x00\x00\x01";
std::list locs;
ErrorMessage msg1(locs, emptyString, Severity::error, std::string("Programming error.\nReading \"")+code1+"\"", "errorId", Certainty::normal);
ASSERT_EQUALS(" ", msg1.toXML());
ErrorMessage msg2(locs, emptyString, Severity::error, std::string("Programming error.\nReading \"")+code2+"\"", "errorId", Certainty::normal);
ASSERT_EQUALS(" ", msg2.toXML());
}
}
void FromXmlV2() const {
const char xmldata[] = "\n"
"\n"
" \n"
" \n"
"";
tinyxml2::XMLDocument doc;
ASSERT(doc.Parse(xmldata, sizeof(xmldata)) == tinyxml2::XML_SUCCESS);
ErrorMessage msg(doc.FirstChildElement());
ASSERT_EQUALS("errorId", msg.id);
ASSERT_EQUALS(static_cast(Severity::error), static_cast(msg.severity));
ASSERT_EQUALS(123u, msg.cwe.id);
ASSERT_EQUALS(static_cast(Certainty::inconclusive), static_cast(msg.certainty));
ASSERT_EQUALS("Programming error.", msg.shortMessage());
ASSERT_EQUALS("Verbose error", msg.verboseMessage());
ASSERT_EQUALS(456u, msg.hash);
ASSERT_EQUALS(2u, msg.callStack.size());
ASSERT_EQUALS("foo.cpp", msg.callStack.front().getfile());
ASSERT_EQUALS(5, msg.callStack.front().line);
ASSERT_EQUALS(2u, msg.callStack.front().column);
ASSERT_EQUALS("bar.cpp", msg.callStack.back().getfile());
ASSERT_EQUALS(8, msg.callStack.back().line);
ASSERT_EQUALS(1u, msg.callStack.back().column);
}
void InconclusiveXml() const {
// Location
std::list locs(1, fooCpp5);
// Inconclusive error message
ErrorMessage msg(locs, emptyString, Severity::error, "Programming error", "errorId", Certainty::inconclusive);
// xml version 2 error message
ASSERT_EQUALS(" \n"
" \n"
" ",
msg.toXML());
}
void SerializeInconclusiveMessage() const {
// Inconclusive error message
std::list locs;
ErrorMessage msg(locs, emptyString, Severity::error, "Programming error", "errorId", Certainty::inconclusive);
msg.file0 = "test.cpp";
const std::string msg_str = msg.serialize();
ASSERT_EQUALS("7 errorId"
"5 error"
"1 0"
"1 0"
"8 test.cpp"
"12 inconclusive"
"17 Programming error"
"17 Programming error"
"0 ", msg_str);
ErrorMessage msg2;
ASSERT_NO_THROW(msg2.deserialize(msg_str));
ASSERT_EQUALS("errorId", msg2.id);
ASSERT_EQUALS(static_cast(Severity::error), static_cast(msg2.severity));
ASSERT_EQUALS("test.cpp", msg2.file0);
ASSERT_EQUALS(static_cast(Certainty::inconclusive), static_cast(msg2.certainty));
ASSERT_EQUALS("Programming error", msg2.shortMessage());
ASSERT_EQUALS("Programming error", msg2.verboseMessage());
}
void DeserializeInvalidInput() const {
{
// missing/invalid length
// missing separator
ErrorMessage msg;
ASSERT_THROW_EQUALS(msg.deserialize("500foobar"), InternalError, "Internal Error: Deserialization of error message failed - invalid separator");
}
{
// invalid length
ErrorMessage msg;
ASSERT_THROW_EQUALS(msg.deserialize("foo foobar"), InternalError, "Internal Error: Deserialization of error message failed - invalid length");
}
{
// mismatching length
ErrorMessage msg;
ASSERT_THROW_EQUALS(msg.deserialize("8 errorId"), InternalError, "Internal Error: Deserialization of error message failed - premature end of data");
}
{
// incomplete message
ErrorMessage msg;
ASSERT_THROW_EQUALS(msg.deserialize("7 errorId"), InternalError, "Internal Error: Deserialization of error message failed - invalid length");
}
{
// invalid CWE ID
const char str[] = "7 errorId"
"5 error"
"7 invalid" // cwe
"1 0"
"8 test.cpp"
"17 Programming error"
"17 Programming error"
"0 ";
ErrorMessage msg;
ASSERT_THROW_EQUALS(msg.deserialize(str), InternalError, "Internal Error: Deserialization of error message failed - invalid CWE ID - not an integer");
}
{
// invalid hash
const char str[] = "7 errorId"
"5 error"
"1 0"
"7 invalid" // hash
"8 test.cpp"
"17 Programming error"
"17 Programming error"
"0 ";
ErrorMessage msg;
ASSERT_THROW_EQUALS(msg.deserialize(str), InternalError, "Internal Error: Deserialization of error message failed - invalid hash - not an integer");
}
{
// out-of-range CWE ID
const char str[] = "7 errorId"
"5 error"
"5 65536" // max +1
"1 0"
"8 test.cpp"
"17 Programming error"
"17 Programming error"
"0 ";
ErrorMessage msg;
ASSERT_THROW(msg.deserialize(str), InternalError);
}
}
void SerializeSanitize() const {
std::list locs;
ErrorMessage msg(locs, emptyString, Severity::error, std::string("Illegal character in \"foo\001bar\""), "errorId", Certainty::normal);
msg.file0 = "1.c";
const std::string msg_str = msg.serialize();
ASSERT_EQUALS("7 errorId"
"5 error"
"1 0"
"1 0"
"3 1.c"
"33 Illegal character in \"foo\\001bar\""
"33 Illegal character in \"foo\\001bar\""
"0 ", msg_str);
ErrorMessage msg2;
ASSERT_NO_THROW(msg2.deserialize(msg_str));
ASSERT_EQUALS("errorId", msg2.id);
ASSERT_EQUALS(static_cast(Severity::error), static_cast(msg2.severity));
ASSERT_EQUALS("1.c", msg2.file0);
ASSERT_EQUALS("Illegal character in \"foo\\001bar\"", msg2.shortMessage());
ASSERT_EQUALS("Illegal character in \"foo\\001bar\"", msg2.verboseMessage());
}
void SerializeFileLocation() const {
ErrorMessage::FileLocation loc1(":/,;", 654, 33);
loc1.setfile("[]:;,()");
loc1.setinfo("abcd:/,");
std::list locs{loc1};
ErrorMessage msg(locs, emptyString, Severity::error, "Programming error", "errorId", Certainty::inconclusive);
const std::string msg_str = msg.serialize();
ASSERT_EQUALS("7 errorId"
"5 error"
"1 0"
"1 0"
"0 "
"12 inconclusive"
"17 Programming error"
"17 Programming error"
"1 "
"27 654\t33\t[]:;,()\t:/,;\tabcd:/,", msg_str);
ErrorMessage msg2;
ASSERT_NO_THROW(msg2.deserialize(msg_str));
ASSERT_EQUALS("[]:;,()", msg2.callStack.front().getfile(false));
ASSERT_EQUALS(":/,;", msg2.callStack.front().getOrigFile(false));
ASSERT_EQUALS(654, msg2.callStack.front().line);
ASSERT_EQUALS(33, msg2.callStack.front().column);
ASSERT_EQUALS("abcd:/,", msg2.callStack.front().getinfo());
}
void substituteTemplateFormatStatic() const
{
{
std::string s;
::substituteTemplateFormatStatic(s);
ASSERT_EQUALS("", s);
}
{
std::string s = "template{black}\\z";
::substituteTemplateFormatStatic(s);
ASSERT_EQUALS("template{black}\\z", s);
}
{
std::string s = "{reset}{bold}{dim}{red}{blue}{magenta}{default}\\b\\n\\r\\t";
::substituteTemplateFormatStatic(s);
ASSERT_EQUALS("\b\n\r\t", s);
}
{
std::string s = "\\\\n";
::substituteTemplateFormatStatic(s);
ASSERT_EQUALS("\\\n", s);
}
{
std::string s = "{{red}";
::substituteTemplateFormatStatic(s);
ASSERT_EQUALS("{", s);
}
}
void substituteTemplateLocationStatic() const
{
{
std::string s;
::substituteTemplateLocationStatic(s);
ASSERT_EQUALS("", s);
}
{
std::string s = "template";
::substituteTemplateLocationStatic(s);
ASSERT_EQUALS("template", s);
}
{
std::string s = "template{black}\\z";
::substituteTemplateFormatStatic(s);
ASSERT_EQUALS("template{black}\\z", s);
}
{
std::string s = "{reset}{bold}{dim}{red}{blue}{magenta}{default}\\b\\n\\r\\t";
::substituteTemplateFormatStatic(s);
ASSERT_EQUALS("\b\n\r\t", s);
}
{
std::string s = "\\\\n";
::substituteTemplateFormatStatic(s);
ASSERT_EQUALS("\\\n", s);
}
{
std::string s = "{{red}";
::substituteTemplateFormatStatic(s);
ASSERT_EQUALS("{", s);
}
}
};
REGISTER_TEST(TestErrorLogger)