kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-09-02 19:16:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add ability to pass arguments to unit tests from the CLI

Browse Source 
Unit tests can now be passed custom arguments from the command
line.  For example, the following command would run the "mytest" test
in the "/main/mycat" category with the option "myoption=54"

`CLI> test execute category /main/mycat name mytest options myoption=54`

You can also pass options to an entire category...

`CLI> test execute category /main/mycat options myoption=54`

Basically, everything after the "options" keyword is passed verbatim to
the test which must decide what to do with it.

* A new API ast_test_get_cli_args() was created to give the tests access to
the cli_args->argc and cli_args->argv elements.

* Although not needed for the option processing, a new macro
ast_test_validate_cleanup_custom() was added to test.h that allows you
to specify a custom error message instead of just "Condition failed".

* The test_skel.c was updated to demonstrate parsing options and the use
of the ast_test_validate_cleanup_custom() macro.

(cherry picked from commit 6d63b62853)
This commit is contained in:
George Joseph
2024-12-27 08:19:08 -07:00
committed by Asterisk Development Team
parent cde6bcf66c
commit 22108f46ee
3 changed files with 127 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
main/test.c
View File

@@ -1013,6 +1013,11 @@ static struct ast_test *test_alloc(ast_test_cb_t *cb)
return test;
}
struct ast_cli_args *ast_test_get_cli_args(struct ast_test *test)
{
return test->cli;
}
static char *complete_test_category(const char *word)
{
int wordlen = strlen(word);
@@ -1115,18 +1120,24 @@ static char *test_cli_show_registered(struct ast_cli_entry *e, int cmd, struct a
static char *test_cli_execute_registered(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
{
static const char * const option1[] = { "all", "category", NULL };
static const char * const option2[] = { "name", NULL };
static const char * const option2[] = { "name", "options", NULL };
static const char * const option3[] = { "options", NULL };
switch (cmd) {
case CLI_INIT:
e->command = "test execute";
e->usage =
"Usage: test execute can be used in three ways.\n"
"Usage: test execute can be used in several ways.\n"
" 1. 'test execute all' runs all registered tests\n"
" 2. 'test execute category [test category]' runs all tests in the given\n"
" category.\n"
" 3. 'test execute category [test category] name [test name]' runs all\n"
" tests in a given category matching a given name\n";
" 3. 'test execute category [test category] options [test option]...' runs all\n"
" tests in the given category with options supplied to each test\n"
" 4. 'test execute category [test category] name [test name]' runs all\n"
" tests in a given category matching a given name\n"
" 5. 'test execute category [test category] name [test name] options [test option]...' runs all\n"
" tests in a given category matching a given name with the specified options\n"
;
return NULL;
case CLI_GENERATE:
if (a->pos == 2) {
@@ -1138,13 +1149,19 @@ static char *test_cli_execute_registered(struct ast_cli_entry *e, int cmd, struc
if (a->pos == 4) {
return ast_cli_complete(a->word, option2, -1);
}
if (a->pos == 5) {
if (a->pos == 5 && !strcasecmp(a->argv[4], "name")) {
return complete_test_name(a->word, a->argv[3]);
}
if (a->pos == 5 && !strcasecmp(a->argv[4], "options")) {
return NULL;
}
if (a->pos == 6 && !strcasecmp(a->argv[4], "name")) {
return ast_cli_complete(a->word, option3, -1);
}
return NULL;
case CLI_HANDLER:
if (a->argc < 3|| a->argc > 6) {
if (a->argc < 3) {
return CLI_SHOWUSAGE;
}
@@ -1154,9 +1171,15 @@ static char *test_cli_execute_registered(struct ast_cli_entry *e, int cmd, struc
} else if (a->argc == 4) { /* run only tests within a category */
ast_cli(a->fd, "Running all available tests matching category %s\n\n", a->argv[3]);
test_execute_multiple(NULL, a->argv[3], a);
} else if (a->argc == 6) { /* run only a single test matching the category and name */
} else if (a->argc >= 6 && !strcasecmp(a->argv[4], "options")) { /* run only tests within a category */
ast_cli(a->fd, "Running all available tests matching category %s with options\n\n", a->argv[3]);
test_execute_multiple(NULL, a->argv[3], a);
} else if (a->argc == 6 && !strcasecmp(a->argv[4], "name")) { /* run only a single test matching the category and name */
ast_cli(a->fd, "Running all available tests matching category %s and name %s\n\n", a->argv[3], a->argv[5]);
test_execute_multiple(a->argv[5], a->argv[3], a);
} else if (a->argc > 7) { /* run only a single test matching the category and name */
ast_cli(a->fd, "Running all available tests matching category %s and name %s with options\n\n", a->argv[3], a->argv[5]);
test_execute_multiple(a->argv[5], a->argv[3], a);
} else {
return CLI_SHOWUSAGE;
}