Skip to content

Commit 6ef6767

Browse files
firewavefirewave
committed
greatly improved Settings::loadCppcheckCfg() error handling
1 parent 237bed8 commit 6ef6767

File tree

9 files changed

+286
-39
lines changed

9 files changed

+286
-39
lines changed

‎Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -809,7 +809,7 @@ test/testpreprocessor.o: test/testpreprocessor.cpp externals/simplecpp/simplecpp
809809
test/testprocessexecutor.o: test/testprocessexecutor.cpp cli/executor.h cli/processexecutor.h lib/addoninfo.h lib/analyzerinfo.h lib/check.h lib/color.h lib/config.h lib/cppcheck.h lib/errorlogger.h lib/errortypes.h lib/filesettings.h lib/library.h lib/mathlib.h lib/platform.h lib/settings.h lib/standards.h lib/suppressions.h lib/timer.h lib/tokenize.h lib/tokenlist.h lib/utils.h test/fixture.h test/helpers.h test/redirect.h
810810
$(CXX) ${INCLUDE_FOR_TEST} $(CPPFLAGS) $(CXXFLAGS) -c -o $@ test/testprocessexecutor.cpp
811811

812-
test/testsettings.o: test/testsettings.cpp lib/addoninfo.h lib/check.h lib/color.h lib/config.h lib/errorlogger.h lib/errortypes.h lib/library.h lib/mathlib.h lib/platform.h lib/settings.h lib/standards.h lib/suppressions.h lib/utils.h test/fixture.h
812+
test/testsettings.o: test/testsettings.cpp lib/addoninfo.h lib/check.h lib/color.h lib/config.h lib/errorlogger.h lib/errortypes.h lib/library.h lib/mathlib.h lib/path.h lib/platform.h lib/settings.h lib/standards.h lib/suppressions.h lib/tokenize.h lib/tokenlist.h lib/utils.h test/fixture.h test/helpers.h
813813
$(CXX) ${INCLUDE_FOR_TEST} $(CPPFLAGS) $(CXXFLAGS) -c -o $@ test/testsettings.cpp
814814

815815
test/testsimplifytemplate.o: test/testsimplifytemplate.cpp lib/addoninfo.h lib/check.h lib/color.h lib/config.h lib/errorlogger.h lib/errortypes.h lib/library.h lib/mathlib.h lib/platform.h lib/settings.h lib/standards.h lib/suppressions.h lib/templatesimplifier.h lib/token.h lib/tokenize.h lib/tokenlist.h lib/utils.h lib/vfvalue.h test/fixture.h

‎cli/cmdlineparser.cpp

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -307,7 +307,8 @@ CmdLineParser::Result CmdLineParser::parseFromArgs(int argc, const char* const a
307307

308308
// print all possible error messages..
309309
if (std::strcmp(argv[i], "--errorlist") == 0) {
310-
mSettings.loadCppcheckCfg();
310+
if (!loadCppcheckCfg())
311+
return Result::Fail;
311312
{
312313
XMLErrorMessagesLogger xmlLogger;
313314
std::cout << ErrorMessage::getXMLHeader(mSettings.cppcheckCfgProductName);
@@ -324,7 +325,8 @@ CmdLineParser::Result CmdLineParser::parseFromArgs(int argc, const char* const a
324325
}
325326

326327
if (std::strcmp(argv[i], "--version") == 0) {
327-
mSettings.loadCppcheckCfg();
328+
if (!loadCppcheckCfg())
329+
return Result::Fail;
328330
if (!mSettings.cppcheckCfgProductName.empty()) {
329331
mLogger.printRaw(mSettings.cppcheckCfgProductName);
330332
} else {
@@ -1203,7 +1205,8 @@ CmdLineParser::Result CmdLineParser::parseFromArgs(int argc, const char* const a
12031205
}
12041206
}
12051207

1206-
mSettings.loadCppcheckCfg();
1208+
if (!loadCppcheckCfg())
1209+
return Result::Fail;
12071210

12081211
// Default template format..
12091212
if (mSettings.templateFormat.empty()) {
@@ -1609,10 +1612,10 @@ void CmdLineParser::printHelp() const
16091612
mLogger.printRaw(oss.str());
16101613
}
16111614

1612-
bool CmdLineParser::isCppcheckPremium() const {
1613-
if (mSettings.cppcheckCfgProductName.empty())
1614-
mSettings.loadCppcheckCfg();
1615-
return startsWith(mSettings.cppcheckCfgProductName, "Cppcheck Premium");
1615+
bool CmdLineParser::isCppcheckPremium() {
1616+
Settings settings;
1617+
settings.loadCppcheckCfg(); // TODO: how to handle errors?
1618+
return startsWith(settings.cppcheckCfgProductName, "Cppcheck Premium");
16161619
}
16171620

16181621
bool CmdLineParser::tryLoadLibrary(Library& destination, const std::string& basepath, const char* filename)
@@ -1701,3 +1704,14 @@ bool CmdLineParser::loadAddons(Settings& settings)
17011704
}
17021705
return result;
17031706
}
1707+
1708+
bool CmdLineParser::loadCppcheckCfg()
1709+
{
1710+
const std::string cfgErr = mSettings.loadCppcheckCfg();
1711+
if (!cfgErr.empty()) {
1712+
mLogger.printError("could not load cppcheck.cfg - " + cfgErr);
1713+
return false;
1714+
}
1715+
return true;
1716+
}
1717+

‎cli/cmdlineparser.h

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ class CmdLineParser {
111111
void printHelp() const;
112112

113113
private:
114-
bool isCppcheckPremium() const;
114+
static bool isCppcheckPremium();
115115

116116
template<typename T>
117117
bool parseNumberArg(const char* const arg, std::size_t offset, T& num, bool mustBePositive = false)
@@ -150,6 +150,8 @@ class CmdLineParser {
150150
*/
151151
bool loadAddons(Settings& settings);
152152

153+
bool loadCppcheckCfg();
154+
153155
CmdLineLogger &mLogger;
154156

155157
std::vector<std::string> mPathNames;

‎gui/mainwindow.cpp

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ MainWindow::MainWindow(TranslationHandler* th, QSettings* settings) :
119119
{
120120
Settings tempSettings;
121121
tempSettings.exename = QCoreApplication::applicationFilePath().toStdString();
122-
tempSettings.loadCppcheckCfg();
122+
tempSettings.loadCppcheckCfg(); // TODO: how to handle error?
123123
mCppcheckCfgProductName = QString::fromStdString(tempSettings.cppcheckCfgProductName);
124124
mCppcheckCfgAbout = QString::fromStdString(tempSettings.cppcheckCfgAbout);
125125
}
@@ -903,8 +903,7 @@ bool MainWindow::tryLoadLibrary(Library *library, const QString& filename)
903903
return true;
904904
}
905905

906-
Settings MainWindow::getCppcheckSettings()
907-
{
906+
Settings MainWindow::getCppcheckSettings() {
908907
saveSettings(); // Save settings
909908

910909
Settings result;
@@ -915,7 +914,11 @@ Settings MainWindow::getCppcheckSettings()
915914
if (!std)
916915
QMessageBox::critical(this, tr("Error"), tr("Failed to load %1. Your Cppcheck installation is broken. You can use --data-dir=<directory> at the command line to specify where this file is located. Please note that --data-dir is supposed to be used by installation scripts and therefore the GUI does not start when it is used, all that happens is that the setting is configured.").arg("std.cfg"));
917916

918-
result.loadCppcheckCfg();
917+
{
918+
const QString cfgErr = QString::fromStdString(result.loadCppcheckCfg());
919+
if (!cfgErr.isEmpty())
920+
QMessageBox::critical(this, tr("Error"), tr("Failed to load %1 - %2").arg("cppcheck.cfg").arg(cfgErr));
921+
}
919922

920923
// If project file loaded, read settings from it
921924
if (mProjectFile) {

‎lib/settings.cpp

Lines changed: 70 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -40,40 +40,87 @@ Settings::Settings()
4040
setCheckLevelNormal();
4141
}
4242

43-
// TODO: report error when the config is invalid
44-
void Settings::loadCppcheckCfg()
43+
std::string Settings::loadCppcheckCfg()
4544
{
46-
std::string fileName = Path::getPathFromFilename(exename) + "cppcheck.cfg";
45+
static const std::string cfgFilename = "cppcheck.cfg";
46+
std::string fileName;
4747
#ifdef FILESDIR
48-
if (Path::isFile(FILESDIR "/cppcheck.cfg"))
49-
fileName = FILESDIR "/cppcheck.cfg";
48+
if (Path::isFile(Path::join(FILESDIR, cfgFilename)))
49+
fileName = Path::join(FILESDIR, cfgFilename);
5050
#endif
51+
// cppcheck-suppress knownConditionTrueFalse
52+
if (fileName.empty()) {
53+
fileName = Path::getPathFromFilename(exename) + cfgFilename;
54+
if (!Path::isFile(fileName))
55+
return "";
56+
}
5157

5258
std::ifstream fin(fileName);
5359
if (!fin.is_open())
54-
return;
60+
return "could not open file";
5561
picojson::value json;
5662
fin >> json;
57-
if (!picojson::get_last_error().empty())
58-
return;
59-
picojson::object obj = json.get<picojson::object>();
60-
if (obj.count("productName") && obj["productName"].is<std::string>())
61-
cppcheckCfgProductName = obj["productName"].get<std::string>();
62-
if (obj.count("about") && obj["about"].is<std::string>())
63-
cppcheckCfgAbout = obj["about"].get<std::string>();
64-
if (obj.count("addons") && obj["addons"].is<picojson::array>()) {
65-
for (const picojson::value &v : obj["addons"].get<picojson::array>()) {
66-
const std::string &s = v.get<std::string>();
67-
if (!Path::isAbsolute(s))
68-
addons.emplace(Path::getPathFromFilename(fileName) + s);
69-
else
70-
addons.emplace(s);
63+
{
64+
const std::string& lastErr = picojson::get_last_error();
65+
if (!lastErr.empty())
66+
return "not a valid JSON - " + lastErr;
67+
}
68+
const picojson::object& obj = json.get<picojson::object>();
69+
{
70+
const picojson::object::const_iterator it = obj.find("productName");
71+
if (it != obj.cend()) {
72+
const auto& v = it->second;
73+
if (!v.is<std::string>())
74+
return "'productName' is not a string";
75+
cppcheckCfgProductName = v.get<std::string>();
7176
}
7277
}
73-
if (obj.count("suppressions") && obj["suppressions"].is<picojson::array>()) {
74-
for (const picojson::value &v : obj["suppressions"].get<picojson::array>())
75-
nomsg.addSuppressionLine(v.get<std::string>());
78+
{
79+
const picojson::object::const_iterator it = obj.find("about");
80+
if (it != obj.cend()) {
81+
const auto& v = it->second;
82+
if (!v.is<std::string>())
83+
return "'about' is not a string";
84+
cppcheckCfgAbout = v.get<std::string>();
85+
}
86+
}
87+
{
88+
const picojson::object::const_iterator it = obj.find("addons");
89+
if (it != obj.cend()) {
90+
const auto& entry = it->second;
91+
if (!entry.is<picojson::array>())
92+
return "'addons' is not an array";
93+
for (const picojson::value &v : entry.get<picojson::array>())
94+
{
95+
if (!v.is<std::string>())
96+
return "'addons' array entry is not a string";
97+
const std::string &s = v.get<std::string>();
98+
if (!Path::isAbsolute(s))
99+
addons.emplace(Path::join(Path::getPathFromFilename(fileName), s));
100+
else
101+
addons.emplace(s);
102+
}
103+
}
76104
}
105+
{
106+
const picojson::object::const_iterator it = obj.find("suppressions");
107+
if (it != obj.cend()) {
108+
const auto& entry = it->second;
109+
if (!entry.is<picojson::array>())
110+
return "'suppressions' is not an array";
111+
for (const picojson::value &v : entry.get<picojson::array>())
112+
{
113+
if (!v.is<std::string>())
114+
return "'suppressions' array entry is not a string";
115+
const std::string &s = v.get<std::string>();
116+
const std::string err = nomsg.addSuppressionLine(s);
117+
if (!err.empty())
118+
return "could not parse suppression '" + s + "' - " + err;
119+
}
120+
}
121+
}
122+
123+
return "";
77124
}
78125

79126
std::string Settings::parseEnabled(const std::string &str, std::tuple<SimpleEnableGroup<Severity>, SimpleEnableGroup<Checks>> &groups)

‎lib/settings.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ class CPPCHECKLIB WARN_UNUSED Settings {
9999
public:
100100
Settings();
101101

102-
void loadCppcheckCfg();
102+
std::string loadCppcheckCfg();
103103

104104
/** @brief addons, either filename of python/json file or json data */
105105
std::unordered_set<std::string> addons;

‎releasenotes.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,3 +32,4 @@ Other:
3232
- You can suppress all warnings where macro is used using "-macro"
3333
- fixed CMake build with UBSAN and GCC
3434
- Added command-line options "--fsigned-char" and "--funsigned-char" to control the signess of the "char" type. This overrides previously specified "--platform" options and is overrides by following ones.
35+
- An error is now reported when the "cppcheck.cfg" is invalid. The CLI version will also exit with a failure in that case.

‎test/testcmdlineparser.cpp

Lines changed: 44 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,7 @@ class TestCmdlineParser : public TestFixture {
125125
TEST_CASE(version);
126126
TEST_CASE(versionWithCfg);
127127
TEST_CASE(versionExclusive);
128+
TEST_CASE(versionWithInvalidCfg);
128129
TEST_CASE(onefile);
129130
TEST_CASE(onepath);
130131
TEST_CASE(optionwithoutfile);
@@ -268,7 +269,9 @@ class TestCmdlineParser : public TestFixture {
268269
TEST_CASE(showtimeEmpty);
269270
TEST_CASE(showtimeInvalid);
270271
TEST_CASE(errorlist);
272+
TEST_CASE(errorlistWithCfg);
271273
TEST_CASE(errorlistExclusive);
274+
TEST_CASE(errorlistWithInvalidCfg);
272275
TEST_CASE(ignorepathsnopath);
273276
#if defined(USE_WINDOWS_SEH) || defined(USE_UNIX_SIGNAL_HANDLING)
274277
TEST_CASE(exceptionhandling);
@@ -360,6 +363,8 @@ class TestCmdlineParser : public TestFixture {
360363
TEST_CASE(cppcheckBuildDirExistent);
361364
TEST_CASE(cppcheckBuildDirNonExistent);
362365
TEST_CASE(cppcheckBuildDirEmpty);
366+
367+
TEST_CASE(invalidCppcheckCfg);
363368
}
364369

365370
void nooptions() {
@@ -433,6 +438,16 @@ class TestCmdlineParser : public TestFixture {
433438
ASSERT_EQUALS("", GET_REDIRECT_OUTPUT);
434439
}
435440

441+
void versionWithInvalidCfg() {
442+
REDIRECT;
443+
ScopedFile file("cppcheck.cfg",
444+
"{\n");
445+
const char * const argv[] = {"cppcheck", "--version"};
446+
ASSERT_EQUALS(CmdLineParser::Result::Fail, parser->parseFromArgs(2, argv));
447+
ASSERT_EQUALS("cppcheck: error: could not load cppcheck.cfg - not a valid JSON - syntax error at line 1 near: \n", logger->str());
448+
ASSERT_EQUALS("", GET_REDIRECT_OUTPUT);
449+
}
450+
436451
void onefile() {
437452
REDIRECT;
438453
const char * const argv[] = {"cppcheck", "file.cpp"};
@@ -1690,11 +1705,19 @@ class TestCmdlineParser : public TestFixture {
16901705
const char * const argv[] = {"cppcheck", "--errorlist"};
16911706
ASSERT_EQUALS(CmdLineParser::Result::Exit, parser->parseFromArgs(2, argv));
16921707
ASSERT_EQUALS("", logger->str()); // empty since it is logged via ErrorLogger
1693-
ASSERT(startsWith(GET_REDIRECT_OUTPUT, "<?xml"));
1708+
ASSERT(startsWith(GET_REDIRECT_OUTPUT, ErrorMessage::getXMLHeader("")));
16941709
ASSERT(endsWith(GET_REDIRECT_OUTPUT, "</results>\n"));
16951710
}
16961711

1697-
// TODO: test --errorlist with product name
1712+
void errorlistWithCfg() {
1713+
REDIRECT;
1714+
ScopedFile file("cppcheck.cfg",
1715+
R"({"productName": "The Product"}\n)");
1716+
const char * const argv[] = {"cppcheck", "--errorlist"};
1717+
ASSERT_EQUALS(CmdLineParser::Result::Exit, parser->parseFromArgs(2, argv));
1718+
ASSERT_EQUALS("", logger->str()); // empty since it is logged via ErrorLogger
1719+
ASSERT(startsWith(GET_REDIRECT_OUTPUT, ErrorMessage::getXMLHeader("The Product")));
1720+
}
16981721

16991722
void errorlistExclusive() {
17001723
REDIRECT;
@@ -1705,6 +1728,16 @@ class TestCmdlineParser : public TestFixture {
17051728
ASSERT(endsWith(GET_REDIRECT_OUTPUT, "</results>\n"));
17061729
}
17071730

1731+
void errorlistWithInvalidCfg() {
1732+
REDIRECT;
1733+
ScopedFile file("cppcheck.cfg",
1734+
"{\n");
1735+
const char * const argv[] = {"cppcheck", "--errorlist"};
1736+
ASSERT_EQUALS(CmdLineParser::Result::Fail, parser->parseFromArgs(2, argv));
1737+
ASSERT_EQUALS("cppcheck: error: could not load cppcheck.cfg - not a valid JSON - syntax error at line 1 near: \n", logger->str());
1738+
ASSERT_EQUALS("", GET_REDIRECT_OUTPUT);
1739+
}
1740+
17081741
void ignorepathsnopath() {
17091742
REDIRECT;
17101743
const char * const argv[] = {"cppcheck", "-i"};
@@ -2309,6 +2342,15 @@ class TestCmdlineParser : public TestFixture {
23092342
ASSERT_EQUALS(CmdLineParser::Result::Fail, parser->parseFromArgs(2, argv));
23102343
ASSERT_EQUALS("cppcheck: error: Directory '' specified by --cppcheck-build-dir argument has to be existent.\n", logger->str());
23112344
}
2345+
2346+
void invalidCppcheckCfg() {
2347+
REDIRECT;
2348+
ScopedFile file("cppcheck.cfg",
2349+
"{\n");
2350+
const char * const argv[] = {"cppcheck", "test.cpp"};
2351+
ASSERT_EQUALS(CmdLineParser::Result::Fail, parser->parseFromArgs(2, argv));
2352+
ASSERT_EQUALS("cppcheck: error: could not load cppcheck.cfg - not a valid JSON - syntax error at line 1 near: \n", logger->str());
2353+
}
23122354
};
23132355

23142356
REGISTER_TEST(TestCmdlineParser)

0 commit comments

Comments
 (0)