deregister_from_admin_server should be covered by E2E

E2E's test_recurring_registration was extended to verify that
deregistration is working properly for all the web frameworks.

Note that the actual invocation of test_recurring_registration is
registered in `atexit` however in the test its too hard to invoke
`atexit` therefore it is called directly.

Solves #25

Author: michael.yak

pyctuator/impl/aiohttp_pyctuator.py

@@ -4,7 +4,7 @@
 from datetime import datetime
 from functools import partial
 from http import HTTPStatus
-from typing import Any, Callable, List, Mapping, Optional
+from typing import Any, Callable, List, Mapping
 
 from aiohttp import web
 from multidict import CIMultiDictProxy

pyctuator/impl/spring_boot_admin_registration.py

@@ -36,10 +36,7 @@ def __init__(
 
         self.should_continue_registration_schedule: bool = False
 
-    def _schedule_next_registration(
-            self,
-            registration_interval_sec: int
-    ) -> None:
+    def _schedule_next_registration(self, registration_interval_sec: int) -> None:
         timer = threading.Timer(
             registration_interval_sec,
             self._register_with_admin_server,

tests/aiohttp_test_server.py

@@ -79,6 +79,12 @@ def start(self) -> None:
             time.sleep(0.01)
 
     def stop(self) -> None:
+        logging.info("Stopping aiohttp server")
         self.pyctuator.stop()
         self.should_stop_server = True
         self.thread.join()
+        logging.info("aiohttp server stopped")
+
+    def atexit(self) -> None:
+        if self.pyctuator.boot_admin_registration_handler:
+            self.pyctuator.boot_admin_registration_handler.deregister_from_admin_server()

tests/conftest.py

@@ -43,6 +43,7 @@ class RegistrationTrackerFixture:
     registration: Optional[RegistrationRequest]
     count: int
     start_time: Optional[str]
+    deregistration_time: Optional[datetime]
     test_start_time: datetime
 
 
@@ -53,7 +54,7 @@ def install_signal_handlers(self) -> None:
 
 @pytest.fixture
 def registration_tracker() -> RegistrationTrackerFixture:
-    return RegistrationTrackerFixture(None, 0, None, datetime.now(timezone.utc))
+    return RegistrationTrackerFixture(None, 0, None, None, datetime.now(timezone.utc))
 
 
 @pytest.fixture
@@ -75,6 +76,13 @@ def register(request: Request, registration: RegistrationRequest) -> Dict[str, s
             registration_tracker.start_time = registration.metadata["startup"]
         return {"id": "JB007"}
 
+    # pylint: disable=unused-argument,unused-variable
+    @boot_admin_app.delete("/register/{registration_id}", tags=["admin-server"])
+    def deregister(registration_id: str) -> None:
+        logging.debug("Got deregistration, delete %s (previous deregistration time is %s)",
+                      registration_id, registration_tracker.deregistration_time)
+        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")
     boot_admin_server = CustomServer(config=boot_admin_config)
@@ -87,6 +95,7 @@ def register(request: Request, registration: RegistrationRequest) -> Dict[str, s
     yield None
 
     boot_admin_server.should_exit = True
+    boot_admin_server.force_exit = True
     boot_admin_thread.join()
 
 
@@ -127,3 +136,7 @@ def start(self) -> None:
     @abstractmethod
     def stop(self) -> None:
         pass
+
+    @abstractmethod
+    def atexit(self) -> None:
+        pass

tests/fast_api_test_server.py

@@ -55,6 +55,17 @@ def start(self) -> None:
             time.sleep(0.01)
 
     def stop(self) -> None:
+        logging.info("Stopping FastAPI server")
         self.pyctuator.stop()
+
+        # Allow the recurring registration to complete any in-progress request before stopping FastAPI
+        time.sleep(1)
+
         self.server.should_exit = True
+        self.server.force_exit = True
         self.thread.join()
+        logging.info("FastAPI server stopped")
+
+    def atexit(self) -> None:
+        if self.pyctuator.boot_admin_registration_handler:
+            self.pyctuator.boot_admin_registration_handler.deregister_from_admin_server()

tests/flask_test_server.py

@@ -71,4 +71,8 @@ def stop(self) -> None:
         self.pyctuator.stop()
         requests.post("http://localhost:5000/shutdown")
         self.thread.join()
-        logging.info("Flask server is shutdown")
+        logging.info("Flask server stopped")
+
+    def atexit(self) -> None:
+        if self.pyctuator.boot_admin_registration_handler:
+            self.pyctuator.boot_admin_registration_handler.deregister_from_admin_server()

tests/test_pyctuator_e2e.py

@@ -32,7 +32,7 @@ def pyctuator_server(request) -> Generator:  # type: ignore
     pyctuator_server.start()
 
     # Yield back to pytest until the module is done
-    yield None
+    yield pyctuator_server
 
     # Once the module is done, stop the pyctuator-server
     pyctuator_server.stop()
@@ -176,14 +176,17 @@ def test_metrics_endpoint(endpoints: Endpoints) -> None:
 
 @pytest.mark.usefixtures("boot_admin_server", "pyctuator_server")
 @pytest.mark.mark_recurring_registration
-def test_recurring_registration(registration_tracker: RegistrationTrackerFixture) -> None:
+def test_recurring_registration_and_deregistration(
+        registration_tracker: RegistrationTrackerFixture,
+        pyctuator_server: PyctuatorServer
+) -> None:
     # Verify that at least 4 registrations occurred within 10 seconds since the test started
     start = time.time()
     while registration_tracker.count < 4:
         time.sleep(0.5)
         if time.time() - start > 15:
             pytest.fail(
-                f"Expected at least 4 recurring registrations within 10 seconds but got {registration_tracker.count}")
+                "Expected at least 4 recurring registrations within 10 seconds but got {registration_tracker.count}")
 
     # Verify that the reported startup time is the same across all the registrations and that its later then the test's
     # start time
@@ -192,6 +195,10 @@ def test_recurring_registration(registration_tracker: RegistrationTrackerFixture
     registration_start_time = datetime.fromisoformat(registration_tracker.start_time)
     assert registration_start_time > registration_tracker.test_start_time - timedelta(seconds=10)
 
+    # 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
+
 
 @pytest.mark.usefixtures("boot_admin_server", "pyctuator_server")
 @pytest.mark.mark_threads_endpoint