experiments/clixon
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

CLI configurable format: [Default format should be configurable](https://github.com/clicon/clixon-controller/issues/87)

Browse source 
Added option: `CLICON_CLI_OUTPUT_FORMAT` - Default CLI output format
This commit is contained in:
Olof hagsand 2024-04-05 15:13:24 +02:00
parent bd3a841103
commit 60a774cbf7
18 changed files with 168 additions and 83 deletions
Download patch file Download diff file Expand all files Collapse all files

13
apps/cli/cli_common.c
View file

@ -926,6 +926,7 @@ cli_validate(clixon_handle h,
* @param[in] db2 Name of second datastrore
* @retval 0 OK
* @retval -1 Error
* @note JSON and CLI are NYI
*/
int
compare_db_names(clixon_handle h,
@ -975,7 +976,7 @@ compare_db_names(clixon_handle h,
goto done;
cligen_output(stdout, "%s", cbuf_get(cb));
break;
case FORMAT_JSON:
case FORMAT_JSON: /* XXX NYI */
case FORMAT_CLI:
if (clixon_compare_xmls(xc1, xc2, format) < 0) /* astext? */
goto done;
@ -1023,6 +1024,14 @@ compare_dbs(clixon_handle h,
clixon_err(OE_XML, 0, "format not found %s", formatstr);
goto done;
}
/* Special default format handling */
if (format == FORMAT_DEFAULT){
formatstr = clicon_option_str(h, "CLICON_CLI_OUTPUT_FORMAT");
if ((int)(format = format_str2int(formatstr)) < 0){
clixon_err(OE_PLUGIN, 0, "Not valid format: %s", formatstr);
goto done;
}
}
if (compare_db_names(h, format, db1, db2) < 0)
goto done;
retval = 0;
@ -1318,6 +1327,8 @@ save_config_file(clixon_handle h,
goto done;
fprintf(f, "</edit-config></rpc>]]>]]>\n");
break;
default:
break;
} /* switch */
retval = 0;
/* Fall through */

2
apps/cli/cli_pipe.c
View file

@ -286,7 +286,7 @@ pipe_showas_fn(clixon_handle h,
goto done;
}
if (cvec_len(argv) > argc){
if (cli_show_option_format(argv, argc++, &format) < 0)
if (cli_show_option_format(h, argv, argc++, &format) < 0)
goto done;
}
if (cvec_len(argv) > argc){

101
apps/cli/cli_show.c
View file

@ -611,13 +611,13 @@ cli_show_common(clixon_handle h,
int skiptop
)
{
int retval = -1;
cxobj *xt = NULL;
cxobj *xerr;
cxobj **vec = NULL;
size_t veclen;
cxobj *xp;
int i;
int retval = -1;
cxobj *xt = NULL;
cxobj *xerr;
cxobj **vec = NULL;
size_t veclen;
cxobj *xp;
int i;
if (state && strcmp(db, "running") != 0){
clixon_err(OE_FATAL, 0, "Show state only for running database, not %s", db);
@ -713,6 +713,7 @@ done:
/*! Common internal parse cli show format option
*
* @param[in] h Clixon handle
* @param[in] argv String vector: <dbname> <format> <xpath> [<varname>]
* @param[in] argc Index into argv
* @param[out] format Output format
@ -720,18 +721,29 @@ done:
* @retval -1 Error
*/
int
cli_show_option_format(cvec *argv,
cli_show_option_format(clixon_handle h,
cvec *argv,
int argc,
enum format_enum *format)
enum format_enum *formatp)
{
int retval = -1;
char *formatstr;
int retval = -1;
enum format_enum format = FORMAT_XML;
char *formatstr;
formatstr = cv_string_get(cvec_i(argv, argc));
if ((int)(*format = format_str2int(formatstr)) < 0){
if ((int)(format = format_str2int(formatstr)) < 0){
clixon_err(OE_PLUGIN, 0, "Not valid format: %s", formatstr);
goto done;
}
/* Special default format handling */
if (format == FORMAT_DEFAULT){
formatstr = clicon_option_str(h, "CLICON_CLI_OUTPUT_FORMAT");
if ((int)(format = format_str2int(formatstr)) < 0){
clixon_err(OE_PLUGIN, 0, "Not valid format: %s", formatstr);
goto done;
}
}
*formatp = format;
retval = 0;
done:
return retval;
@ -774,7 +786,7 @@ cli_show_option_bool(cvec *argv,
/*! Common internal parse cli show with-default option
*
* Ddefault modes accorsing to RFC6243 + three extra modes based on report-all-tagged:
* Default modes accorsing to RFC6243 + three extra modes based on report-all-tagged:
* 1) NULL
* 2) report-all-tagged-default Strip "default" attribute (=report-all)
* 3) report-all-tagged-strip Strip "default" attribute and all nodes tagged with it (=trim)
@ -878,7 +890,7 @@ cli_show_config(clixon_handle h,
}
dbname = cv_string_get(cvec_i(argv, argc++));
if (cvec_len(argv) > argc)
if (cli_show_option_format(argv, argc++, &format) < 0)
if (cli_show_option_format(h, argv, argc++, &format) < 0)
goto done;
if (cvec_len(argv) > argc)
xpath = cv_string_get(cvec_i(argv, argc++));
@ -1062,7 +1074,7 @@ cli_show_auto(clixon_handle h,
else
dbname = str;
if (cvec_len(argv) > argc)
if (cli_show_option_format(argv, argc++, &format) < 0)
if (cli_show_option_format(h, argv, argc++, &format) < 0)
goto done;
if (cvec_len(argv) > argc){
if (cli_show_option_bool(argv, argc++, &pretty) < 0)
@ -1194,7 +1206,7 @@ cli_show_auto_mode(clixon_handle h,
}
dbname = cv_string_get(cvec_i(argv, argc++));
if (cvec_len(argv) > argc)
if (cli_show_option_format(argv, argc++, &format) < 0)
if (cli_show_option_format(h, argv, argc++, &format) < 0)
goto done;
if (cvec_len(argv) > argc){
if (cli_show_option_bool(argv, argc++, &pretty) < 0)
@ -1868,3 +1880,60 @@ cli_show_statistics(clixon_handle h,
cbuf_free(cb);
return retval;
}
/*! CLI set default output format
*
* @param[in] h Clixon handle
* @param[in] cvv Vector of cli string and instantiated variables, expected: 1: format
* @param[in] argv Vector, expected NULL
* @retval 0 OK
* @retval -1 Error
* Format of argv:
* <api-path-fmt> Generated
*/
int
cli_format_set(clixon_handle h,
cvec *cvv,
cvec *argv)
{
int retval = -1;
cg_var *cv;
char *str;
enum format_enum fmt = FORMAT_XML;
if ((cv = cvec_find(cvv, "fmt")) == NULL){
clixon_err(OE_PLUGIN, EINVAL, "Requires one variable to be <format>");
goto done;
}
str = cv_string_get(cv);
if ((fmt = format_str2int(str)) < 0){
clixon_err(OE_PLUGIN, EINVAL, "Invalid format: %s", str);
goto done;
}
/* Alt make a int option/data */
retval = clicon_option_str_set(h, "CLICON_CLI_OUTPUT_FORMAT", str);
done:
return retval;
}
/*! CLI set default output format
*
* @param[in] h Clixon handle
* @param[in] cvv Vector of cli string and instantiated variables, expected: 1: format
* @param[in] argv Vector, expected NULL
* @retval 0 OK
* @retval -1 Error
* Format of argv:
* <api-path-fmt> Generated
*/
int
cli_format_show(clixon_handle h,
cvec *cvv,
cvec *argv)
{
char *str;
str = clicon_option_str(h, "CLICON_CLI_OUTPUT_FORMAT");
cligen_output(stderr, "%s\n", str);
return 0;
}

2
apps/cli/clixon_cli_api.h
View file

@ -128,7 +128,7 @@ int cli_show_common(clixon_handle h, char *db, enum format_enum format, int pret
int show_yang(clixon_handle h, cvec *vars, cvec *argv);
int show_conf_xpath(clixon_handle h, cvec *cvv, cvec *argv);
int cli_show_option_format(cvec *argv, int argc, enum format_enum *format);
int cli_show_option_format(clixon_handle h, cvec *argv, int argc, enum format_enum *format);
int cli_show_option_bool(cvec *argv, int argc, int *result);
int cli_show_option_withdefault(cvec *argv, int argc, char **withdefault, char **extdefault);
int cli_show_config(clixon_handle h, cvec *cvv, cvec *argv);