walkero
/
cppcheck
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity

some small `CmdLineParser` cleanups and improvements (#4654)

This commit is contained in:
Oliver Stöneberg 2022-12-19 22:28:36 +01:00 committed by GitHub
parent 6fedbb4f77
commit 2cd8bb94e4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 29 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
cli/cmdlineparser.cpp
View File

@ -53,15 +53,16 @@
#include <unistd.h> #include <unistd.h>
#endif #endif
static void addFilesToList(const std::string& fileList, std::vector<std::string>& pathNames) static bool addFilesToList(const std::string& fileList, std::vector<std::string>& pathNames)
{ {
// To keep things initially simple, if the file can't be opened, just be silent and move on.
std::istream *files; std::istream *files;
std::ifstream infile; std::ifstream infile;
if (fileList == "-") { // read from stdin if (fileList == "-") { // read from stdin
files = &std::cin; files = &std::cin;
} else { } else {
infile.open(fileList); infile.open(fileList);
if (!infile.is_open())
return false;
files = &infile; files = &infile;
} }
if (files && *files) { if (files && *files) {
@ -74,6 +75,7 @@ static void addFilesToList(const std::string& fileList, std::vector<std::string>
} }
} }
} }
return true;
} }
static bool addIncludePathsToList(const std::string& fileList, std::list<std::string>* pathNames) static bool addIncludePathsToList(const std::string& fileList, std::list<std::string>* pathNames)
@ -126,6 +128,8 @@ void CmdLineParser::printError(const std::string &message)
printMessage("error: " + message); printMessage("error: " + message);
} }
// TODO: normalize/simplify/native all path parameters
// TODO: error out on all missing given files/paths
bool CmdLineParser::parseFromArgs(int argc, const char* const argv[]) bool CmdLineParser::parseFromArgs(int argc, const char* const argv[])
{ {
bool def = false; bool def = false;
@ -338,7 +342,6 @@ bool CmdLineParser::parseFromArgs(int argc, const char* const argv[])
const std::string temp = argv[i]+17; const std::string temp = argv[i]+17;
std::istringstream iss(temp); std::istringstream iss(temp);
if (!(iss >> mSettings->exitCode)) { if (!(iss >> mSettings->exitCode)) {
mSettings->exitCode = 0;
printError("argument must be an integer. Try something like '--error-exitcode=1'."); printError("argument must be an integer. Try something like '--error-exitcode=1'.");
return false; return false;
} }
@ -382,9 +385,14 @@ bool CmdLineParser::parseFromArgs(int argc, const char* const argv[])
mSettings->fileFilters.emplace_back(argv[i] + 14); mSettings->fileFilters.emplace_back(argv[i] + 14);
// file list specified // file list specified
else if (std::strncmp(argv[i], "--file-list=", 12) == 0) else if (std::strncmp(argv[i], "--file-list=", 12) == 0) {
// open this file and read every input file (1 file name per line) // open this file and read every input file (1 file name per line)
addFilesToList(12 + argv[i], mPathNames); const std::string fileList = argv[i] + 12;
if (!addFilesToList(fileList, mPathNames)) {
printError("couldn't open the file: \"" + fileList + "\".");
return false;
}
}
// Force checking of files that have "too many" configurations // Force checking of files that have "too many" configurations
else if (std::strcmp(argv[i], "-f") == 0 || std::strcmp(argv[i], "--force") == 0) else if (std::strcmp(argv[i], "-f") == 0 || std::strcmp(argv[i], "--force") == 0)

1
releasenotes.txt
View File

@ -1,3 +1,4 @@
release notes for cppcheck-2.10 release notes for cppcheck-2.10
- the deprecated Makefile option SRCDIR is no longer accepted - the deprecated Makefile option SRCDIR is no longer accepted
- if the file provided via "--file-list" cannot be opened it will now error out

48
test/testcmdlineparser.cpp
View File

@ -41,7 +41,7 @@ public:
private: private:
Settings settings; // TODO: reset after each test Settings settings; // TODO: reset after each test
CmdLineParser defParser; CmdLineParser defParser; // TODO: reset after each test
void run() override { void run() override {
TEST_CASE(nooptions); TEST_CASE(nooptions);
@ -95,8 +95,8 @@ private:
TEST_CASE(exitcodeSuppressionsOld); TEST_CASE(exitcodeSuppressionsOld);
TEST_CASE(exitcodeSuppressions); TEST_CASE(exitcodeSuppressions);
TEST_CASE(exitcodeSuppressionsNoFile); TEST_CASE(exitcodeSuppressionsNoFile);
//TEST_CASE(fileList); TEST_CASE(fileList);
//TEST_CASE(fileListNoFile); TEST_CASE(fileListNoFile);
// TEST_CASE(fileListStdin); // Disabled since hangs the test run // TEST_CASE(fileListStdin); // Disabled since hangs the test run
TEST_CASE(fileListInvalid); TEST_CASE(fileListInvalid);
TEST_CASE(inlineSuppr); TEST_CASE(inlineSuppr);
@ -526,16 +526,13 @@ private:
void includesFile() { void includesFile() {
REDIRECT; REDIRECT;
const char * const argv[] = {"cppcheck", "--includes-file=fileThatDoesNotExist.txt", "file.cpp"}; const char * const argv[] = {"cppcheck", "--includes-file=fileThatDoesNotExist.txt", "file.cpp"};
settings.includePaths.clear();
TODO_ASSERT_EQUALS(true, false, defParser.parseFromArgs(3, argv)); TODO_ASSERT_EQUALS(true, false, defParser.parseFromArgs(3, argv));
TODO_ASSERT_EQUALS(3, 0, settings.includePaths.size());
TODO_ASSERT_EQUALS("", "cppcheck: error: unable to open includes file at 'fileThatDoesNotExist.txt'\n", GET_REDIRECT_OUTPUT); TODO_ASSERT_EQUALS("", "cppcheck: error: unable to open includes file at 'fileThatDoesNotExist.txt'\n", GET_REDIRECT_OUTPUT);
} }
void includesFileNoFile() { void includesFileNoFile() {
REDIRECT; REDIRECT;
const char * const argv[] = {"cppcheck", "--includes-file=fileThatDoesNotExist.txt", "file.cpp"}; const char * const argv[] = {"cppcheck", "--includes-file=fileThatDoesNotExist.txt", "file.cpp"};
settings.includePaths.clear();
ASSERT_EQUALS(false, defParser.parseFromArgs(3, argv)); ASSERT_EQUALS(false, defParser.parseFromArgs(3, argv));
ASSERT_EQUALS("cppcheck: error: unable to open includes file at 'fileThatDoesNotExist.txt'\n", GET_REDIRECT_OUTPUT); ASSERT_EQUALS("cppcheck: error: unable to open includes file at 'fileThatDoesNotExist.txt'\n", GET_REDIRECT_OUTPUT);
} }
@ -553,7 +550,6 @@ private:
void configExcludesFileNoFile() { void configExcludesFileNoFile() {
REDIRECT; REDIRECT;
const char * const argv[] = {"cppcheck", "--config-excludes-file=fileThatDoesNotExist.txt", "file.cpp"}; const char * const argv[] = {"cppcheck", "--config-excludes-file=fileThatDoesNotExist.txt", "file.cpp"};
settings.includePaths.clear();
ASSERT_EQUALS( false, defParser.parseFromArgs(3, argv)); ASSERT_EQUALS( false, defParser.parseFromArgs(3, argv));
ASSERT_EQUALS("cppcheck: error: unable to open config excludes file at 'fileThatDoesNotExist.txt'\n", GET_REDIRECT_OUTPUT); ASSERT_EQUALS("cppcheck: error: unable to open config excludes file at 'fileThatDoesNotExist.txt'\n", GET_REDIRECT_OUTPUT);
} }
@ -677,7 +673,6 @@ private:
void errorExitcodeMissing() { void errorExitcodeMissing() {
REDIRECT; REDIRECT;
const char * const argv[] = {"cppcheck", "--error-exitcode=", "file.cpp"}; const char * const argv[] = {"cppcheck", "--error-exitcode=", "file.cpp"};
settings.exitCode = 0;
// Fails since exit code not given // Fails since exit code not given
ASSERT_EQUALS(false, defParser.parseFromArgs(3, argv)); ASSERT_EQUALS(false, defParser.parseFromArgs(3, argv));
ASSERT_EQUALS("cppcheck: error: argument must be an integer. Try something like '--error-exitcode=1'.\n", GET_REDIRECT_OUTPUT); ASSERT_EQUALS("cppcheck: error: argument must be an integer. Try something like '--error-exitcode=1'.\n", GET_REDIRECT_OUTPUT);
@ -686,7 +681,6 @@ private:
void errorExitcodeStr() { void errorExitcodeStr() {
REDIRECT; REDIRECT;
const char * const argv[] = {"cppcheck", "--error-exitcode=foo", "file.cpp"}; const char * const argv[] = {"cppcheck", "--error-exitcode=foo", "file.cpp"};
settings.exitCode = 0;
// Fails since invalid exit code // Fails since invalid exit code
ASSERT_EQUALS(false, defParser.parseFromArgs(3, argv)); ASSERT_EQUALS(false, defParser.parseFromArgs(3, argv));
ASSERT_EQUALS("cppcheck: error: argument must be an integer. Try something like '--error-exitcode=1'.\n", GET_REDIRECT_OUTPUT); ASSERT_EQUALS("cppcheck: error: argument must be an integer. Try something like '--error-exitcode=1'.\n", GET_REDIRECT_OUTPUT);
@ -695,7 +689,6 @@ private:
void exitcodeSuppressionsOld() { void exitcodeSuppressionsOld() {
REDIRECT; REDIRECT;
const char * const argv[] = {"cppcheck", "--exitcode-suppressions", "suppr.txt", "file.cpp"}; const char * const argv[] = {"cppcheck", "--exitcode-suppressions", "suppr.txt", "file.cpp"};
settings.exitCode = 0;
ASSERT_EQUALS(false, defParser.parseFromArgs(4, argv)); ASSERT_EQUALS(false, defParser.parseFromArgs(4, argv));
ASSERT_EQUALS("cppcheck: error: unrecognized command line option: \"--exitcode-suppressions\".\n", GET_REDIRECT_OUTPUT); ASSERT_EQUALS("cppcheck: error: unrecognized command line option: \"--exitcode-suppressions\".\n", GET_REDIRECT_OUTPUT);
} }
@ -704,7 +697,6 @@ private:
// TODO: Fails since cannot open the file // TODO: Fails since cannot open the file
REDIRECT; REDIRECT;
const char * const argv[] = {"cppcheck", "--exitcode-suppressions=suppr.txt", "file.cpp"}; const char * const argv[] = {"cppcheck", "--exitcode-suppressions=suppr.txt", "file.cpp"};
settings.exitCode = 0;
TODO_ASSERT_EQUALS(true, false, defParser.parseFromArgs(3, argv)); TODO_ASSERT_EQUALS(true, false, defParser.parseFromArgs(3, argv));
TODO_ASSERT_EQUALS("", "cppcheck: error: couldn't open the file: \"suppr.txt\".\n", GET_REDIRECT_OUTPUT); TODO_ASSERT_EQUALS("", "cppcheck: error: couldn't open the file: \"suppr.txt\".\n", GET_REDIRECT_OUTPUT);
} }
@ -712,33 +704,26 @@ private:
void exitcodeSuppressionsNoFile() { void exitcodeSuppressionsNoFile() {
REDIRECT; REDIRECT;
const char * const argv[] = {"cppcheck", "--exitcode-suppressions", "file.cpp"}; const char * const argv[] = {"cppcheck", "--exitcode-suppressions", "file.cpp"};
settings.exitCode = 0;
ASSERT_EQUALS(false, defParser.parseFromArgs(3, argv)); ASSERT_EQUALS(false, defParser.parseFromArgs(3, argv));
ASSERT_EQUALS("cppcheck: error: unrecognized command line option: \"--exitcode-suppressions\".\n", GET_REDIRECT_OUTPUT); ASSERT_EQUALS("cppcheck: error: unrecognized command line option: \"--exitcode-suppressions\".\n", GET_REDIRECT_OUTPUT);
} }
// TODO: AddressSanitizer: stack-buffer-overflow // TODO: file does not exist
// TODO: nothing is read since the file does not exist void fileList() {
/*
void fileList() {
REDIRECT; REDIRECT;
const char * const argv[] = {"cppcheck", "--file-list=files.txt", "file.cpp"}; const char * const argv[] = {"cppcheck", "--file-list=files.txt", "file.cpp"};
ASSERT_EQUALS(true, defParser.parseFromArgs(4, argv)); TODO_ASSERT_EQUALS(true, false, defParser.parseFromArgs(3, argv));
// TODO: settings are not being reset after each test // TODO: settings are not being reset after each test
//TODO_ASSERT_EQUALS(4, 1, defParser.getPathNames().size()); //TODO_ASSERT_EQUALS(4, 1, defParser.getPathNames().size());
ASSERT_EQUALS("", GET_REDIRECT_OUTPUT); TODO_ASSERT_EQUALS("", "cppcheck: error: couldn't open the file: \"files.txt\".\n", GET_REDIRECT_OUTPUT);
} }
*/
// TODO: should fail since the file is missing void fileListNoFile() {
/*
void fileListNoFile() {
REDIRECT; REDIRECT;
const char * const argv[] = {"cppcheck", "--file-list=files.txt", "file.cpp"}; const char * const argv[] = {"cppcheck", "--file-list=files.txt", "file.cpp"};
TODO_ASSERT_EQUALS(false, true, defParser.parseFromArgs(4, argv)); ASSERT_EQUALS(false, defParser.parseFromArgs(3, argv));
TODO_ASSERT_EQUALS("cppcheck: error: error: couldn't open the file: \"files.txt\".\n", "", GET_REDIRECT_OUTPUT); ASSERT_EQUALS("cppcheck: error: couldn't open the file: \"files.txt\".\n", GET_REDIRECT_OUTPUT);
} }
*/
/* void fileListStdin() { /* void fileListStdin() {
// TODO: Give it some stdin to read from, fails because the list of // TODO: Give it some stdin to read from, fails because the list of
@ -759,7 +744,9 @@ private:
void inlineSuppr() { void inlineSuppr() {
REDIRECT; REDIRECT;
const char * const argv[] = {"cppcheck", "--inline-suppr", "file.cpp"}; const char * const argv[] = {"cppcheck", "--inline-suppr", "file.cpp"};
settings.inlineSuppressions = false;
ASSERT(defParser.parseFromArgs(3, argv)); ASSERT(defParser.parseFromArgs(3, argv));
ASSERT(settings.inlineSuppressions);
ASSERT_EQUALS("", GET_REDIRECT_OUTPUT); ASSERT_EQUALS("", GET_REDIRECT_OUTPUT);
} }
@ -775,7 +762,6 @@ private:
void jobsMissingCount() { void jobsMissingCount() {
REDIRECT; REDIRECT;
const char * const argv[] = {"cppcheck", "-j", "file.cpp"}; const char * const argv[] = {"cppcheck", "-j", "file.cpp"};
settings.jobs = 0;
// Fails since -j is missing thread count // Fails since -j is missing thread count
ASSERT_EQUALS(false, defParser.parseFromArgs(3, argv)); ASSERT_EQUALS(false, defParser.parseFromArgs(3, argv));
ASSERT_EQUALS("cppcheck: error: argument to '-j' is not a number.\n", GET_REDIRECT_OUTPUT); ASSERT_EQUALS("cppcheck: error: argument to '-j' is not a number.\n", GET_REDIRECT_OUTPUT);
@ -784,7 +770,6 @@ private:
void jobsInvalid() { void jobsInvalid() {
REDIRECT; REDIRECT;
const char * const argv[] = {"cppcheck", "-j", "e", "file.cpp"}; const char * const argv[] = {"cppcheck", "-j", "e", "file.cpp"};
settings.jobs = 0;
// Fails since invalid count given for -j // Fails since invalid count given for -j
ASSERT_EQUALS(false, defParser.parseFromArgs(4, argv)); ASSERT_EQUALS(false, defParser.parseFromArgs(4, argv));
ASSERT_EQUALS("cppcheck: error: argument to '-j' is not a number.\n", GET_REDIRECT_OUTPUT); ASSERT_EQUALS("cppcheck: error: argument to '-j' is not a number.\n", GET_REDIRECT_OUTPUT);
@ -794,7 +779,7 @@ private:
REDIRECT; REDIRECT;
const char * const argv[] = {"cppcheck", "-f", "--max-configs=12", "file.cpp"}; const char * const argv[] = {"cppcheck", "-f", "--max-configs=12", "file.cpp"};
settings.force = false; settings.force = false;
settings.maxConfigs = 12; settings.maxConfigs = 0;
ASSERT(defParser.parseFromArgs(4, argv)); ASSERT(defParser.parseFromArgs(4, argv));
ASSERT_EQUALS(12, settings.maxConfigs); ASSERT_EQUALS(12, settings.maxConfigs);
ASSERT_EQUALS(false, settings.force); ASSERT_EQUALS(false, settings.force);
@ -945,7 +930,6 @@ private:
void platformUnknown() { void platformUnknown() {
REDIRECT; REDIRECT;
const char * const argv[] = {"cppcheck", "--platform=win128", "file.cpp"}; const char * const argv[] = {"cppcheck", "--platform=win128", "file.cpp"};
ASSERT(settings.platform(Settings::Unspecified));
ASSERT(!defParser.parseFromArgs(3, argv)); ASSERT(!defParser.parseFromArgs(3, argv));
ASSERT_EQUALS("cppcheck: error: unrecognized platform: \"win128\".\n", GET_REDIRECT_OUTPUT); ASSERT_EQUALS("cppcheck: error: unrecognized platform: \"win128\".\n", GET_REDIRECT_OUTPUT);
} }
@ -962,7 +946,6 @@ private:
void plistDoesNotExist() { void plistDoesNotExist() {
REDIRECT; REDIRECT;
const char * const argv[] = {"cppcheck", "--plist-output=./cppcheck_reports", "file.cpp"}; const char * const argv[] = {"cppcheck", "--plist-output=./cppcheck_reports", "file.cpp"};
settings.plistOutput = "";
// Fails since folder pointed by --plist-output= does not exist // Fails since folder pointed by --plist-output= does not exist
ASSERT_EQUALS(false, defParser.parseFromArgs(3, argv)); ASSERT_EQUALS(false, defParser.parseFromArgs(3, argv));
// TODO: output contains non-native separator // TODO: output contains non-native separator
@ -1198,7 +1181,6 @@ private:
CmdLineParser parser(&settings); CmdLineParser parser(&settings);
// Fails since no ignored path given // Fails since no ignored path given
ASSERT_EQUALS(false, parser.parseFromArgs(2, argv)); ASSERT_EQUALS(false, parser.parseFromArgs(2, argv));
ASSERT_EQUALS(0, parser.getIgnoredPaths().size());
ASSERT_EQUALS("cppcheck: error: argument to '-i' is missing.\n", GET_REDIRECT_OUTPUT); ASSERT_EQUALS("cppcheck: error: argument to '-i' is missing.\n", GET_REDIRECT_OUTPUT);
} }