Skip to content

fix #13431: consolidate CLI options for XML output format #7700

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

Merged
danmar merged 5 commits into from
Aug 7, 2025
Merged

fix #13431: consolidate CLI options for XML output format #7700

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a93ef00
forbid mixing --xml... and --output-format
ludviggunne Jul 24, 2025
8e0526d
add --output-format arguments xml2 & xml3
ludviggunne Jul 24, 2025
1e29668
add/update cmdlineparser tests
ludviggunne Jul 24, 2025
99843e6
rename xmlX -> xmlvX
ludviggunne Aug 5, 2025
c5cd0e7
split tests
ludviggunne Aug 5, 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
37 changes: 34 additions & 3 deletions cli/cmdlineparser.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -315,6 +315,9 @@ CmdLineParser::Result CmdLineParser::parseFromArgs(int argc, const char* const a
{
mSettings.exename = Path::getCurrentExecutablePath(argv[0]);

bool xmlOptionProvided = false;
bool outputFormatOptionProvided = false;

// default to --check-level=normal from CLI for now
mSettings.setCheckLevel(Settings::CheckLevel::normal);

Expand Down Expand Up @@ -1001,6 +1004,10 @@ CmdLineParser::Result CmdLineParser::parseFromArgs(int argc, const char* const a
mSettings.outputFile = Path::simplifyPath(argv[i] + 14);

else if (std::strncmp(argv[i], "--output-format=", 16) == 0) {
if (xmlOptionProvided) {
outputFormatOptionMixingError();
return Result::Fail;
}
const std::string format = argv[i] + 16;
// plist can not be handled here because it requires additional data
if (format == "text")
Expand All @@ -1009,11 +1016,18 @@ CmdLineParser::Result CmdLineParser::parseFromArgs(int argc, const char* const a
mSettings.outputFormat = Settings::OutputFormat::sarif;
else if (format == "xml")
mSettings.outputFormat = Settings::OutputFormat::xml;
else {
mLogger.printError("argument to '--output-format=' must be 'text', 'sarif' or 'xml'.");
else if (format == "xmlv2") {
mSettings.outputFormat = Settings::OutputFormat::xml;
mSettings.xml_version = 2;
} else if (format == "xmlv3") {
mSettings.outputFormat = Settings::OutputFormat::xml;
mSettings.xml_version = 3;
} else {
mLogger.printError("argument to '--output-format=' must be 'text', 'sarif', 'xml' (deprecated), 'xmlv2' or 'xmlv3'.");
return Result::Fail;
}
mSettings.plistOutput = "";
outputFormatOptionProvided = true;
}


Expand Down Expand Up @@ -1486,11 +1500,20 @@ CmdLineParser::Result CmdLineParser::parseFromArgs(int argc, const char* const a

// Write results in results.xml
else if (std::strcmp(argv[i], "--xml") == 0) {
if (outputFormatOptionProvided) {
outputFormatOptionMixingError();
return Result::Fail;
}
mSettings.outputFormat = Settings::OutputFormat::xml;
xmlOptionProvided = true;
}

// Define the XML file version (and enable XML output)
else if (std::strncmp(argv[i], "--xml-version=", 14) == 0) {
if (outputFormatOptionProvided) {
outputFormatOptionMixingError();
return Result::Fail;
}
int tmp;
if (!parseNumberArg(argv[i], 14, tmp))
return Result::Fail;
Expand All @@ -1503,6 +1526,7 @@ CmdLineParser::Result CmdLineParser::parseFromArgs(int argc, const char* const a
mSettings.xml_version = tmp;
// Enable also XML if version is set
mSettings.outputFormat = Settings::OutputFormat::xml;
xmlOptionProvided = true;
}

else {
Expand Down Expand Up @@ -1814,7 +1838,9 @@ void CmdLineParser::printHelp() const
" Specify the output format. The available formats are:\n"
" * text\n"
" * sarif\n"
" * xml\n"
" * xml (deprecated)\n"
Copy link
Copy Markdown
Collaborator

@firewave firewave Aug 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this is deprecated we should show a message to the user about it when used and determine a version when this will be removed. As xmlv2 has been the default for a long time already I think it should be fine if this is removed in 2.20. The import code in the GUI and htmlreport should also reflect that.

Maybe also mention that text is the default.

We should also have a releasenotes.txt entry and ticket for the deprecation. And another for the planned removal.

Given the additional scope the whole deprecation thing should be done in a follow-up PR though.

Copy link
Copy Markdown
Collaborator

@firewave firewave Aug 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The --xml* options should be deprecated as well but I would not do that until we can show the CLI messages as findings.

Copy link
Copy Markdown
Collaborator

@danmar danmar Aug 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The --xml* options should be deprecated as well but I would not do that until we can show the CLI messages as findings.

not sure why we would deprecate those? it would break A LOT of scripts to remove them. we can just hide them from the --help output.

Copy link
Copy Markdown
Collaborator

@firewave firewave Aug 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I filed https://trac.cppcheck.net/ticket/14055 and https://trac.cppcheck.net/ticket/14056 about this.

not sure why we would deprecate those?

So we do not have multiple ways to achieve the same. Also so the logic added here is not actually necessary.

" * xmlv2\n"
" * xmlv3\n"
" --platform=<type>, --platform=<file>\n"
" Specifies platform specific types and sizes. The\n"
" available builtin platforms are:\n"
Expand Down Expand Up @@ -2149,3 +2175,8 @@ std::list<FileWithDetails> CmdLineParser::filterFiles(const std::vector<std::str
});
return files;
}

void CmdLineParser::outputFormatOptionMixingError() const
{
mLogger.printError("'--output-format' and '--xml...' may not be used in conjunction.");
}
2 changes: 2 additions & 0 deletions cli/cmdlineparser.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,8 @@ class CmdLineParser {
bool mAnalyzeAllVsConfigsSetOnCmdLine = false;
/** @brief Name of the language that is enforced. Empty per default. */
Standards::Language mEnforcedLang{Standards::Language::None};

void outputFormatOptionMixingError() const;
};

/// @}
Expand Down
44 changes: 43 additions & 1 deletion test/testcmdlineparser.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,10 +227,15 @@ class TestCmdlineParser : public TestFixture {
TEST_CASE(outputFormatText);
TEST_CASE(outputFormatSarif);
TEST_CASE(outputFormatXml);
TEST_CASE(outputFormatXmlv2);
TEST_CASE(outputFormatXmlv3);
TEST_CASE(outputFormatOther);
TEST_CASE(outputFormatImplicitPlist);
TEST_CASE(outputFormatImplicitXml);
TEST_CASE(outputFormatOverridePlist);
TEST_CASE(outputFormatMixed1);
TEST_CASE(outputFormatMixed2);
TEST_CASE(outputFormatMixed3);
TEST_CASE(premiumOptions1);
TEST_CASE(premiumOptions2);
TEST_CASE(premiumOptions3);
Expand Down Expand Up @@ -1381,11 +1386,27 @@ class TestCmdlineParser : public TestFixture {
ASSERT_EQUALS_ENUM(Settings::OutputFormat::xml, settings->outputFormat);
}

void outputFormatXmlv2() {
REDIRECT;
const char * const argv[] = {"cppcheck", "--output-format=xmlv2", "file.cpp"};
ASSERT_EQUALS_ENUM(CmdLineParser::Result::Success, parseFromArgs(argv));
ASSERT_EQUALS_ENUM(Settings::OutputFormat::xml, settings->outputFormat);
ASSERT_EQUALS(2, settings->xml_version);
}

void outputFormatXmlv3() {
REDIRECT;
const char * const argv[] = {"cppcheck", "--output-format=xmlv3", "file.cpp"};
ASSERT_EQUALS_ENUM(CmdLineParser::Result::Success, parseFromArgs(argv));
ASSERT_EQUALS_ENUM(Settings::OutputFormat::xml, settings->outputFormat);
ASSERT_EQUALS(3, settings->xml_version);
}

void outputFormatOther() {
REDIRECT;
const char * const argv[] = {"cppcheck", "--output-format=plist", "file.cpp"};
ASSERT_EQUALS_ENUM(CmdLineParser::Result::Fail, parseFromArgs(argv));
ASSERT_EQUALS("cppcheck: error: argument to '--output-format=' must be 'text', 'sarif' or 'xml'.\n", logger->str());
ASSERT_EQUALS("cppcheck: error: argument to '--output-format=' must be 'text', 'sarif', 'xml' (deprecated), 'xmlv2' or 'xmlv3'.\n", logger->str());
}

void outputFormatImplicitPlist() {
Expand All @@ -1411,6 +1432,27 @@ class TestCmdlineParser : public TestFixture {
ASSERT_EQUALS("", settings->plistOutput);
}

void outputFormatMixed1() {
REDIRECT;
const char * const argv[] = {"cppcheck", "--xml", "--output-format=xml", "file.cpp"};
ASSERT_EQUALS_ENUM(CmdLineParser::Result::Fail, parseFromArgs(argv));
ASSERT_EQUALS("cppcheck: error: '--output-format' and '--xml...' may not be used in conjunction.\n", logger->str());
}

void outputFormatMixed2() {
REDIRECT;
const char * const argv[] = {"cppcheck", "--output-format=xml", "--xml", "file.cpp"};
ASSERT_EQUALS_ENUM(CmdLineParser::Result::Fail, parseFromArgs(argv));
ASSERT_EQUALS("cppcheck: error: '--output-format' and '--xml...' may not be used in conjunction.\n", logger->str());
}

void outputFormatMixed3() {
REDIRECT;
const char * const argv[] = {"cppcheck", "--xml-version=2", "--output-format=xml", "file.cpp"};
ASSERT_EQUALS_ENUM(CmdLineParser::Result::Fail, parseFromArgs(argv));
ASSERT_EQUALS("cppcheck: error: '--output-format' and '--xml...' may not be used in conjunction.\n", logger->str());
}

void premiumOptions1() {
REDIRECT;
asPremium();
Expand Down