[PATCH v3 18/20] avocado/tasst: Helpers for testing DHCP & DHCPv6 behaviour

[David Gibson <david@gibson.dropbear.id.au>]

Signed-off-by: David Gibson <david@gibson.dropbear.id.au>
---
 avocado/tasst/dhcp.py   | 152 ++++++++++++++++++++++++++++++++++++++++
 avocado/tasst/dhcpv6.py | 135 +++++++++++++++++++++++++++++++++++
 2 files changed, 287 insertions(+)
 create mode 100644 avocado/tasst/dhcp.py
 create mode 100644 avocado/tasst/dhcpv6.py

diff --git a/avocado/tasst/dhcp.py b/avocado/tasst/dhcp.py
new file mode 100644
index 0000000..be226e4
--- /dev/null
+++ b/avocado/tasst/dhcp.py
@@ -0,0 +1,152 @@
+#! /usr/bin/python3
+
+# SPDX-License-Identifier: GPL-2.0-or-later
+#
+# tasst - Test A Simple Socket Transport
+#         library of test helpers for passt & pasta
+#
+# tasst/dhcp.py - Helpers for testing DHCP
+#
+# Copyright Red Hat
+# Author: David Gibson <david@gibson.dropbear.id.au>
+
+import contextlib
+import ipaddress
+import os
+
+from tasst import Tasst, TasstSubData
+from tasst.address import IpiAllocator, TEST_NET_1
+from tasst.nstool import UnshareSite
+from tasst.site import Site
+from tasst.typing import typecheck
+
+
+class DhcpTasstInfo:
+    def __init__(self, site, ifname, addr, gw, mtu):
+        self.site = typecheck(site, Site)
+        self.ifname = typecheck(ifname, str)
+        self.addr = typecheck(addr, ipaddress.IPv4Address)
+        self.gw = typecheck(gw, ipaddress.IPv4Address)
+        self.mtu = typecheck(mtu, int)
+
+        site.require_cmds('ip')
+
+
+class BaseDhcpTasst(Tasst):
+    """
+    Test DHCP behaviour.
+
+    :avocado: disable
+    """
+
+    DHCLIENT = '/sbin/dhclient'
+
+    def setup_dhcp(self):
+        raise NotImplementedError("{} must implement setup_dhcp() method".format(type(self).__name__))
+
+    @contextlib.contextmanager
+    def dhclient(self):
+        with self.setup_dhcp() as dti:
+            dti = typecheck(dti, DhcpTasstInfo)
+
+            dti.site.require_cmds(self.DHCLIENT, 'cat', 'kill')
+
+            pidfile = os.path.join(self.workdir, 'dhclient.pid')
+            leasefile = os.path.join(self.workdir, 'dhclient.leases')
+
+            # We need '-nc' because we may be running with
+            # capabilities but not UID 0.  Without -nc dhclient drops
+            # capabilities before invoking dhclient-script, so it's
+            # unable to actually configure the interface
+            dti.site.fg('{} -4 -v -nc -pf {} -lf {} {}'
+                        .format(self.DHCLIENT, pidfile, leasefile, dti.ifname), sudo=True)
+
+            try:
+                yield dti
+            finally:
+                pid = int(dti.site.output('cat {}'.format(pidfile)))
+                dti.site.fg('kill {}'.format(pid))
+
+    def test_addr(self):
+        with self.dhclient() as dti:
+            (addr,) = dti.site.addrs(dti.ifname, family='inet', scope='global')
+            self.assertEquals(addr.ip, dti.addr)
+
+    def test_route(self):
+        with self.dhclient() as dti:
+            (defroute,) = dti.site.routes4(dst='default')
+            self.assertEquals(ipaddress.ip_address(defroute['gateway']), dti.gw)
+
+    def test_mtu(self):
+        with self.dhclient() as dti:
+            self.assertEquals(dti.site.mtu(dti.ifname), dti.mtu)
+
+
+class MetaDhcpTasst(BaseDhcpTasst):
+    """Ugly workaround for
+    https://github.com/avocado-framework/avocado/issues/5680.
+    Explicitly apply the "meta" tag to inherited tests
+
+    :avocado: disable
+    :avocado: tags=meta
+
+    """
+
+    def test_addr(self):
+        super().test_addr()
+
+    def test_route(self):
+        super().test_route()
+
+    def test_mtu(self):
+        super().test_mtu()
+
+
+class DhcpdTasst(MetaDhcpTasst):
+    DHCPD = 'dhcpd'
+    SUBNET = TEST_NET_1
+
+    @contextlib.contextmanager
+    def setup_dhcp(self):
+        ifname = 'clientif'
+        server_ifname = 'serverif'
+
+        with UnshareSite(type(self).__name__ + '.client', '-Un') as client, \
+             UnshareSite(type(self).__name__ + '.server', '-n',
+                         parent=client, sudo=True) as server:
+
+            server.require_cmds(self.DHCPD)
+
+            client.veth(ifname, server_ifname, server)
+
+            # Configure the DHCP server
+            ipa = IpiAllocator(self.SUBNET)
+            (server_ip4,) = ipa.next_ipis()
+            (client_ip4,) = ipa.next_ipis()
+
+            confpath = os.path.join(self.workdir, 'dhcpd.conf')
+            open(confpath, 'w').write('''
+            subnet {} netmask {} {{
+                option routers {};
+                range {} {};
+            }}
+            '''.format(self.SUBNET.network_address, self.SUBNET.netmask,
+                       server_ip4.ip, client_ip4.ip, client_ip4.ip))
+            pidpath = os.path.join(self.workdir, 'dhcpd.pid')
+            leasepath = os.path.join(self.workdir, 'dhcpd.leases')
+            open(leasepath, 'w').write('')
+
+            server.ifup('lo')
+            server.ifup(server_ifname, server_ip4)
+
+            opts = ('-f -d -4 -cf {} -lf {} -pf {}'.format(confpath, leasepath, pidpath))
+            server.fg('{} -t {}'.format(self.DHCPD, opts)) # test config
+            with server.bg('{} {}'.format(self.DHCPD, opts), sudo=True) as dhcpd:
+                # Configure the client
+                client.ifup('lo')
+
+                yield DhcpTasstInfo(client, ifname, client_ip4.ip, server_ip4.ip, 1500)
+
+                pid = int(open(pidpath).read())
+                server.fg('kill {}'.format(pid))
+                status = dhcpd.wait()
diff --git a/avocado/tasst/dhcpv6.py b/avocado/tasst/dhcpv6.py
new file mode 100644
index 0000000..5a0c166
--- /dev/null
+++ b/avocado/tasst/dhcpv6.py
@@ -0,0 +1,135 @@
+#! /usr/bin/python3
+
+# SPDX-License-Identifier: GPL-2.0-or-later
+#
+# tasst - Test A Simple Socket Transport
+#         library of test helpers for passt & pasta
+#
+# tasst/dhcpv6.py - Helpers for testing DHCPv6
+#
+# Copyright Red Hat
+# Author: David Gibson <david@gibson.dropbear.id.au>
+
+import contextlib
+import ipaddress
+import os
+
+from tasst import Tasst, TasstSubData
+from tasst.address import IpiAllocator, TEST_NET6_TASST_A
+from tasst.nstool import UnshareSite
+from tasst.site import Site
+from tasst.typing import typecheck
+
+
+class Dhcpv6TasstInfo:
+    def __init__(self, site, ifname, addr):
+        self.site = typecheck(site, Site)
+        self.ifname = typecheck(ifname, str)
+        self.addr = typecheck(addr, ipaddress.IPv6Address)
+
+        site.require_cmds('ip')
+
+
+class BaseDhcpv6Tasst(Tasst):
+    """
+    Test DHCPv6 behaviour.
+
+    :avocado: disable
+    """
+
+    DHCLIENT = '/sbin/dhclient'
+
+    def setup_dhcpv6(self):
+        raise NotImplementedError("{} must implement setup_dhcpv6() method".format(type(self).__name__))
+
+    @contextlib.contextmanager
+    def dhclientv6(self):
+        with self.setup_dhcpv6() as d6ti:
+            d6ti.site.require_cmds(self.DHCLIENT)
+
+            pidfile = os.path.join(self.workdir, 'dhclient.pid')
+            leasefile = os.path.join(self.workdir, 'dhclient.leases')
+
+            # We need '-nc' because we may be running with
+            # capabilities but not UID 0.  Without -nc dhclient drops
+            # capabilities before invoking dhclient-script, so it's
+            # unable to actually configure the interface
+            d6ti.site.fg('{} -6 -v -nc -pf {} -lf {} {}'
+                         .format(self.DHCLIENT, pidfile, leasefile, d6ti.ifname), sudo=True)
+
+            yield d6ti
+
+            pid = int(d6ti.site.output('cat {}'.format(pidfile)))
+            d6ti.site.fg('kill {}'.format(pid))
+
+    def test_addr(self):
+        with self.dhclientv6() as d6ti:
+            addrs = [a.ip for a in d6ti.site.addrs(d6ti.ifname, family='inet6', scope='global')]
+            self.assertIn(d6ti.addr, addrs) # Might also have a SLAAC address
+
+
+class MetaDhcpv6Tasst(BaseDhcpv6Tasst):
+    """Ugly workaround for
+    https://github.com/avocado-framework/avocado/issues/5680.
+    Explicitly apply the "meta" tag to inherited tests
+
+    :avocado: disable
+    :avocado: tags=meta
+
+    """
+
+    def test_addr(self):
+        super().test_addr()
+
+
+class Dhcpd6Tasst(MetaDhcpv6Tasst):
+    """
+    :avocado: tags=meta
+    """
+
+    DHCPD = 'dhcpd'
+    SUBNET = TEST_NET6_TASST_A
+
+    @contextlib.contextmanager
+    def setup_dhcpv6(self):
+        ifname = 'clientif'
+        server_ifname = 'serverif'
+
+        with UnshareSite(type(self).__name__ + '.client', '-Un') as client, \
+             UnshareSite(type(self).__name__ + '.server', '-n',
+                         parent=client, sudo=True) as server:
+            server.require_cmds(self.DHCPD)
+
+            client.veth(ifname, server_ifname, server)
+
+            # Allocate IPs, and sort out link local addressing
+            ipa = IpiAllocator(self.SUBNET)
+            (server_ip6,) = ipa.next_ipis()
+            (client_ip6,) = ipa.next_ipis()
+
+            server.ifup('lo')
+            server.ifup(server_ifname, server_ip6)
+            client.ifup('lo')
+            client.ifup(ifname)
+            (server_ip6_ll,) = server.addr_wait(server_ifname, family='inet6', scope='link')
+
+            # Configure the DHCP server
+            confpath = os.path.join(self.workdir, 'dhcpd.conf')
+            open(confpath, 'w').write('''
+            subnet6 {} {{
+                range6 {} {};
+            }}
+            '''.format(self.SUBNET, client_ip6.ip, client_ip6.ip))
+            pidpath = os.path.join(self.workdir, 'dhcpd.pid')
+            leasepath = os.path.join(self.workdir, 'dhcpd.leases')
+            open(leasepath, 'w').write('')
+
+            opts = ('-f -d -6 -cf {} -lf {} -pf {}'.format(confpath, leasepath, pidpath))
+            server.fg('{} -t {}'.format(self.DHCPD, opts)) # test config
+            with server.bg('{} {}'.format(self.DHCPD, opts), sudo=True) as dhcpd:
+                yield Dhcpv6TasstInfo(client, ifname, client_ip6.ip)
+
+                pid = int(open(pidpath).read())
+                server.fg('kill {}'.format(pid))
+                status = dhcpd.wait()
+
-- 
@@ -0,0 +1,135 @@
+#! /usr/bin/python3
+
+# SPDX-License-Identifier: GPL-2.0-or-later
+#
+# tasst - Test A Simple Socket Transport
+#         library of test helpers for passt & pasta
+#
+# tasst/dhcpv6.py - Helpers for testing DHCPv6
+#
+# Copyright Red Hat
+# Author: David Gibson <david@gibson.dropbear.id.au>
+
+import contextlib
+import ipaddress
+import os
+
+from tasst import Tasst, TasstSubData
+from tasst.address import IpiAllocator, TEST_NET6_TASST_A
+from tasst.nstool import UnshareSite
+from tasst.site import Site
+from tasst.typing import typecheck
+
+
+class Dhcpv6TasstInfo:
+    def __init__(self, site, ifname, addr):
+        self.site = typecheck(site, Site)
+        self.ifname = typecheck(ifname, str)
+        self.addr = typecheck(addr, ipaddress.IPv6Address)
+
+        site.require_cmds('ip')
+
+
+class BaseDhcpv6Tasst(Tasst):
+    """
+    Test DHCPv6 behaviour.
+
+    :avocado: disable
+    """
+
+    DHCLIENT = '/sbin/dhclient'
+
+    def setup_dhcpv6(self):
+        raise NotImplementedError("{} must implement setup_dhcpv6() method".format(type(self).__name__))
+
+    @contextlib.contextmanager
+    def dhclientv6(self):
+        with self.setup_dhcpv6() as d6ti:
+            d6ti.site.require_cmds(self.DHCLIENT)
+
+            pidfile = os.path.join(self.workdir, 'dhclient.pid')
+            leasefile = os.path.join(self.workdir, 'dhclient.leases')
+
+            # We need '-nc' because we may be running with
+            # capabilities but not UID 0.  Without -nc dhclient drops
+            # capabilities before invoking dhclient-script, so it's
+            # unable to actually configure the interface
+            d6ti.site.fg('{} -6 -v -nc -pf {} -lf {} {}'
+                         .format(self.DHCLIENT, pidfile, leasefile, d6ti.ifname), sudo=True)
+
+            yield d6ti
+
+            pid = int(d6ti.site.output('cat {}'.format(pidfile)))
+            d6ti.site.fg('kill {}'.format(pid))
+
+    def test_addr(self):
+        with self.dhclientv6() as d6ti:
+            addrs = [a.ip for a in d6ti.site.addrs(d6ti.ifname, family='inet6', scope='global')]
+            self.assertIn(d6ti.addr, addrs) # Might also have a SLAAC address
+
+
+class MetaDhcpv6Tasst(BaseDhcpv6Tasst):
+    """Ugly workaround for
+    https://github.com/avocado-framework/avocado/issues/5680.
+    Explicitly apply the "meta" tag to inherited tests
+
+    :avocado: disable
+    :avocado: tags=meta
+
+    """
+
+    def test_addr(self):
+        super().test_addr()
+
+
+class Dhcpd6Tasst(MetaDhcpv6Tasst):
+    """
+    :avocado: tags=meta
+    """
+
+    DHCPD = 'dhcpd'
+    SUBNET = TEST_NET6_TASST_A
+
+    @contextlib.contextmanager
+    def setup_dhcpv6(self):
+        ifname = 'clientif'
+        server_ifname = 'serverif'
+
+        with UnshareSite(type(self).__name__ + '.client', '-Un') as client, \
+             UnshareSite(type(self).__name__ + '.server', '-n',
+                         parent=client, sudo=True) as server:
+            server.require_cmds(self.DHCPD)
+
+            client.veth(ifname, server_ifname, server)
+
+            # Allocate IPs, and sort out link local addressing
+            ipa = IpiAllocator(self.SUBNET)
+            (server_ip6,) = ipa.next_ipis()
+            (client_ip6,) = ipa.next_ipis()
+
+            server.ifup('lo')
+            server.ifup(server_ifname, server_ip6)
+            client.ifup('lo')
+            client.ifup(ifname)
+            (server_ip6_ll,) = server.addr_wait(server_ifname, family='inet6', scope='link')
+
+            # Configure the DHCP server
+            confpath = os.path.join(self.workdir, 'dhcpd.conf')
+            open(confpath, 'w').write('''
+            subnet6 {} {{
+                range6 {} {};
+            }}
+            '''.format(self.SUBNET, client_ip6.ip, client_ip6.ip))
+            pidpath = os.path.join(self.workdir, 'dhcpd.pid')
+            leasepath = os.path.join(self.workdir, 'dhcpd.leases')
+            open(leasepath, 'w').write('')
+
+            opts = ('-f -d -6 -cf {} -lf {} -pf {}'.format(confpath, leasepath, pidpath))
+            server.fg('{} -t {}'.format(self.DHCPD, opts)) # test config
+            with server.bg('{} {}'.format(self.DHCPD, opts), sudo=True) as dhcpd:
+                yield Dhcpv6TasstInfo(client, ifname, client_ip6.ip)
+
+                pid = int(open(pidpath).read())
+                server.fg('kill {}'.format(pid))
+                status = dhcpd.wait()
+
-- 
2.40.1