passt/test/pasta/dhcp

# SPDX-License-Identifier: GPL-2.0-or-later
#
# PASST - Plug A Simple Socket Transport
#  for qemu/UNIX domain socket mode
#
# PASTA - Pack A Subtle Tap Abstraction
#  for network namespace/tap device mode
#
# test/pasta/dhcp - Check DHCP and DHCPv6 functionality in pasta mode
#
# Copyright (c) 2021 Red Hat GmbH
# Author: Stefano Brivio <sbrivio@redhat.com>

nstools	ip jq /sbin/dhclient
htools	ip jq

test	Interface name
nsout	IFNAME ip -j link show | jq -rM '.[] | select(.link_type == "ether").ifname'
check	[ -n "__IFNAME__" ]

test	DHCP: address
ns	/sbin/dhclient -4 --no-pid __IFNAME__
nsout	ADDR ip -j -4 addr show|jq -rM '.[] | select(.ifname == "__IFNAME__").addr_info[0].local'
hout	HOST_ADDR ip -j -4 addr show|jq -rM '.[] | select(.ifname == "__IFNAME__").addr_info[0].local'
check	[ __ADDR__ = __HOST_ADDR__ ]

test	DHCP: route
nsout	GW ip -j -4 route show|jq -rM '.[] | select(.dst == "default").gateway'
hout	HOST_GW ip -j -4 route show|jq -rM '[.[] | select(.dst == "default").gateway] | .[0]'
check	[ __GW__ = __HOST_GW__ ]

test	DHCP: MTU
nsout	MTU ip -j link show | jq -rM '.[] | select(.ifname == "__IFNAME__").mtu'
check	[ __MTU__ = 65520 ]

test	DHCPv6: address
ns	/sbin/dhclient -6 --no-pid __IFNAME__
hout	HOST_IFNAME6 ip -j -6 route show|jq -rM '[.[] | select(.dst == "default").dev] | .[0]'
nsout	ADDR6 ip -j -6 addr show|jq -rM '[.[] | select(.ifname == "__IFNAME__").addr_info[] | select(.prefixlen == 128).local] | .[0]'
hout	HOST_ADDR6 ip -j -6 addr show|jq -rM '[.[] | select(.ifname == "__HOST_IFNAME6__").addr_info[] | select(.scope == "global" and .deprecated != true).local] | .[0]'
check	[ __ADDR6__ = __HOST_ADDR6__ ]

test	DHCPv6: route
nsout	GW6 ip -j -6 route show|jq -rM '.[] | select(.dst == "default").gateway'
hout	HOST_GW6 ip -j -6 route show|jq -rM '[.[] | select(.dst == "default").gateway] | .[0]'
check	[ __GW6__ = __HOST_GW6__ ]
passt: Relicense to GPL 2.0, or any later version In practical terms, passt doesn't benefit from the additional protection offered by the AGPL over the GPL, because it's not suitable to be executed over a computer network. Further, restricting the distribution under the version 3 of the GPL wouldn't provide any practical advantage either, as long as the passt codebase is concerned, and might cause unnecessary compatibility dilemmas. Change licensing terms to the GNU General Public License Version 2, or any later version, with written permission from all current and past contributors, namely: myself, David Gibson, Laine Stump, Andrea Bolognani, Paul Holzinger, Richard W.M. Jones, Chris Kuhn, Florian Weimer, Giuseppe Scrivano, Stefan Hajnoczi, and Vasiliy Ulyanov. Signed-off-by: Stefano Brivio <sbrivio@redhat.com> 2023-04-05 18:11:44 +00:00			`# SPDX-License-Identifier: GPL-2.0-or-later`
test: Add CI/demo scripts Not really quick, definitely dirty. Signed-off-by: Stefano Brivio <sbrivio@redhat.com> 2021-09-27 13:10:35 +00:00			`#`
			`# PASST - Plug A Simple Socket Transport`
			`# for qemu/UNIX domain socket mode`
			`#`
			`# PASTA - Pack A Subtle Tap Abstraction`
			`# for network namespace/tap device mode`
			`#`
test: Group tests by mode then protocol, rather than the reverse For example, passt/dhcp rather than dhcp/passt. This is more consistent with the two_guests and other test groups, and makes some other cleanups simpler. Signed-off-by: David Gibson <david@gibson.dropbear.id.au> 2022-09-13 04:35:16 +00:00			`# test/pasta/dhcp - Check DHCP and DHCPv6 functionality in pasta mode`
test: Add CI/demo scripts Not really quick, definitely dirty. Signed-off-by: Stefano Brivio <sbrivio@redhat.com> 2021-09-27 13:10:35 +00:00			`#`
			`# Copyright (c) 2021 Red Hat GmbH`
			`# Author: Stefano Brivio <sbrivio@redhat.com>`

Use dhclient instead of udhcpc For some reason, the passt/pasta tests and examples use dhclient for DHCPv6, but in most cases use udhcpc for DHCPv4. Change it to use dhclient for both DHCPv4 and DHCPv6. This means one less tool we need for testing, plus dhclient is easily available on Fedora whereas udhcpc is not. Note that the passt tests still rely on udhcpc indirectly because mbuto wants to put it into the guest images it generates. Signed-off-by: David Gibson <david@gibson.dropbear.id.au> 2022-06-10 02:32:44 +00:00			`nstools ip jq /sbin/dhclient`
test: Add CI/demo scripts Not really quick, definitely dirty. Signed-off-by: Stefano Brivio <sbrivio@redhat.com> 2021-09-27 13:10:35 +00:00			`htools ip jq`

			`test Interface name`
Don't abbreviate ip(8) arguments in examples and tests ip(8)'s ability to take abbreviated arguments (e.g. "li sh" instead of "link show") is very handy when using it interactively, but it doesn't make for very readable scripts and examples when shown that way. Signed-off-by: David Gibson <david@gibson.dropbear.id.au> 2022-06-10 02:32:42 +00:00			`nsout IFNAME ip -j link show \| jq -rM '.[] \| select(.link_type == "ether").ifname'`
test: Add CI/demo scripts Not really quick, definitely dirty. Signed-off-by: Stefano Brivio <sbrivio@redhat.com> 2021-09-27 13:10:35 +00:00			`check [ -n "__IFNAME__" ]`

			`test DHCP: address`
Use dhclient instead of udhcpc For some reason, the passt/pasta tests and examples use dhclient for DHCPv6, but in most cases use udhcpc for DHCPv4. Change it to use dhclient for both DHCPv4 and DHCPv6. This means one less tool we need for testing, plus dhclient is easily available on Fedora whereas udhcpc is not. Note that the passt tests still rely on udhcpc indirectly because mbuto wants to put it into the guest images it generates. Signed-off-by: David Gibson <david@gibson.dropbear.id.au> 2022-06-10 02:32:44 +00:00			`ns /sbin/dhclient -4 --no-pid __IFNAME__`
Don't abbreviate ip(8) arguments in examples and tests ip(8)'s ability to take abbreviated arguments (e.g. "li sh" instead of "link show") is very handy when using it interactively, but it doesn't make for very readable scripts and examples when shown that way. Signed-off-by: David Gibson <david@gibson.dropbear.id.au> 2022-06-10 02:32:42 +00:00			`nsout ADDR ip -j -4 addr show\|jq -rM '.[] \| select(.ifname == "__IFNAME__").addr_info[0].local'`
			`hout HOST_ADDR ip -j -4 addr show\|jq -rM '.[] \| select(.ifname == "__IFNAME__").addr_info[0].local'`
test: Add CI/demo scripts Not really quick, definitely dirty. Signed-off-by: Stefano Brivio <sbrivio@redhat.com> 2021-09-27 13:10:35 +00:00			`check [ __ADDR__ = __HOST_ADDR__ ]`

			`test DHCP: route`
Don't abbreviate ip(8) arguments in examples and tests ip(8)'s ability to take abbreviated arguments (e.g. "li sh" instead of "link show") is very handy when using it interactively, but it doesn't make for very readable scripts and examples when shown that way. Signed-off-by: David Gibson <david@gibson.dropbear.id.au> 2022-06-10 02:32:42 +00:00			`nsout GW ip -j -4 route show\|jq -rM '.[] \| select(.dst == "default").gateway'`
test: Only select a single interface or gateway in tests The queries we use in the test scripts to locate the external interface or gateway can return multiple results. We get away with this because the way we parse command output only looks at the last line. It's not really correct, though, and improvements to our handling of command output will mean it breaks. Signed-off-by: David Gibson <david@gibson.dropbear.id.au> 2022-08-18 06:13:54 +00:00			`hout HOST_GW ip -j -4 route show\|jq -rM '[.[] \| select(.dst == "default").gateway] \| .[0]'`
test: Add CI/demo scripts Not really quick, definitely dirty. Signed-off-by: Stefano Brivio <sbrivio@redhat.com> 2021-09-27 13:10:35 +00:00			`check [ __GW__ = __HOST_GW__ ]`

			`test DHCP: MTU`
Don't abbreviate ip(8) arguments in examples and tests ip(8)'s ability to take abbreviated arguments (e.g. "li sh" instead of "link show") is very handy when using it interactively, but it doesn't make for very readable scripts and examples when shown that way. Signed-off-by: David Gibson <david@gibson.dropbear.id.au> 2022-06-10 02:32:42 +00:00			`nsout MTU ip -j link show \| jq -rM '.[] \| select(.ifname == "__IFNAME__").mtu'`
test: Add CI/demo scripts Not really quick, definitely dirty. Signed-off-by: Stefano Brivio <sbrivio@redhat.com> 2021-09-27 13:10:35 +00:00			`check [ __MTU__ = 65520 ]`

			`test DHCPv6: address`
Tweak dhclient arguments for readability A number of tests and examples use dhclient in both IPv4 and IPv6 modes. We use "dhclient -6" for IPv6, but usually just "dhclient" for IPv4. Add an explicit "-4" argument to make it more clear and explicit. In addition, when dhclient is run from within pasta it usually won't be "real" root, and so will not have access to write the default global pid file. This results in a mostly harmless but irritating error: Can't create /var/run/dhclient.pid: Permission denied We can avoid that by using the --no-pid flag to dhclient. Signed-off-by: David Gibson <david@gibson.dropbear.id.au> 2022-06-10 02:32:43 +00:00			`ns /sbin/dhclient -6 --no-pid __IFNAME__`
Separately locate external interfaces for IPv4 and IPv6 Now that the back end allows passt/pasta to use different external interfaces for IPv4 and IPv6, use that to do the right thing in the case that the host has IPv4 and IPv6 connectivity via different interfaces. If the user hasn't explicitly chosen an interface, separately search for a suitable external interface for each protocol. As a bonus, this substantially simplifies the external interface probe. It also eliminates a subtle confusing case where in some circumstances we would pick the first interface in interface index order, and sometimes in order of routes returned from netlink. On some network configurations that could cause tests to fail, because the logic in the tests was subtly different (it always used route order). Signed-off-by: David Gibson <david@gibson.dropbear.id.au> 2022-07-22 05:31:13 +00:00			`hout HOST_IFNAME6 ip -j -6 route show\|jq -rM '[.[] \| select(.dst == "default").dev] \| .[0]'`
test: Select first reported IPv6 address for guest/host comparison If we run passt nested (a guest connected via passt to a guest connected via passt to the host), the first guest (L1) typically has two IPv6 addresses on the same interface: one formed from the prefix assigned via SLAAC, and another one assigned via DHCPv6 (to match the address on the host). When we select addresses for comparison, in this case, we have multiple global unicast addresses -- again, on the same interface. Selecting the first reported one on both host and guest is not entirely correct (in theory, the order might differ), but works reasonably well. Use the trick from 5beef085978e ("test: Only select a single interface or gateway in tests") to ask jq(1) for the first address returned by the query. Signed-off-by: Stefano Brivio <sbrivio@redhat.com> 2023-12-08 17:41:36 +00:00			`nsout ADDR6 ip -j -6 addr show\|jq -rM '[.[] \| select(.ifname == "__IFNAME__").addr_info[] \| select(.prefixlen == 128).local] \| .[0]'`
netlink, test: Ignore deprecated addresses When we retrieve or copy host addresses we can include deprecated addresses, which is not what we want. Adjust our logic to exclude them. Similarly our tests can retrieve deprecated addresses, so exclude them there too. I hit this in practice because my router sometimes temporarily advertises an fd00:: prefix before the real delegated IPv6 prefix. The deprecated address can hang around for some time messing up my tests. Signed-off-by: David Gibson <david@gibson.dropbear.id.au> Signed-off-by: Stefano Brivio <sbrivio@redhat.com> 2024-05-22 07:22:32 +00:00			`hout HOST_ADDR6 ip -j -6 addr show\|jq -rM '[.[] \| select(.ifname == "__HOST_IFNAME6__").addr_info[] \| select(.scope == "global" and .deprecated != true).local] \| .[0]'`
test: Add CI/demo scripts Not really quick, definitely dirty. Signed-off-by: Stefano Brivio <sbrivio@redhat.com> 2021-09-27 13:10:35 +00:00			`check [ __ADDR6__ = __HOST_ADDR6__ ]`

			`test DHCPv6: route`
Don't abbreviate ip(8) arguments in examples and tests ip(8)'s ability to take abbreviated arguments (e.g. "li sh" instead of "link show") is very handy when using it interactively, but it doesn't make for very readable scripts and examples when shown that way. Signed-off-by: David Gibson <david@gibson.dropbear.id.au> 2022-06-10 02:32:42 +00:00			`nsout GW6 ip -j -6 route show\|jq -rM '.[] \| select(.dst == "default").gateway'`
test: Only select a single interface or gateway in tests The queries we use in the test scripts to locate the external interface or gateway can return multiple results. We get away with this because the way we parse command output only looks at the last line. It's not really correct, though, and improvements to our handling of command output will mean it breaks. Signed-off-by: David Gibson <david@gibson.dropbear.id.au> 2022-08-18 06:13:54 +00:00			`hout HOST_GW6 ip -j -6 route show\|jq -rM '[.[] \| select(.dst == "default").gateway] \| .[0]'`
test: Add CI/demo scripts Not really quick, definitely dirty. Signed-off-by: Stefano Brivio <sbrivio@redhat.com> 2021-09-27 13:10:35 +00:00			`check [ __GW6__ = __HOST_GW6__ ]`