mirror of
https://github.com/CLIUtils/CLI11.git
synced 2025-04-29 20:23:55 +00:00
0f5bf21e91
This adds a round trip test for config file generation to the fuzzer. (the next step after this PR will be a fuzzer that verifies that the round trip actually matches the results. This change ended up requiring quite a few minor changes to fix the ambiguities between the config file generation and config file reader. 1). There was a number of potential conflicts between positional names and regular option names that could be triggered in config files, this required a number of additional checks on the positional naming to ensure no conflicts. 2). flag options with disable flag override can produce output results that are not valid by themselves, resolving this required flag input to be able to handle an array and output the original value set of results. 3). strings with non-printable characters could cause all sorts of chaos in the config files. This was resolved by generating a binary string conversion format and handling multiline comments and characters, and handling escaped characters. Note; I think a better solution is to move to fully supporting string formatting and escaping along with the binary strings from TOML now that TOML 1.0 is finalized. That will not be this PR though, maybe the next one. 4). Lot of ambiguities and edge cases in the string splitter, this was reworked 5). handling of comments was not done well, especially comment characters in the name of the option which is allowed. 6). non printable characters in the option naming. This would be weird in practice but it also cause some big holes in the config file generation, so the restricted character set for option naming was expanded. (don't allow spaces or control characters). --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
98 lines
2.7 KiB
C++
98 lines
2.7 KiB
C++
// Copyright (c) 2017-2023, University of Cincinnati, developed by Henry Schreiner
|
|
// under NSF AWARD 1414736 and by the respective contributors.
|
|
// All rights reserved.
|
|
//
|
|
// SPDX-License-Identifier: BSD-3-Clause
|
|
|
|
#include "../fuzz/fuzzApp.hpp"
|
|
#include "app_helper.hpp"
|
|
|
|
std::string loadFailureFile(const std::string &type, int index) {
|
|
std::string fileName(TEST_FILE_FOLDER "/fuzzFail/");
|
|
fileName.append(type);
|
|
fileName += std::to_string(index);
|
|
std::ifstream crashFile(fileName, std::ios::in | std::ios::binary);
|
|
if(crashFile) {
|
|
std::vector<char> buffer(std::istreambuf_iterator<char>(crashFile), {});
|
|
|
|
std::string cdata(buffer.begin(), buffer.end());
|
|
return cdata;
|
|
}
|
|
return std::string{};
|
|
}
|
|
|
|
TEST_CASE("app_fail") {
|
|
CLI::FuzzApp fuzzdata;
|
|
auto app = fuzzdata.generateApp();
|
|
|
|
int index = GENERATE(range(1, 4));
|
|
std::string optionString;
|
|
auto parseData = loadFailureFile("fuzz_app_fail", index);
|
|
if(index >= 3 && parseData.size() > 25) {
|
|
optionString = parseData.substr(0, 25);
|
|
parseData.erase(0, 25);
|
|
}
|
|
|
|
try {
|
|
|
|
if(!optionString.empty()) {
|
|
app->add_option(optionString, fuzzdata.buffer);
|
|
}
|
|
try {
|
|
app->parse(parseData);
|
|
} catch(const CLI::ParseError & /*e*/) {
|
|
}
|
|
} catch(const CLI::ConstructionError & /*e*/) {
|
|
}
|
|
}
|
|
|
|
TEST_CASE("file_fail") {
|
|
CLI::FuzzApp fuzzdata;
|
|
auto app = fuzzdata.generateApp();
|
|
|
|
int index = GENERATE(range(1, 3));
|
|
auto parseData = loadFailureFile("fuzz_file_fail", index);
|
|
std::stringstream out(parseData);
|
|
try {
|
|
app->parse_from_stream(out);
|
|
} catch(const CLI::ParseError & /*e*/) {
|
|
}
|
|
}
|
|
|
|
TEST_CASE("app_file_gen_fail") {
|
|
CLI::FuzzApp fuzzdata;
|
|
auto app = fuzzdata.generateApp();
|
|
|
|
int index = GENERATE(range(1, 33));
|
|
std::string optionString, flagString;
|
|
auto parseData = loadFailureFile("fuzz_app_file_fail", index);
|
|
if(parseData.size() > 25) {
|
|
optionString = parseData.substr(0, 25);
|
|
parseData.erase(0, 25);
|
|
}
|
|
if(parseData.size() > 25) {
|
|
flagString = parseData.substr(0, 25);
|
|
parseData.erase(0, 25);
|
|
}
|
|
try {
|
|
|
|
if(!optionString.empty()) {
|
|
app->add_option(optionString, fuzzdata.buffer);
|
|
}
|
|
if(!flagString.empty()) {
|
|
app->add_flag(flagString, fuzzdata.intbuffer);
|
|
}
|
|
try {
|
|
app->parse(parseData);
|
|
} catch(const CLI::ParseError & /*e*/) {
|
|
return;
|
|
}
|
|
} catch(const CLI::ConstructionError & /*e*/) {
|
|
return;
|
|
}
|
|
std::string configOut = app->config_to_str();
|
|
app->clear();
|
|
std::stringstream out(configOut);
|
|
app->parse_from_stream(out);
|
|
}
|