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
| | #! /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/transfer.py - Helpers for testing data transfers
#
# Copyright Red Hat
# Author: David Gibson <david@gibson.dropbear.id.au>
import contextlib
import ipaddress
import time
import avocado
from tasst import Tasst, TasstSubData
from tasst.site import Site
from tasst.nstool import UnshareSite
from tasst.typing import typecheck, typecheck_default
# HACK: how long to wait for the server to be ready and listening (s)
SERVER_READY_DELAY = 0.05 # 1/20th of a second
# socat needs IPv6 addresses in square brackets
def socat_fmt(ip):
if isinstance(ip, ipaddress.IPv6Address):
return '[{}]'.format(ip)
elif isinstance(ip, ipaddress.IPv4Address):
return '{}'.format(ip)
else:
raise TypeError
class TransferTasstInfo:
def __init__(self, datafile, cs, ss, ip4, ip6, port,
listen_ip4=None, listen_ip6=None, listenport=None,
from_ip4=None, from_ip6=None):
self.datafile = typecheck(datafile, str)
self.cs = typecheck(cs, Site)
self.ss = typecheck(ss, Site)
self.ip4 = typecheck(ip4, ipaddress.IPv4Address)
self.ip6 = typecheck(ip6, ipaddress.IPv6Address)
self.port = typecheck(port, int)
self.listen_ip4 = typecheck_default(listen_ip4, ipaddress.IPv4Address, None)
self.listen_ip6 = typecheck_default(listen_ip6, ipaddress.IPv6Address, None)
self.listenport = typecheck_default(listenport, int, port)
self.from_ip4 = typecheck_default(from_ip4, ipaddress.IPv4Address, None)
self.from_ip6 = typecheck_default(from_ip6, ipaddress.IPv6Address, None)
cs.require_cmds('socat', 'cat')
ss.require_cmds('socat', 'cat')
class BaseTransferTasst(Tasst):
def socat_upload(self, datafile, cs, ss, connect, listen):
with ss.bg('socat -u {} STDOUT'.format(listen), verbose=False) as server:
time.sleep(SERVER_READY_DELAY)
cs.fg('socat -u OPEN:{} {}'.format(datafile, connect))
res = server.run()
self.assertEquals(res.exit_status, 0)
srcdata = cs.output('cat {}'.format(datafile), verbose=False)
self.assertEquals(srcdata, res.stdout)
def socat_download(self, datafile, cs, ss, connect, listen):
with ss.bg('socat -u OPEN:{} {}'.format(datafile, listen)) as server:
time.sleep(SERVER_READY_DELAY)
dstdata = cs.output('socat -u {} STDOUT'.format(connect), verbose=False)
res = server.run()
self.assertEquals(res.exit_status, 0)
srcdata = ss.output('cat {}'.format(datafile), verbose=False)
self.assertEquals(srcdata, dstdata)
def _tcp_socat(self, datafile, connectip, connectport,
listenip, listenport, fromip):
v6 = isinstance(connectip, ipaddress.IPv6Address)
if listenport is None:
listenport = connectport
if v6:
connect = 'TCP6:[{}]:{},ipv6only'.format(connectip, connectport)
listen = 'TCP6-LISTEN:{},ipv6only'.format(listenport)
else:
connect = 'TCP4:{}:{}'.format(connectip, connectport)
listen = 'TCP4-LISTEN:{}'.format(listenport)
if listenip is not None:
listen += ',bind=' + socat_fmt(listenip)
if fromip is not None:
connect += ',bind=' + socat_fmt(fromip)
return (connect, listen)
def tcp_upload(self, datafile, cs, ss, connectip, connectport,
listenip=None, listenport=None, fromip=None):
connect, listen = self._tcp_socat(datafile, connectip, connectport,
listenip, listenport, fromip)
self.socat_upload(datafile, cs, ss, connect, listen)
def tcp_download(self, datafile, cs, ss, connectip, connectport,
listenip=None, listenport=None, fromip=None):
connect, listen = self._tcp_socat(datafile, connectip, connectport,
listenip, listenport, fromip)
self.socat_download(datafile, cs, ss, connect, listen)
def udp_transfer(self, datafile, cs, ss, connectip, connectport,
listenip=None, listenport=None, fromip=None):
v6 = isinstance(connectip, ipaddress.IPv6Address)
if listenport is None:
listenport = connectport
if v6:
connect = 'UDP6:[{}]:{},ipv6only,shut-null'.format(connectip, connectport)
listen = 'UDP6-LISTEN:{},ipv6only,null-eof'.format(listenport)
if listenip is not None:
assert isinstance(listenip, ipaddress.IPv6Address)
listen += ',bind=[{}]'.format(listenip)
else:
connect = 'UDP4:{}:{},shut-null'.format(connectip, connectport)
listen = 'UDP4-LISTEN:{},null-eof'.format(listenport)
if listenip is not None:
assert isinstance(listenip, ipaddress.IPv4Address)
listen += ',bind={}'.format(listenip)
self.socat_upload(datafile, cs, ss, connect, listen)
def setup_transfer(self):
raise NotImplementedError("{} must implement setup_transfer() method".format(type(self).__name__))
@contextlib.contextmanager
def check_setup_transfer(self):
with self.setup_transfer() as tti:
if not isinstance(tti, TransferTasstInfo):
raise TypeError("{}.setup_tranfer() must yield a TransferTasstInfo instance".format(type(self).__name__))
yield tti
class TcpUploadTasst(BaseTransferTasst):
"""
:avocado: disable
"""
def test_tcp4_upload(self):
with self.check_setup_transfer() as tti:
self.tcp_upload(tti.datafile, tti.cs, tti.ss, tti.ip4, tti.port,
listenip=tti.listen_ip4, listenport=tti.listenport,
fromip=tti.from_ip4)
def test_tcp6_upload(self):
with self.check_setup_transfer() as tti:
self.tcp_upload(tti.datafile, tti.cs, tti.ss, tti.ip6, tti.port,
listenip=tti.listen_ip6, listenport=tti.listenport,
fromip=tti.from_ip6)
class MetaTcpUploadTasst(TcpUploadTasst):
"""Ugly workaround for
https://github.com/avocado-framework/avocado/issues/5680.
Explicitly apply the "meta" tag to the tests in TransferTasst.
:avocado: disable
:avocado: tags=meta
"""
def test_tcp4_upload(self):
super().test_tcp4_upload()
def test_tcp6_upload(self):
super().test_tcp6_upload()
class UdpTransferTasst(BaseTransferTasst):
"""
:avocado: disable
"""
def test_udp4_transfer(self):
with self.check_setup_transfer() as tti:
self.udp_transfer(tti.datafile, tti.cs, tti.ss, tti.ip4, tti.port,
listenip=tti.listen_ip4, listenport=tti.listenport,
fromip=tti.from_ip4)
def test_udp6_transfer(self):
with self.check_setup_transfer() as tti:
self.udp_transfer(tti.datafile, tti.cs, tti.ss, tti.ip6, tti.port,
listenip=tti.listen_ip6, listenport=tti.listenport,
fromip=tti.from_ip6)
class MetaUdpTransferTasst(UdpTransferTasst):
"""Ugly workaround for
https://github.com/avocado-framework/avocado/issues/5680.
Explicitly apply the "meta" tag to the tests in TransferTasst.
:avocado: disable
:avocado: tags=meta
"""
def test_udp4_transfer(self):
super().test_udp4_transfer()
def test_udp6_transfer(self):
super().test_udp6_transfer()
LOOPBACK4 = ipaddress.ip_address('127.0.0.1')
LOOPBACK6 = ipaddress.ip_address('::1')
class LocalTransferTasst(MetaTcpUploadTasst, MetaUdpTransferTasst):
"""Test the transfer helpers
"""
PORT = 10000
@contextlib.contextmanager
def setup_transfer(self):
with UnshareSite(type(self).__name__ + '.netns', '-Un') as ns:
ns.ifup('lo')
yield TransferTasstInfo('test/small.bin', ns, ns,
LOOPBACK4, LOOPBACK6, self.PORT)
|