// SPDX-License-Identifier: LGPL-3.0-or-other // Copyright (C) 2021 Contributors to the SLS Detector Package #include "CmdParser.h" #include "catch.hpp" #include #include // tests to add // help for all docs // command for all depreciated commands namespace sls { using vs = std::vector; SCENARIO("Construction", "[support]") { GIVEN("A default constructed CmdParser") { CmdParser p; THEN("The state of the object is valid") { REQUIRE(p.detector_id() == -1); REQUIRE(p.multi_id() == 0); REQUIRE(p.command().empty()); REQUIRE(p.arguments().empty()); // REQUIRE(p.argv().empty()); // REQUIRE(p.argv().data() == nullptr); } } } SCENARIO("Parsing a string with the command line parser", "[support]") { GIVEN("A CmdParser") { CmdParser p; WHEN("Parsing an empty string") { std::string s; p.Parse(s); THEN("command and arguments are empty") { REQUIRE(p.detector_id() == -1); REQUIRE(p.multi_id() == 0); REQUIRE(p.command().empty()); REQUIRE(p.arguments().empty()); // REQUIRE(p.argv().empty()); } } WHEN("Parsing a string with a single command") { std::string s = "vrf"; p.Parse(s); THEN("command is assigned and id's remain default") { REQUIRE(p.command() == "vrf"); REQUIRE(p.detector_id() == -1); REQUIRE(p.multi_id() == 0); REQUIRE(p.arguments().empty()); // REQUIRE(p.argv().size() == 1); } } WHEN("Parsing a string with command and value") { std::string s = "vthreshold 1500"; p.Parse(s); THEN("cmd and value are assigned and id's remain default") { REQUIRE(p.command() == "vthreshold"); REQUIRE(p.arguments()[0] == "1500"); REQUIRE(p.arguments().size() == 1); REQUIRE(p.detector_id() == -1); REQUIRE(p.multi_id() == 0); } } WHEN("Parsing a string with detector id and command") { vs arg{"9:vcp", "53:vthreshold", "128:vtrim", "5:threshold"}; std::vector det_id{9, 53, 128, 5}; vs res{"vcp", "vthreshold", "vtrim", "threshold"}; THEN("Values are correctly decoded") { for (size_t i = 0; i != arg.size(); ++i) { p.Parse(arg[i]); REQUIRE(p.detector_id() == det_id[i]); REQUIRE(p.multi_id() == 0); REQUIRE(p.command() == res[i]); REQUIRE(p.arguments().empty()); // REQUIRE(p.argv().size() == 1); } } } WHEN("Parsing a string with multi_id detector id and command") { vs arg{"8-12:vrf", "0-52:vcmp", "19-10:vtrim", "31-127:threshold"}; std::vector det_id{12, 52, 10, 127}; std::vector multi_id{8, 0, 19, 31}; vs res{"vrf", "vcmp", "vtrim", "threshold"}; THEN("Values are correctly decoded") { for (size_t i = 0; i != arg.size(); ++i) { p.Parse(arg[i]); REQUIRE(p.detector_id() == det_id[i]); REQUIRE(p.multi_id() == multi_id[i]); REQUIRE(p.command() == res[i]); REQUIRE(p.arguments().empty()); // REQUIRE(p.argv().size() == 1); } } } WHEN("Parsing string with cmd and multiple arguments") { std::string s = "trimen 5000 6000 7000"; p.Parse(s); THEN("cmd and args are correct") { REQUIRE(p.command() == "trimen"); REQUIRE(p.arguments().size() == 3); REQUIRE(p.arguments()[0] == "5000"); REQUIRE(p.arguments()[1] == "6000"); REQUIRE(p.arguments()[2] == "7000"); } } } } SCENARIO("Parsing strings with -h or --help", "[support]") { GIVEN("A parser") { CmdParser p; WHEN("Parsing a string with a command and help ") { std::string s = "-h list"; THEN("the command is correct and isHelp is set") { p.Parse(s); REQUIRE(p.detector_id() == -1); REQUIRE(p.multi_id() == 0); REQUIRE(p.command() == "list"); REQUIRE(p.isHelp()); REQUIRE(p.arguments().empty()); // REQUIRE(p.argv().size() == 1); } } WHEN("Parsing a string with -h at a different position") { std::string s = "list -h something"; THEN("its also done right") { p.Parse(s); REQUIRE(p.isHelp()); REQUIRE(p.command() == "list"); REQUIRE(p.arguments().size() == 1); REQUIRE(p.arguments().front() == "something"); } } WHEN("Parsing a string with -help at a different position") { std::string s = "list --help something"; THEN("its also done right") { p.Parse(s); REQUIRE(p.isHelp()); REQUIRE(p.command() == "list"); REQUIRE(p.arguments().size() == 1); REQUIRE(p.arguments().front() == "something"); } } } } TEST_CASE("Parse string with --help") { CmdParser p; p.Parse("list --help"); REQUIRE(p.isHelp() == true); REQUIRE(p.command() == "list"); } TEST_CASE("Parse string with -h") { CmdParser p; p.Parse("list -h"); REQUIRE(p.isHelp() == true); REQUIRE(p.command() == "list"); } TEST_CASE("Parsing consecutive strings resets not found det id") { CmdParser p; p.Parse("1:exptime 0.5"); REQUIRE(p.detector_id() == 1); p.Parse("exptime 0.5"); REQUIRE(p.detector_id() == -1); p.Parse("3:exptime 0.5"); REQUIRE(p.detector_id() == 3); } TEST_CASE("Parsing consecutive strings resets not found multi id") { CmdParser p; p.Parse("1-1:exptime 0.5"); REQUIRE(p.multi_id() == 1); p.Parse("1:exptime 0.5"); REQUIRE(p.multi_id() == 0); } TEST_CASE("Parse with no arguments results in no command and default id", "[support]") { // build up argc and argv // first argument is the command used to call the binary int argc = 1; const char *const argv[]{"call"}; CmdParser p; p.Parse(argc, argv); REQUIRE(p.detector_id() == -1); REQUIRE(p.multi_id() == 0); REQUIRE(p.command().empty()); REQUIRE(p.arguments().empty()); } TEST_CASE( "Parse a command without client id and detector id results in default", "[support]") { int argc = 2; const char *const argv[]{"caller", "vrf"}; CmdParser p; p.Parse(argc, argv); REQUIRE(p.detector_id() == -1); REQUIRE(p.multi_id() == 0); REQUIRE(p.command() == "vrf"); REQUIRE(p.arguments().empty()); } TEST_CASE("Parse a command with value but without client or detector id", "[support]") { int argc = 3; const char *const argv[]{"caller", "vrf", "3000"}; CmdParser p; p.Parse(argc, argv); REQUIRE(p.detector_id() == -1); REQUIRE(p.multi_id() == 0); REQUIRE(p.command() == "vrf"); REQUIRE(p.arguments().size() == 1); REQUIRE(p.arguments()[0] == "3000"); } TEST_CASE("Decodes position") { int argc = 2; const char *const argv[]{"caller", "7:vrf"}; CmdParser p; p.Parse(argc, argv); REQUIRE(p.detector_id() == 7); REQUIRE(p.multi_id() == 0); REQUIRE(p.command() == "vrf"); REQUIRE(p.arguments().empty()); } TEST_CASE("Decodes double digit position", "[support]") { int argc = 2; const char *const argv[]{"caller", "73:vcmp"}; CmdParser p; p.Parse(argc, argv); REQUIRE(p.detector_id() == 73); REQUIRE(p.multi_id() == 0); REQUIRE(p.command() == "vcmp"); REQUIRE(p.arguments().empty()); } TEST_CASE("Decodes position and id", "[support]") { int argc = 2; const char *const argv[]{"caller", "5-8:vrf"}; CmdParser p; p.Parse(argc, argv); REQUIRE(p.detector_id() == 8); REQUIRE(p.multi_id() == 5); REQUIRE(p.command() == "vrf"); REQUIRE(p.arguments().empty()); } TEST_CASE("Double digit id", "[support]") { int argc = 2; const char *const argv[]{"caller", "56-8:vrf"}; CmdParser p; p.Parse(argc, argv); REQUIRE(p.detector_id() == 8); REQUIRE(p.multi_id() == 56); REQUIRE(p.command() == "vrf"); REQUIRE(p.arguments().empty()); } TEST_CASE("Allows space between mod id and command") { CmdParser p; p.Parse("7: exptime 0.5"); REQUIRE(p.detector_id() == 7); REQUIRE(p.command() == "exptime"); REQUIRE(p.arguments().size() == 1); REQUIRE(p.arguments()[0] == "0.5"); } TEST_CASE("Allows space between mod id and command also without :") { CmdParser p; p.Parse("1 exptime 0.5"); REQUIRE(p.detector_id() == 1); REQUIRE(p.command() == "exptime"); REQUIRE(p.arguments().size() == 1); REQUIRE(p.arguments()[0] == "0.5"); } TEST_CASE("Allows space between mod id and command when detector id is used") { CmdParser p; p.Parse("1-5 exptime 0.5"); REQUIRE(p.detector_id() == 5); REQUIRE(p.multi_id() == 1); REQUIRE(p.command() == "exptime"); REQUIRE(p.arguments().size() == 1); REQUIRE(p.arguments()[0] == "0.5"); } TEST_CASE("Allows space between mod id and command with detector id and :") { CmdParser p; p.Parse("1-5: exptime 0.5"); REQUIRE(p.detector_id() == 5); REQUIRE(p.multi_id() == 1); REQUIRE(p.command() == "exptime"); REQUIRE(p.arguments().size() == 1); REQUIRE(p.arguments()[0] == "0.5"); } TEST_CASE("Parse receiver ID") { CmdParser p; p.Parse("2-5:3 flowcontrol10g 1"); REQUIRE(p.detector_id() == 5); REQUIRE(p.multi_id() == 2); REQUIRE(p.command() == "flowcontrol10g"); REQUIRE(p.arguments().size() == 1); REQUIRE(p.arguments()[0] == "1"); REQUIRE(p.receiver_id() == 3); } TEST_CASE("Parse receiver ID no det id") { CmdParser p; p.Parse("5:95 flowcontrol10g"); REQUIRE(p.detector_id() == 5); REQUIRE(p.multi_id() == 0); REQUIRE(p.command() == "flowcontrol10g"); REQUIRE(p.arguments().size() == 0); REQUIRE(p.receiver_id() == 95); } TEST_CASE("Det id but no mod id") { CmdParser p; p.Parse("1-exptime"); REQUIRE(p.detector_id() == -1); // not there REQUIRE(p.multi_id() == 1); REQUIRE(p.command() == "exptime"); } TEST_CASE("Det id but no mod id but with space after -") { CmdParser p; p.Parse("1- exptime"); REQUIRE(p.detector_id() == -1); // not there REQUIRE(p.multi_id() == 1); REQUIRE(p.command() == "exptime"); } TEST_CASE("Parse receiver ID no det id no mod") { CmdParser p; p.Parse(":95 flowcontrol10g"); REQUIRE(p.detector_id() == -1); // not there REQUIRE(p.multi_id() == 0); REQUIRE(p.command() == "flowcontrol10g"); REQUIRE(p.arguments().size() == 0); REQUIRE(p.receiver_id() == 95); } TEST_CASE("Parse mod and receiver id") { CmdParser p; p.Parse("1:3 exptime"); REQUIRE(p.detector_id() == 1); REQUIRE(p.receiver_id() == 3); REQUIRE(p.command() == "exptime"); } TEST_CASE("Det id but no no mod") { CmdParser p; p.Parse("2-:35 exptime"); REQUIRE(p.detector_id() == -1); REQUIRE(p.receiver_id() == 35); REQUIRE(p.multi_id() == 2); REQUIRE(p.command() == "exptime"); } TEST_CASE("All stuff") { CmdParser p; p.Parse("3-4:2 exptime"); REQUIRE(p.detector_id() == 4); REQUIRE(p.receiver_id() == 2); REQUIRE(p.multi_id() == 3); REQUIRE(p.command() == "exptime"); } TEST_CASE("Parse a command that has -h in it") { CmdParser p; p.Parse("1-hostname somepc"); REQUIRE(p.multi_id() == 1); REQUIRE(p.command() == "hostname"); REQUIRE(p.arguments().size() == 1); REQUIRE(p.arguments()[0] == "somepc"); } TEST_CASE("Parse a command in the form 0-1 command") { CmdParser p; p.Parse("3-5 exptime"); REQUIRE(p.multi_id() == 3); REQUIRE(p.detector_id() == 5); REQUIRE(p.command() == "exptime"); } TEST_CASE("Parse a command in the form 0-1:command") { CmdParser p; p.Parse("3-5:exptime"); REQUIRE(p.multi_id() == 3); REQUIRE(p.detector_id() == 5); REQUIRE(p.command() == "exptime"); } } // namespace sls