Skip to content

refs #14111 - testrunner: enforce unique filename in ScopedFile to prevent conflicts in parallel execution #7794

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

refs #14111 - testrunner: enforce unique filename in ScopedFile to prevent conflicts in parallel execution #7794

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8dc9ed0
refs #14111 - testrunner: enforce unique filename in `ScopedFile` to …
firewave Sep 3, 2025
957e5dc
s [skip ci]
firewave Sep 4, 2025
f843ad7
s [skip ci]
firewave Sep 4, 2025
0dc702e
s [skip ci]
firewave Sep 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions test/helpers.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,12 +50,22 @@ class SuppressionList;

const Settings SimpleTokenizer::s_settings;

std::set<std::string> ScopedFile::s_scopedfiles;

// TODO: better path-only usage
ScopedFile::ScopedFile(std::string name, const std::string &content, std::string path)
: mName(std::move(name))
, mPath(Path::toNativeSeparators(std::move(path)))
, mFullPath(Path::join(mPath, mName))
{
if (mPath.empty() && mName.empty()) {
throw std::runtime_error("ScopedFile(" + mFullPath + ") - no file specified");
}

if (!s_scopedfiles.emplace(mFullPath).second) {
throw std::runtime_error("ScopedFile(" + mFullPath + ") - file not unique");
}

if (!mPath.empty() && mPath != Path::getCurrentPath()) {
if (Path::isDirectory(mPath))
throw std::runtime_error("ScopedFile(" + mFullPath + ") - directory already exists");
Expand Down
2 changes: 2 additions & 0 deletions test/helpers.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,8 @@ class ScopedFile {
const std::string mName;
const std::string mPath;
const std::string mFullPath;

static std::set<std::string> s_scopedfiles;
};

class PreprocessorHelper
Expand Down
104 changes: 52 additions & 52 deletions test/testcmdlineparser.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1183,10 +1183,10 @@ class TestCmdlineParser : public TestFixture {

void exitcodeSuppressions() {
REDIRECT;
ScopedFile file("suppr.txt",
ScopedFile file("suppr_ec.txt",
"uninitvar\n"
"unusedFunction\n");
const char * const argv[] = {"cppcheck", "--exitcode-suppressions=suppr.txt", "file.cpp"};
const char * const argv[] = {"cppcheck", "--exitcode-suppressions=suppr_ec.txt", "file.cpp"};
ASSERT_EQUALS_ENUM(CmdLineParser::Result::Success, parseFromArgs(argv));
const auto supprsNofail = supprs->nofail.getSuppressions();
ASSERT_EQUALS(2, supprsNofail.size());
Expand Down Expand Up @@ -1836,10 +1836,10 @@ class TestCmdlineParser : public TestFixture {

void suppressions() {
REDIRECT;
ScopedFile file("suppr.txt",
ScopedFile file("supprs.txt",
"uninitvar\n"
"unusedFunction\n");
const char * const argv[] = {"cppcheck", "--suppressions-list=suppr.txt", "file.cpp"};
const char * const argv[] = {"cppcheck", "--suppressions-list=supprs.txt", "file.cpp"};
ASSERT_EQUALS_ENUM(CmdLineParser::Result::Success, parseFromArgs(argv));
const auto supprsNomsg = supprs->nomsg.getSuppressions();
ASSERT_EQUALS(2, supprsNomsg.size());
Expand Down Expand Up @@ -2467,16 +2467,16 @@ class TestCmdlineParser : public TestFixture {

void projectMultiple() {
REDIRECT;
ScopedFile file("project.cppcheck", "<project></project>");
const char * const argv[] = {"cppcheck", "--project=project.cppcheck", "--project=project.cppcheck", "file.cpp"};
ScopedFile file("project_multi.cppcheck", "<project></project>");
const char * const argv[] = {"cppcheck", "--project=project_multi.cppcheck", "--project=project.cppcheck", "file.cpp"};
ASSERT_EQUALS_ENUM(CmdLineParser::Result::Fail, parseFromArgs(argv));
ASSERT_EQUALS("cppcheck: error: multiple --project options are not supported.\n", logger->str());
}

void projectAndSource() {
REDIRECT;
ScopedFile file("project.cppcheck", "<project></project>");
const char * const argv[] = {"cppcheck", "--project=project.cppcheck", "file.cpp"};
ScopedFile file("project_src.cppcheck", "<project></project>");
const char * const argv[] = {"cppcheck", "--project=project_src.cppcheck", "file.cpp"};
ASSERT_EQUALS_ENUM(CmdLineParser::Result::Fail, parseFromArgs(argv));
ASSERT_EQUALS("cppcheck: error: --project cannot be used in conjunction with source files.\n", logger->str());
}
Expand All @@ -2496,8 +2496,8 @@ class TestCmdlineParser : public TestFixture {
}

void projectNoPaths() {
ScopedFile file("project.cppcheck", "<project></project>");
const char * const argv[] = {"cppcheck", "--project=project.cppcheck"};
ScopedFile file("project_nopaths.cppcheck", "<project></project>");
const char * const argv[] = {"cppcheck", "--project=project_nopaths.cppcheck"};
ASSERT_EQUALS_ENUM(CmdLineParser::Result::Fail, parseFromArgs(argv));
ASSERT_EQUALS("cppcheck: error: no C or C++ source files found.\n", logger->str());
}
Expand Down Expand Up @@ -2582,7 +2582,7 @@ class TestCmdlineParser : public TestFixture {
#ifdef HAVE_RULES
void ruleFileMulti() {
REDIRECT;
ScopedFile file("rule.xml",
ScopedFile file("rule_multi.xml",
"<rules>\n"
"<rule>\n"
"<tokenlist>raw</tokenlist>\n"
Expand All @@ -2603,7 +2603,7 @@ class TestCmdlineParser : public TestFixture {
"</message>\n"
"</rule>\n"
"</rules>");
const char * const argv[] = {"cppcheck", "--rule-file=rule.xml", "file.cpp"};
const char * const argv[] = {"cppcheck", "--rule-file=rule_multi.xml", "file.cpp"};
ASSERT_EQUALS_ENUM(CmdLineParser::Result::Success, parseFromArgs(argv));
ASSERT_EQUALS(2, settings->rules.size());
auto it = settings->rules.cbegin();
Expand All @@ -2622,7 +2622,7 @@ class TestCmdlineParser : public TestFixture {

void ruleFileSingle() {
REDIRECT;
ScopedFile file("rule.xml",
ScopedFile file("rule_single.xml",
"<rule>\n"
"<tokenlist>define</tokenlist>\n"
"<pattern>.+</pattern>\n"
Expand All @@ -2632,7 +2632,7 @@ class TestCmdlineParser : public TestFixture {
"<summary>ruleSummary</summary>\n"
"</message>\n"
"</rule>\n");
const char * const argv[] = {"cppcheck", "--rule-file=rule.xml", "file.cpp"};
const char * const argv[] = {"cppcheck", "--rule-file=rule_single.xml", "file.cpp"};
ASSERT_EQUALS_ENUM(CmdLineParser::Result::Success, parseFromArgs(argv));
ASSERT_EQUALS(1, settings->rules.size());
auto it = settings->rules.cbegin();
Expand All @@ -2659,37 +2659,37 @@ class TestCmdlineParser : public TestFixture {

void ruleFileInvalid() {
REDIRECT;
ScopedFile file("rule.xml", "");
const char * const argv[] = {"cppcheck", "--rule-file=rule.xml", "file.cpp"};
ScopedFile file("rule_invalid.xml", "");
const char * const argv[] = {"cppcheck", "--rule-file=rule_invalid.xml", "file.cpp"};
ASSERT_EQUALS_ENUM(CmdLineParser::Result::Fail, parseFromArgs(argv));
ASSERT_EQUALS("cppcheck: error: unable to load rule-file 'rule.xml' (XML_ERROR_EMPTY_DOCUMENT).\n", logger->str());
ASSERT_EQUALS("cppcheck: error: unable to load rule-file 'rule_invalid.xml' (XML_ERROR_EMPTY_DOCUMENT).\n", logger->str());
}

void ruleFileNoRoot() {
REDIRECT;
ScopedFile file("rule.xml", "<?xml version=\"1.0\"?>");
const char * const argv[] = {"cppcheck", "--rule-file=rule.xml", "file.cpp"};
ScopedFile file("rule_noroot.xml", "<?xml version=\"1.0\"?>");
const char * const argv[] = {"cppcheck", "--rule-file=rule_noroot.xml", "file.cpp"};
ASSERT_EQUALS_ENUM(CmdLineParser::Result::Success, parseFromArgs(argv));
ASSERT_EQUALS(0, settings->rules.size());
}

void ruleFileEmptyElements1() {
REDIRECT;
ScopedFile file("rule.xml",
ScopedFile file("rule_empty_elems_1.xml",
"<rule>"
"<tokenlist/>"
"<pattern/>"
"<message/>"
"</rule>"
);
const char * const argv[] = {"cppcheck", "--rule-file=rule.xml", "file.cpp"};
const char * const argv[] = {"cppcheck", "--rule-file=rule_empty_elems_1.xml", "file.cpp"};
ASSERT_EQUALS_ENUM(CmdLineParser::Result::Fail, parseFromArgs(argv)); // do not crash
ASSERT_EQUALS("cppcheck: error: unable to load rule-file 'rule.xml' - a rule is lacking a pattern.\n", logger->str());
ASSERT_EQUALS("cppcheck: error: unable to load rule-file 'rule_empty_elems_1.xml' - a rule is lacking a pattern.\n", logger->str());
}

void ruleFileEmptyElements2() {
REDIRECT;
ScopedFile file("rule.xml",
ScopedFile file("rule_empty_elems_2.xml",
"<rule>"
"<message>"
"<severity/>"
Expand All @@ -2698,101 +2698,101 @@ class TestCmdlineParser : public TestFixture {
"</message>"
"</rule>"
);
const char * const argv[] = {"cppcheck", "--rule-file=rule.xml", "file.cpp"};
const char * const argv[] = {"cppcheck", "--rule-file=rule_empty_elems_2.xml", "file.cpp"};
ASSERT_EQUALS_ENUM(CmdLineParser::Result::Fail, parseFromArgs(argv)); // do not crash
ASSERT_EQUALS("cppcheck: error: unable to load rule-file 'rule.xml' - a rule is lacking a pattern.\n", logger->str());
ASSERT_EQUALS("cppcheck: error: unable to load rule-file 'rule_empty_elems_2.xml' - a rule is lacking a pattern.\n", logger->str());
}

void ruleFileUnknownElement1() {
REDIRECT;
ScopedFile file("rule.xml",
ScopedFile file("rule_unk_elems_1.xml",
"<rule>"
"<messages/>"
"</rule>"
);
const char * const argv[] = {"cppcheck", "--rule-file=rule.xml", "file.cpp"};
const char * const argv[] = {"cppcheck", "--rule-file=rule_unk_elems_1.xml", "file.cpp"};
ASSERT_EQUALS_ENUM(CmdLineParser::Result::Fail, parseFromArgs(argv));
ASSERT_EQUALS("cppcheck: error: unable to load rule-file 'rule.xml' - unknown element 'messages' encountered in 'rule'.\n", logger->str());
ASSERT_EQUALS("cppcheck: error: unable to load rule-file 'rule_unk_elems_1.xml' - unknown element 'messages' encountered in 'rule'.\n", logger->str());
}

void ruleFileUnknownElement2() {
REDIRECT;
ScopedFile file("rule.xml",
ScopedFile file("rule_unk_elems_2.xml",
"<rule>"
"<message>"
"<pattern/>"
"</message>"
"</rule>"
);
const char * const argv[] = {"cppcheck", "--rule-file=rule.xml", "file.cpp"};
const char * const argv[] = {"cppcheck", "--rule-file=rule_unk_elems_2.xml", "file.cpp"};
ASSERT_EQUALS_ENUM(CmdLineParser::Result::Fail, parseFromArgs(argv));
ASSERT_EQUALS("cppcheck: error: unable to load rule-file 'rule.xml' - unknown element 'pattern' encountered in 'message'.\n", logger->str());
ASSERT_EQUALS("cppcheck: error: unable to load rule-file 'rule_unk_elems_2.xml' - unknown element 'pattern' encountered in 'message'.\n", logger->str());
}

void ruleFileMissingTokenList() {
REDIRECT;
ScopedFile file("rule.xml",
ScopedFile file("rule_missing_toklist.xml",
"<rule>\n"
"<tokenlist/>\n"
"<pattern>.+</pattern>\n"
"</rule>\n");
const char * const argv[] = {"cppcheck", "--rule-file=rule.xml", "file.cpp"};
const char * const argv[] = {"cppcheck", "--rule-file=rule_missing_toklist.xml", "file.cpp"};
ASSERT_EQUALS_ENUM(CmdLineParser::Result::Fail, parseFromArgs(argv));
ASSERT_EQUALS("cppcheck: error: unable to load rule-file 'rule.xml' - a rule is lacking a tokenlist.\n", logger->str());
ASSERT_EQUALS("cppcheck: error: unable to load rule-file 'rule_missing_toklist.xml' - a rule is lacking a tokenlist.\n", logger->str());
}

void ruleFileUnknownTokenList() {
REDIRECT;
ScopedFile file("rule.xml",
ScopedFile file("rule_unk_toklist.xml",
"<rule>\n"
"<tokenlist>simple</tokenlist>\n"
"<pattern>.+</pattern>\n"
"</rule>\n");
const char * const argv[] = {"cppcheck", "--rule-file=rule.xml", "file.cpp"};
const char * const argv[] = {"cppcheck", "--rule-file=rule_unk_toklist.xml", "file.cpp"};
ASSERT_EQUALS_ENUM(CmdLineParser::Result::Fail, parseFromArgs(argv));
ASSERT_EQUALS("cppcheck: error: unable to load rule-file 'rule.xml' - a rule is using the unsupported tokenlist 'simple'.\n", logger->str());
ASSERT_EQUALS("cppcheck: error: unable to load rule-file 'rule_unk_toklist.xml' - a rule is using the unsupported tokenlist 'simple'.\n", logger->str());
}

void ruleFileMissingId() {
REDIRECT;
ScopedFile file("rule.xml",
ScopedFile file("rule_missing_id.xml",
"<rule>\n"
"<pattern>.+</pattern>\n"
"<message>\n"
"<id/>"
"</message>\n"
"</rule>\n");
const char * const argv[] = {"cppcheck", "--rule-file=rule.xml", "file.cpp"};
const char * const argv[] = {"cppcheck", "--rule-file=rule_missing_id.xml", "file.cpp"};
ASSERT_EQUALS_ENUM(CmdLineParser::Result::Fail, parseFromArgs(argv));
ASSERT_EQUALS("cppcheck: error: unable to load rule-file 'rule.xml' - a rule is lacking an id.\n", logger->str());
ASSERT_EQUALS("cppcheck: error: unable to load rule-file 'rule_missing_id.xml' - a rule is lacking an id.\n", logger->str());
}

void ruleFileInvalidSeverity1() {
REDIRECT;
ScopedFile file("rule.xml",
ScopedFile file("rule_invalid_sev_1.xml",
"<rule>\n"
"<pattern>.+</pattern>\n"
"<message>\n"
"<severity/>"
"</message>\n"
"</rule>\n");
const char * const argv[] = {"cppcheck", "--rule-file=rule.xml", "file.cpp"};
const char * const argv[] = {"cppcheck", "--rule-file=rule_invalid_sev_1.xml", "file.cpp"};
ASSERT_EQUALS_ENUM(CmdLineParser::Result::Fail, parseFromArgs(argv));
ASSERT_EQUALS("cppcheck: error: unable to load rule-file 'rule.xml' - a rule has an invalid severity.\n", logger->str());
ASSERT_EQUALS("cppcheck: error: unable to load rule-file 'rule_invalid_sev_1.xml' - a rule has an invalid severity.\n", logger->str());
}

void ruleFileInvalidSeverity2() {
REDIRECT;
ScopedFile file("rule.xml",
ScopedFile file("rule_invalid_sev_2.xml",
"<rule>\n"
"<pattern>.+</pattern>\n"
"<message>\n"
"<severity>none</severity>"
"</message>\n"
"</rule>\n");
const char * const argv[] = {"cppcheck", "--rule-file=rule.xml", "file.cpp"};
const char * const argv[] = {"cppcheck", "--rule-file=rule_invalid_sev_2.xml", "file.cpp"};
ASSERT_EQUALS_ENUM(CmdLineParser::Result::Fail, parseFromArgs(argv));
ASSERT_EQUALS("cppcheck: error: unable to load rule-file 'rule.xml' - a rule has an invalid severity.\n", logger->str());
ASSERT_EQUALS("cppcheck: error: unable to load rule-file 'rule_invalid_sev_2.xml' - a rule has an invalid severity.\n", logger->str());
}
#else
void ruleFileNotSupported() {
Expand Down Expand Up @@ -2876,18 +2876,18 @@ class TestCmdlineParser : public TestFixture {

void suppressXmlInvalid() {
REDIRECT;
ScopedFile file("suppress.xml", "");
const char * const argv[] = {"cppcheck", "--suppress-xml=suppress.xml", "file.cpp"};
ScopedFile file("suppress_invalid.xml", "");
const char * const argv[] = {"cppcheck", "--suppress-xml=suppress_invalid.xml", "file.cpp"};
ASSERT_EQUALS_ENUM(CmdLineParser::Result::Fail, parseFromArgs(argv));
ASSERT_EQUALS("cppcheck: error: failed to load suppressions XML 'suppress.xml' (XML_ERROR_EMPTY_DOCUMENT).\n", logger->str());
ASSERT_EQUALS("cppcheck: error: failed to load suppressions XML 'suppress_invalid.xml' (XML_ERROR_EMPTY_DOCUMENT).\n", logger->str());
}

void suppressXmlNoRoot() {
REDIRECT;
ScopedFile file("suppress.xml", "<?xml version=\"1.0\"?>");
const char * const argv[] = {"cppcheck", "--suppress-xml=suppress.xml", "file.cpp"};
ScopedFile file("suppress_noroot.xml", "<?xml version=\"1.0\"?>");
const char * const argv[] = {"cppcheck", "--suppress-xml=suppress_noroot.xml", "file.cpp"};
ASSERT_EQUALS_ENUM(CmdLineParser::Result::Fail, parseFromArgs(argv));
ASSERT_EQUALS("cppcheck: error: failed to load suppressions XML 'suppress.xml' (no root node found).\n", logger->str());
ASSERT_EQUALS("cppcheck: error: failed to load suppressions XML 'suppress_noroot.xml' (no root node found).\n", logger->str());
}

void executorDefault() {
Expand Down
Loading