feat: delete checkpoint when input is removed (#6)

artemrys · web-flow · commit d09acc24bc36 · 2024-11-11T16:55:07.000+01:00
This PR removes a relevant checkpoint from the KVStore when an input is
deleted.

Additionally it introduces a basic bash script to update local
environment for the testing purposes.
diff --git a/globalConfig.json b/globalConfig.json
@@ -62,6 +62,8 @@
             "services": [
                 {
                     "name": "example",
+                    "restHandlerModule": "example_delete_checkpoint_rh",
+                    "restHandlerClass": "DeleteCheckpointRestHandler",
                     "entity": [
                         {
                             "type": "text",
@@ -178,7 +180,7 @@
     "meta": {
         "name": "Splunk_TA_Example",
         "restRoot": "Splunk_TA_Example",
-        "version": "0.0.1+81ad77f",
+        "version": "0.0.1+15d0f3a",
         "displayName": "Splunk Add-on for Example",
         "schemaVersion": "0.0.9",
         "supportedThemes": [
diff --git a/package/bin/example_delete_checkpoint_rh.py b/package/bin/example_delete_checkpoint_rh.py
@@ -0,0 +1,48 @@
+import traceback
+
+import import_declare_test
+
+from solnlib import log
+from solnlib.modular_input import checkpointer
+from splunktaucclib.rest_handler.admin_external import AdminExternalHandler
+
+import example_utils
+
+
+class DeleteCheckpointRestHandler(AdminExternalHandler):
+    def __init__(self, *args, **kwargs):
+        AdminExternalHandler.__init__(self, *args, **kwargs)
+
+    def handleList(self, confInfo):
+        AdminExternalHandler.handleList(self, confInfo)
+
+    def handleEdit(self, confInfo):
+        AdminExternalHandler.handleEdit(self, confInfo)
+
+    def handleCreate(self, confInfo):
+        AdminExternalHandler.handleCreate(self, confInfo)
+
+    def handleRemove(self, confInfo):
+        log_filename = "example_delete_checkpoint"
+        logger = log.Logs().get_logger(log_filename)
+        session_key = self.getSessionKey()
+        input_name = str(self.callerArgs.id)
+        checkpointer_key_name = example_utils.get_example_collection_key_name(
+            input_name
+        )
+        logger.info(f"Deleting the checkpoint for input '{input_name}'")
+        try:
+            kvstore_checkpointer = checkpointer.KVStoreCheckpointer(
+                "example_checkpointer",
+                session_key,
+                example_utils.ADDON_NAME,
+            )
+            kvstore_checkpointer.delete(checkpointer_key_name)
+        except Exception as e:
+            log.log_exception(
+                logger,
+                e,
+                "Checkpoint Error",
+                msg_before=f"Error while deleting checkpoint for {input_name} input. {traceback.format_exc()}",
+            )
+        AdminExternalHandler.handleRemove(self, confInfo)
diff --git a/package/bin/example_helper.py b/package/bin/example_helper.py
@@ -14,18 +14,15 @@
 from splunklib import modularinput as smi
 
 
-ADDON_NAME = "Splunk_TA_Example"
-
-
 def logger_for_input(input_name: str) -> logging.Logger:
-    return log.Logs().get_logger(f"{ADDON_NAME.lower()}_{input_name}")
+    return log.Logs().get_logger(f"{example_utils.ADDON_NAME.lower()}_{input_name}")
 
 
 def get_account_api_key(session_key: str, account_name: str):
     cfm = conf_manager.ConfManager(
         session_key,
-        ADDON_NAME,
-        realm=f"__REST_CREDENTIAL__#{ADDON_NAME}#configs/conf-splunk_ta_example_account",
+        example_utils.ADDON_NAME,
+        realm=f"__REST_CREDENTIAL__#{example_utils.ADDON_NAME}#configs/conf-splunk_ta_example_account",
     )
     account_conf_file = cfm.get_conf("splunk_ta_example_account")
     return account_conf_file.get(account_name).get("api_key")
@@ -81,12 +78,12 @@ def stream_events(inputs: smi.InputDefinition, event_writer: smi.EventWriter):
             kvstore_checkpointer = checkpointer.KVStoreCheckpointer(
                 "example_checkpointer",
                 session_key,
-                ADDON_NAME,
+                example_utils.ADDON_NAME,
             )
             log_level = conf_manager.get_log_level(
                 logger=logger,
                 session_key=session_key,
-                app_name=ADDON_NAME,
+                app_name=example_utils.ADDON_NAME,
                 conf_name="splunk_ta_example_settings",
             )
             logger.setLevel(log_level)
diff --git a/package/bin/example_utils.py b/package/bin/example_utils.py
@@ -1,3 +1,6 @@
+ADDON_NAME = "Splunk_TA_Example"
+
+
 def get_example_collection_key_name(input_name: str) -> str:
     # `input_name` is a string like "example://<input_name>".
     return input_name.split("/")[-1]
diff --git a/scripts/local_testing_setup.sh b/scripts/local_testing_setup.sh
@@ -0,0 +1,6 @@
+curl -k -X POST -u admin:Chang3d! --header "Content-Type: application/json" https://localhost:8089/servicesNS/-/Splunk_TA_Example/Splunk_TA_Example_account -d name=api_key -d api_key=super-secret-api-token
+
+for i in $(seq 1 4);
+do
+    curl -k -X POST -u admin:Chang3d! --header "Content-Type: application/json" https://localhost:8089/servicesNS/-/Splunk_TA_Example/Splunk_TA_Example_example -d name=test_input_$i -d interval=20 -d index=main -d account=api_key
+done
