VladPolskiy/linux-kernel-model
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2026-01-21 08:31:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

tools: ynl: add YNL test framework

Browse Source 
Add a test framework for YAML Netlink (YNL) tools, covering both CLI and
ethtool functionality. The framework includes:

1) cli: family listing, netdev, ethtool, rt-* families, and nlctrl
   operations
2) ethtool: device info, statistics, ring/coalesce/pause parameters, and
   feature gettings

The current YNL syntax is a bit obscure, and end users may not always know
how to use it. This test framework provides usage examples and also serves
as a regression test to catch potential breakages caused by future changes.

Reviewed-by: Donald Hunter <donald.hunter@gmail.com>
Acked-by: Matthieu Baerts (NGI0) <matttbe@kernel.org>
Signed-off-by: Hangbin Liu <liuhangbin@gmail.com>
Link: https://patch.msgid.link/20251124022055.33389-1-liuhangbin@gmail.com
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
This commit is contained in:
Hangbin Liu
2025-11-24 02:20:55 +00:00
committed by Jakub Kicinski
parent 651765e8d5
commit 308b7dee3e
5 changed files with 593 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
tools/net/ynl/Makefile
View File

@ -12,7 +12,7 @@ endif
libdir ?= $(prefix)/$(libdir_relative)
includedir ?= $(prefix)/include
SUBDIRS = lib generated samples ynltool
SUBDIRS = lib generated samples ynltool tests
all: $(SUBDIRS) libynl.a
@ -49,5 +49,9 @@ install: libynl.a lib/*.h
@echo -e "\tINSTALL pyynl"
@pip install --prefix=$(DESTDIR)$(prefix) .
@make -C generated install
@make -C tests install
.PHONY: all clean distclean install $(SUBDIRS)
run_tests:
@$(MAKE) -C tests run_tests
.PHONY: all clean distclean install run_tests $(SUBDIRS)

32
tools/net/ynl/tests/Makefile Normal file
View File

@ -0,0 +1,32 @@
# SPDX-License-Identifier: GPL-2.0
# Makefile for YNL tests
TESTS := \
test_ynl_cli.sh \
test_ynl_ethtool.sh \
# end of TESTS
all: $(TESTS)
run_tests:
@for test in $(TESTS); do \
./$$test; \
done
install: $(TESTS)
@mkdir -p $(DESTDIR)/usr/bin
@mkdir -p $(DESTDIR)/usr/share/kselftest
@cp ../../../testing/selftests/kselftest/ktap_helpers.sh $(DESTDIR)/usr/share/kselftest/
@for test in $(TESTS); do \
name=$$(basename $$test .sh); \
sed -e 's|^ynl=.*|ynl="ynl"|' \
-e 's|^ynl_ethtool=.*|ynl_ethtool="ynl-ethtool"|' \
-e 's|KSELFTEST_KTAP_HELPERS=.*|KSELFTEST_KTAP_HELPERS="/usr/share/kselftest/ktap_helpers.sh"|' \
$$test > $(DESTDIR)/usr/bin/$$name; \
chmod +x $(DESTDIR)/usr/bin/$$name; \
done
clean distclean:
@# Nothing to clean
.PHONY: all install clean run_tests

6
tools/net/ynl/tests/config Normal file
View File

@ -0,0 +1,6 @@
CONFIG_DUMMY=m
CONFIG_INET_DIAG=y
CONFIG_IPV6=y
CONFIG_NET_NS=y
CONFIG_NETDEVSIM=m
CONFIG_VETH=m

327
tools/net/ynl/tests/test_ynl_cli.sh Executable file
View File

@ -0,0 +1,327 @@
#!/bin/bash
# SPDX-License-Identifier: GPL-2.0
# Test YNL CLI functionality
# Load KTAP test helpers
KSELFTEST_KTAP_HELPERS="$(dirname "$(realpath "$0")")/../../../testing/selftests/kselftest/ktap_helpers.sh"
# shellcheck source=../../../testing/selftests/kselftest/ktap_helpers.sh
source "$KSELFTEST_KTAP_HELPERS"
# Default ynl path for direct execution, can be overridden by make install
ynl="../pyynl/cli.py"
readonly NSIM_ID="1338"
readonly NSIM_DEV_NAME="nsim${NSIM_ID}"
readonly VETH_A="veth_a"
readonly VETH_B="veth_b"
testns="ynl-$(mktemp -u XXXXXX)"
TESTS_NO=0
# Test listing available families
cli_list_families()
{
if $ynl --list-families &>/dev/null; then
ktap_test_pass "YNL CLI list families"
else
ktap_test_fail "YNL CLI list families"
fi
}
TESTS_NO=$((TESTS_NO + 1))
# Test netdev family operations (dev-get, queue-get)
cli_netdev_ops()
{
local dev_output
local ifindex
ifindex=$(ip netns exec "$testns" cat /sys/class/net/"$NSIM_DEV_NAME"/ifindex 2>/dev/null)
dev_output=$(ip netns exec "$testns" $ynl --family netdev \
--do dev-get --json "{\"ifindex\": $ifindex}" 2>/dev/null)
if ! echo "$dev_output" | grep -q "ifindex"; then
ktap_test_fail "YNL CLI netdev operations (netdev dev-get output missing ifindex)"
return
fi
if ! ip netns exec "$testns" $ynl --family netdev \
--dump queue-get --json "{\"ifindex\": $ifindex}" &>/dev/null; then
ktap_test_fail "YNL CLI netdev operations (failed to get netdev queue info)"
return
fi
ktap_test_pass "YNL CLI netdev operations"
}
TESTS_NO=$((TESTS_NO + 1))
# Test ethtool family operations (rings-get, linkinfo-get)
cli_ethtool_ops()
{
local rings_output
local linkinfo_output
rings_output=$(ip netns exec "$testns" $ynl --family ethtool \
--do rings-get --json "{\"header\": {\"dev-name\": \"$NSIM_DEV_NAME\"}}" 2>/dev/null)
if ! echo "$rings_output" | grep -q "header"; then
ktap_test_fail "YNL CLI ethtool operations (ethtool rings-get output missing header)"
return
fi
linkinfo_output=$(ip netns exec "$testns" $ynl --family ethtool \
--do linkinfo-get --json "{\"header\": {\"dev-name\": \"$VETH_A\"}}" 2>/dev/null)
if ! echo "$linkinfo_output" | grep -q "header"; then
ktap_test_fail "YNL CLI ethtool operations (ethtool linkinfo-get output missing header)"
return
fi
ktap_test_pass "YNL CLI ethtool operations"
}
TESTS_NO=$((TESTS_NO + 1))
# Test rt-route family operations
cli_rt_route_ops()
{
local ifindex
if ! $ynl --list-families 2>/dev/null | grep -q "rt-route"; then
ktap_test_skip "YNL CLI rt-route operations (rt-route family not available)"
return
fi
ifindex=$(ip netns exec "$testns" cat /sys/class/net/"$NSIM_DEV_NAME"/ifindex 2>/dev/null)
# Add route: 192.0.2.0/24 dev $dev scope link
if ! ip netns exec "$testns" $ynl --family rt-route --do newroute --create \
--json "{\"dst\": \"192.0.2.0\", \"oif\": $ifindex, \"rtm-dst-len\": 24, \"rtm-family\": 2, \"rtm-scope\": 253, \"rtm-type\": 1, \"rtm-protocol\": 3, \"rtm-table\": 254}" &>/dev/null; then
ktap_test_fail "YNL CLI rt-route operations (failed to add route)"
return
fi
local route_output
route_output=$(ip netns exec "$testns" $ynl --family rt-route --dump getroute 2>/dev/null)
if echo "$route_output" | grep -q "192.0.2.0"; then
ktap_test_pass "YNL CLI rt-route operations"
else
ktap_test_fail "YNL CLI rt-route operations (failed to verify route)"
fi
ip netns exec "$testns" $ynl --family rt-route --do delroute \
--json "{\"dst\": \"192.0.2.0\", \"oif\": $ifindex, \"rtm-dst-len\": 24, \"rtm-family\": 2, \"rtm-scope\": 253, \"rtm-type\": 1, \"rtm-protocol\": 3, \"rtm-table\": 254}" &>/dev/null
}
TESTS_NO=$((TESTS_NO + 1))
# Test rt-addr family operations
cli_rt_addr_ops()
{
local ifindex
if ! $ynl --list-families 2>/dev/null | grep -q "rt-addr"; then
ktap_test_skip "YNL CLI rt-addr operations (rt-addr family not available)"
return
fi
ifindex=$(ip netns exec "$testns" cat /sys/class/net/"$NSIM_DEV_NAME"/ifindex 2>/dev/null)
if ! ip netns exec "$testns" $ynl --family rt-addr --do newaddr \
--json "{\"ifa-index\": $ifindex, \"local\": \"192.0.2.100\", \"ifa-prefixlen\": 24, \"ifa-family\": 2}" &>/dev/null; then
ktap_test_fail "YNL CLI rt-addr operations (failed to add address)"
return
fi
local addr_output
addr_output=$(ip netns exec "$testns" $ynl --family rt-addr --dump getaddr 2>/dev/null)
if echo "$addr_output" | grep -q "192.0.2.100"; then
ktap_test_pass "YNL CLI rt-addr operations"
else
ktap_test_fail "YNL CLI rt-addr operations (failed to verify address)"
fi
ip netns exec "$testns" $ynl --family rt-addr --do deladdr \
--json "{\"ifa-index\": $ifindex, \"local\": \"192.0.2.100\", \"ifa-prefixlen\": 24, \"ifa-family\": 2}" &>/dev/null
}
TESTS_NO=$((TESTS_NO + 1))
# Test rt-link family operations
cli_rt_link_ops()
{
if ! $ynl --list-families 2>/dev/null | grep -q "rt-link"; then
ktap_test_skip "YNL CLI rt-link operations (rt-link family not available)"
return
fi
if ! ip netns exec "$testns" $ynl --family rt-link --do newlink --create \
--json "{\"ifname\": \"dummy0\", \"linkinfo\": {\"kind\": \"dummy\"}}" &>/dev/null; then
ktap_test_fail "YNL CLI rt-link operations (failed to add link)"
return
fi
local link_output
link_output=$(ip netns exec "$testns" $ynl --family rt-link --dump getlink 2>/dev/null)
if echo "$link_output" | grep -q "$NSIM_DEV_NAME" && echo "$link_output" | grep -q "dummy0"; then
ktap_test_pass "YNL CLI rt-link operations"
else
ktap_test_fail "YNL CLI rt-link operations (failed to verify link)"
fi
ip netns exec "$testns" $ynl --family rt-link --do dellink \
--json "{\"ifname\": \"dummy0\"}" &>/dev/null
}
TESTS_NO=$((TESTS_NO + 1))
# Test rt-neigh family operations
cli_rt_neigh_ops()
{
local ifindex
if ! $ynl --list-families 2>/dev/null | grep -q "rt-neigh"; then
ktap_test_skip "YNL CLI rt-neigh operations (rt-neigh family not available)"
return
fi
ifindex=$(ip netns exec "$testns" cat /sys/class/net/"$NSIM_DEV_NAME"/ifindex 2>/dev/null)
# Add neighbor: 192.0.2.1 dev nsim1338 lladdr 11:22:33:44:55:66 PERMANENT
if ! ip netns exec "$testns" $ynl --family rt-neigh --do newneigh --create \
--json "{\"ndm-ifindex\": $ifindex, \"dst\": \"192.0.2.1\", \"lladdr\": \"11:22:33:44:55:66\", \"ndm-family\": 2, \"ndm-state\": 128}" &>/dev/null; then
ktap_test_fail "YNL CLI rt-neigh operations (failed to add neighbor)"
fi
local neigh_output
neigh_output=$(ip netns exec "$testns" $ynl --family rt-neigh --dump getneigh 2>/dev/null)
if echo "$neigh_output" | grep -q "192.0.2.1"; then
ktap_test_pass "YNL CLI rt-neigh operations"
else
ktap_test_fail "YNL CLI rt-neigh operations (failed to verify neighbor)"
fi
ip netns exec "$testns" $ynl --family rt-neigh --do delneigh \
--json "{\"ndm-ifindex\": $ifindex, \"dst\": \"192.0.2.1\", \"lladdr\": \"11:22:33:44:55:66\", \"ndm-family\": 2}" &>/dev/null
}
TESTS_NO=$((TESTS_NO + 1))
# Test rt-rule family operations
cli_rt_rule_ops()
{
if ! $ynl --list-families 2>/dev/null | grep -q "rt-rule"; then
ktap_test_skip "YNL CLI rt-rule operations (rt-rule family not available)"
return
fi
# Add rule: from 192.0.2.0/24 lookup 100 none
if ! ip netns exec "$testns" $ynl --family rt-rule --do newrule \
--json "{\"family\": 2, \"src-len\": 24, \"src\": \"192.0.2.0\", \"table\": 100}" &>/dev/null; then
ktap_test_fail "YNL CLI rt-rule operations (failed to add rule)"
return
fi
local rule_output
rule_output=$(ip netns exec "$testns" $ynl --family rt-rule --dump getrule 2>/dev/null)
if echo "$rule_output" | grep -q "192.0.2.0"; then
ktap_test_pass "YNL CLI rt-rule operations"
else
ktap_test_fail "YNL CLI rt-rule operations (failed to verify rule)"
fi
ip netns exec "$testns" $ynl --family rt-rule --do delrule \
--json "{\"family\": 2, \"src-len\": 24, \"src\": \"192.0.2.0\", \"table\": 100}" &>/dev/null
}
TESTS_NO=$((TESTS_NO + 1))
# Test nlctrl family operations
cli_nlctrl_ops()
{
local family_output
if ! family_output=$($ynl --family nlctrl \
--do getfamily --json "{\"family-name\": \"netdev\"}" 2>/dev/null); then
ktap_test_fail "YNL CLI nlctrl getfamily (failed to get nlctrl family info)"
return
fi
if ! echo "$family_output" | grep -q "family-name"; then
ktap_test_fail "YNL CLI nlctrl getfamily (nlctrl getfamily output missing family-name)"
return
fi
if ! echo "$family_output" | grep -q "family-id"; then
ktap_test_fail "YNL CLI nlctrl getfamily (nlctrl getfamily output missing family-id)"
return
fi
ktap_test_pass "YNL CLI nlctrl getfamily"
}
TESTS_NO=$((TESTS_NO + 1))
setup()
{
modprobe netdevsim &> /dev/null
if ! [ -f /sys/bus/netdevsim/new_device ]; then
ktap_skip_all "netdevsim module not available"
exit "$KSFT_SKIP"
fi
if ! ip netns add "$testns" 2>/dev/null; then
ktap_skip_all "failed to create test namespace"
exit "$KSFT_SKIP"
fi
echo "$NSIM_ID 1" | ip netns exec "$testns" tee /sys/bus/netdevsim/new_device >/dev/null 2>&1 || {
ktap_skip_all "failed to create netdevsim device"
exit "$KSFT_SKIP"
}
local dev
dev=$(ip netns exec "$testns" ls /sys/bus/netdevsim/devices/netdevsim$NSIM_ID/net 2>/dev/null | head -1)
if [[ -z "$dev" ]]; then
ktap_skip_all "failed to find netdevsim device"
exit "$KSFT_SKIP"
fi
ip -netns "$testns" link set dev "$dev" name "$NSIM_DEV_NAME" 2>/dev/null || {
ktap_skip_all "failed to rename netdevsim device"
exit "$KSFT_SKIP"
}
ip -netns "$testns" link set dev "$NSIM_DEV_NAME" up 2>/dev/null
if ! ip -n "$testns" link add "$VETH_A" type veth peer name "$VETH_B" 2>/dev/null; then
ktap_skip_all "failed to create veth pair"
exit "$KSFT_SKIP"
fi
ip -n "$testns" link set "$VETH_A" up 2>/dev/null
ip -n "$testns" link set "$VETH_B" up 2>/dev/null
}
cleanup()
{
ip netns exec "$testns" bash -c "echo $NSIM_ID > /sys/bus/netdevsim/del_device" 2>/dev/null || true
ip netns del "$testns" 2>/dev/null || true
}
# Check if ynl command is available
if ! command -v $ynl &>/dev/null && [[ ! -x $ynl ]]; then
ktap_skip_all "ynl command not found: $ynl"
exit "$KSFT_SKIP"
fi
trap cleanup EXIT
ktap_print_header
setup
ktap_set_plan "${TESTS_NO}"
cli_list_families
cli_netdev_ops
cli_ethtool_ops
cli_rt_route_ops
cli_rt_addr_ops
cli_rt_link_ops
cli_rt_neigh_ops
cli_rt_rule_ops
cli_nlctrl_ops
ktap_finished

222
tools/net/ynl/tests/test_ynl_ethtool.sh Executable file
View File

@ -0,0 +1,222 @@
#!/bin/bash
# SPDX-License-Identifier: GPL-2.0
# Test YNL ethtool functionality
# Load KTAP test helpers
KSELFTEST_KTAP_HELPERS="$(dirname "$(realpath "$0")")/../../../testing/selftests/kselftest/ktap_helpers.sh"
# shellcheck source=../../../testing/selftests/kselftest/ktap_helpers.sh
source "$KSELFTEST_KTAP_HELPERS"
# Default ynl-ethtool path for direct execution, can be overridden by make install
ynl_ethtool="../pyynl/ethtool.py"
readonly NSIM_ID="1337"
readonly NSIM_DEV_NAME="nsim${NSIM_ID}"
readonly VETH_A="veth_a"
readonly VETH_B="veth_b"
testns="ynl-ethtool-$(mktemp -u XXXXXX)"
TESTS_NO=0
# Uses veth device as netdevsim doesn't support basic ethtool device info
ethtool_device_info()
{
local info_output
info_output=$(ip netns exec "$testns" $ynl_ethtool "$VETH_A" 2>/dev/null)
if ! echo "$info_output" | grep -q "Settings for"; then
ktap_test_fail "YNL ethtool device info (device info output missing expected content)"
return
fi
ktap_test_pass "YNL ethtool device info"
}
TESTS_NO=$((TESTS_NO + 1))
ethtool_statistics()
{
local stats_output
stats_output=$(ip netns exec "$testns" $ynl_ethtool --statistics "$NSIM_DEV_NAME" 2>/dev/null)
if ! echo "$stats_output" | grep -q -E "(NIC statistics|packets|bytes)"; then
ktap_test_fail "YNL ethtool statistics (statistics output missing expected content)"
return
fi
ktap_test_pass "YNL ethtool statistics"
}
TESTS_NO=$((TESTS_NO + 1))
ethtool_ring_params()
{
local ring_output
ring_output=$(ip netns exec "$testns" $ynl_ethtool --show-ring "$NSIM_DEV_NAME" 2>/dev/null)
if ! echo "$ring_output" | grep -q -E "(Ring parameters|RX|TX)"; then
ktap_test_fail "YNL ethtool ring parameters (ring parameters output missing expected content)"
return
fi
if ! ip netns exec "$testns" $ynl_ethtool --set-ring "$NSIM_DEV_NAME" rx 64 2>/dev/null; then
ktap_test_fail "YNL ethtool ring parameters (set-ring command failed unexpectedly)"
return
fi
ktap_test_pass "YNL ethtool ring parameters (show/set)"
}
TESTS_NO=$((TESTS_NO + 1))
ethtool_coalesce_params()
{
if ! ip netns exec "$testns" $ynl_ethtool --show-coalesce "$NSIM_DEV_NAME" &>/dev/null; then
ktap_test_fail "YNL ethtool coalesce parameters (failed to get coalesce parameters)"
return
fi
if ! ip netns exec "$testns" $ynl_ethtool --set-coalesce "$NSIM_DEV_NAME" rx-usecs 50 2>/dev/null; then
ktap_test_fail "YNL ethtool coalesce parameters (set-coalesce command failed unexpectedly)"
return
fi
ktap_test_pass "YNL ethtool coalesce parameters (show/set)"
}
TESTS_NO=$((TESTS_NO + 1))
ethtool_pause_params()
{
if ! ip netns exec "$testns" $ynl_ethtool --show-pause "$NSIM_DEV_NAME" &>/dev/null; then
ktap_test_fail "YNL ethtool pause parameters (failed to get pause parameters)"
return
fi
if ! ip netns exec "$testns" $ynl_ethtool --set-pause "$NSIM_DEV_NAME" tx 1 rx 1 2>/dev/null; then
ktap_test_fail "YNL ethtool pause parameters (set-pause command failed unexpectedly)"
return
fi
ktap_test_pass "YNL ethtool pause parameters (show/set)"
}
TESTS_NO=$((TESTS_NO + 1))
ethtool_features_info()
{
local features_output
features_output=$(ip netns exec "$testns" $ynl_ethtool --show-features "$NSIM_DEV_NAME" 2>/dev/null)
if ! echo "$features_output" | grep -q -E "(Features|offload)"; then
ktap_test_fail "YNL ethtool features info (features output missing expected content)"
return
fi
ktap_test_pass "YNL ethtool features info (show/set)"
}
TESTS_NO=$((TESTS_NO + 1))
ethtool_channels_info()
{
local channels_output
channels_output=$(ip netns exec "$testns" $ynl_ethtool --show-channels "$NSIM_DEV_NAME" 2>/dev/null)
if ! echo "$channels_output" | grep -q -E "(Channel|Combined|RX|TX)"; then
ktap_test_fail "YNL ethtool channels info (channels output missing expected content)"
return
fi
if ! ip netns exec "$testns" $ynl_ethtool --set-channels "$NSIM_DEV_NAME" combined-count 1 2>/dev/null; then
ktap_test_fail "YNL ethtool channels info (set-channels command failed unexpectedly)"
return
fi
ktap_test_pass "YNL ethtool channels info (show/set)"
}
TESTS_NO=$((TESTS_NO + 1))
ethtool_time_stamping()
{
local ts_output
ts_output=$(ip netns exec "$testns" $ynl_ethtool --show-time-stamping "$NSIM_DEV_NAME" 2>/dev/null)
if ! echo "$ts_output" | grep -q -E "(Time stamping|timestamping|SOF_TIMESTAMPING)"; then
ktap_test_fail "YNL ethtool time stamping (time stamping output missing expected content)"
return
fi
ktap_test_pass "YNL ethtool time stamping"
}
TESTS_NO=$((TESTS_NO + 1))
setup()
{
modprobe netdevsim &> /dev/null
if ! [ -f /sys/bus/netdevsim/new_device ]; then
ktap_skip_all "netdevsim module not available"
exit "$KSFT_SKIP"
fi
if ! ip netns add "$testns" 2>/dev/null; then
ktap_skip_all "failed to create test namespace"
exit "$KSFT_SKIP"
fi
echo "$NSIM_ID 1" | ip netns exec "$testns" tee /sys/bus/netdevsim/new_device >/dev/null 2>&1 || {
ktap_skip_all "failed to create netdevsim device"
exit "$KSFT_SKIP"
}
local dev
dev=$(ip netns exec "$testns" ls /sys/bus/netdevsim/devices/netdevsim$NSIM_ID/net 2>/dev/null | head -1)
if [[ -z "$dev" ]]; then
ktap_skip_all "failed to find netdevsim device"
exit "$KSFT_SKIP"
fi
ip -netns "$testns" link set dev "$dev" name "$NSIM_DEV_NAME" 2>/dev/null || {
ktap_skip_all "failed to rename netdevsim device"
exit "$KSFT_SKIP"
}
ip -netns "$testns" link set dev "$NSIM_DEV_NAME" up 2>/dev/null
if ! ip -n "$testns" link add "$VETH_A" type veth peer name "$VETH_B" 2>/dev/null; then
ktap_skip_all "failed to create veth pair"
exit "$KSFT_SKIP"
fi
ip -n "$testns" link set "$VETH_A" up 2>/dev/null
ip -n "$testns" link set "$VETH_B" up 2>/dev/null
}
cleanup()
{
ip netns exec "$testns" bash -c "echo $NSIM_ID > /sys/bus/netdevsim/del_device" 2>/dev/null || true
ip netns del "$testns" 2>/dev/null || true
}
# Check if ynl-ethtool command is available
if ! command -v $ynl_ethtool &>/dev/null && [[ ! -x $ynl_ethtool ]]; then
ktap_skip_all "ynl-ethtool command not found: $ynl_ethtool"
exit "$KSFT_SKIP"
fi
trap cleanup EXIT
ktap_print_header
setup
ktap_set_plan "${TESTS_NO}"
ethtool_device_info
ethtool_statistics
ethtool_ring_params
ethtool_coalesce_params
ethtool_pause_params
ethtool_features_info
ethtool_channels_info
ethtool_time_stamping
ktap_finished