feat(client): add heartbeat as client API function (#63)

* WIP: heartbeat
* tests(client): added tests for client
* docs(client): added docstring
Signed-off-by: Michael Schilonka <[email protected]>

Author: Schille

client/beiboot/api/__init__.py

@@ -3,3 +3,4 @@
 from .delete import *  # noqa
 from .list import *  # noqa
 from .read import *  # noqa
+from .heartbeat import *  # noqa

client/beiboot/api/heartbeat.py

@@ -0,0 +1,60 @@
+import logging
+from datetime import datetime
+from typing import Optional
+from beiboot.configuration import ClientConfiguration, default_configuration
+import kubernetes as k8s
+
+from beiboot.api import stopwatch
+from beiboot.types import Beiboot
+
+logger = logging.getLogger(__name__)
+
+
+@stopwatch
+def write_heartbeat(
+    client_id: str,
+    bbt: Beiboot,
+    timestamp: Optional[datetime] = None,
+    config: ClientConfiguration = default_configuration,
+) -> datetime:
+    """
+    Create a client contact entry to the heartbeat configmap for a Beiboot. Returns the timestamp written to the
+    configmap.
+
+    :param client_id: The client id to write the contact entry on behalf of
+    :type client_id: str
+    :param bbt: The Beiboot to write a heartbeat for
+    :type bbt: Beiboot
+    :param timestamp: Optional timestamp to write to the configmap
+    :type timestamp: datetime
+    """
+
+    if timestamp is None:
+        timestamp = datetime.utcnow()
+
+    _timestamp = timestamp.isoformat()
+    configmap = k8s.client.V1ConfigMap(  # type: ignore
+        api_version="v1",
+        kind="ConfigMap",
+        data={client_id: _timestamp},
+        metadata=k8s.client.V1ObjectMeta(  # type: ignore
+            name=config.CLIENT_HEARTBEAT_CONFIGMAP_NAME,
+            namespace=bbt.namespace,
+        ),
+    )
+    try:
+        config.K8S_CORE_API.patch_namespaced_config_map(
+            name=config.CLIENT_HEARTBEAT_CONFIGMAP_NAME,
+            namespace=bbt.namespace,
+            body=configmap,
+        )
+        logger.debug(f"Successfully heartbeat for client {client_id} to {_timestamp}")
+    except k8s.client.exceptions.ApiException as e:  # type: ignore
+        if e.status == 404:
+            raise RuntimeError(
+                f"Cannot write heartbeat, the required configmap '{config.CLIENT_HEARTBEAT_CONFIGMAP_NAME}' does not exist"
+            ) from None
+        else:
+            raise RuntimeError(f"Cannot write heartbeat: {e}") from None
+
+    return timestamp

client/beiboot/configuration.py

@@ -25,6 +25,7 @@ def __init__(
     ):
         self.NAMESPACE = namespace
         self.CONFIGMAP_NAME = "beiboot-config"
+        self.CLIENT_HEARTBEAT_CONFIGMAP_NAME = "beiboot-clients"
         self.REGISTRY_URL = (
             registry_url.rstrip("/") if registry_url else "quay.io/getdeck"
         )

client/tests/e2e/test_heartbeat.py

@@ -0,0 +1,63 @@
+from datetime import datetime
+import json
+
+from beiboot import api
+from beiboot.types import BeibootRequest, BeibootParameters
+from tests.e2e.base import TestClientBase
+
+from beiboot.types import BeibootState
+from beiboot.configuration import default_configuration
+
+
+class TestBaseSetup(TestClientBase):
+
+    beiboot_name = "mycluster-hb"
+
+    def test_write_heartbeat(self, operator, kubectl, timeout):
+
+        req = BeibootRequest(
+            name=self.beiboot_name,
+            parameters=BeibootParameters(
+                nodes=1,
+                serverStorageRequests="500Mi",
+                serverResources={"requests": {"cpu": "0.25", "memory": "0.25Gi"}},
+                nodeResources={"requests": {"cpu": "0.25", "memory": "0.25Gi"}},
+            ),
+        )
+        bbt = api.create(req)
+
+        bbt.wait_for_state(awaited_state=BeibootState.PENDING, timeout=timeout)
+
+        timestamp = datetime.utcnow()
+
+        api.write_heartbeat("test-client", bbt, timestamp)
+        configmap = kubectl(
+            [
+                "-n",
+                bbt.namespace,
+                "get",
+                "configmap",
+                default_configuration.CLIENT_HEARTBEAT_CONFIGMAP_NAME,
+                "--output",
+                "json",
+            ]
+        )
+        cm = json.loads(configmap)
+        assert "test-client" in cm["data"].keys()
+        assert cm["data"]["test-client"] == str(timestamp.isoformat())
+
+        api.write_heartbeat("test-client1", bbt)
+        configmap = kubectl(
+            [
+                "-n",
+                bbt.namespace,
+                "get",
+                "configmap",
+                default_configuration.CLIENT_HEARTBEAT_CONFIGMAP_NAME,
+                "--output",
+                "json",
+            ]
+        )
+        cm = json.loads(configmap)
+        assert "test-client1" in cm["data"].keys()
+        assert datetime.fromisoformat(cm["data"]["test-client1"])

client/tests/unit/test_api.py

@@ -1,4 +1,5 @@
 import pytest
+from datetime import datetime
 
 from beiboot import api
 from beiboot.types import BeibootRequest
@@ -46,3 +47,9 @@ def test_d_read_events(self, operator):
         beiboot = api.read("test-read-all")
         events = beiboot.events_by_timestamp
         assert type(events) == dict
+
+    def test_e_write_heartbeat(self, operator, kubectl):
+        bbt = api.read(name="test-read")
+        timestamp = datetime.utcnow()
+        with pytest.raises(RuntimeError):
+            api.write_heartbeat("test-client", bbt, timestamp)