Implement healthcheck handler
Issue-ID: RIC-228
Change-Id: I1136cbc1fb3e9b7e542033e8cba8d23ba79b15bd
Signed-off-by: Tommy Carpenter <tc677g@att.com>
diff --git a/docs/overview.rst b/docs/overview.rst
index 7a2a156..a572390 100644
--- a/docs/overview.rst
+++ b/docs/overview.rst
@@ -40,6 +40,16 @@
In the case of RMR Xapps, there are currently 3 potential threads; the thread that reads from rmr directly, and the user can optionally have the rmr queue read run in a thread, returning execution back to the user thread.
The default is only two threads however, where `.run` does not return back execution and the user code is "finished" at that point.
+Healthchecks
+------------
+RMRXapps come with a default rmr healthcheck probe handler.
+When the RMRXapp is sent an rmr healthcheck, it will check to see if the rmr thread is healthy (well it can't even reply if it's not!), and that the SDL connection is healthy.
+The Xapp responds accordingly.
+The user can override this default handler by registering a new callback to the appropriate message type.
+
+General Xapps must handle healthchecks when they read their rmr mailbox, since there is no notion of handlers.
+
+There is no http service (Currently) in the framework therefore there are no http healthchecks.
Examples
--------
@@ -48,10 +58,3 @@
Ping then reads it's own mailbox and demonstrates other functionality.
The highlight to note is that `pong` is purely reactive, it only does anything when a message is received.
Ping uses a general that also happens to read it's rmr mailbox inside.
-
-Current gaps
-------------
-The following are known gaps or potential enhancements at the time of writing.
-::
-
- * a logger has to be provided to the xapp
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index c3d358f..46de054 100644
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -14,6 +14,14 @@
:depth: 3
:local:
+[0.7.0] - 4/2/2020
+-------------------
+::
+
+ * RMRXapps by default now implement the rmr healthcheck probe; users can also override it with a more complex handler if they wish
+ * Fix a bug in the unit tests where a payload mismatch wouldn't actually fail the test (would now)
+
+
[0.6.0] - 3/23/2020
-------------------
::
diff --git a/ricxappframe/xapp_frame.py b/ricxappframe/xapp_frame.py
index e977e27..180c3ae 100644
--- a/ricxappframe/xapp_frame.py
+++ b/ricxappframe/xapp_frame.py
@@ -24,6 +24,10 @@
from rmr import rmr
from mdclogpy import Logger
+# constants
+RIC_HEALTH_CHECK_REQ = 100
+RIC_HEALTH_CHECK_RESP = 101
+
# Private base class; not for direct client use
@@ -135,6 +139,7 @@
if sbuf.contents.state == 0:
return True
+ self.logger.info("RTS Failed! Summary: {}".format(rmr.message_summary(sbuf)))
return False
def rmr_free(self, sbuf):
@@ -282,6 +287,17 @@
# used for thread control
self._keep_going = True
+ # register a default healthcheck handler
+ # this default checks that rmr is working and SDL is working
+ # the user can override this and register their own handler if they wish since the "last registered callback wins".
+ def handle_healthcheck(self, summary, sbuf):
+ ok = self.healthcheck()
+ payload = b"OK\n" if ok else b"ERROR [RMR or SDL is unhealthy]\n"
+ self.rmr_rts(sbuf, new_payload=payload, new_mtype=RIC_HEALTH_CHECK_RESP)
+ self.rmr_free(sbuf)
+
+ self.register_callback(handle_healthcheck, RIC_HEALTH_CHECK_REQ)
+
def register_callback(self, handler, message_type):
"""
registers this xapp to call handler(summary, buf) when an rmr message is received of type message_type
diff --git a/setup.py b/setup.py
index 56f9e7e..43a34af 100644
--- a/setup.py
+++ b/setup.py
@@ -32,7 +32,7 @@
setup(
name="ricxappframe",
- version="0.6.0",
+ version="0.7.0",
packages=find_packages(exclude=["tests.*", "tests"]),
author="Tommy Carpenter",
description="Xapp framework for python",
diff --git a/tests/fixtures/test_local.rt b/tests/fixtures/test_local.rt
index 9741aa3..4853613 100644
--- a/tests/fixtures/test_local.rt
+++ b/tests/fixtures/test_local.rt
@@ -2,4 +2,5 @@
newrt|start
mse| 60000 | -1 | 127.0.0.1:4564
mse| 60001 | -1 | 127.0.0.1:4564
+mse| 100 | -1 | 127.0.0.1:4564
newrt|end
diff --git a/tests/test_xapps.py b/tests/test_xapps.py
index c52f54f..cd806ac 100644
--- a/tests/test_xapps.py
+++ b/tests/test_xapps.py
@@ -17,46 +17,44 @@
import json
import time
from contextlib import suppress
-from ricxappframe.xapp_frame import Xapp, RMRXapp
+from ricxappframe.xapp_frame import Xapp, RMRXapp, RIC_HEALTH_CHECK_REQ, RIC_HEALTH_CHECK_RESP
rmr_xapp = None
+rmr_xapp_health = None
gen_xapp = None
-def test_flow():
+def test_rmr_init():
# test variables
- def_called = 0
- sixty_called = 0
+ def_pay = None
+ sixty_pay = None
# create rmr app
- global rmr_xapp
-
- def post_init(self):
- self.logger.info("suppp info")
- self.logger.debug("suppp debug")
def default_handler(self, summary, sbuf):
- nonlocal def_called
- def_called += 1
- assert json.loads(summary["payload"]) == {"test send 60001": 1}
+ nonlocal def_pay
+ def_pay = json.loads(summary["payload"])
self.rmr_free(sbuf)
- rmr_xapp = RMRXapp(default_handler, post_init=post_init, rmr_port=4564, rmr_wait_for_ready=False, use_fake_sdl=True)
-
def sixtythou_handler(self, summary, sbuf):
- nonlocal sixty_called
- sixty_called += 1
- assert json.loads(summary["payload"]) == {"test send 60000": 1}
+ nonlocal sixty_pay
+ sixty_pay = json.loads(summary["payload"])
self.rmr_free(sbuf)
+ global rmr_xapp
+ rmr_xapp = RMRXapp(default_handler, rmr_port=4564, use_fake_sdl=True)
rmr_xapp.register_callback(sixtythou_handler, 60000)
rmr_xapp.run(thread=True) # in unit tests we need to thread here or else execution is not returned!
time.sleep(1)
+ # create a general xapp that will demonstrate some SDL functionality and launch some requests against the rmr xapp
+
def entry(self):
+ time.sleep(1)
+
self.sdl_set("testns", "mykey", 6)
assert self.sdl_get("testns", "mykey") == 6
assert self.sdl_find_and_get("testns", "myk") == {"mykey": 6}
@@ -69,13 +67,41 @@
self.rmr_send(val, 60001)
global gen_xapp
- gen_xapp = Xapp(entrypoint=entry, rmr_wait_for_ready=False, use_fake_sdl=True)
+ gen_xapp = Xapp(entrypoint=entry, use_fake_sdl=True)
gen_xapp.run()
time.sleep(1)
- assert def_called == 1
- assert sixty_called == 1
+ assert def_pay == {"test send 60001": 2}
+ assert sixty_pay == {"test send 60000": 1}
+
+
+def test_rmr_healthcheck():
+ # thanos uses the rmr xapp to healthcheck the rmr xapp
+
+ # test variables
+ health_pay = None
+
+ def post_init(self):
+ self.rmr_send(b"", RIC_HEALTH_CHECK_REQ)
+
+ def default_handler(self, summary, sbuf):
+ pass
+
+ global rmr_xapp_health
+ rmr_xapp_health = RMRXapp(default_handler, post_init=post_init, rmr_port=4666, use_fake_sdl=True)
+
+ def health_handler(self, summary, sbuf):
+ nonlocal health_pay
+ health_pay = summary["payload"]
+ self.rmr_free(sbuf)
+
+ rmr_xapp_health.register_callback(health_handler, RIC_HEALTH_CHECK_RESP)
+ rmr_xapp_health.run(thread=True) # in unit tests we need to thread here or else execution is not returned!
+
+ time.sleep(1)
+
+ assert health_pay == b"OK\n"
def teardown_module():
@@ -88,3 +114,5 @@
gen_xapp.stop()
with suppress(Exception):
rmr_xapp.stop()
+ with suppress(Exception):
+ rmr_xapp_health.stop()