hcq/MaxScale
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add descriptions to module commands

Browse Source 
Each module command has to describe what it does. This should make module
commands self-documenting to some degree.
This commit is contained in:
Markus Mäkelä
2017-06-09 13:23:30 +03:00
parent 06995837cf
commit 45afbda100
11 changed files with 50 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
examples/roundrobinrouter.cpp
View File

@ -675,7 +675,8 @@ static MXS_ROUTER* createInstance(SERVICE* service, char** options)
/* Register a custom command */
if (!modulecmd_register_command("rrrouter", "test_command",
MODULECMD_TYPE_ACTIVE, custom_cmd_example,
2, custom_cmd_args))
2, custom_cmd_args,
"This is the command description"))
{
MXS_ERROR("Module command registration failed.");
}

6
include/maxscale/modulecmd.h
View File

@ -141,6 +141,7 @@ typedef struct modulecmd
{
char *identifier; /**< Unique identifier */
char *domain; /**< Command domain */
char *description; /**< Command description */
enum modulecmd_type type; /**< Command type, either active or passive */
MODULECMDFN func; /**< The registered function */
int arg_count_min; /**< Minimum number of arguments */
@ -162,11 +163,14 @@ typedef struct modulecmd
* @param entry_point The actual entry point function
* @param argc Maximum number of arguments
* @param argv Array of argument types of size @c argc
* @param description Human-readable description of this command
*
* @return True if the module was successfully registered, false on error
*/
bool modulecmd_register_command(const char *domain, const char *identifier,
enum modulecmd_type type, MODULECMDFN entry_point,
int argc, modulecmd_arg_type_t *argv);
int argc, modulecmd_arg_type_t *argv,
const char *description);
/**
* @brief Find a registered command

1
server/core/load_utils.cc
View File

@ -434,6 +434,7 @@ bool modulecmd_cb(const MODULECMD *cmd, void *data)
json_object_set_new(attr, CN_METHOD, json_string(method));
json_object_set_new(attr, CN_ARG_MIN, json_integer(cmd->arg_count_min));
json_object_set_new(attr, CN_ARG_MAX, json_integer(cmd->arg_count_max));
json_object_set_new(attr, CN_DESCRIPTION, json_string(cmd->description));
json_t* param = json_array();

15
server/core/modulecmd.cc
View File

@ -138,15 +138,18 @@ static MODULECMD_DOMAIN* get_or_create_domain(const char *domain)
static MODULECMD* command_create(const char *identifier, const char *domain,
enum modulecmd_type type, MODULECMDFN entry_point,
int argc, modulecmd_arg_type_t* argv)
int argc, modulecmd_arg_type_t* argv,
const char *description)
{
ss_dassert((argc && argv) || (argc == 0 && argv == NULL));
ss_dassert(description);
MODULECMD *rval = (MODULECMD*)MXS_MALLOC(sizeof(*rval));
char *id = MXS_STRDUP(identifier);
char *dm = MXS_STRDUP(domain);
char *desc = MXS_STRDUP(description);
modulecmd_arg_type_t *types = (modulecmd_arg_type_t*)MXS_MALLOC(sizeof(*types) * (argc ? argc : 1));
if (rval && id && dm && types)
if (rval && id && dm && types && desc)
{
int argc_min = 0;
@ -170,6 +173,7 @@ static MODULECMD* command_create(const char *identifier, const char *domain,
rval->func = entry_point;
rval->identifier = id;
rval->domain = dm;
rval->description = desc;
rval->arg_types = types;
rval->arg_count_min = argc_min;
rval->arg_count_max = argc;
@ -181,6 +185,7 @@ static MODULECMD* command_create(const char *identifier, const char *domain,
MXS_FREE(id);
MXS_FREE(dm);
MXS_FREE(types);
MXS_FREE(desc);
rval = NULL;
}
@ -415,7 +420,8 @@ static void free_argument(struct arg_node *arg)
bool modulecmd_register_command(const char *domain, const char *identifier,
enum modulecmd_type type, MODULECMDFN entry_point,
int argc, modulecmd_arg_type_t *argv)
int argc, modulecmd_arg_type_t *argv,
const char *description)
{
reset_error();
bool rval = false;
@ -432,7 +438,8 @@ bool modulecmd_register_command(const char *domain, const char *identifier,
}
else
{
MODULECMD *cmd = command_create(identifier, domain, type, entry_point, argc, argv);
MODULECMD *cmd = command_create(identifier, domain, type, entry_point,
argc, argv, description);
if (cmd)
{

16
server/core/test/testmodulecmd.cc
View File

@ -67,10 +67,10 @@ int test_arguments()
TEST(modulecmd_find_command(ns, id) == NULL, "The registered command should not yet be found");
TEST(strlen(modulecmd_get_error()), "Error message should not be empty");
TEST(modulecmd_register_command(ns, id, MODULECMD_TYPE_ACTIVE, test_fn, 2, args1),
TEST(modulecmd_register_command(ns, id, MODULECMD_TYPE_ACTIVE, test_fn, 2, args1, ""),
"Registering a command should succeed");
TEST(!modulecmd_register_command(ns, id, MODULECMD_TYPE_ACTIVE, test_fn, 2, args1),
TEST(!modulecmd_register_command(ns, id, MODULECMD_TYPE_ACTIVE, test_fn, 2, args1, ""),
"Registering the command a second time should fail");
TEST(strlen(modulecmd_get_error()), "Error message should not be empty");
@ -163,7 +163,7 @@ int test_optional_arguments()
{MODULECMD_ARG_BOOLEAN | MODULECMD_ARG_OPTIONAL, ""}
};
TEST(modulecmd_register_command(ns, id, MODULECMD_TYPE_ACTIVE, test_fn2, 2, args1),
TEST(modulecmd_register_command(ns, id, MODULECMD_TYPE_ACTIVE, test_fn2, 2, args1, ""),
"Registering a command should succeed");
const MODULECMD *cmd = modulecmd_find_command(ns, id);
@ -235,7 +235,7 @@ int test_module_errors()
const char *ns = "test_module_errors";
const char *id = "test_module_errors";
TEST(modulecmd_register_command(ns, id, MODULECMD_TYPE_ACTIVE, test_fn3, 0, NULL),
TEST(modulecmd_register_command(ns, id, MODULECMD_TYPE_ACTIVE, test_fn3, 0, NULL, ""),
"Registering a command should succeed");
const MODULECMD *cmd = modulecmd_find_command(ns, id);
@ -267,7 +267,7 @@ int test_map()
{
char id[200];
sprintf(id, "test_map%d", i + 1);
TEST(modulecmd_register_command(map_dom, id, MODULECMD_TYPE_ACTIVE, test_fn_map, 0, NULL),
TEST(modulecmd_register_command(map_dom, id, MODULECMD_TYPE_ACTIVE, test_fn_map, 0, NULL, ""),
"Registering a command should succeed");
}
@ -333,7 +333,7 @@ int test_pointers()
{MODULECMD_ARG_DCB, ""}
};
TEST(modulecmd_register_command(ns, id, MODULECMD_TYPE_ACTIVE, ptrfn, 1, args),
TEST(modulecmd_register_command(ns, id, MODULECMD_TYPE_ACTIVE, ptrfn, 1, args, ""),
"Registering a command should succeed");
TEST(strlen(modulecmd_get_error()) == 0, "Error message should be empty");
@ -368,7 +368,7 @@ int test_domain_matching()
{MODULECMD_ARG_MONITOR | MODULECMD_ARG_NAME_MATCHES_DOMAIN, ""}
};
TEST(modulecmd_register_command(ns, id, MODULECMD_TYPE_ACTIVE, monfn, 1, args),
TEST(modulecmd_register_command(ns, id, MODULECMD_TYPE_ACTIVE, monfn, 1, args, ""),
"Registering a command should succeed");
TEST(strlen(modulecmd_get_error()) == 0, "Error message should be empty");
@ -406,7 +406,7 @@ int test_output()
const char *ns = "test_output";
const char *id = "test_output";
TEST(modulecmd_register_command(ns, id, MODULECMD_TYPE_ACTIVE, outputfn, 0, NULL),
TEST(modulecmd_register_command(ns, id, MODULECMD_TYPE_ACTIVE, outputfn, 0, NULL, ""),
"Registering a command should succeed");
TEST(strlen(modulecmd_get_error()) == 0, "Error message should be empty");

4
server/modules/authenticator/CDCPlainAuth/cdc_plain_auth.c
View File

@ -154,7 +154,9 @@ MXS_MODULE* MXS_CREATE_MODULE()
{ MODULECMD_ARG_STRING, "Password of the user"}
};
modulecmd_register_command("cdc", "add_user", MODULECMD_TYPE_ACTIVE, cdc_add_new_user, 3, args);
modulecmd_register_command("cdc", "add_user", MODULECMD_TYPE_ACTIVE,
cdc_add_new_user, 3, args,
"Add a new CDC user");
static MXS_AUTHENTICATOR MyObject =
{

3
server/modules/filter/cache/cachefilter.cc vendored
View File

@ -148,7 +148,8 @@ extern "C" MXS_MODULE* MXS_CREATE_MODULE()
};
modulecmd_register_command(MXS_MODULE_NAME, "show", MODULECMD_TYPE_PASSIVE,
cache_command_show, MXS_ARRAY_NELEMS(show_argv), show_argv);
cache_command_show, MXS_ARRAY_NELEMS(show_argv), show_argv,
"Show cache filter statistics");
MXS_NOTICE("Initialized cache module %s.\n", VERSION_STRING);

9
server/modules/filter/dbfwfilter/dbfwfilter.c
View File

@ -852,7 +852,8 @@ MXS_MODULE* MXS_CREATE_MODULE()
};
modulecmd_register_command(MXS_MODULE_NAME, "rules/reload", MODULECMD_TYPE_ACTIVE,
dbfw_reload_rules, 2, args_rules_reload);
dbfw_reload_rules, 2, args_rules_reload,
"Reload dbfwfilter rules");
modulecmd_arg_type_t args_rules_show[] =
{
@ -861,7 +862,8 @@ MXS_MODULE* MXS_CREATE_MODULE()
};
modulecmd_register_command(MXS_MODULE_NAME, "rules", MODULECMD_TYPE_PASSIVE,
dbfw_show_rules, 2, args_rules_show);
dbfw_show_rules, 2, args_rules_show,
"(deprecated) Show dbfwfilter rule statistics");
modulecmd_arg_type_t args_rules_show_json[] =
{
@ -869,7 +871,8 @@ MXS_MODULE* MXS_CREATE_MODULE()
};
modulecmd_register_command(MXS_MODULE_NAME, "rules/json", MODULECMD_TYPE_PASSIVE,
dbfw_show_rules_json, 1, args_rules_show_json);
dbfw_show_rules_json, 1, args_rules_show_json,
"Show dbfwfilter rule statistics as JSON");
static MXS_FILTER_OBJECT MyObject =
{

3
server/modules/filter/masking/maskingfilter.cc
View File

@ -66,7 +66,8 @@ extern "C" MXS_MODULE* MXS_CREATE_MODULE()
modulecmd_register_command(MXS_MODULE_NAME, "reload",
MODULECMD_TYPE_ACTIVE, masking_command_reload,
MXS_ARRAY_NELEMS(reload_argv), reload_argv);
MXS_ARRAY_NELEMS(reload_argv), reload_argv,
"Reload masking filter rules");
MXS_NOTICE("Masking module %s initialized.", VERSION_STRING);

4
server/modules/routing/avrorouter/avro.c
View File

@ -148,7 +148,9 @@ MXS_MODULE* MXS_CREATE_MODULE()
{ MODULECMD_ARG_SERVICE | MODULECMD_ARG_NAME_MATCHES_DOMAIN, "The avrorouter service" },
{ MODULECMD_ARG_STRING, "Action, whether to 'start' or 'stop' the conversion process" }
};
modulecmd_register_command(MXS_MODULE_NAME, "convert", MODULECMD_TYPE_ACTIVE, avro_handle_convert, 2, args);
modulecmd_register_command(MXS_MODULE_NAME, "convert", MODULECMD_TYPE_ACTIVE,
avro_handle_convert, 2, args,
"Start or stop the binlog to avro conversion process");
static MXS_ROUTER_OBJECT MyObject =
{

5
server/modules/routing/debugcli/debugcmd.c
View File

@ -321,8 +321,9 @@ bool listfuncs_cb(const MODULECMD *cmd, void *data)
{
DCB *dcb = (DCB*)data;
dcb_printf(dcb, "Command: %s %s\n", cmd->domain, cmd->identifier);
dcb_printf(dcb, "Parameters: ");
dcb_printf(dcb, "Command:\t%s %s\n", cmd->domain, cmd->identifier);
dcb_printf(dcb, "Description:\t%s\n", cmd->description);
dcb_printf(dcb, "Parameters:\t");
for (int i = 0; i < cmd->arg_count_max; i++)
{