From 3b01bf881c848ba0be72fc74ba5eaa58c66c35e1 Mon Sep 17 00:00:00 2001 From: Tom Jones Date: Wed, 22 Jul 2020 13:49:54 +0000 Subject: [PATCH] Add tests for "add", "change" and "delete" functionality of /sbin/route. Add tests to cover "add", "change" and "delete" functionality of /sbin/route for ipv4 and ipv6. These tests for the existing route tool are the first step towards creating libroute. Submitted by: Ahsan Barkati Sponsored by: Google, Inc. (GSoC 2020) Reviewed by: kp, thj Approved by: bz (mentor) MFC after: 1 month Differential Revision: https://reviews.freebsd.org/D25220 --- etc/mtree/BSD.tests.dist | 2 + sbin/route/Makefile | 3 + sbin/route/tests/Makefile | 11 ++++ sbin/route/tests/basic.sh | 125 ++++++++++++++++++++++++++++++++++++ sbin/route/tests/utils.subr | 47 ++++++++++++++ 5 files changed, 188 insertions(+) create mode 100644 sbin/route/tests/Makefile create mode 100644 sbin/route/tests/basic.sh create mode 100644 sbin/route/tests/utils.subr diff --git a/etc/mtree/BSD.tests.dist b/etc/mtree/BSD.tests.dist index 9fbf74246f4a..80c4b3e47dc3 100644 --- a/etc/mtree/BSD.tests.dist +++ b/etc/mtree/BSD.tests.dist @@ -448,6 +448,8 @@ .. ping6 .. + route + .. .. secure lib diff --git a/sbin/route/Makefile b/sbin/route/Makefile index a1db0b6528dd..e65030f805bb 100644 --- a/sbin/route/Makefile +++ b/sbin/route/Makefile @@ -19,6 +19,9 @@ CFLAGS+= -DINET6 .endif CFLAGS+= -I. +HAS_TESTS= +SUBDIR.${MK_TESTS}+= tests + keywords.h: keywords LC_ALL=C awk '!/^#|^$$/ { \ printf "#define\tK_%s\t%d\n\t{\"%s\", K_%s},\n", \ diff --git a/sbin/route/tests/Makefile b/sbin/route/tests/Makefile new file mode 100644 index 000000000000..eb278981f8cd --- /dev/null +++ b/sbin/route/tests/Makefile @@ -0,0 +1,11 @@ +# $FreeBSD$ + +PACKAGE= tests + +ATF_TESTS_SH+= \ + basic + +${PACKAGE}FILES+= \ + utils.subr + +.include diff --git a/sbin/route/tests/basic.sh b/sbin/route/tests/basic.sh new file mode 100644 index 000000000000..6141097a09ec --- /dev/null +++ b/sbin/route/tests/basic.sh @@ -0,0 +1,125 @@ +#- +# SPDX-License-Identifier: BSD-2-Clause-FreeBSD +# +# Copyright (c) 2020 Ahsan Barkati +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions +# are met: +# 1. Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# 2. Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# +# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +# ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +# SUCH DAMAGE. +# +# $FreeBSD$ +# + +. $(atf_get_srcdir)/utils.subr + +atf_test_case "basic_v4" "cleanup" +basic_v4_head() +{ + atf_set descr 'add/change/delete route test for v4' + atf_set require.user root + atf_set require.progs jq +} + +basic_v4_body() +{ + epair=$(vnet_mkepair) + ifconfig ${epair}a 192.0.2.2/24 up + vnet_mkjail alcatraz ${epair}b + jexec alcatraz ifconfig ${epair}b 192.0.2.1/24 up + + # add a new route in the jail + jexec alcatraz route add 192.0.2.3 192.0.2.2 + gateway=$(check_route "alcatraz" "192.0.2.3") + + if [ "${gateway}" != "192.0.2.2" ]; then + atf_fail "Failed to add new route." + fi + + # change the added route + jexec alcatraz route change 192.0.2.3 192.0.2.4 + gateway=$(check_route "alcatraz" "192.0.2.3") + + if [ "${gateway}" != "192.0.2.4" ]; then + atf_fail "Failed to change route." + fi + + # delete the route + jexec alcatraz route delete 192.0.2.3 + gateway=$(check_route "alcatraz" "192.0.2.3") + + if [ "${gateway}" != "" ]; then + atf_fail "Failed to delete route." + fi +} + +basic_v4_cleanup() +{ + vnet_cleanup +} + +atf_test_case "basic_v6" "cleanup" +basic_v6_head() +{ + atf_set descr 'add/change/delete route test for v6' + atf_set require.user root + atf_set require.progs jq +} + +basic_v6_body() +{ + epair=$(vnet_mkepair) + ifconfig ${epair}a inet6 2001:db8:cc4b::1/64 up no_dad + vnet_mkjail alcatraz ${epair}b + jexec alcatraz ifconfig ${epair}b inet6 2001:db8:cc4b::2/64 up no_dad + + # add a new route in the jail + jexec alcatraz route add -6 2001:db8:cc4b::3 2001:db8:cc4b::1 + gateway=$(check_route "alcatraz" "2001:db8:cc4b::3") + + if [ "${gateway}" != "2001:db8:cc4b::1" ]; then + atf_fail "Failed to add new route." + fi + + # change the added route + jexec alcatraz route change -6 2001:db8:cc4b::3 2001:db8:cc4b::4 + gateway=$(check_route "alcatraz" "2001:db8:cc4b::3") + if [ "${gateway}" != "2001:db8:cc4b::4" ]; then + atf_fail "Failed to change route." + fi + + # delete the route + jexec alcatraz route -6 delete 2001:db8:cc4b::3 + gateway=$(check_route "alcatraz" "2001:db8:cc4b::3") + + if [ "${gateway}" != "" ]; then + atf_fail "Failed to delete route." + fi +} + +basic_v6_cleanup() +{ + vnet_cleanup +} + +atf_init_test_cases() +{ + atf_add_test_case "basic_v4" + atf_add_test_case "basic_v6" +} diff --git a/sbin/route/tests/utils.subr b/sbin/route/tests/utils.subr new file mode 100644 index 000000000000..fda9980eb78d --- /dev/null +++ b/sbin/route/tests/utils.subr @@ -0,0 +1,47 @@ +#- +# SPDX-License-Identifier: BSD-2-Clause-FreeBSD +# +# Copyright (c) 2020 Ahsan Barkati +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions +# are met: +# 1. Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# 2. Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# +# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +# ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +# SUCH DAMAGE. +# +# $FreeBSD$ +# + +. $(atf_get_srcdir)/../../sys/common/vnet.subr + +check_route() +{ + jname=$1 + dest=$2 + result=$(jexec $jname netstat -r --libxo json) + + # This query selects the JSON item from the array of rt-entry + # for which the destination address is $dest + query=".statistics.\"route-information\".\"route-table\".\"rt-family\"[0].\"rt-entry\"[]|select(.destination==\"${dest}\")" + + # Gateway is then extracted from the JSON item as described above + gateway=$(echo $result | jq -r ${query}.gateway) + + echo ${gateway} +} +