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 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
|
"""Configure pytest."""
import asyncio
import platform
import sys
from collections import deque
from threading import enumerate as thread_enumerate
import pytest
import pytest_asyncio
from pymodbus.datastore import ModbusBaseSlaveContext
from pymodbus.server import ServerAsyncStop
from pymodbus.transport import NULLMODEM_HOST, CommParams, CommType
from pymodbus.transport.transport import NullModem
sys.path.extend(["examples", "../examples", "../../examples"])
from examples.server_async import ( # pylint: disable=wrong-import-position
run_async_server,
setup_server,
)
def pytest_configure():
"""Configure pytest."""
# -----------------------------------------------------------------------#
# Generic fixtures
# -----------------------------------------------------------------------#
BASE_PORTS = {
"TestTransportNullModem": 7100,
"TestTransportNullModemComm": 7150,
"TestTransportProtocol1": 7200,
"TestTransportProtocol2": 7300,
"TestTransportSerial": 7400,
"TestTransportReconnect": 7500,
"TestTransportComm": 7600,
"TestMessage": 7700,
"TestExamples": 7800,
"TestAsyncExamples": 7900,
"TestSyncExamples": 8000,
"TestModbusProtocol": 8100,
"TestClientServerSyncExamples": 8300,
"TestClientServerAsyncExamples": 8400,
"TestNetwork": 8500,
"TestSimulator": 8600,
}
@pytest.fixture(name="base_ports", scope="package")
def get_base_ports():
"""Return base_ports."""
return BASE_PORTS
@pytest.fixture(name="use_comm_type")
def prepare_dummy_use_comm_type():
"""Return default comm_type."""
return CommType.TCP
@pytest.fixture(name="use_host")
def define_use_host():
"""Set default host."""
return NULLMODEM_HOST
@pytest.fixture(name="use_cls")
def prepare_commparams_server(use_port, use_host, use_comm_type):
"""Prepare CommParamsClass object."""
if use_host == NULLMODEM_HOST and use_comm_type == CommType.SERIAL:
use_host = f"{NULLMODEM_HOST}:{use_port}"
return CommParams(
comm_name="test comm",
comm_type=use_comm_type,
reconnect_delay=0,
reconnect_delay_max=0,
timeout_connect=0,
source_address=(use_host, use_port),
baudrate=9600,
bytesize=8,
parity="E",
stopbits=2,
)
@pytest.fixture(name="use_clc")
def prepare_commparams_client(use_port, use_host, use_comm_type):
"""Prepare CommParamsClass object."""
if use_host == NULLMODEM_HOST and use_comm_type == CommType.SERIAL:
use_host = f"{NULLMODEM_HOST}:{use_port}"
timeout = 10 if platform.system().lower() != "windows" else 2
return CommParams(
comm_name="test comm",
comm_type=use_comm_type,
reconnect_delay=0.1,
reconnect_delay_max=0.35,
timeout_connect=timeout,
host=use_host,
port=use_port,
baudrate=9600,
bytesize=8,
parity="E",
stopbits=2,
)
@pytest.fixture(name="mock_clc")
def define_commandline_client(
use_comm,
use_framer,
use_port,
use_host,
):
"""Define commandline."""
my_port = str(use_port)
cmdline = ["--comm", use_comm, "--framer", use_framer, "--timeout", "0.1"]
if use_comm == "serial":
if use_host == NULLMODEM_HOST:
use_host = f"{use_host}:{my_port}"
else:
use_host = f"socket://{use_host}:{my_port}"
cmdline.extend(["--baudrate", "9600", "--port", use_host])
else:
cmdline.extend(["--port", my_port, "--host", use_host])
return cmdline
@pytest.fixture(name="mock_cls")
def define_commandline_server(
use_comm,
use_framer,
use_port,
use_host,
):
"""Define commandline."""
my_port = str(use_port)
cmdline = [
"--comm",
use_comm,
"--framer",
use_framer,
]
if use_comm == "serial":
if use_host == NULLMODEM_HOST:
use_host = f"{use_host}:{my_port}"
else:
use_host = f"socket://{use_host}:{my_port}"
cmdline.extend(["--baudrate", "9600", "--port", use_host])
else:
cmdline.extend(["--port", my_port, "--host", use_host])
return cmdline
@pytest_asyncio.fixture(name="mock_server")
async def _run_server(
mock_cls,
):
"""Run server."""
run_args = setup_server(cmdline=mock_cls)
task = asyncio.create_task(run_async_server(run_args))
task.set_name("mock_server")
await asyncio.sleep(0.1)
yield mock_cls
await ServerAsyncStop()
task.cancel()
await task
@pytest.fixture(name="system_health_check", autouse=True)
async def _check_system_health():
"""Check Thread, asyncio.task and NullModem for leftovers."""
if task := asyncio.current_task():
task.set_name("main loop")
start_threads = {thread.name: thread for thread in thread_enumerate()}
start_tasks = {task.get_name(): task for task in asyncio.all_tasks()}
yield
await asyncio.sleep(0.1)
for count in range(10):
all_clean = True
error_text = f"ERROR tasks/threads hanging after {count} retries:\n"
for thread in thread_enumerate():
name = thread.name
if not (
name in start_threads
or name.startswith("asyncio_")
or (sys.version_info.minor == 8 and name.startswith("ThreadPoolExecutor"))
):
thread.join(1.0)
error_text += f"-->THREAD{name}: {thread}\n"
all_clean = False
for task in asyncio.all_tasks():
name = task.get_name()
if not (name in start_tasks or "wrap_asyncgen_fixture" in str(task)):
task.cancel()
error_text += f"-->TASK{name}: {task}\n"
all_clean = False
if all_clean:
break
await asyncio.sleep(0.3)
assert all_clean, error_text
assert not NullModem.is_dirty()
@pytest.fixture(name="mock_context")
def define_mock_context():
"""Define context class."""
class MockContext(ModbusBaseSlaveContext):
"""Mock context."""
def __init__(self, valid=False, default=True):
"""Initialize."""
self.valid = valid
self.default = default
def validate(self, _fc, _address, _count=0):
"""Validate values."""
return self.valid
def getValues(self, _fc, _address, count=0):
"""Get values."""
return [self.default] * count
def setValues(self, _fc, _address, _values):
"""Set values."""
return MockContext
class MockLastValuesContext(ModbusBaseSlaveContext):
"""Mock context."""
def __init__(self, valid=False, default=True):
"""Initialize."""
self.valid = valid
self.default = default
self.last_values = []
def validate(self, _fc, _address, _count=0):
"""Validate values."""
return self.valid
def getValues(self, _fc, _address, count=0):
"""Get values."""
return [self.default] * count
def setValues(self, _fc, _address, values):
"""Set values."""
self.last_values = values
class mockSocket: # pylint: disable=invalid-name
"""Mock socket."""
timeout = 2
def __init__(self, copy_send=True):
"""Initialize."""
self.packets = deque()
self.buffer = None
self.in_waiting = 0
self.copy_send = copy_send
def mock_prepare_receive(self, msg):
"""Store message."""
self.packets.append(msg)
self.in_waiting += len(msg)
def close(self):
"""Close."""
return True
def recv(self, size):
"""Receive."""
if not self.packets or not size:
return b""
retval = self.packets.popleft()
self.in_waiting -= len(retval)
return retval
def read(self, size):
"""Read."""
return self.recv(size)
def recvfrom(self, size):
"""Receive from."""
return [self.recv(size)]
def write(self, msg):
"""Write."""
return self.send(msg)
def send(self, msg):
"""Send."""
if not self.copy_send:
return len(msg)
self.packets.append(msg)
self.in_waiting += len(msg)
return len(msg)
def sendto(self, msg, *_args):
"""Send to."""
return self.send(msg)
def setblocking(self, _flag):
"""Set blocking."""
return None
|