CommandLineParser: throw on programmer error

requesting a previously undeclared key is most likely an programming
error. e.g. a typo "--unused vs --unsued".
So throw in those cases.

Add an according failure testcase.
This commit is contained in:
Pavel Rojtberg 2015-09-22 12:16:09 +02:00
parent d430e802f2
commit 2ced3ba276
2 changed files with 35 additions and 21 deletions

View File

@ -37,7 +37,7 @@ struct CommandLineParser::Impl
}; };
static String get_type_name(int type) static const char* get_type_name(int type)
{ {
if( type == Param::INT ) if( type == Param::INT )
return "int"; return "int";
@ -78,14 +78,11 @@ static void from_str(const String& str, int type, void* dst)
else if( type == Param::STRING ) else if( type == Param::STRING )
*(String*)dst = str; *(String*)dst = str;
else else
throw cv::Exception(CV_StsBadArg, "unknown/unsupported parameter type", "", __FILE__, __LINE__); CV_Error(Error::StsBadArg, "unknown/unsupported parameter type");
if (ss.fail()) if (ss.fail())
{ {
String err_msg = "can not convert: [" + str + CV_Error_(Error::StsBadArg, ("can not convert: [%s] to [%s]", str.c_str(), get_type_name(type)));
+ "] to [" + get_type_name(type) + "]";
throw cv::Exception(CV_StsBadArg, err_msg, "", __FILE__, __LINE__);
} }
} }
@ -103,23 +100,27 @@ void CommandLineParser::getByName(const String& name, bool space_delete, int typ
if (space_delete) if (space_delete)
v = impl->cat_string(v); v = impl->cat_string(v);
// it is an error if we just got the default value here // the key was neither specified nor has it a default value
if (v.empty() && type != Param::STRING) if(v.empty() && type != Param::STRING) {
break; impl->error = true;
impl->error_message = impl->error_message + "Missing parameter: '" + name + "'\n";
return;
}
from_str(v, type, dst); from_str(v, type, dst);
return; return;
} }
} }
} }
impl->error = true;
impl->error_message = impl->error_message + "Missing parameter: '" + name + "'\n";
} }
catch (Exception& e) catch (Exception& e)
{ {
impl->error = true; impl->error = true;
impl->error_message = impl->error_message + "Parameter '"+ name + "': " + e.err + "\n"; impl->error_message = impl->error_message + "Parameter '"+ name + "': " + e.err + "\n";
return;
} }
CV_Error_(Error::StsBadArg, ("undeclared key '%s' requested", name.c_str()));
} }
@ -134,22 +135,25 @@ void CommandLineParser::getByIndex(int index, bool space_delete, int type, void*
String v = impl->data[i].def_value; String v = impl->data[i].def_value;
if (space_delete == true) v = impl->cat_string(v); if (space_delete == true) v = impl->cat_string(v);
// it is an error if we just got the default value here // the key was neither specified nor has it a default value
if(v.empty()) if(v.empty() && type != Param::STRING) {
break; impl->error = true;
impl->error_message = impl->error_message + format("Missing parameter #%d\n", index);
return;
}
from_str(v, type, dst); from_str(v, type, dst);
return; return;
} }
} }
impl->error = true;
impl->error_message = impl->error_message + "Missing parameter #" + format("%d", index) + "\n";
} }
catch(Exception& e) catch(Exception& e)
{ {
impl->error = true; impl->error = true;
impl->error_message = impl->error_message + format("Parameter #%d: ", index) + e.err + "\n"; impl->error_message = impl->error_message + format("Parameter #%d: ", index) + e.err + "\n";
return;
} }
CV_Error_(Error::StsBadArg, ("undeclared position %d requested", index));
} }
static bool cmp_params(const CommandLineParserParams & p1, const CommandLineParserParams & p2) static bool cmp_params(const CommandLineParserParams & p1, const CommandLineParserParams & p2)
@ -340,6 +344,8 @@ bool CommandLineParser::has(const String& name) const
} }
} }
} }
CV_Error_(Error::StsBadArg, ("undeclared key '%s' requested", name.c_str()));
return false; return false;
} }

View File

@ -15,6 +15,18 @@ static const char * const keys =
"{ n unused | | dummy }" "{ n unused | | dummy }"
; ;
TEST(CommandLineParser, testFailure)
{
const char* argv[] = {"<bin>", "-q"};
const int argc = 2;
cv::CommandLineParser parser(argc, argv, keys);
EXPECT_ANY_THROW(parser.has("q"));
EXPECT_ANY_THROW(parser.get<bool>("q"));
EXPECT_ANY_THROW(parser.get<bool>(0));
parser.get<bool>("h");
EXPECT_FALSE(parser.check());
}
TEST(CommandLineParser, testHas_noValues) TEST(CommandLineParser, testHas_noValues)
{ {
const char* argv[] = {"<bin>", "-h", "--info"}; const char* argv[] = {"<bin>", "-h", "--info"};
@ -26,7 +38,6 @@ TEST(CommandLineParser, testHas_noValues)
EXPECT_TRUE(parser.has("i")); EXPECT_TRUE(parser.has("i"));
EXPECT_FALSE(parser.has("n")); EXPECT_FALSE(parser.has("n"));
EXPECT_FALSE(parser.has("unused")); EXPECT_FALSE(parser.has("unused"));
EXPECT_FALSE(parser.has("q")); // TODO Throw ???
} }
TEST(CommandLineParser, testHas_TrueValues) TEST(CommandLineParser, testHas_TrueValues)
{ {
@ -39,7 +50,6 @@ TEST(CommandLineParser, testHas_TrueValues)
EXPECT_TRUE(parser.has("i")); EXPECT_TRUE(parser.has("i"));
EXPECT_FALSE(parser.has("n")); EXPECT_FALSE(parser.has("n"));
EXPECT_FALSE(parser.has("unused")); EXPECT_FALSE(parser.has("unused"));
EXPECT_FALSE(parser.has("q")); // TODO Throw ???
} }
TEST(CommandLineParser, testHas_TrueValues1) TEST(CommandLineParser, testHas_TrueValues1)
{ {
@ -52,7 +62,6 @@ TEST(CommandLineParser, testHas_TrueValues1)
EXPECT_TRUE(parser.has("i")); EXPECT_TRUE(parser.has("i"));
EXPECT_FALSE(parser.has("n")); EXPECT_FALSE(parser.has("n"));
EXPECT_FALSE(parser.has("unused")); EXPECT_FALSE(parser.has("unused"));
EXPECT_FALSE(parser.has("q")); // TODO Throw ???
} }
TEST(CommandLineParser, testHas_FalseValues0) TEST(CommandLineParser, testHas_FalseValues0)
{ {
@ -65,7 +74,6 @@ TEST(CommandLineParser, testHas_FalseValues0)
EXPECT_TRUE(parser.has("i")); EXPECT_TRUE(parser.has("i"));
EXPECT_FALSE(parser.has("n")); EXPECT_FALSE(parser.has("n"));
EXPECT_FALSE(parser.has("unused")); EXPECT_FALSE(parser.has("unused"));
EXPECT_FALSE(parser.has("q")); // TODO Throw ???
} }
TEST(CommandLineParser, testBoolOption_noArgs) TEST(CommandLineParser, testBoolOption_noArgs)