public inbox for passt-dev@passt.top
 help / color / mirror / code / Atom feed
blob 63872c34d811d1bc03309f68f4e61a0d31161771 6773 bytes (raw)

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
#! /usr/bin/env avocado-runner-avocado-classless

# SPDX-License-Identifier: GPL-2.0-or-later
#
# Copyright Red Hat
# Author: David Gibson <david@gibson.dropbear.id.au>

"""
Test A Simple Socket Transport

tasst/exesite.py - Manage simulated network sites for testing
"""


import contextlib
import ipaddress
import json

import avocado
from avocado.utils.process import CmdError
from avocado_classless.test import (
    assert_eq, assert_eq_unordered, assert_in, assert_raises, test_output
)

from tasst.typecheck import typecheck


class SiteProcess(contextlib.AbstractContextManager):
    """
    A background process running on a Site
    """

    def __init__(self, site, cmd, subp, *,
                 ignore_status, context_timeout):
        self.site = typecheck(site, Site)
        self.cmd = typecheck(cmd, str)
        self.subproc = typecheck(subp, avocado.utils.process.SubProcess)
        self.ignore_status = typecheck(ignore_status, bool)
        self.context_timeout = float(context_timeout)

    def __enter__(self):
        self.subproc.start()
        return self

    def __exit__(self, *exc_details):
        result = self.subproc.run(timeout=self.context_timeout)
        if not self.ignore_status and result.exit_status != 0:
            siteinfo = f'[{self.site.name} site]'
            raise avocado.utils.process.CmdError(self.cmd, result, siteinfo)

    def run(self, **kwargs):
        return self.subproc.run(**kwargs)


class Site(contextlib.AbstractContextManager):
    """
    A (usually virtual or simulated) location where we can execute
    commands and configure networks.

    """

    def __init__(self, name):
        self.name = name   # For debugging

    def hostify(self, cmd, **kwargs):
        raise NotImplementedError

    def __enter__(self):
        return self

    def __exit__(self, *exc_details):
        pass

    def output(self, cmd, strip_trail_nl=False, **kwargs):
        kwargs['strip_trail_nl'] = strip_trail_nl
        cmd, kwargs = self.hostify(cmd, **kwargs)
        return avocado.utils.process.system_output(cmd, **kwargs)

    def fg(self, cmd, **kwargs):
        cmd, kwargs = self.hostify(cmd, **kwargs)
        return avocado.utils.process.system(cmd, **kwargs)

    def subprocess(self, cmd, **kwargs):
        cmd, kwargs = self.hostify(cmd, **kwargs)
        return avocado.utils.process.SubProcess(cmd, **kwargs)

    def bg(self, cmd, context_timeout=1.0, ignore_status=False, **kwargs):
        subproc = self.subprocess(cmd, **kwargs)
        return SiteProcess(self, cmd, subproc,
                           context_timeout=context_timeout,
                           ignore_status=ignore_status)

    def require_cmds(self, *cmds):
        missing = [c for c in cmds
                   if self.fg(f'type {c}', ignore_status=True) != 0]
        if missing:
            raise avocado.TestCancel(
                f"Missing commands {', '.join(missing)} on {self.name}")

    def ifs(self):
        self.require_cmds('ip')
        info = json.loads(self.output('ip -j link show'))
        return [i['ifname'] for i in info]

    def ifup(self, ifname):
        self.require_cmds('ip')
        self.fg(f'ip link set {ifname} up', sudo=True)

    def addrinfos(self, ifname, **criteria):
        self.require_cmds('ip')
        info = json.loads(self.output(f'ip -j addr show {ifname}'))
        assert len(info) == 1  # We specified a specific interface

        ais = list(ai for ai in info[0]['addr_info'])
        for key, value in criteria.items():
            ais = [ai for ai in ais if key in ai and ai[key] == value]

        return ais

    def addrs(self, ifname, **criteria):
        self.require_cmds('ip')
        # Return just the parsed, non-tentative addresses
        return [ipaddress.ip_interface(f'{ai["local"]}/{ai["prefixlen"]}')
                for ai in self.addrinfos(ifname, **criteria)
                if 'tentative' not in ai]

    def mtu(self, ifname):
        self.require_cmds('ip')
        (info,) = json.loads(self.output(f'ip -j link show {ifname}'))
        return info['mtu']


def test_site(sitefn):
    def test_true(s):
        with s as site:
            site.fg('true')

    def test_false(s):
        with s as site:
            assert_raises(CmdError, site.fg, 'false')

    def test_echo(s):
        with s as site:
            msg = 'Hello tasst'
            out = site.output(f'echo {msg}')
            assert_eq(out, msg.encode('utf-8') + b'\n')

    def test_timeout(s):
        with s as site:
            site.fg('sleep infinity', timeout=0.1, ignore_status=True)

    def test_bg_true(s):
        with s as site:
            with site.bg('true'):
                pass

    def test_bg_false(s):
        with s as site:
            def run_false():
                with site.bg('false'):
                    pass
            assert_raises(CmdError, run_false)

    def test_bg_echo(s):
        msg = 'Hello tasst'
        with s as site:
            with site.bg(f'echo {msg}') as proc:
                res = proc.run()
        assert_eq(res.stdout, msg.encode('utf-8') + b'\n')

    def test_bg_timeout(s):
        with s as site:
            with site.bg('sleep infinity', ignore_status=True) as proc:
                proc.run(timeout=0.1)

    def test_bg_context_timeout(s):
        with s as site:
            with site.bg('sleep infinity', context_timeout=0.1,
                         ignore_status=True):
                pass

    def test_has_lo(s):
        with s as site:
            assert_in('lo', site.ifs())

    def test_lo_addrs(s):
        expected = [ipaddress.ip_interface(a)
                    for a in ['127.0.0.1/8', '::1/128']]
        with s as site:
            assert_eq_unordered(site.addrs('lo'), expected)

    def test_lo_mtu(s):
        with s as site:
            assert_eq(site.mtu('lo'), 65536)

    return test_output(test_true, test_false, test_echo, test_timeout,
                       test_bg_true, test_bg_false, test_bg_echo,
                       test_bg_timeout, test_bg_context_timeout,
                       test_has_lo, test_lo_addrs, test_lo_mtu)(sitefn)


def test_isolated_site(sitefn):
    def test_isolated_net(s):
        with s as site:
            assert_eq(site.ifs(), ['lo'])

    return test_output(test_isolated_net)(test_site(sitefn))


class RealHost(Site):
    """Represents the host on which the tests are running (as opposed
    to some simulated host created by the tests)

    """

    def __init__(self):
        super().__init__('REAL_HOST')

    def hostify(self, cmd, *, sudo=False, **kwargs):
        assert not sudo, "BUG: Shouldn't run commands with privilege on host"
        return cmd, kwargs


REAL_HOST = RealHost()


@test_site
def real_host():
    return REAL_HOST

debug log:

solving 63872c34 ...
found 63872c34 in https://archives.passt.top/passt-dev/20230627025429.2209702-19-david@gibson.dropbear.id.au/
found 246f9b3f in https://archives.passt.top/passt-dev/20230627025429.2209702-17-david@gibson.dropbear.id.au/
found 2e15129f in https://archives.passt.top/passt-dev/20230627025429.2209702-16-david@gibson.dropbear.id.au/
found 811b670e in https://archives.passt.top/passt-dev/20230627025429.2209702-15-david@gibson.dropbear.id.au/
found e69db8ad in https://archives.passt.top/passt-dev/20230627025429.2209702-14-david@gibson.dropbear.id.au/
found 9f037f77 in https://archives.passt.top/passt-dev/20230627025429.2209702-11-david@gibson.dropbear.id.au/

applying [1/6] https://archives.passt.top/passt-dev/20230627025429.2209702-11-david@gibson.dropbear.id.au/
diff --git a/test/tasst/exesite.py b/test/tasst/exesite.py
new file mode 100644
index 00000000..9f037f77


applying [2/6] https://archives.passt.top/passt-dev/20230627025429.2209702-14-david@gibson.dropbear.id.au/
diff --git a/test/tasst/exesite.py b/test/tasst/exesite.py
index 9f037f77..e69db8ad 100644


applying [3/6] https://archives.passt.top/passt-dev/20230627025429.2209702-15-david@gibson.dropbear.id.au/
diff --git a/test/tasst/exesite.py b/test/tasst/exesite.py
index e69db8ad..811b670e 100644


applying [4/6] https://archives.passt.top/passt-dev/20230627025429.2209702-16-david@gibson.dropbear.id.au/
diff --git a/test/tasst/exesite.py b/test/tasst/exesite.py
index 811b670e..2e15129f 100644


applying [5/6] https://archives.passt.top/passt-dev/20230627025429.2209702-17-david@gibson.dropbear.id.au/
diff --git a/test/tasst/exesite.py b/test/tasst/exesite.py
index 2e15129f..246f9b3f 100644


applying [6/6] https://archives.passt.top/passt-dev/20230627025429.2209702-19-david@gibson.dropbear.id.au/
diff --git a/test/tasst/exesite.py b/test/tasst/exesite.py
index 246f9b3f..63872c34 100644

Checking patch test/tasst/exesite.py...
Applied patch test/tasst/exesite.py cleanly.
Checking patch test/tasst/exesite.py...
Applied patch test/tasst/exesite.py cleanly.
Checking patch test/tasst/exesite.py...
Applied patch test/tasst/exesite.py cleanly.
Checking patch test/tasst/exesite.py...
Applied patch test/tasst/exesite.py cleanly.
Checking patch test/tasst/exesite.py...
Applied patch test/tasst/exesite.py cleanly.
Checking patch test/tasst/exesite.py...
Applied patch test/tasst/exesite.py cleanly.

index at:
100644 63872c34d811d1bc03309f68f4e61a0d31161771	test/tasst/exesite.py

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).