Make sure test servers bind on unique ports - hopefully this will solve the random test failures

Author: michael.yak

tests/aiohttp_test_server.py

@@ -8,20 +8,26 @@
 from pyctuator.pyctuator import Pyctuator
 from tests.conftest import PyctuatorServer
 
+bind_port = 6000
+
 
 # mypy: ignore_errors
 # pylint: disable=unused-variable
 class AiohttpPyctuatorServer(PyctuatorServer):
 
     def __init__(self) -> None:
+        global bind_port
+        self.port = bind_port
+        bind_port += 1
+
         self.app = web.Application()
         self.routes = web.RouteTableDef()
 
         self.pyctuator = Pyctuator(
             self.app,
             "AIOHTTP Pyctuator",
-            "http://localhost:8888",
-            "http://localhost:8888/pyctuator",
+            f"http://localhost:{self.port}",
+            f"http://localhost:{self.port}/pyctuator",
             "http://localhost:8001/register",
             registration_interval_sec=1,
             metadata=self.metadata,
@@ -61,7 +67,7 @@ async def _run_server(self) -> None:
         await runner.setup()
 
         logging.info("Starting aiohttp server")
-        site = web.TCPSite(runner, port=8888)
+        site = web.TCPSite(runner, port=self.port)
         await site.start()
         self.server_started = True
         logging.info("aiohttp server started")

tests/conftest.py

@@ -114,7 +114,7 @@ def deregister(registration_id: str) -> None:
         registration_tracker.deregistration_time = datetime.now(timezone.utc)
 
     # Start the mock boot-admin server that is needed to test pyctuator's registration
-    boot_admin_config = Config(app=boot_admin_app, port=8001, loop="asyncio", lifespan="off", log_level="info")
+    boot_admin_config = Config(app=boot_admin_app, port=8001, lifespan="off", log_level="info")
     boot_admin_server = CustomServer(config=boot_admin_config)
     boot_admin_thread = threading.Thread(target=boot_admin_server.run)
     boot_admin_thread.start()

tests/fast_api_test_server.py

@@ -11,9 +11,15 @@
 from pyctuator.pyctuator import Pyctuator
 from tests.conftest import PyctuatorServer, CustomServer
 
+bind_port = 7000
+
 
 class FastApiPyctuatorServer(PyctuatorServer):
     def __init__(self) -> None:
+        global bind_port
+        self.port = bind_port
+        bind_port += 1
+
         self.app = FastAPI(
             title="FastAPI Example Server",
             description="Demonstrate Spring Boot Admin Integration with FastAPI",
@@ -23,8 +29,8 @@ def __init__(self) -> None:
         self.pyctuator = Pyctuator(
             self.app,
             "FastAPI Pyctuator",
-            "http://localhost:8000",
-            "http://localhost:8000/pyctuator",
+            f"http://localhost:{self.port}",
+            f"http://localhost:{self.port}/pyctuator",
             "http://localhost:8001/register",
             registration_interval_sec=1,
             metadata=self.metadata,
@@ -37,7 +43,7 @@ def logfile_test_repeater(repeated_string: str) -> str:
             logging.error(repeated_string)
             return repeated_string
 
-        self.server = CustomServer(config=(Config(app=self.app, loop="asyncio", lifespan="off", log_level="info")))
+        self.server = CustomServer(config=(Config(app=self.app, port=self.port, lifespan="off", log_level="info")))
         self.thread = threading.Thread(target=self.server.run)
 
         @self.app.get("/httptrace_test_url")

tests/flask_test_server.py

@@ -11,11 +11,17 @@
 
 REQUEST_TIMEOUT = 10
 
+bind_port = 5000
+
 
 class FlaskPyctuatorServer(PyctuatorServer):
     def __init__(self) -> None:
+        global bind_port
+        self.port = bind_port
+        bind_port += 1
+
         self.app = Flask("Flask Example Server")
-        self.server = make_server('127.0.0.1', 5000, self.app)
+        self.server = make_server('127.0.0.1', self.port, self.app)
         self.ctx = self.app.app_context()
         self.ctx.push()
 
@@ -24,8 +30,8 @@ def __init__(self) -> None:
         self.pyctuator = Pyctuator(
             self.app,
             "Flask Pyctuator",
-            "http://localhost:5000",
-            "http://localhost:5000/pyctuator",
+            f"http://localhost:{self.port}",
+            f"http://localhost:{self.port}/pyctuator",
             "http://localhost:8001/register",
             registration_interval_sec=1,
             metadata=self.metadata,
@@ -61,7 +67,7 @@ def start(self) -> None:
         while True:
             time.sleep(0.5)
             try:
-                requests.get("http://localhost:5000/pyctuator", timeout=REQUEST_TIMEOUT)
+                requests.get(f"http://localhost:{self.port}/pyctuator", timeout=REQUEST_TIMEOUT)
                 logging.info("Flask server started")
                 return
             except requests.exceptions.RequestException:  # Catches all exceptions that Requests raises!

tests/tornado_test_server.py

@@ -10,9 +10,14 @@
 from pyctuator.pyctuator import Pyctuator
 from tests.conftest import PyctuatorServer
 
+bind_port = 9000
+
 
 class TornadoPyctuatorServer(PyctuatorServer):
     def __init__(self) -> None:
+        global bind_port
+        self.port = bind_port
+        bind_port += 1
 
         # pylint: disable=abstract-method
         class LogfileTestRepeater(RequestHandler):
@@ -43,13 +48,14 @@ def get(self) -> None:
                 ("/logfile_test_repeater", LogfileTestRepeater),
                 ("/httptrace_test_url", GetHttptraceTestUrl)
             ],
-            debug=True)
+            debug=False
+        )
 
         self.pyctuator = Pyctuator(
             self.app,
             "Tornado Pyctuator",
-            app_url="http://localhost:6000",
-            pyctuator_endpoint_url="http://localhost:6000/pyctuator",
+            app_url=f"http://localhost:{self.port}",
+            pyctuator_endpoint_url=f"http://localhost:{self.port}/pyctuator",
             registration_url="http://localhost:8001/register",
             app_description="Demonstrate Spring Boot Admin Integration with Tornado",
             registration_interval_sec=1,
@@ -63,7 +69,7 @@ def get(self) -> None:
 
     def _start_in_thread(self) -> None:
         self.io_loop = ioloop.IOLoop()
-        self.http_server.listen(6000)
+        self.app.listen(self.port)
         self.io_loop.start()
 
     def start(self) -> None: