19e21be0bc
Major New features
* New and updated search functions using xpath, api-path and instance-id
* New search functions using api-path and instance_id:
* C search functions: `clixon_find_instance_id()` and `clixon_find_api_path()`
* Binary search optimization in lists for indexed leafs in all three formats.
* This improves search performance to O(logN) which is drastical improvements for large lists.
* You can also register explicit indexes for making binary search (not only list keys)
* For more info, see docs at [paths](https://clixon-docs.readthedocs.io/en/latest/paths.html) and
[search](https://clixon-docs.readthedocs.io/en/latest/xml.html#searching-in-xml)
API changes on existing features (you may need to change your code)
* On failed validation of leafrefs, error message changed from: `No such leaf` to `No leaf <name> matching path <path>`.
* CLI Error message (clicon_rpc_generate_error()) changed when backend returns netconf error to be more descriptive:
* Original: `Config error: Validate failed. Edit and try again or discard changes: Invalid argument`
* New (example): `Netconf error: application operation-failed Identityref validation failed, undefined not derived from acl-base . Validate failed. Edit and try again or discard changes"
Minor changes
* Test framework
* Added `-- -S <file>` command-line to main example to be able to return any state to main example.
* Added `test/cicd` test scripts for running on a set of other hosts
* C-code restructuring
* clixon_yang.c partitioned and moved code into clixon_yang_parse_lib.c and clixon_yang_module.c and move back some code from clixon_yang_type.c.
* partly to reduce size, but most important to limit code that accesses internal yang structures, only clixon_yang.c does this now.
260 lines
8 KiB
Bash
Executable file
260 lines
8 KiB
Bash
Executable file
#!/usr/bin/env bash
|
|
# API-PATH tests
|
|
# Most tests are: generate lists, then access
|
|
# Tests include single and double indexes.
|
|
# string and int indexes
|
|
# Lists and leaf-lists
|
|
# Augmented yang where two lists are inside each other (depth)
|
|
# Multiple matches
|
|
|
|
# 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_path:=clixon_util_path -a -D $DBG}
|
|
|
|
# Number of list/leaf-list entries
|
|
: ${nr:=100}
|
|
|
|
# XML file (alt provide it in stdin after xpath)
|
|
for (( i=1; i<7; i++ )); do
|
|
eval xml$i=$dir/xml$i.xml
|
|
done
|
|
ydir=$dir/yang
|
|
|
|
if [ ! -d $ydir ]; then
|
|
mkdir $ydir
|
|
fi
|
|
|
|
# XPATH binary search in ordered-by system lists
|
|
cat <<EOF > $ydir/moda.yang
|
|
module moda{
|
|
namespace "urn:example:a";
|
|
prefix a;
|
|
container x1{
|
|
description "list with single string key";
|
|
list y{
|
|
ordered-by system;
|
|
key k1;
|
|
leaf k1{
|
|
type string;
|
|
}
|
|
leaf z{
|
|
type string;
|
|
}
|
|
}
|
|
}
|
|
container x2{
|
|
description "list with single int key";
|
|
list y{
|
|
ordered-by system;
|
|
key k1;
|
|
leaf k1{
|
|
type uint32;
|
|
}
|
|
leaf z{
|
|
type string;
|
|
}
|
|
}
|
|
}
|
|
container x3{
|
|
description "list with double string keys";
|
|
list y{
|
|
ordered-by system;
|
|
key "k1 k2";
|
|
leaf k1{
|
|
type string;
|
|
}
|
|
leaf k2{
|
|
type string;
|
|
}
|
|
leaf z{
|
|
type string;
|
|
}
|
|
}
|
|
}
|
|
container x4{
|
|
description "leaf-list with int key";
|
|
leaf-list y{
|
|
type string;
|
|
}
|
|
}
|
|
list x5{
|
|
ordered-by system;
|
|
description "Direct under root";
|
|
key "k1";
|
|
leaf k1{
|
|
type string;
|
|
}
|
|
leaf z{
|
|
type string;
|
|
}
|
|
}
|
|
augment "/b:x6/b:yy" {
|
|
list y{
|
|
ordered-by system;
|
|
key "k1 k2";
|
|
leaf k1{
|
|
type string;
|
|
}
|
|
leaf k2{
|
|
type string;
|
|
}
|
|
leaf-list z{
|
|
type string;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
EOF
|
|
|
|
# This is for augment usecase
|
|
cat <<EOF > $ydir/modb.yang
|
|
module modb{
|
|
namespace "urn:example:b";
|
|
prefix b;
|
|
container x6{
|
|
description "deep tree and augment";
|
|
list yy{
|
|
ordered-by system;
|
|
key "kk1 kk2";
|
|
leaf kk1{
|
|
type string;
|
|
}
|
|
leaf kk2{
|
|
type string;
|
|
}
|
|
leaf-list zz{
|
|
type string;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
EOF
|
|
|
|
rnd=$(( ( RANDOM % $nr ) ))
|
|
|
|
# Single string key
|
|
new "generate list with $nr single string key to $xml1"
|
|
echo -n '<x1 xmlns="urn:example:a">' > $xml1
|
|
for (( i=0; i<$nr; i++ )); do
|
|
echo -n "<y><k1>a$i</k1><z>foo$i</z></y>" >> $xml1
|
|
done
|
|
echo -n '</x1>' >> $xml1
|
|
|
|
new "api-path single string key k1=a$rnd"
|
|
echo "$clixon_util_path -f $xml1 -y $ydir -p /moda:x1/y=a$rnd"
|
|
expectpart "$($clixon_util_path -f $xml1 -y $ydir -p /moda:x1/y=a$rnd)" 0 "^0: <y><k1>a$rnd</k1><z>foo$rnd</z></y>$"
|
|
|
|
new "api-path single string key /x1"
|
|
echo "$clixon_util_path -f $xml1 -y $ydir -p /moda:x1"
|
|
expectpart "$($clixon_util_path -f $xml1 -y $ydir -p /moda:x1)" 0 "0: <x1 xmlns=\"urn:example:a\"><y><k1>a0</k1><z>foo0</z></y><y><k1>a1</k1><z>foo1</z></y>" # Assume at least two elements
|
|
|
|
new "api-path single string key omit key"
|
|
expectpart "$($clixon_util_path -f $xml1 -y $ydir -p /moda:x1/y)" 0 '^0: <y><k1>a0</k1><z>foo0</z></y>
|
|
1: <y><k1>a0</k1><z>foo0</z></y>'
|
|
|
|
new "api-path single string wrong module, notfound"
|
|
expectpart "$($clixon_util_path -f $xml1 -y $ydir -p /modxxx:x1/y=a$rnd 2> /dev/null)" 255 '^$'
|
|
|
|
new "api-path single string no module, notfound"
|
|
expectpart "$($clixon_util_path -f $xml1 -y $ydir -p /x1/y=a$rnd 2> /dev/null)" 255 '^$'
|
|
|
|
new "api-path single string wrong top-symbol, notfound"
|
|
expectpart "$($clixon_util_path -f $xml1 -y $ydir -p /moda:xxx/y=a$rnd 2> /dev/null)" 255 '^$'
|
|
|
|
new "api-path single string wrong list-symbol, notfound"
|
|
expectpart "$($clixon_util_path -f $xml1 -y $ydir -p /moda:x1/xxx=a$rnd 2> /dev/null)" 255 '^$'
|
|
|
|
new "api-path single string two keys, notfound"
|
|
expectpart "$($clixon_util_path -f $xml1 -y $ydir -p /moda:x1/y=a$rnd,a$rnd 2> /dev/null)" 255 '^$'
|
|
|
|
new "api-path single string sub-element, notfound"
|
|
expectpart "$($clixon_util_path -f $xml1 -y $ydir -p /moda:x1/y=a$rnd/xxx 2> /dev/null)" 255 '^$'
|
|
|
|
# Single int key
|
|
new "generate list with $nr single int key to $xml2"
|
|
echo -n '<x2 xmlns="urn:example:a">' > $xml2
|
|
for (( i=0; i<$nr; i++ )); do
|
|
echo -n "<y><k1>$i</k1><z>foo$i</z></y>" >> $xml2
|
|
done
|
|
echo -n '</x2>' >> $xml2
|
|
|
|
new "api-path single int key k1=$rnd"
|
|
echo "$clixon_util_path -f $xml2 -y $ydir -p /moda:x2/y=$rnd"
|
|
expectpart "$($clixon_util_path -f $xml2 -y $ydir -p /moda:x2/y=$rnd)" 0 "^0: <y><k1>$rnd</k1><z>foo$rnd</z></y>$"
|
|
|
|
# Double string key
|
|
new "generate list with $nr double string keys to $xml3 (two k2 entries per k1 key)"
|
|
echo -n '<x3 xmlns="urn:example:a">' > $xml3
|
|
for (( i=0; i<$nr; i++ )); do
|
|
echo -n "<y><k1>a$i</k1><k2>a$i</k2><z>foo$i</z></y>" >> $xml3
|
|
echo -n "<y><k1>a$i</k1><k2>b$i</k2><z>foob$i</z></y>" >> $xml3
|
|
done
|
|
# Add two rules with empty k2 string
|
|
echo -n "<y><k1>a0</k1><k2></k2><z>foo0</z></y>" >> $xml3
|
|
echo -n "<y><k1>a1</k1><k2></k2><z>foo1</z></y>" >> $xml3
|
|
echo -n '</x3>' >> $xml3
|
|
|
|
new "api-path double string key k1=a$rnd,b$rnd"
|
|
echo "$clixon_util_path -f $xml3 -y $ydir -p /moda:x3/y=a$rnd,b$rnd"
|
|
expectpart "$($clixon_util_path -f $xml3 -y $ydir -p /moda:x3/y=a$rnd,b$rnd)" 0 "0: <y><k1>a$rnd</k1><k2>b$rnd</k2><z>foob$rnd</z></y>"
|
|
|
|
new "api-path double string key k1=a$rnd, - empty k2 string"
|
|
echo "$clixon_util_path -f $xml3 -y $ydir -p /moda:x3/y=a1,"
|
|
expectpart "$($clixon_util_path -f $xml3 -y $ydir -p /moda:x3/y=a1,)" 0 "0: <y><k1>a1</k1><k2/><z>foo1</z></y>"
|
|
|
|
new "api-path double string key k1=a$rnd, - no k2 string - three matches"
|
|
echo "$clixon_util_path -f $xml3 -y $ydir -p /moda:x3/y=a1"
|
|
expecteq "$($clixon_util_path -f $xml3 -y $ydir -p /moda:x3/y=a1)" 0 "0: <y><k1>a1</k1><k2/><z>foo1</z></y>
|
|
1: <y><k1>a1</k1><k2>a1</k2><z>foo1</z></y>
|
|
2: <y><k1>a1</k1><k2>b1</k2><z>foob1</z></y>"
|
|
|
|
# Leaf-list
|
|
new "generate leaf-list int keys to $xml4"
|
|
echo -n '<x4 xmlns="urn:example:a">' > $xml4
|
|
for (( i=0; i<$nr; i++ )); do
|
|
echo -n "<y>a$i</y>" >> $xml4
|
|
done
|
|
echo -n '</x4>' >> $xml4
|
|
|
|
new "api-path leaf-list k1=a$rnd"
|
|
echo "$clixon_util_path -f $xml4 -y $ydir -p /moda:x4/y=a$rnd"
|
|
expectpart "$($clixon_util_path -f $xml4 -y $ydir -p /moda:x4/y=a$rnd)" 0 "^0: <y>a$rnd</y>$"
|
|
|
|
# Single string key direct under root
|
|
new "generate list with $nr single string key to $xml5"
|
|
echo -n '' > $xml5
|
|
for (( i=0; i<$nr; i++ )); do
|
|
echo -n "<x5 xmlns=\"urn:example:a\"><k1>a$i</k1><z>foo$i</z></x5>" >> $xml5
|
|
done
|
|
|
|
new "api-path direct under root single string key k1=a$rnd"
|
|
echo "$clixon_util_path -f $xml5 -y $ydir -p /moda:x5=a$rnd"
|
|
expectpart "$($clixon_util_path -f $xml5 -y $ydir -p /moda:x5=a$rnd)" 0 "^0: <x5 xmlns=\"urn:example:a\"><k1>a$rnd</k1><z>foo$rnd</z></x5>$"
|
|
|
|
# Depth and augment
|
|
# Deep augmented xml path
|
|
new "generate deep list with augment"
|
|
echo -n '<x6 xmlns="urn:example:b">' > $xml6
|
|
for (( i=0; i<$nr; i++ )); do
|
|
echo -n "<yy><kk1>b$i</kk1><kk2>b$i</kk2><zz>foo$i</zz>" >> $xml6
|
|
for (( j=0; j<3; j++ )); do
|
|
echo -n "<y xmlns=\"urn:example:a\"><k1>a$j</k1><k2>a$j</k2><z>foo$j</z></y>" >> $xml6
|
|
done
|
|
echo -n "</yy>" >> $xml6
|
|
done
|
|
echo -n '</x6>' >> $xml6
|
|
|
|
new "api-path double string key k1=b$rnd,b$rnd in modb"
|
|
echo "$clixon_util_path -f $xml6 -y $ydir -p /modb:x6/yy=b$rnd,b$rnd"
|
|
expectpart "$($clixon_util_path -f $xml6 -y $ydir -p /modb:x6/yy=b$rnd,b$rnd)" 0 "0: <yy><kk1>b$rnd</kk1><kk2>b$rnd</kk2><zz>foo$rnd</zz><y xmlns=\"urn:example:a\"><k1>a0</k1><k2>a0</k2><z>foo0</z></y><y xmlns=\"urn:example:a\"><k1>a1</k1><k2>a1</k2><z>foo1</z></y><y xmlns=\"urn:example:a\"><k1>a2</k1><k2>a2</k2><z>foo2</z></y></yy>"
|
|
|
|
new "api-path double string key k1=a$rnd,b$rnd in modb + augmented in moda"
|
|
echo "$clixon_util_path -f $xml6 -y $ydir -p /modb:x6/yy=b$rnd,b$rnd/moda:y=a1,a1"
|
|
expectpart "$($clixon_util_path -f $xml6 -y $ydir -p /modb:x6/yy=b$rnd,b$rnd/moda:y=a1,a1/z=foo1)" 0 "0: <z>foo1</z>"
|
|
|
|
# unset conditional parameters
|
|
unset nr
|
|
unset clixon_util_path
|
|
|
|
rm -rf $dir
|