manafiles/test/testutilargparser.cpp

#include <string>
#include <vector>

#include "macro.h"
#include "testcase.h"
#include "testsuite.h"
#include "util/argparser.h"

bool runParser(std::vector<const char*> arguments, std::function<void(Util::ArgParser&)> initializer = {})
{
	stdout = Test::TestSuite::the().outputNull();

	Util::ArgParser parser;
	if (initializer) {
		initializer(parser);
	}

	arguments.insert(arguments.begin(), "app");
	auto result = parser.parse(arguments.size(), arguments.data());

	stdout = Test::TestSuite::the().outputStd();
	return result;
}

// -----------------------------------------

TEST_CASE(NoArguments)
{
	auto result = runParser({});
	EXPECT_EQ(result, true);
}

// -----------------------------------------

TEST_CASE(BoolOptions)
{
	// Short option
	bool boolOpt1 = false;
	auto result = runParser({ "-b" }, [&](auto& parser) {
		parser.addOption(boolOpt1, 'b', nullptr, nullptr, nullptr);
	});
	EXPECT_EQ(result, true);
	EXPECT_EQ(boolOpt1, true);

	// Short option, not given
	boolOpt1 = false;
	result = runParser({}, [&](auto& parser) {
		parser.addOption(boolOpt1, 'b', nullptr, nullptr, nullptr);
	});
	EXPECT_EQ(result, true);
	EXPECT_EQ(boolOpt1, false);

	// Long option
	boolOpt1 = false;
	result = runParser({ "--bool" }, [&](auto& parser) {
		parser.addOption(boolOpt1, '\0', "bool", nullptr, nullptr);
	});
	EXPECT_EQ(result, true);
	EXPECT_EQ(boolOpt1, true);

	// Long option, not given
	boolOpt1 = false;
	result = runParser({}, [&](auto& parser) {
		parser.addOption(boolOpt1, '\0', "bool", nullptr, nullptr);
	});
	EXPECT_EQ(result, true);
	EXPECT_EQ(boolOpt1, false);

	// Allow both short and long option, provide short
	boolOpt1 = false;
	result = runParser({ "-b" }, [&](auto& parser) {
		parser.addOption(boolOpt1, 'b', "bool", nullptr, nullptr);
	});
	EXPECT_EQ(result, true);
	EXPECT_EQ(boolOpt1, true);

	// Allow both short and long option, provide long
	boolOpt1 = false;
	result = runParser({ "--bool" }, [&](auto& parser) {
		parser.addOption(boolOpt1, 'b', "bool", nullptr, nullptr);
	});
	EXPECT_EQ(result, true);
	EXPECT_EQ(boolOpt1, true);

	// Allow both short and long option, provide both
	boolOpt1 = false;
	result = runParser({ "-b", "--bool" }, [&](auto& parser) {
		parser.addOption(boolOpt1, 'b', "bool", nullptr, nullptr);
	});
	EXPECT_EQ(result, true);
	EXPECT_EQ(boolOpt1, true);
}

// -----------------------------------------

TEST_CASE(SingleRequiredStringOptions)
{
	// Single required string short option
	std::string stringOpt1 = "";
	auto result = runParser({ "-s", "my-required-argument" }, [&](auto& parser) {
		parser.addOption(stringOpt1, 's', nullptr, nullptr, nullptr, nullptr, Util::ArgParser::Required::Yes);
	});
	EXPECT_EQ(result, true);
	EXPECT_EQ(stringOpt1, "my-required-argument");

	// Single required string short option, given directly after
	stringOpt1 = "";
	result = runParser({ "-smy-required-argument" }, [&](auto& parser) {
		parser.addOption(stringOpt1, 's', nullptr, nullptr, nullptr, nullptr, Util::ArgParser::Required::Yes);
	});
	EXPECT_EQ(result, true);
	EXPECT_EQ(stringOpt1, "my-required-argument");

	// Single required string short option, empty given
	stringOpt1 = "";
	result = runParser({ "-s" }, [&](auto& parser) {
		parser.addOption(stringOpt1, 's', nullptr, nullptr, nullptr, nullptr, Util::ArgParser::Required::Yes);
	});
	EXPECT_EQ(result, false);
	EXPECT_EQ(stringOpt1, "");

	// Single required string short option, not given
	stringOpt1 = "";
	result = runParser({}, [&](auto& parser) {
		parser.addOption(stringOpt1, 's', nullptr, nullptr, nullptr, nullptr, Util::ArgParser::Required::Yes);
	});
	EXPECT_EQ(result, true);
	EXPECT_EQ(stringOpt1, "");

	// Single required string long option
	stringOpt1 = "";
	result = runParser({ "--string", "my-required-argument" }, [&](auto& parser) {
		parser.addOption(stringOpt1, '\0', "string", nullptr, nullptr, nullptr, Util::ArgParser::Required::Yes);
	});
	EXPECT_EQ(result, true);
	EXPECT_EQ(stringOpt1, "my-required-argument");

	// Single required string long option, given directly after
	stringOpt1 = "";
	result = runParser({ "--string=my-required-argument" }, [&](auto& parser) {
		parser.addOption(stringOpt1, '\0', "string", nullptr, nullptr, nullptr, Util::ArgParser::Required::Yes);
	});
	EXPECT_EQ(result, true);
	EXPECT_EQ(stringOpt1, "my-required-argument");

	// Single required string long option, empty given
	stringOpt1 = "";
	result = runParser({ "--string" }, [&](auto& parser) {
		parser.addOption(stringOpt1, '\0', "string", nullptr, nullptr, nullptr, Util::ArgParser::Required::Yes);
	});
	EXPECT_EQ(result, false);
	EXPECT_EQ(stringOpt1, "");

	// Single required string long option, not given
	stringOpt1 = "";
	result = runParser({}, [&](auto& parser) {
		parser.addOption(stringOpt1, '\0', "string", nullptr, nullptr, nullptr, Util::ArgParser::Required::Yes);
	});
	EXPECT_EQ(result, true);
	EXPECT_EQ(stringOpt1, "");
}

// -----------------------------------------

TEST_CASE(SingleOptionalStringOptions)
{
	// Single optional string short option
	std::string stringOpt1 = "";
	auto result = runParser({ "-s", "my-optional-argument" }, [&](auto& parser) {
		parser.addOption(stringOpt1, 's', nullptr, nullptr, nullptr, nullptr, Util::ArgParser::Required::Optional);
	});
	EXPECT_EQ(result, true);
	EXPECT_EQ(stringOpt1, "");

	// Single optional string short option, given directly after
	stringOpt1 = "";
	result = runParser({ "-smy-optional-argument" }, [&](auto& parser) {
		parser.addOption(stringOpt1, 's', nullptr, nullptr, nullptr, nullptr, Util::ArgParser::Required::Optional);
	});
	EXPECT_EQ(result, true);
	EXPECT_EQ(stringOpt1, "my-optional-argument");

	// Single optional string short option, empty given
	stringOpt1 = "";
	result = runParser({ "-s" }, [&](auto& parser) {
		parser.addOption(stringOpt1, 's', nullptr, nullptr, nullptr, nullptr, Util::ArgParser::Required::Optional);
	});
	EXPECT_EQ(result, true);
	EXPECT_EQ(stringOpt1, "");

	// Single optional string short option, not given
	stringOpt1 = "";
	result = runParser({}, [&](auto& parser) {
		parser.addOption(stringOpt1, 's', nullptr, nullptr, nullptr, nullptr, Util::ArgParser::Required::Optional);
	});
	EXPECT_EQ(result, true);
	EXPECT_EQ(stringOpt1, "");

	// Single optional string long option
	stringOpt1 = "";
	result = runParser({ "--string", "my-optional-argument" }, [&](auto& parser) {
		parser.addOption(stringOpt1, '\0', "string", nullptr, nullptr, nullptr, Util::ArgParser::Required::Optional);
	});
	EXPECT_EQ(result, true);
	EXPECT_EQ(stringOpt1, "");

	// Single optional string long option, given directly after
	stringOpt1 = "";
	result = runParser({ "--string=my-optional-argument" }, [&](auto& parser) {
		parser.addOption(stringOpt1, '\0', "string", nullptr, nullptr, nullptr, Util::ArgParser::Required::Optional);
	});
	EXPECT_EQ(result, true);
	EXPECT_EQ(stringOpt1, "my-optional-argument");

	// Single optional string long option, empty given
	stringOpt1 = "";
	result = runParser({ "--string" }, [&](auto& parser) {
		parser.addOption(stringOpt1, '\0', "string", nullptr, nullptr, nullptr, Util::ArgParser::Required::Optional);
	});
	EXPECT_EQ(result, true);
	EXPECT_EQ(stringOpt1, "");

	// Single optional string long option, not given
	stringOpt1 = "";
	result = runParser({}, [&](auto& parser) {
		parser.addOption(stringOpt1, '\0', "string", nullptr, nullptr, nullptr, Util::ArgParser::Required::Optional);
	});
	EXPECT_EQ(result, true);
	EXPECT_EQ(stringOpt1, "");
}

// -----------------------------------------

TEST_CASE(SingleNonRequiredStringOptions)
{
	// Single non-required string short option
	std::string stringOpt1 = "";
	auto result = runParser({ "-s", "my-non-required-argument" }, [&](auto& parser) {
		parser.addOption(stringOpt1, 's', nullptr, nullptr, nullptr, nullptr, Util::ArgParser::Required::No);
	});
	EXPECT_EQ(result, true);
	EXPECT_EQ(stringOpt1, "");

	// Single non-required string short option, given directly after
	stringOpt1 = "";
	result = runParser({ "-smy-non-required-argument" }, [&](auto& parser) {
		parser.addOption(stringOpt1, 's', nullptr, nullptr, nullptr, nullptr, Util::ArgParser::Required::No);
	});
	EXPECT_EQ(result, false);
	EXPECT_EQ(stringOpt1, "");

	// Single non-required string short option, empty given
	stringOpt1 = "";
	result = runParser({ "-s" }, [&](auto& parser) {
		parser.addOption(stringOpt1, 's', nullptr, nullptr, nullptr, nullptr, Util::ArgParser::Required::No);
	});
	EXPECT_EQ(result, true);
	EXPECT_EQ(stringOpt1, "");

	// Single non-required string short option, not given
	stringOpt1 = "";
	result = runParser({}, [&](auto& parser) {
		parser.addOption(stringOpt1, 's', nullptr, nullptr, nullptr, nullptr, Util::ArgParser::Required::No);
	});
	EXPECT_EQ(result, true);
	EXPECT_EQ(stringOpt1, "");

	// Single non-required string long option
	stringOpt1 = "";
	result = runParser({ "--string", "my-non-required-argument" }, [&](auto& parser) {
		parser.addOption(stringOpt1, '\0', "string", nullptr, nullptr, nullptr, Util::ArgParser::Required::No);
	});
	EXPECT_EQ(result, true);
	EXPECT_EQ(stringOpt1, "");

	// Single non-required string long option, given directly after
	stringOpt1 = "";
	result = runParser({ "--string=my-non-required-argument" }, [&](auto& parser) {
		parser.addOption(stringOpt1, '\0', "string", nullptr, nullptr, nullptr, Util::ArgParser::Required::No);
	});
	EXPECT_EQ(result, false);
	EXPECT_EQ(stringOpt1, "");

	// Single non-required string long option, empty given
	stringOpt1 = "";
	result = runParser({ "--string" }, [&](auto& parser) {
		parser.addOption(stringOpt1, '\0', "string", nullptr, nullptr, nullptr, Util::ArgParser::Required::No);
	});
	EXPECT_EQ(result, true);
	EXPECT_EQ(stringOpt1, "");

	// Single non-required string long option, not given
	stringOpt1 = "";
	result = runParser({}, [&](auto& parser) {
		parser.addOption(stringOpt1, '\0', "string", nullptr, nullptr, nullptr, Util::ArgParser::Required::No);
	});
	EXPECT_EQ(result, true);
	EXPECT_EQ(stringOpt1, "");
}

// -----------------------------------------

TEST_CASE(VectorStringOptions)
{
	// Required vector string short option, not given
	std::vector<std::string> vectorOpt1 = {};
	auto result = runParser({}, [&](auto& parser) {
		parser.addOption(vectorOpt1, 'v', nullptr, nullptr, nullptr, nullptr, Util::ArgParser::Required::Yes);
	});
	EXPECT_EQ(result, true);
	EXPECT_EQ(vectorOpt1.size(), 0);

	// Required vector string short option, empty given
	vectorOpt1 = {};
	result = runParser({ "-v" }, [&](auto& parser) {
		parser.addOption(vectorOpt1, 'v', nullptr, nullptr, nullptr, nullptr, Util::ArgParser::Required::Yes);
	});
	EXPECT_EQ(result, false);
	EXPECT_EQ(vectorOpt1.size(), 0);

	// Required vector string short option, one given
	vectorOpt1 = {};
	result = runParser({ "-v", "a vector argument!" }, [&](auto& parser) {
		parser.addOption(vectorOpt1, 'v', nullptr, nullptr, nullptr, nullptr, Util::ArgParser::Required::Yes);
	});
	EXPECT_EQ(result, true);
	EXPECT_EQ(vectorOpt1.size(), 1);
	if (vectorOpt1.size() == 1) {
		EXPECT_EQ(vectorOpt1[0], "a vector argument!");
	}

	// Required vector string short option, two given
	vectorOpt1 = {};
	result = runParser({ "-v", "hello", "-v", "world" }, [&](auto& parser) {
		parser.addOption(vectorOpt1, 'v', nullptr, nullptr, nullptr, nullptr, Util::ArgParser::Required::Yes);
	});
	EXPECT_EQ(result, true);
	EXPECT_EQ(vectorOpt1.size(), 2);
	if (vectorOpt1.size() == 2) {
		EXPECT_EQ(vectorOpt1[0], "hello");
		EXPECT_EQ(vectorOpt1[1], "world");
	}

	// Required vector string short option, two given directly after
	vectorOpt1 = {};
	result = runParser({ "-vhello", "-vworld" }, [&](auto& parser) {
		parser.addOption(vectorOpt1, 'v', nullptr, nullptr, nullptr, nullptr, Util::ArgParser::Required::Yes);
	});
	EXPECT_EQ(result, true);
	EXPECT_EQ(vectorOpt1.size(), 2);
	if (vectorOpt1.size() == 2) {
		EXPECT_EQ(vectorOpt1[0], "hello");
		EXPECT_EQ(vectorOpt1[1], "world");
	}

	// Required vector string long option, empty given
	vectorOpt1 = {};
	result = runParser({ "--vector" }, [&](auto& parser) {
		parser.addOption(vectorOpt1, '\0', "vector", nullptr, nullptr, nullptr, Util::ArgParser::Required::Yes);
	});
	EXPECT_EQ(result, false);
	EXPECT_EQ(vectorOpt1.size(), 0);

	// Required vector string long option, one given
	vectorOpt1 = {};
	result = runParser({ "--vector", "a vector argument!" }, [&](auto& parser) {
		parser.addOption(vectorOpt1, '\0', "vector", nullptr, nullptr, nullptr, Util::ArgParser::Required::Yes);
	});
	EXPECT_EQ(result, true);
	EXPECT_EQ(vectorOpt1.size(), 1);
	if (vectorOpt1.size() == 1) {
		EXPECT_EQ(vectorOpt1[0], "a vector argument!");
	}

	// Required vector string long option, two given
	vectorOpt1 = {};
	result = runParser({ "--vector", "hello", "--vector", "world" }, [&](auto& parser) {
		parser.addOption(vectorOpt1, '\0', "vector", nullptr, nullptr, nullptr, Util::ArgParser::Required::Yes);
	});
	EXPECT_EQ(result, true);
	EXPECT_EQ(vectorOpt1.size(), 2);
	if (vectorOpt1.size() == 2) {
		EXPECT_EQ(vectorOpt1[0], "hello");
		EXPECT_EQ(vectorOpt1[1], "world");
	}

	// Required vector string long option, two given directly after
	vectorOpt1 = {};
	result = runParser({ "--vector=hello", "--vector=world" }, [&](auto& parser) {
		parser.addOption(vectorOpt1, '\0', "vector", nullptr, nullptr, nullptr, Util::ArgParser::Required::Yes);
	});
	EXPECT_EQ(result, true);
	EXPECT_EQ(vectorOpt1.size(), 2);
	if (vectorOpt1.size() == 2) {
		EXPECT_EQ(vectorOpt1[0], "hello");
		EXPECT_EQ(vectorOpt1[1], "world");
	}
}

// -----------------------------------------

TEST_CASE(MultipleOptions)
{
	// Both short options, second is required, with a non-option argument in-between
	bool boolOpt1 = false;
	std::string stringOpt1 = "";
	auto result = runParser({ "-b", "something", "-s", "a-string-value" }, [&](auto& parser) {
		parser.addOption(boolOpt1, 'b', nullptr, nullptr, nullptr);
		parser.addOption(stringOpt1, 's', nullptr, nullptr, nullptr, nullptr, Util::ArgParser::Required::Yes);
	});
	EXPECT_EQ(result, true);
	EXPECT_EQ(boolOpt1, true);
	EXPECT_EQ(stringOpt1, "a-string-value");
}

// -----------------------------------------

TEST_CASE(NonOptionMode)
{
	// Bool short options, missing
	// Expected: The bool options are interpreted as non-option parameters
	bool boolOpt1 = false;
	bool boolOpt2 = false;
	auto result = runParser({ "--", "-b", "-c" }, [&](auto& parser) {
		parser.addOption(boolOpt1, 'b', nullptr, nullptr, nullptr);
		parser.addOption(boolOpt2, 'c', nullptr, nullptr, nullptr);
	});
	EXPECT_EQ(result, true);
	EXPECT_EQ(boolOpt1, false);
	EXPECT_EQ(boolOpt2, false);

	// Bool short options, one given
	// Expected: boolOpt1 is set, one non-option parameter
	boolOpt1 = false;
	boolOpt2 = false;
	result = runParser({ "-b", "--", "-c" }, [&](auto& parser) {
		parser.addOption(boolOpt1, 'b', nullptr, nullptr, nullptr);
		parser.addOption(boolOpt2, 'c', nullptr, nullptr, nullptr);
	});
	EXPECT_EQ(result, true);
	EXPECT_EQ(boolOpt1, true);
	EXPECT_EQ(boolOpt2, false);

	// Bool long options, missing
	// Expected: The bool options are interpreted as non-option parameters
	boolOpt1 = false;
	boolOpt2 = false;
	result = runParser({ "--", "--bool", "--cool" }, [&](auto& parser) {
		parser.addOption(boolOpt1, '\0', "bool", nullptr, nullptr);
		parser.addOption(boolOpt2, '\0', "cool", nullptr, nullptr);
	});
	EXPECT_EQ(result, true);
	EXPECT_EQ(boolOpt1, false);
	EXPECT_EQ(boolOpt2, false);

	// Bool long options, one given
	// Expected: boolOpt1 is set, one non-option parameter
	boolOpt1 = false;
	boolOpt2 = false;
	result = runParser({ "--bool", "--", "--cool" }, [&](auto& parser) {
		parser.addOption(boolOpt1, '\0', "bool", nullptr, nullptr);
		parser.addOption(boolOpt2, '\0', "cool", nullptr, nullptr);
	});
	EXPECT_EQ(result, true);
	EXPECT_EQ(boolOpt1, true);
	EXPECT_EQ(boolOpt2, false);
}