Verify metadata is included in registration

Author: michael.yak

pyctuator/pyctuator.py

@@ -38,7 +38,7 @@ def __init__(
             logfile_max_size: int = 10000,
             logfile_formatter: str = default_logfile_format,
             auto_deregister: bool = True,
-            metadata: Optional[dict] = {}
+            metadata: Optional[dict] = None
     ) -> None:
         """The entry point for integrating pyctuator with a web-frameworks such as FastAPI and Flask.
 
@@ -70,6 +70,10 @@ def __init__(
         :param registration_interval_sec: how often pyctuator will renew its registration with spring-boot-admin
         :param free_disk_space_down_threshold_bytes: amount of free space in bytes in "./" (the application's current
          working directory) below which the built-in disk-space health-indicator will fail
+        :param auto_deregister: if true, pyctuator will automatically deregister from SBA during shutdown, needed for
+        example when running in k8s so every time a new pod is created it is assigned a different IP address, resulting
+        with SBA showing "offline" instances
+        :param metadata: optional metadata key-value pairs that are displayed in SBA main page of an instance
         """
 
         self.auto_deregister = auto_deregister

tests/aiohttp_test_server.py

@@ -24,6 +24,7 @@ def __init__(self) -> None:
             "http://localhost:8888/pyctuator",
             "http://localhost:8001/register",
             registration_interval_sec=1,
+            metadata=self.metadata,
         )
 
         @self.routes.get("/logfile_test_repeater")

tests/conftest.py

@@ -1,4 +1,5 @@
 import logging
+import random
 import secrets
 import threading
 import time
@@ -155,6 +156,7 @@ def endpoints(registration_tracker: RegistrationTrackerFixture) -> Endpoints:
 
 
 class PyctuatorServer(ABC):
+    metadata: Optional[dict] = {f"k{i}": f"v{i}" for i in range(random.randrange(10))}
 
     @abstractmethod
     def start(self) -> None:

tests/fast_api_test_server.py

@@ -27,6 +27,7 @@ def __init__(self) -> None:
             "http://localhost:8000/pyctuator",
             "http://localhost:8001/register",
             registration_interval_sec=1,
+            metadata=self.metadata,
         )
 
         @self.app.get("/logfile_test_repeater", tags=["pyctuator"])

tests/flask_test_server.py

@@ -20,7 +20,8 @@ def __init__(self) -> None:
             "http://localhost:5000",
             "http://localhost:5000/pyctuator",
             "http://localhost:8001/register",
-            registration_interval_sec=1
+            registration_interval_sec=1,
+            metadata=self.metadata,
         )
 
         @self.app.route("/shutdown", methods=["POST"])

tests/test_pyctuator_e2e.py

@@ -19,8 +19,6 @@
 from tests.conftest import Endpoints, PyctuatorServer, RegistrationRequest, RegistrationTrackerFixture
 from tests.fast_api_test_server import FastApiPyctuatorServer
 from tests.flask_test_server import FlaskPyctuatorServer
-
-
 # mypy: ignore_errors
 from tests.tornado_test_server import TornadoPyctuatorServer
 
@@ -198,6 +196,11 @@ def test_recurring_registration_and_deregistration(
     registration_start_time = datetime.fromisoformat(registration_tracker.start_time)
     assert registration_start_time > registration_tracker.test_start_time - timedelta(seconds=10)
 
+    # Verify that the randomly generated metadata created when the server starter are included in the registration
+    metadata = registration_tracker.registration.metadata
+    metadata_without_startup = {k: metadata[k] for k in metadata if k != "startup"}
+    assert metadata_without_startup == pyctuator_server.metadata
+
     # Ask to deregister (in real life, called by atexit) and verify it was registered
     pyctuator_server.atexit()
     assert registration_tracker.deregistration_time > registration_start_time

tests/tornado_test_server.py

@@ -53,6 +53,7 @@ def get(self) -> None:
             registration_url=f"http://localhost:8001/register",
             app_description="Demonstrate Spring Boot Admin Integration with Tornado",
             registration_interval_sec=1,
+            metadata=self.metadata,
         )
 
         self.io_loop: Optional[ioloop.IOLoop] = None