diff --git a/lib/clixon/clixon_dispatcher.h b/lib/clixon/clixon_dispatcher.h index 88bde49d..ff8bb0fd 100644 --- a/lib/clixon/clixon_dispatcher.h +++ b/lib/clixon/clixon_dispatcher.h @@ -1,12 +1,43 @@ /* - * Copyright 2021 Rubicon Communications LLC (Netgate) + * + ***** BEGIN LICENSE BLOCK ***** + + Copyright (C) 2021 Rubicon Communications, LLC(Netgate) + + This file is part of CLIXON. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + Alternatively, the contents of this file may be used under the terms of + the GNU General Public License Version 3 or later (the "GPL"), + in which case the provisions of the GPL are applicable instead + of those above. If you wish to allow use of your version of this file only + under the terms of the GPL, and not to allow others to + use your version of this file under the terms of Apache License version 2, + indicate your decision by deleting the provisions above and replace them with + the notice and other provisions required by the GPL. If you do not delete + the provisions above, a recipient may use your version of this file under + the terms of any one of the Apache License version 2 or the GPL. + + ***** END LICENSE BLOCK ***** + * @see https://github.com/dcornejo/dispatcher */ -#ifndef DISPATCH_DISPATCHER_H -#define DISPATCH_DISPATCHER_H +#ifndef _CLIXON_DISPATCH_DISPATCHER_H +#define _CLIXON_DISPATCH_DISPATCHER_H -/*! prototype for a function to handle a path +/*! Prototype for a function to handle a path * minimally needs the path it's working on, but probably * we want to hand down cached data somehow * @param[in] h Generic handler @@ -74,5 +105,6 @@ struct _dispatcher_entry { int dispatcher_register_handler(dispatcher_entry_t **root, dispatcher_definition *x); int dispatcher_call_handlers(dispatcher_entry_t *root, void *handle, char *path, void *user_args); int dispatcher_free(dispatcher_entry_t *root); +int dispatcher_print(FILE *f, dispatcher_entry_t *root); -#endif /* DISPATCH_DISPATCHER_H */ +#endif /* _CLIXON_DISPATCH_DISPATCHER_H */ diff --git a/test/test_dispatcher.sh b/test/test_dispatcher.sh new file mode 100755 index 00000000..2735a9ad --- /dev/null +++ b/test/test_dispatcher.sh @@ -0,0 +1,54 @@ +#!/usr/bin/env bash +# Test of path dispatcher + +# Magic line must be first in script (see README.md) +s="$_" ; . ./lib.sh || if [ "$s" = $0 ]; then exit 0; else return 0; fi + +: ${clixon_util_dispatcher:="clixon_util_dispatcher"} + +new "null test" +expectpart "$($clixon_util_dispatcher)" 0 "^$" + +new "path /, nothing regged. Expect fail" +expectpart "$($clixon_util_dispatcher -c /)" 255 "^$" + +new "reg /, path / arg foo" +expectpart "$($clixon_util_dispatcher -a foo -p / -r -c /)" 0 "cb1 foo" + +new "reg /foo and /bar same cb1, call /" +expectpart "$($clixon_util_dispatcher -a foo -p /foo -r -a bar -p /bar -r -c /)" 0 "cb1 foo" "cb1 bar" + +new "reg /foo and /bar different cb, call /" +expectpart "$($clixon_util_dispatcher -i 1 -a foo -p /foo -r -a bar -p /bar -i 2 -r -c /)" 0 "cb1 foo" "cb2 bar" + +new "reg /foo and /bar call /foo" +expectpart "$($clixon_util_dispatcher -i 1 -a foo -p /foo -r -a bar -p /bar -i 2 -r -c /foo)" 0 "cb1 foo" + +new "reg /foo and /bar call /bar" +expectpart "$($clixon_util_dispatcher -i 1 -a foo -p /foo -r -a bar -p /bar -i 2 -r -c /bar)" 0 "cb2 bar" + +new "reg /route-table ipv4 and ipv6 call /route-table" +expectpart "$($clixon_util_dispatcher -i 1 -a ipv4 -p /route-table/ipv4 -r -a ipv6 -p /route-table -i 2 -r -c /route-table)" 0 "cb1 ipv4" "cb2 ipv6" + +new "reg /route-table/ ipv4,ipv6 call /route-table/ipv4" +expectpart "$($clixon_util_dispatcher -i 1 -a ipv4 -p /route-table/ipv4 -r -a ipv6 -p /route-table/ipv6 -i 2 -r -c /route-table/ipv4)" 0 "cb1 ipv4" --not-- cb2 + +new "reg /route-table/ ipv4,ipv6 call /route-table/ipv6" +expectpart "$($clixon_util_dispatcher -i 1 -a ipv4 -p /route-table/ipv4 -r -a ipv6 -p /route-table/ipv6 -i 2 -r -c /route-table/ipv6)" 0 "cb2 ipv6" --not-- cb1 + +new "reg /route-table/ ipv4,ipv6 call /route-table[proto='ipv4']/ipv4" +expectpart "$($clixon_util_dispatcher -i 1 -a ipv4 -p /route-table/ipv4 -r -a ipv6 -p /route-table/ipv6 -i 2 -r -c /route-table[proto='ipv4']/ipv4)" 0 "cb1 ipv4" --not-- "cb2 ipv6" + +new "reg /route-table/ ipv4,ipv6 call /route-table[proto='ipv6']/ipv6" +expectpart "$($clixon_util_dispatcher -i 1 -a ipv4 -p /route-table/ipv4 -r -a ipv6 -p /route-table/ipv6 -i 2 -r -c /route-table[proto='ipv6']/ipv6)" 0 "cb2 ipv6" --not-- "cb1 ipv4" + +new "reg /route-table/ ipv4,ipv6 call /route-table=/ipv4" +expectpart "$($clixon_util_dispatcher -i 1 -a ipv4 -p /route-table/ipv4 -r -a ipv6 -p /route-table/ipv6 -i 2 -r -c /route-table=/ipv4)" 0 "cb1 ipv4" --not-- "cb2 ipv6" + +# unset conditional parameters +unset clixon_util_dispatcher + +rm -rf $dir + +new "endtest" +endtest diff --git a/util/clixon_util_dispatcher b/util/clixon_util_dispatcher new file mode 100755 index 00000000..4601c6a9 Binary files /dev/null and b/util/clixon_util_dispatcher differ