Coverage not allowed below 99.5%. (#2765)

Author: janiversen

examples/server_hook.py

@@ -8,6 +8,7 @@
 
 import asyncio
 import logging
+import sys
 
 from pymodbus import FramerType, pymodbus_apply_logging_config
 from pymodbus.datastore import (
@@ -19,6 +20,15 @@
 from pymodbus.server import ModbusTcpServer
 
 
+try:
+    import helper  # type: ignore[import-not-found]
+except ImportError:
+    print("*** ERROR --> THIS EXAMPLE needs the example directory, please see \n\
+          https://pymodbus.readthedocs.io/en/latest/source/examples.html\n\
+          for more information.")
+    sys.exit(-1)
+
+
 class Manipulator:
     """A Class to run the server."""
 
@@ -43,8 +53,9 @@ def trace_connect(self, connect: bool) -> None:
         txt = "Connected" if connect else "Disconnected"
         print(f"---> {txt}")
 
-    async def setup(self):
+    async def setup(self, cmdline):
         """Prepare server."""
+        args = helper.get_commandline(server=True, description="server hooks", cmdline=cmdline)
         pymodbus_apply_logging_config(logging.DEBUG)
         datablock = ModbusSequentialDataBlock(0x00, [17] * 100)
         context = ModbusServerContext(
@@ -53,11 +64,12 @@ async def setup(self):
             ),
             single=True,
         )
+        address: tuple[str, int] = (args.host if args.host else "", args.port if args.port else 0)
         self.server = ModbusTcpServer(
             context,
             framer=FramerType.SOCKET,
             identity=None,
-            address=("127.0.0.1", 5020),
+            address=address,
             trace_packet=self.trace_packet,
             trace_pdu=self.trace_pdu,
             trace_connect=self.trace_connect,
@@ -68,10 +80,10 @@ async def run(self):
         await self.server.serve_forever()
 
 
-async def main():
+async def main(cmdline=None):
     """Run example."""
     server = Manipulator()
-    await server.setup()
+    await server.setup(cmdline=cmdline)
     await server.run()
 
 

pyproject.toml

@@ -244,7 +244,7 @@ exclude_also = [
     "if __name__ == .__main__.:",
     ]
 skip_covered = true
-fail_under = 94.9
+fail_under = 99.5
 
 [tool.coverage.html]
 directory = "build/cov"

test/examples/test_examples.py

@@ -22,6 +22,7 @@
 from examples.server_async import setup_server
 from examples.server_callback import run_callback_server
 from examples.server_datamodel import main as run_main_datamodel
+from examples.server_hook import main as main_hook_server
 from examples.server_sync import run_sync_server
 from examples.server_updating import main as main_updating_server
 from examples.simple_async_client import run_async_simple_client
@@ -70,6 +71,20 @@ async def test_updating_server(self, use_port, use_host):
         await asyncio.sleep(0.1)
         client = setup_async_client(cmdline=cmdargs)
         await run_async_client(client, modbus_calls=run_a_few_calls)
+        await asyncio.sleep(10)
+        await ServerAsyncStop()
+        await asyncio.sleep(0.1)
+        task.cancel()
+        await task
+
+    async def test_hook_server(self, use_port, use_host):
+        """Test server server hooks."""
+        cmdargs = ["--port", str(use_port), "--host", use_host]
+        task = asyncio.create_task(main_hook_server(cmdline=cmdargs))
+        task.set_name("run main_hook_server")
+        await asyncio.sleep(0.1)
+        client = setup_async_client(cmdline=cmdargs)
+        await run_async_client(client, modbus_calls=run_a_few_calls)
         await asyncio.sleep(0.1)
         await ServerAsyncStop()
         await asyncio.sleep(0.1)