14418919fSjohnjiang /* SPDX-License-Identifier: BSD-3-Clause
24418919fSjohnjiang * Copyright 2014 6WIND S.A.
34418919fSjohnjiang */
44418919fSjohnjiang
54418919fSjohnjiang #include <stdlib.h>
64418919fSjohnjiang #include <stdio.h>
74418919fSjohnjiang #include <string.h>
84418919fSjohnjiang
94418919fSjohnjiang #include <rte_common.h>
104418919fSjohnjiang #include <rte_kvargs.h>
114418919fSjohnjiang
124418919fSjohnjiang #include "test.h"
134418919fSjohnjiang
144418919fSjohnjiang /* incrementd in handler, to check it is properly called once per
154418919fSjohnjiang * key/value association */
164418919fSjohnjiang static unsigned count;
174418919fSjohnjiang
184418919fSjohnjiang /* this handler increment the "count" variable at each call and check
194418919fSjohnjiang * that the key is "check" and the value is "value%d" */
check_handler(const char * key,const char * value,__rte_unused void * opaque)204418919fSjohnjiang static int check_handler(const char *key, const char *value,
214418919fSjohnjiang __rte_unused void *opaque)
224418919fSjohnjiang {
234418919fSjohnjiang char buf[16];
244418919fSjohnjiang
254418919fSjohnjiang /* we check that the value is "check" */
264418919fSjohnjiang if (strcmp(key, "check"))
274418919fSjohnjiang return -1;
284418919fSjohnjiang
294418919fSjohnjiang /* we check that the value is "value$(count)" */
304418919fSjohnjiang snprintf(buf, sizeof(buf), "value%d", count);
314418919fSjohnjiang if (strncmp(buf, value, sizeof(buf)))
324418919fSjohnjiang return -1;
334418919fSjohnjiang
344418919fSjohnjiang count ++;
354418919fSjohnjiang return 0;
364418919fSjohnjiang }
374418919fSjohnjiang
384418919fSjohnjiang /* test a valid case */
test_valid_kvargs(void)394418919fSjohnjiang static int test_valid_kvargs(void)
404418919fSjohnjiang {
414418919fSjohnjiang struct rte_kvargs *kvlist;
424418919fSjohnjiang const char *args;
434418919fSjohnjiang const char *valid_keys_list[] = { "foo", "check", NULL };
444418919fSjohnjiang const char **valid_keys;
454418919fSjohnjiang
464418919fSjohnjiang /* empty args is valid */
474418919fSjohnjiang args = "";
484418919fSjohnjiang valid_keys = NULL;
494418919fSjohnjiang kvlist = rte_kvargs_parse(args, valid_keys);
504418919fSjohnjiang if (kvlist == NULL) {
514418919fSjohnjiang printf("rte_kvargs_parse() error");
524418919fSjohnjiang goto fail;
534418919fSjohnjiang }
544418919fSjohnjiang rte_kvargs_free(kvlist);
554418919fSjohnjiang
564418919fSjohnjiang /* first test without valid_keys */
574418919fSjohnjiang args = "foo=1234,check=value0,check=value1";
584418919fSjohnjiang valid_keys = NULL;
594418919fSjohnjiang kvlist = rte_kvargs_parse(args, valid_keys);
604418919fSjohnjiang if (kvlist == NULL) {
614418919fSjohnjiang printf("rte_kvargs_parse() error");
624418919fSjohnjiang goto fail;
634418919fSjohnjiang }
644418919fSjohnjiang /* call check_handler() for all entries with key="check" */
654418919fSjohnjiang count = 0;
664418919fSjohnjiang if (rte_kvargs_process(kvlist, "check", check_handler, NULL) < 0) {
674418919fSjohnjiang printf("rte_kvargs_process() error\n");
684418919fSjohnjiang rte_kvargs_free(kvlist);
694418919fSjohnjiang goto fail;
704418919fSjohnjiang }
714418919fSjohnjiang if (count != 2) {
724418919fSjohnjiang printf("invalid count value %d after rte_kvargs_process(check)\n",
734418919fSjohnjiang count);
744418919fSjohnjiang rte_kvargs_free(kvlist);
754418919fSjohnjiang goto fail;
764418919fSjohnjiang }
774418919fSjohnjiang count = 0;
784418919fSjohnjiang /* call check_handler() for all entries with key="unexistant_key" */
794418919fSjohnjiang if (rte_kvargs_process(kvlist, "unexistant_key", check_handler, NULL) < 0) {
804418919fSjohnjiang printf("rte_kvargs_process() error\n");
814418919fSjohnjiang rte_kvargs_free(kvlist);
824418919fSjohnjiang goto fail;
834418919fSjohnjiang }
844418919fSjohnjiang if (count != 0) {
854418919fSjohnjiang printf("invalid count value %d after rte_kvargs_process(unexistant_key)\n",
864418919fSjohnjiang count);
874418919fSjohnjiang rte_kvargs_free(kvlist);
884418919fSjohnjiang goto fail;
894418919fSjohnjiang }
904418919fSjohnjiang /* count all entries with key="foo" */
914418919fSjohnjiang count = rte_kvargs_count(kvlist, "foo");
924418919fSjohnjiang if (count != 1) {
934418919fSjohnjiang printf("invalid count value %d after rte_kvargs_count(foo)\n",
944418919fSjohnjiang count);
954418919fSjohnjiang rte_kvargs_free(kvlist);
964418919fSjohnjiang goto fail;
974418919fSjohnjiang }
984418919fSjohnjiang /* count all entries */
994418919fSjohnjiang count = rte_kvargs_count(kvlist, NULL);
1004418919fSjohnjiang if (count != 3) {
1014418919fSjohnjiang printf("invalid count value %d after rte_kvargs_count(NULL)\n",
1024418919fSjohnjiang count);
1034418919fSjohnjiang rte_kvargs_free(kvlist);
1044418919fSjohnjiang goto fail;
1054418919fSjohnjiang }
1064418919fSjohnjiang /* count all entries with key="unexistant_key" */
1074418919fSjohnjiang count = rte_kvargs_count(kvlist, "unexistant_key");
1084418919fSjohnjiang if (count != 0) {
1094418919fSjohnjiang printf("invalid count value %d after rte_kvargs_count(unexistant_key)\n",
1104418919fSjohnjiang count);
1114418919fSjohnjiang rte_kvargs_free(kvlist);
1124418919fSjohnjiang goto fail;
1134418919fSjohnjiang }
1144418919fSjohnjiang rte_kvargs_free(kvlist);
1154418919fSjohnjiang
1164418919fSjohnjiang /* second test using valid_keys */
1174418919fSjohnjiang args = "foo=droids,check=value0,check=value1,check=wrong_value";
1184418919fSjohnjiang valid_keys = valid_keys_list;
1194418919fSjohnjiang kvlist = rte_kvargs_parse(args, valid_keys);
1204418919fSjohnjiang if (kvlist == NULL) {
1214418919fSjohnjiang printf("rte_kvargs_parse() error");
1224418919fSjohnjiang goto fail;
1234418919fSjohnjiang }
1244418919fSjohnjiang /* call check_handler() on all entries with key="check", it
1254418919fSjohnjiang * should fail as the value is not recognized by the handler */
1264418919fSjohnjiang if (rte_kvargs_process(kvlist, "check", check_handler, NULL) == 0) {
1274418919fSjohnjiang printf("rte_kvargs_process() is success bu should not\n");
1284418919fSjohnjiang rte_kvargs_free(kvlist);
1294418919fSjohnjiang goto fail;
1304418919fSjohnjiang }
1314418919fSjohnjiang count = rte_kvargs_count(kvlist, "check");
1324418919fSjohnjiang if (count != 3) {
1334418919fSjohnjiang printf("invalid count value %d after rte_kvargs_count(check)\n",
1344418919fSjohnjiang count);
1354418919fSjohnjiang rte_kvargs_free(kvlist);
1364418919fSjohnjiang goto fail;
1374418919fSjohnjiang }
1384418919fSjohnjiang rte_kvargs_free(kvlist);
1394418919fSjohnjiang
1404418919fSjohnjiang /* third test using list as value */
1414418919fSjohnjiang args = "foo=[0,1],check=value2";
1424418919fSjohnjiang valid_keys = valid_keys_list;
1434418919fSjohnjiang kvlist = rte_kvargs_parse(args, valid_keys);
1444418919fSjohnjiang if (kvlist == NULL) {
145*0c6bd470Sfengbojiang printf("rte_kvargs_parse() error\n");
1464418919fSjohnjiang goto fail;
1474418919fSjohnjiang }
1484418919fSjohnjiang if (strcmp(kvlist->pairs[0].value, "[0,1]") != 0) {
1494418919fSjohnjiang printf("wrong value %s", kvlist->pairs[0].value);
1504418919fSjohnjiang goto fail;
1514418919fSjohnjiang }
1524418919fSjohnjiang count = kvlist->count;
1534418919fSjohnjiang if (count != 2) {
1544418919fSjohnjiang printf("invalid count value %d\n", count);
1554418919fSjohnjiang rte_kvargs_free(kvlist);
1564418919fSjohnjiang goto fail;
1574418919fSjohnjiang }
1584418919fSjohnjiang rte_kvargs_free(kvlist);
1594418919fSjohnjiang
160*0c6bd470Sfengbojiang /* test using empty string (it is valid) */
161*0c6bd470Sfengbojiang args = "";
162*0c6bd470Sfengbojiang kvlist = rte_kvargs_parse(args, NULL);
163*0c6bd470Sfengbojiang if (kvlist == NULL) {
164*0c6bd470Sfengbojiang printf("rte_kvargs_parse() error\n");
165*0c6bd470Sfengbojiang goto fail;
166*0c6bd470Sfengbojiang }
167*0c6bd470Sfengbojiang if (rte_kvargs_count(kvlist, NULL) != 0) {
168*0c6bd470Sfengbojiang printf("invalid count value\n");
169*0c6bd470Sfengbojiang goto fail;
170*0c6bd470Sfengbojiang }
171*0c6bd470Sfengbojiang rte_kvargs_free(kvlist);
172*0c6bd470Sfengbojiang
173*0c6bd470Sfengbojiang /* test using empty elements (it is valid) */
174*0c6bd470Sfengbojiang args = "foo=1,,check=value2,,";
175*0c6bd470Sfengbojiang kvlist = rte_kvargs_parse(args, NULL);
176*0c6bd470Sfengbojiang if (kvlist == NULL) {
177*0c6bd470Sfengbojiang printf("rte_kvargs_parse() error\n");
178*0c6bd470Sfengbojiang goto fail;
179*0c6bd470Sfengbojiang }
180*0c6bd470Sfengbojiang if (rte_kvargs_count(kvlist, NULL) != 2) {
181*0c6bd470Sfengbojiang printf("invalid count value\n");
182*0c6bd470Sfengbojiang goto fail;
183*0c6bd470Sfengbojiang }
184*0c6bd470Sfengbojiang if (rte_kvargs_count(kvlist, "foo") != 1) {
185*0c6bd470Sfengbojiang printf("invalid count value for 'foo'\n");
186*0c6bd470Sfengbojiang goto fail;
187*0c6bd470Sfengbojiang }
188*0c6bd470Sfengbojiang if (rte_kvargs_count(kvlist, "check") != 1) {
189*0c6bd470Sfengbojiang printf("invalid count value for 'check'\n");
190*0c6bd470Sfengbojiang goto fail;
191*0c6bd470Sfengbojiang }
192*0c6bd470Sfengbojiang rte_kvargs_free(kvlist);
193*0c6bd470Sfengbojiang
1944418919fSjohnjiang return 0;
1954418919fSjohnjiang
1964418919fSjohnjiang fail:
1974418919fSjohnjiang printf("while processing <%s>", args);
1984418919fSjohnjiang if (valid_keys != NULL && *valid_keys != NULL) {
1994418919fSjohnjiang printf(" using valid_keys=<%s", *valid_keys);
2004418919fSjohnjiang while (*(++valid_keys) != NULL)
2014418919fSjohnjiang printf(",%s", *valid_keys);
2024418919fSjohnjiang printf(">");
2034418919fSjohnjiang }
2044418919fSjohnjiang printf("\n");
2054418919fSjohnjiang return -1;
2064418919fSjohnjiang }
2074418919fSjohnjiang
2084418919fSjohnjiang /* test several error cases */
test_invalid_kvargs(void)2094418919fSjohnjiang static int test_invalid_kvargs(void)
2104418919fSjohnjiang {
2114418919fSjohnjiang struct rte_kvargs *kvlist;
2124418919fSjohnjiang /* list of argument that should fail */
2134418919fSjohnjiang const char *args_list[] = {
2144418919fSjohnjiang "wrong-key=x", /* key not in valid_keys_list */
2154418919fSjohnjiang "foo=1,foo=", /* empty value */
2164418919fSjohnjiang "foo=1,foo", /* no value */
2174418919fSjohnjiang "foo=1,=2", /* no key */
2184418919fSjohnjiang "foo=[1,2", /* no closing bracket in value */
2194418919fSjohnjiang ",=", /* also test with a smiley */
220*0c6bd470Sfengbojiang "foo=[", /* no value in list and no closing bracket */
2214418919fSjohnjiang NULL };
2224418919fSjohnjiang const char **args;
2234418919fSjohnjiang const char *valid_keys_list[] = { "foo", "check", NULL };
2244418919fSjohnjiang const char **valid_keys = valid_keys_list;
2254418919fSjohnjiang
2264418919fSjohnjiang for (args = args_list; *args != NULL; args++) {
2274418919fSjohnjiang
2284418919fSjohnjiang kvlist = rte_kvargs_parse(*args, valid_keys);
2294418919fSjohnjiang if (kvlist != NULL) {
2304418919fSjohnjiang printf("rte_kvargs_parse() returned 0 (but should not)\n");
2314418919fSjohnjiang rte_kvargs_free(kvlist);
2324418919fSjohnjiang goto fail;
2334418919fSjohnjiang }
2344418919fSjohnjiang }
235*0c6bd470Sfengbojiang return 0;
2364418919fSjohnjiang
2374418919fSjohnjiang fail:
2384418919fSjohnjiang printf("while processing <%s>", *args);
2394418919fSjohnjiang if (valid_keys != NULL && *valid_keys != NULL) {
2404418919fSjohnjiang printf(" using valid_keys=<%s", *valid_keys);
2414418919fSjohnjiang while (*(++valid_keys) != NULL)
2424418919fSjohnjiang printf(",%s", *valid_keys);
2434418919fSjohnjiang printf(">");
2444418919fSjohnjiang }
2454418919fSjohnjiang printf("\n");
2464418919fSjohnjiang return -1;
2474418919fSjohnjiang }
2484418919fSjohnjiang
2494418919fSjohnjiang static int
test_kvargs(void)2504418919fSjohnjiang test_kvargs(void)
2514418919fSjohnjiang {
2524418919fSjohnjiang printf("== test valid case ==\n");
2534418919fSjohnjiang if (test_valid_kvargs() < 0)
2544418919fSjohnjiang return -1;
2554418919fSjohnjiang printf("== test invalid case ==\n");
2564418919fSjohnjiang if (test_invalid_kvargs() < 0)
2574418919fSjohnjiang return -1;
2584418919fSjohnjiang return 0;
2594418919fSjohnjiang }
2604418919fSjohnjiang
2614418919fSjohnjiang REGISTER_TEST_COMMAND(kvargs_autotest, test_kvargs);
262