diff --git a/CHANGELOG.md b/CHANGELOG.md index 6751aa70..8f199bdc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -26,10 +26,13 @@ Expected: October 2024 * New `clixon-autocli@2024-08-01.yang` revision - Added: disable operation for module rules * Optimize YANG memory - * Added union and extended struct for uncommon fields - * Removed per-object YANG linenr info - * Yang-type cache only for original trees (not derived via grouping/augment) - * Added option `CLICON_YANG_USE_ORIGINAL` to use original yang object in grouping/augment + * Autocli + * Late evaluation of uses/grouping + * YANG + * Added union and extended struct for uncommon fields + * Removed per-object YANG linenr info + * Yang-type cache only for original trees (not derived via grouping/augment) + * Added option `CLICON_YANG_USE_ORIGINAL` to use original yang object in grouping/augment * New: [CLI simple alias](https://github.com/clicon/cligen/issues/112) * See: https://clixon-docs.readthedocs.io/en/latest/cli.html#cli-aliases * List pagination: Added where, sort-by and direction parameter for configured data diff --git a/apps/cli/cli_generate.c b/apps/cli/cli_generate.c index e6a5da09..175e94b1 100644 --- a/apps/cli/cli_generate.c +++ b/apps/cli/cli_generate.c @@ -265,6 +265,95 @@ yang2cli_print_alias(cbuf *cb, return retval; } +/*! Use cligen cmd name to encode info: ---> + * + * @param[out] cb CLIgen buf + * @param[in] delim Delimiter string that may not occur in any of the elements (except the last) + * @param[in] tag Context-specific tag, eg "grouping" + * @param[in] domain Domain name (= yspec name) + * @param[in] module Name of module (in domain context) + * @param[in] id Top-level nodeid (schema-id) + * @retval 0 Ok + * @retval -1 Error + */ +int +yang2cli_cmd_encode(cbuf *cb, + const char *delim, + char *tag, + char *domain, + char *module, + char *id) +{ + if (tag == NULL || domain == NULL || module == NULL || id == NULL){ + clixon_err(OE_YANG, EINVAL, "tag, domain, module or id is NULL"); + return -1; + } + cprintf(cb, "%s", tag); + cprintf(cb, "%s%s", delim, domain); + cprintf(cb, "%s%s", delim, module); + cprintf(cb, "%s%s", delim, id); + return 0; +} + +/*! Use cligen cmd name to decode info: ---> + * + * @param[in] cmd CLIgen cmd string + * @param[in] delim Delimiter string that may not occur in any of the elements (except the last) + * @param[out] tag Context-specific tag, eg "grouping" + * @param[out] domain Domain name (= yspec name) + * @param[out] module Name of module (in domain context) + * @param[out] id Top-level nodeid (schema-id) + * @retval 0 Ok + * @retval -1 Error + */ +int +yang2cli_cmd_decode(char *cmd, + const char *delim, + char **tag, + char **domain, + char **modname, + char **id) +{ + int retval = -1; + char *s1; + char *s2 = NULL; + + if (cmd == NULL || delim == NULL || tag == NULL){ + clixon_err(OE_YANG, EINVAL, "cmd, delim or tag is NULL"); + goto done; + } + if ((s2 = strdup(cmd)) == NULL){ + clixon_err(OE_UNIX, errno, "strdup"); + goto done; + } + *tag = s2; + s1 = s2; + if ((s2 = strstr(s1, delim)) == NULL) + goto ok; + *s2 = '\0'; + s2 += strlen(delim); + if (domain) + *domain = s2; + s1 = s2; + if ((s2 = strstr(s1, delim)) == NULL) + goto ok; + *s2 = '\0'; + s2 += strlen(delim); + if (modname) + *modname = s2; + s1 = s2; + if ((s2 = strstr(s1, delim)) == NULL) + goto ok; + *s2 = '\0'; + s2 += strlen(delim); + if (id) + *id = s2; + ok: + retval = 0; + done: + return retval; +} + /*! Generate identityref statements for CLI variables * * @param[in] ys Yang statement @@ -1178,20 +1267,6 @@ yang2cli_choice(clixon_handle h, return retval; } -/*! Generate clispec for all modules in a grouping - * - * Called in cli main function for top-level yangs. But may also be called dynamically for - * mountpoints. - * @param[in] h Clixon handle - * @param[in] ys Top-level Yang statement - * @param[in] treename Name of tree - * @retval 0 OK - * @retval -1 Error - * @note Tie-break of same top-level symbol: prefix is NYI - * @see yang2cli_yspec for original - */ -static int yang2cli_grouping(clixon_handle h, yang_stmt *ys, char *treename); - /*! Generate CLI code for Yang uses statement * * @param[in] h Clixon handle @@ -1200,6 +1275,7 @@ static int yang2cli_grouping(clixon_handle h, yang_stmt *ys, char *treename); * @param[out] cb Buffer where cligen code is written * @retval 0 OK * @retval -1 Error + * @note This function is called only if autcli grouping_treeref */ static int yang2cli_uses(clixon_handle h, @@ -1215,7 +1291,6 @@ yang2cli_uses(clixon_handle h, cbuf *cbtree = NULL; char *api_path_fmt = NULL; yang_stmt *yp; - int ret; if (nodeid_split(yang_argument_get(ys), &prefix, &id) < 0) goto done; @@ -1228,27 +1303,22 @@ yang2cli_uses(clixon_handle h, if ((cbtree = cbuf_new()) == NULL){ clixon_err(OE_XML, errno, "cbuf_new"); goto done; - } - /* prefix is not globally unique, need namespace */ + } /* prefix is not globally unique, need namespace */ if ((ns = yang_find_mynamespace(ygrouping)) == NULL) goto done; - cprintf(cbtree, "grouping-%s-%s", ns, id); - if (cligen_ph_find(cli_cligen(h), cbuf_get(cbtree)) == NULL){ - /* No such tree, generate it */ - if ((ret = yang2cli_grouping(h, ygrouping, cbuf_get(cbtree))) < 0) - goto done; - if (ret == 0) /* tree empty */ - goto ok; - } + if (yang2cli_cmd_encode(cbtree, AUTOCLI_CMD_DELIM, "grouping", + yang_argument_get(ys_spec(ygrouping)), + yang_argument_get(ys_module(ygrouping)), + id) < 0) + goto done; cprintf(cb, "%*s@%s", level*3, "", cbuf_get(cbtree)); /* get api-path to parent, do not include "uses" argument since it is replaced */ yp = yang_parent_get(ys); if (yang2api_path_fmt(yp, 0, &api_path_fmt) < 0) goto done; - /* This adds a "prepend" callback with decendant argument */ + /* This adds a "prepend" callback with descendant argument */ cprintf(cb, ",%s(\"%s\")", GROUPING_CALLBACK, api_path_fmt); cprintf(cb, ";\n"); - ok: retval = 0; done: if (api_path_fmt) @@ -1542,7 +1612,7 @@ yang2cli_post(clixon_handle h, * @see yang2cli_yspec and yang2cli_stmt for original * XXX merge with yang2cli_yspec */ -static int +int yang2cli_grouping(clixon_handle h, yang_stmt *ys, char *treename) @@ -1801,15 +1871,105 @@ yang2cli_yspec(clixon_handle h, return retval; } +/*! CLIgen wrap function for making treeref lookup: generate clispec tree from YANG + * + * This adds an indirection based on name and context + * If a yang and specific tree is created, the name of that tree is returned in namep, + * That tree is called something like mountpoint- + * otherwise the generic name "mountpoint" is used. + * @param[in] ch CLIgen handle + * @param[in] name Base tree name + * @param[in] cvt Tokenized string: vector of tokens + * @param[in] arg Argument given when registering wrap function (maybe not needed?) + * @param[out] namep New (malloced) name + * @retval 1 New malloced name in namep + * @retval 0 No wrapper, use existing + * @retval -1 Error + * @see yang2cli_container where @mountpoint is added as a generic treeref causing this call + */ +int +yang2cli_grouping_wrap(cligen_handle ch, + char *name, + cvec *cvt, + void *arg, + char **namep) +{ + int retval = -1; + clixon_handle h; + yang_stmt *ymnt; + yang_stmt *yspec; + yang_stmt *ymod; + yang_stmt *ygrouping; + char *tag = NULL; + char *domain = NULL; + char *modname = NULL; + char *grouping = NULL; + int ret; + + if (namep == NULL){ + clixon_err(OE_UNIX, EINVAL, "Missing namep"); + goto done; + } + h = cligen_userhandle(ch); + yspec = clicon_dbspec_yang(h); + if (yang2cli_cmd_decode(name, AUTOCLI_CMD_DELIM, &tag, &domain, &modname, &grouping) < 0) + goto done; + if (tag == NULL || strcmp(tag, "grouping") != 0) + goto ok; + if (cligen_ph_find(ch, name) != NULL){ + *namep = strdup(name); + goto ok; + } + if (domain == NULL || modname == NULL || grouping == NULL){ + clixon_err(OE_YANG, 0, "yang2cli cmd label invalid format"); + goto done; + } + ymnt = clixon_yang_mounts_get(h); + if ((yspec = yang_find(ymnt, Y_SPEC, domain)) == NULL){ + clixon_err(OE_YANG, 0, "yang2cli cmd label no yspec %s", domain); + goto done; + } + if ((ymod = yang_find(yspec, 0, modname)) == NULL){ + clixon_err(OE_YANG, 0, "yang2cli cmd label no module %s", modname); + goto done; + } + if ((ygrouping = yang_find(ymod, Y_GROUPING, grouping)) == NULL) + goto ok; + if ((ret = yang2cli_grouping(h, ygrouping, name)) < 0) + goto done; + if (ret == 0) /* tree empty */ + goto ok; + *namep = strdup(name); + ok: + retval = 0; + done: + if (tag) + free(tag); + return retval; +} + /*! Init yang2cli * * Initialize CLIgen generation from YANG models. - * Nothing now - * + * Some logic around grouping-treeref: if enabled, then groupings are sperate trees with lazy + * evaluation. Only expanded when referenced, but need a callback. If one is not already installed. * @param[in] h Clixon handle */ int yang2cli_init(clixon_handle h) { - return 0; + int retval = -1; + int grouping_treeref = 0; + cligen_tree_resolve_wrapper_fn *fn = NULL; + + if (autocli_grouping_treeref(h, &grouping_treeref) < 0) + goto done; + if (grouping_treeref) { + cligen_tree_resolve_wrapper_get(cli_cligen(h), &fn, NULL); + if (fn == NULL) + cligen_tree_resolve_wrapper_set(cli_cligen(h), yang2cli_grouping_wrap, NULL); + } + retval = 0; + done: + return retval; } diff --git a/apps/cli/cli_generate.h b/apps/cli/cli_generate.h index 3f1f07e9..e1b13950 100644 --- a/apps/cli/cli_generate.h +++ b/apps/cli/cli_generate.h @@ -54,14 +54,20 @@ /* variable expand function */ #define GENERATE_EXPAND_XMLDB "expand_dbvar" -/* Name of autocli CLIgen treename - */ +/* Name of autocli CLIgen treename */ #define AUTOCLI_TREENAME "basemodel" +/*! Delimiter when creating yang2cli grouping cmd label */ +#define AUTOCLI_CMD_DELIM "--" + /* * Prototypes */ +int yang2cli_cmd_encode(cbuf *cb, const char *delim, char *tag, char *domain, char *modname, char *id); +int yang2cli_cmd_decode(char *cmd, const char *delim, char **tag, char **domain, char **modname, char **id); +int yang2cli_grouping(clixon_handle h, yang_stmt *ys, char *treename); int yang2cli_yspec(clixon_handle h, yang_stmt *yspec, char *treename); +int yang2cli_grouping_wrap(cligen_handle ch, char *name, cvec *cvt, void *arg, char **namep); int yang2cli_init(clixon_handle h); #endif /* _CLI_GENERATE_H_ */ diff --git a/test/test_autocli_grouping.sh b/test/test_autocli_grouping.sh index f8646a5f..4b2b3468 100755 --- a/test/test_autocli_grouping.sh +++ b/test/test_autocli_grouping.sh @@ -209,10 +209,10 @@ EOF # The testcase assumes enabled if ${grouping_treeref}; then new "verify grouping is enabled" - expectpart "$($clixon_cli -f $cfg -G -1 2>&1)" 0 "@grouping-urn:example:clixon-pg1" "@grouping-urn:example:external-pg2" "@grouping-urn:example:external-pg3" + expectpart "$($clixon_cli -f $cfg -G -1 2>&1)" 0 "@grouping--data--example--pg1" "@grouping--data--example-external--pg2" # "@grouping--data--example-external--pg3" else new "verify grouping is disabled" - expectpart "$($clixon_cli -f $cfg -G -1 2>&1)" 0 --not-- "@grouping-urn:example:clixon-pg1" "@grouping-urn:example:external-pg2" "@grouping-urn:example:external-pg3" + expectpart "$($clixon_cli -f $cfg -G -1 2>&1)" 0 --not-- "@grouping--data--example--pg1" "@grouping--data--example-external--pg2" "@grouping--data-example-external-pg3" fi new "set top-level grouping"