public inbox for passt-dev@passt.top
 help / color / mirror / code / Atom feed
From: David Gibson <david@gibson.dropbear.id.au>
To: passt-dev@passt.top, Stefano Brivio <sbrivio@redhat.com>
Cc: Cleber Rosa <crosa@redhat.com>,
	jarichte@redhat.com, David Gibson <david@gibson.dropbear.id.au>
Subject: [PATCH v3 09/20] avocado/tasst: Add helpers to run commands with nstool
Date: Wed, 31 May 2023 11:58:38 +1000	[thread overview]
Message-ID: <20230531015849.3229596-10-david@gibson.dropbear.id.au> (raw)
In-Reply-To: <20230531015849.3229596-1-david@gibson.dropbear.id.au>

Use our existing nstool C helper, add python wrappers to easily run
commands in various namespaces.

Signed-off-by: David Gibson <david@gibson.dropbear.id.au>
---
 Makefile                |   7 +-
 avocado/tasst/nstool.py | 182 ++++++++++++++++++++++++++++++++++++++++
 avocado/tasst/site.py   |  16 +++-
 3 files changed, 202 insertions(+), 3 deletions(-)
 create mode 100644 avocado/tasst/nstool.py

diff --git a/Makefile b/Makefile
index fc83cd2..9add0a4 100644
--- a/Makefile
+++ b/Makefile
@@ -298,10 +298,13 @@ cppcheck: $(SRCS) $(HEADERS)
 
 AVOCADO = avocado
 
-avocado-%:
+avocado-assets:
+	$(MAKE) -C test nstool
+
+avocado-%: avocado-assets
 	PYTHONPATH=./avocado $(AVOCADO) run avocado --filter-by-tags=$*
 
-avocado-all:
+avocado-all: avocado-assets
 	PYTHONPATH=./avocado $(AVOCADO) run avocado
 
 # Default avocado tests to run, everything except the "meta" tests
diff --git a/avocado/tasst/nstool.py b/avocado/tasst/nstool.py
new file mode 100644
index 0000000..020e8a0
--- /dev/null
+++ b/avocado/tasst/nstool.py
@@ -0,0 +1,182 @@
+#! /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/nstool.py - Run commands in namespaces via 'nstool'
+#
+# Copyright Red Hat
+# Author: David Gibson <david@gibson.dropbear.id.au>
+
+import contextlib
+import os
+import sys
+import tempfile
+
+import avocado
+from avocado.utils.process import CmdError
+
+from tasst import Tasst
+from tasst.site import IsolatedSiteTasst, SiteTasst, Site, REAL_HOST
+from tasst.typing import typecheck
+
+# FIXME: Can this be made more portable?
+UNIX_PATH_MAX = 108
+
+
+class NsToolSite(Site):
+    NST_BIN = './test/nstool'
+
+    def __init__(self, name, sockpath):
+        if len(sockpath) > UNIX_PATH_MAX:
+            raise ValueError('Unix domain socket path \"{}\" is too long'.format(sockpath))
+
+        super().__init__(name)
+        self.sockpath = sockpath
+
+    def __enter__(self):
+        self._pid = int(REAL_HOST.output('{} info -wp {}'.format(self.NST_BIN, self.sockpath), timeout=1))
+        return self
+
+    def __exit__(self, *exc_details):
+        pass
+
+    # PID of the nstool hold process as seen by the test host
+    def pid(self):
+        return self._pid
+
+    # PID of the nstool hold process as seen by another site
+    # (important when using PID namespaces)
+    def relative_pid(self, relative_to):
+        cmd = '{} info -p {}'.format(self.NST_BIN, self.sockpath)
+        return int(relative_to.output(cmd))
+
+    def _nst_cmd(self, cmd, sudo=False):
+        nst_args = self.sockpath
+        if sudo:
+            nst_args = '--keep-caps ' + nst_args
+        return '{} exec {} -- {}'.format(self.NST_BIN, nst_args, cmd)
+
+    def output(self, cmd, sudo=False, **kwargs):
+        return REAL_HOST.output(self._nst_cmd(cmd, sudo), **kwargs)
+
+    def fg(self, cmd, sudo=False, **kwargs):
+        return REAL_HOST.fg(self._nst_cmd(cmd, sudo), **kwargs)
+
+    def bg(self, cmd, sudo=False, **kwargs):
+        return REAL_HOST.bg(self._nst_cmd(cmd, sudo), **kwargs)
+
+
+# Create path for temporary nstool Unix socket
+#
+# The obvious choice would be to use Avocado's workdir, but that often
+# gives paths that are too long for Unix sockets
+def temp_sockpath(name):
+    tmpd = tempfile.mkdtemp(suffix=name)
+    return os.path.join(tmpd, 's')
+
+
+class UnshareSite(NsToolSite):
+    def __init__(self, name, unshare_opts, parent=REAL_HOST, sudo=False):
+        sockpath = temp_sockpath(name)
+        parent.require_cmds('unshare', self.NST_BIN)
+
+        super().__init__(name, sockpath)
+
+        self.parent = typecheck(parent, Site)
+        self.holdcmd = 'unshare {} -- {} hold {}'.format(unshare_opts,
+                                                         self.NST_BIN, sockpath)
+        self.sudo = typecheck(sudo, bool)
+
+    def __enter__(self):
+        self.holder = self.parent.bg(self.holdcmd, sudo=self.sudo)
+        self.holder.__enter__()
+        return super().__enter__()
+
+    def __exit__(self, *exc_details):
+        super().__exit__(*exc_details)
+        
+        try:
+            self.parent.fg('{} stop {}'.format(self.NST_BIN, self.sockpath))
+        finally:
+            self.holder.__exit__(*exc_details)
+
+        try:
+            os.remove(self.sockpath)
+        except FileNotFoundError:
+            pass
+
+        os.rmdir(os.path.dirname(self.sockpath))
+
+
+class UserNetNsTasst(IsolatedSiteTasst):
+    """
+    Test creating a userns+netns together
+
+    :avocado: tags=meta
+    """
+
+    def setup_site(self):
+        return UnshareSite(type(self).__name__, '-Ucn')
+
+    def test_userns(self):
+        REAL_HOST.require_cmds('capsh')
+        with self.setup_site() as ns:
+            ns.require_cmds('capsh')
+            capcmd = 'capsh --has-p=CAP_SETUID'
+            self.assertRaises(CmdError, REAL_HOST.fg, capcmd)
+            ns.fg(capcmd, sudo=True)
+
+
+class NestedNsTasst(IsolatedSiteTasst):
+    """
+    Test creating userns with a netns nested within
+
+    :avocado: tags=meta
+    """
+
+    @contextlib.contextmanager
+    def setup_site(self):
+        name = type(self).__name__
+        with UnshareSite(name + '.userns', '-Uc') as userns:
+            with UnshareSite(name + '.netns', '-n', parent=userns, sudo=True) as netns:
+                yield netns
+
+
+class PidNsTasst(IsolatedSiteTasst):
+    """
+    Test unsing unshare -p  to create a pidns
+
+    :avocado: tags=meta
+    """
+
+    def setup_site(self):
+        return UnshareSite(type(self).__name__, '-Upfn')
+
+    def test_relative_pid(self):
+        with self.setup_site() as site:
+            # The holder is init (pid 1) within its own pidns
+            self.assertEquals(site.relative_pid(site), 1)
+
+
+class ConnectNsToolTasst(SiteTasst):
+    """
+    Test connecting to a pre-existing nstool
+
+    :avocado: tags=meta
+    """
+
+    @contextlib.contextmanager
+    def setup_site(self):
+        sockpath = temp_sockpath(type(self).__name__)
+        holdcmd = '{} hold {}'.format(NsToolSite.NST_BIN, sockpath)
+        with REAL_HOST.bg(holdcmd) as holder:
+            with NsToolSite("fake ns", sockpath) as site:
+                yield site
+
+        try:
+            os.remove(sockpath)
+        finally:
+            os.rmdir(os.path.dirname(sockpath))
diff --git a/avocado/tasst/site.py b/avocado/tasst/site.py
index 6450944..900e945 100644
--- a/avocado/tasst/site.py
+++ b/avocado/tasst/site.py
@@ -101,6 +101,19 @@ class SiteTasst(Tasst):
             self.assertIn('lo', site.ifs())
 
 
+class IsolatedSiteTasst(SiteTasst):
+    """
+    Test a site with isolated network (loopback only)
+
+    :avocado: disable
+    :avocado: tags=meta
+    """
+
+    def test_isolated_net(self):
+        with self.setup_site() as site:
+            self.assertEquals(site.ifs(), ['lo'])
+
+
 # Represents the host on which the tests are running, as opposed to
 # some simulated host created by the tests
 class RealHost(Site):
@@ -129,7 +142,8 @@ class RealHost(Site):
             proc.start()
             yield proc
         finally:
-            proc.stop()
+            if proc.poll() is None:
+                proc.stop()
 
 
 REAL_HOST = RealHost()
-- 
@@ -101,6 +101,19 @@ class SiteTasst(Tasst):
             self.assertIn('lo', site.ifs())
 
 
+class IsolatedSiteTasst(SiteTasst):
+    """
+    Test a site with isolated network (loopback only)
+
+    :avocado: disable
+    :avocado: tags=meta
+    """
+
+    def test_isolated_net(self):
+        with self.setup_site() as site:
+            self.assertEquals(site.ifs(), ['lo'])
+
+
 # Represents the host on which the tests are running, as opposed to
 # some simulated host created by the tests
 class RealHost(Site):
@@ -129,7 +142,8 @@ class RealHost(Site):
             proc.start()
             yield proc
         finally:
-            proc.stop()
+            if proc.poll() is None:
+                proc.stop()
 
 
 REAL_HOST = RealHost()
-- 
2.40.1


  parent reply	other threads:[~2023-05-31  1:59 UTC|newest]

Thread overview: 21+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-05-31  1:58 [PATCH v3 00/20] RFCv3: Proof-of-concept conversion of some tests to Avocado framework David Gibson
2023-05-30 23:59 ` [PATCH v3 01/20] avocado: Make a duplicate copy of testsuite for comparison purposes David Gibson
2023-05-31  1:58 ` [PATCH v3 02/20] avocado: Don't double download assets for test/ and oldtest/ David Gibson
2023-05-31  1:58 ` [PATCH v3 03/20] avocado: Move static checkers to avocado David Gibson
2023-05-31  1:58 ` [PATCH v3 04/20] avocado/tasst: Helper functions for executing commands in different places David Gibson
2023-05-31  1:58 ` [PATCH v3 05/20] avocado/tasst: Type checking helpers David Gibson
2023-05-31  1:58 ` [PATCH v3 06/20] avocado: Convert build tests to avocado David Gibson
2023-05-31  1:58 ` [PATCH v3 07/20] avocado/tasst: Add helpers for running background commands on sites David Gibson
2023-05-31  1:58 ` [PATCH v3 08/20] avocado/tasst: Add helper to get network interface names for a site David Gibson
2023-05-31  1:58 ` David Gibson [this message]
2023-05-31  1:58 ` [PATCH v3 10/20] avocado/tasst: Add ifup and network address helpers to Site David Gibson
2023-05-31  1:58 ` [PATCH v3 11/20] avocado/tasst: Helper for creating veth devices between namespaces David Gibson
2023-05-31  1:58 ` [PATCH v3 12/20] avocado/tasst: Add helper for getting MTU of a network interface David Gibson
2023-05-31  1:58 ` [PATCH v3 13/20] avocado/tasst: Add helper to wait for IP address to appear David Gibson
2023-05-31  1:58 ` [PATCH v3 14/20] avocado/tasst: Add helpers for getting a site's routes David Gibson
2023-05-31  1:58 ` [PATCH v3 15/20] avocado/tasst: Helpers for test transferring data between sites David Gibson
2023-05-31  1:58 ` [PATCH v3 16/20] avocado/tasst: IP address allocation helpers David Gibson
2023-05-31  1:58 ` [PATCH v3 17/20] avocado/tasst: Helpers for testing NDP behaviour David Gibson
2023-05-31  1:58 ` [PATCH v3 18/20] avocado/tasst: Helpers for testing DHCP & DHCPv6 behaviour David Gibson
2023-05-31  1:58 ` [PATCH v3 19/20] avocado/tasst: Helpers to construct a simple network environment for tests David Gibson
2023-05-31  1:58 ` [PATCH v3 20/20] avocado: Convert basic pasta tests David Gibson

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230531015849.3229596-10-david@gibson.dropbear.id.au \
    --to=david@gibson.dropbear.id.au \
    --cc=crosa@redhat.com \
    --cc=jarichte@redhat.com \
    --cc=passt-dev@passt.top \
    --cc=sbrivio@redhat.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://passt.top/passt

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for IMAP folder(s).