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 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268
|
import logging
from signal import SIGTERM
import sys
import threading
import pytest
import pexpect
from labgrid import Target
from labgrid.driver import SerialDriver
from labgrid.resource import RawSerialPort, NetworkSerialPort
from labgrid.driver.fake import FakeConsoleDriver
psutil = pytest.importorskip("psutil")
@pytest.fixture(scope="session")
def curses_init():
""" curses only reads the terminfo DB once on the first import, so make
sure we prime it correctly."""
try:
import curses
curses.setupterm("linux")
except ModuleNotFoundError:
logging.warning("curses module not found, not setting up a default terminal – tests may fail")
class Prefixer:
def __init__(self, wrapped, prefix):
self.__wrapped = wrapped
self.__prefix = prefix.encode()+b": "
self.__continuation = False
def write(self, data):
if data[-1:] == b'\n':
continuation = False
data = data[:-1]
else:
continuation = True
data = data.replace(b'\n', b'\n'+self.__prefix)
if not self.__continuation:
data = self.__prefix+data
if not continuation:
data += b'\n'
self.__continuation = continuation
self.__wrapped.write(data)
def __getattr__(self, name):
return getattr(self.__wrapped, name)
class LabgridComponent:
def __init__(self, cwd):
self.cwd = str(cwd)
self.spawn = None
self.reader = None
def stop(self):
logging.info("stopping %s pid=%s", self.__class__.__name__, self.spawn.pid)
# let coverage write its data:
# https://coverage.readthedocs.io/en/latest/subprocess.html#process-termination
self.spawn.kill(SIGTERM)
if not self.spawn.closed:
self.spawn.expect(pexpect.EOF)
self.spawn.wait()
assert not self.spawn.isalive()
self.spawn = None
self.stop_reader()
@staticmethod
def keep_reading(spawn):
"The output from background processes must be read to avoid blocking them."
while spawn.isalive():
try:
data = spawn.read_nonblocking(size=1024, timeout=0.1)
if not data:
return
except pexpect.TIMEOUT:
continue
except pexpect.EOF:
return
except OSError:
return
def start_reader(self):
self.reader = threading.Thread(
target=LabgridComponent.keep_reading,
name=f'{self.__class__.__name__}-reader-{self.pid}',
args=(self.spawn,), daemon=True)
self.reader.start()
def stop_reader(self):
self.reader.join()
self.reader = None
def isalive(self):
return self.spawn.isalive()
@property
def exitstatus(self):
return self.spawn.exitstatus
@property
def pid(self):
return self.spawn.pid
def suspend_tree(self):
main = psutil.Process(self.pid)
main.suspend()
for child in main.children(recursive=True):
child.suspend()
def resume_tree(self):
main = psutil.Process(self.pid)
main.resume()
for child in main.children(recursive=True):
child.resume()
class Exporter(LabgridComponent):
def __init__(self, config, cwd):
super().__init__(cwd)
self.config = config
def start(self):
assert self.spawn is None
assert self.reader is None
self.spawn = pexpect.spawn(
f'labgrid-exporter --name testhost {self.config}',
logfile=Prefixer(sys.stdout.buffer, 'exporter'),
cwd=self.cwd)
try:
self.spawn.expect('exporter name: testhost')
self.spawn.expect('connected to coordinator')
except Exception as e:
raise Exception(f"exporter startup failed with {self.spawn.before}") from e
self.start_reader()
class Coordinator(LabgridComponent):
def start(self):
assert self.spawn is None
assert self.reader is None
self.spawn = pexpect.spawn(
'labgrid-coordinator',
logfile=Prefixer(sys.stdout.buffer, 'coordinator'),
cwd=self.cwd)
try:
self.spawn.expect('Coordinator ready')
except Exception as e:
raise Exception(f"coordinator startup failed with {self.spawn.before}") from e
self.start_reader()
@pytest.fixture(scope='function')
def target():
return Target('Test')
@pytest.fixture(scope='function')
def target_with_fakeconsole():
t = Target('dummy')
cp = FakeConsoleDriver(t, "console")
return t
@pytest.fixture(scope='function')
def serial_port(target):
return RawSerialPort(target, 'serial', '/dev/test')
@pytest.fixture(scope='function')
def serial_rfc2711_port(target):
return NetworkSerialPort(target, 'rfc2711', host='localhost', port=8888)
@pytest.fixture(scope='function')
def serial_raw_port(target):
return NetworkSerialPort(target, 'serialraw', host='localhost', port=8888, protocol="raw")
@pytest.fixture(scope='function')
def serial_driver(target, serial_port, mocker):
m = mocker.patch('serial.Serial')
s = SerialDriver(target, 'serial')
target.activate(s)
return s
@pytest.fixture(scope='function')
def serial_driver_no_name(target, serial_port, mocker):
m = mocker.patch('serial.Serial')
s = SerialDriver(target, None)
target.activate(s)
return s
@pytest.fixture(scope='function')
def coordinator(tmpdir):
coordinator = Coordinator(tmpdir)
coordinator.start()
yield coordinator
coordinator.stop()
@pytest.fixture(scope='function')
def exporter(tmpdir, coordinator):
config = "exports.yaml"
p = tmpdir.join(config)
p.write(
"""
Testport:
NetworkSerialPort:
host: 'localhost'
port: 4000
Broken:
RawSerialPort:
port: 'none'
Many:
NetworkSerialPort:
host: 'localhost'
port: 4000
NetworkService:
address: "192.168.0.1"
username: "root"
"""
)
exporter = Exporter(config, tmpdir)
exporter.start()
yield exporter
exporter.stop()
def pytest_addoption(parser):
parser.addoption("--sigrok-usb", action="store_true",
help="Run sigrok usb tests with fx2lafw device (0925:3881)")
parser.addoption("--local-sshmanager", action="store_true",
help="Run SSHManager tests against localhost")
parser.addoption("--ssh-username", default=None,
help="SSH username to use for SSHDriver testing")
def pytest_configure(config):
# register an additional marker
config.addinivalue_line("markers",
"sigrokusb: enable fx2lafw USB tests (0925:3881)")
config.addinivalue_line("markers",
"localsshmanager: test SSHManager against Localhost")
config.addinivalue_line("markers",
"sshusername: test SSHDriver against Localhost")
config.addinivalue_line("markers",
"coordinator: test against local coordinator")
def pytest_runtest_setup(item):
envmarker = item.get_closest_marker("sigrokusb")
if envmarker is not None:
if item.config.getoption("--sigrok-usb") is False:
pytest.skip("sigrok usb tests not enabled (enable with --sigrok-usb)")
envmarker = item.get_closest_marker("localsshmanager")
if envmarker is not None:
if item.config.getoption("--local-sshmanager") is False:
pytest.skip("SSHManager tests against localhost not enabled (enable with --local-sshmanager)")
envmarker = item.get_closest_marker("sshusername")
if envmarker is not None:
if item.config.getoption("--ssh-username") is None:
pytest.skip("SSHDriver tests against localhost not enabled (enable with --ssh-username <username>)")
|