DPDV-4642: Propagate error to the UI (#98)

* DPDV-4642: Propagate error to the UI

* Improve error messages

Author: martin-majlis-s1

TA_dataset/bin/dataset_common.py

@@ -2,7 +2,6 @@
 import json
 import logging
 import os.path as op
-import sys
 import time
 from logging import Logger
 from typing import Optional  # noqa: F401
@@ -54,22 +53,26 @@ def get_logger(session_key, suffix: str) -> Logger:
 
 # one conf manager to rule them all
 def get_conf_manager(session_key, logger):
+    realm = "__REST_CREDENTIAL__#{}#configs/conf-{}_settings".format(
+        APP_NAME, CONF_NAME
+    )
     try:
+        logger.debug("Get conf manager - App: {}; Realm: {}".format(APP_NAME, realm))
         cfm = conf_manager.ConfManager(
             session_key,
             APP_NAME,
-            realm="__REST_CREDENTIAL__#{}#configs/conf-{}_settings".format(
-                APP_NAME, CONF_NAME
-            ),
+            realm=realm,
         )
 
         return cfm
 
     except Exception as e:
-        logger.error(
-            "Failed to fetch configuration. Check permissions. error={}".format(e)
+        msg = (
+            "Failed to fetch configuration for realm {}. Check permissions. error={}"
+            .format(realm, e)
         )
-        sys.exit(1)
+        logger.error(msg + " - %s", e, exc_info=True)
+        raise Exception(msg) from e
 
 
 def get_log_level(session_key, logger):
@@ -88,10 +91,12 @@ def get_log_level(session_key, logger):
         )
         return log_level
 
-    except Exception:
+    except Exception as e:
         logger.error(
             "Failed to fetch the log details from the configuration taking INFO as"
-            " default level."
+            " default level - %s",
+            e,
+            exc_info=True,
         )
         return "INFO"
 
@@ -110,7 +115,7 @@ def get_proxy(session_key, logger):
             proxy_details = cfm.get_conf(CONF_NAME + "_settings").get("proxy")
             proxy_enabled = proxy_details.get("proxy_enabled", 0)
         except Exception as e:
-            logger.debug("No proxy information defined: {}".format(e))
+            logger.debug("No proxy information defined: {}".format(e), exc_info=True)
             return None
 
         if int(proxy_enabled) == 0:
@@ -143,7 +148,7 @@ def get_proxy(session_key, logger):
             return proxies
 
     except Exception as e:
-        logger.info("Failed to fetch proxy information: {}".format(e))
+        logger.info("Failed to fetch proxy information: {}".format(e), exc_info=True)
         return None
 
 
@@ -152,39 +157,43 @@ def get_acct_info(self, logger, account=None):
         "DataSetFunction={}, startTime={}".format("get_acct_info", time.time())
     )
     acct_dict = {}
+    conf_name = "ta_dataset_account"
+
     if account is not None:
         # wildcard to use all accounts
         if account == "*":
             try:
-                confs = self.service.confs["ta_dataset_account"]
+                confs = self.service.confs[conf_name]
                 for conf in confs:
                     acct_dict[conf.name] = {}
                     acct_dict[conf.name]["base_url"] = conf.url
                     acct_dict[conf.name]["ds_api_key"] = get_token(
                         self, conf.name, "read", logger
                     )
             except Exception as e:
-                logger.error("Error retrieving add-on settings, error = {}".format(e))
-                return None
+                msg = "Error retrieving add-on settings, error = {}".format(e)
+                logger.error(msg + " - %s", e, exc_info=True)
+                raise Exception(msg) from e
         else:
             try:
                 # remove spaces and split by commas
                 account = account.replace(" ", "").split(",")
                 for entry in account:
-                    conf = self.service.confs["ta_dataset_account"][entry]
+                    conf = self.service.confs[conf_name][entry]
                     acct_dict[entry] = {}
                     acct_dict[entry]["base_url"] = conf.url
                     acct_dict[entry]["ds_api_key"] = get_token(
                         self, entry, "read", logger
                     )
             except Exception as e:
-                logger.error("Error retrieving account settings, error = {}".format(e))
-                return None
+                msg = "Error retrieving account settings, error = {}".format(e)
+                logger.error(msg + " - %s", e, exc_info=True)
+                raise Exception(msg) from e
     # if account is not defined, try to get the first entry
     # (Splunk sorts alphabetically)
     else:
         try:
-            confs = self.service.confs["ta_dataset_account"]
+            confs = self.service.confs[conf_name]
             for conf in confs:
                 acct_dict[conf.name] = {}
                 acct_dict[conf.name]["base_url"] = conf.url
@@ -193,7 +202,12 @@ def get_acct_info(self, logger, account=None):
                 )
                 break
         except Exception as e:
-            logger.error("Error retrieving settings, error = {}".format(e))
+            msg = (
+                "Error retrieving settings. Do you have at least one account in"
+                " Configuration?, error = {}".format(e)
+            )
+            logger.error(msg + " - %s", e, exc_info=True)
+            raise Exception(msg) from e
     logger.debug("DataSetFunction={}, endTime={}".format("get_acct_info", time.time()))
     return acct_dict
 
@@ -222,7 +236,11 @@ def get_token(self, account, rw, logger):
     except Exception as e:
         logger.error(
             self,
-            "Unable to retrieve API token, check configuration. error={}".format(e),
+            "Unable to retrieve API token, check configuration. error={} - %s".format(
+                e
+            ),
+            e,
+            exc_info=True,
         )
 
 

TA_dataset/bin/dataset_search_command.py

@@ -119,7 +119,7 @@ def get_search_arguments(self):
 
 
 def search_error_exit(self, r_json: Union[Dict[str, Any], str]) -> None:
-    logger().error(r_json)
+    logger().error("search_error_exit: %r", r_json)
     if "message" in r_json:
         if r_json["message"].startswith("Couldn't decode API token"):
             error_message = (  # make API error more user-friendly
@@ -284,26 +284,36 @@ def generate(self):
         logger = get_logger(self.service.token, "search_command")
 
         proxy = get_proxy(self.service.token, logger)
-        acct_dict = get_acct_info(self, logger, ds_account)
-        if acct_dict is None:
-            search_error_exit(
-                self, "Account token error, review search log for details"
-            )
+        try:
+            acct_dict = get_acct_info(self, logger, ds_account)
+            if not acct_dict:
+                search_error_exit(
+                    self, "Account token error, review search log for details"
+                )
+        except Exception as e:
+            search_error_exit(self, str(e))
 
         for ds_acct in acct_dict.keys():
             try:
                 ds_base_url = acct_dict[ds_acct]["base_url"]
+                if not ds_base_url:
+                    raise Exception("Configuration error: URL is not specified")
                 ds_url = get_url(ds_base_url, ds_method)
                 ds_api_key = acct_dict[ds_acct]["ds_api_key"]
+                if not ds_api_key:
+                    raise Exception(
+                        "Configuration error: Read access key is not specified"
+                    )
                 ds_headers = {
-                    "Authorization": "Bearer " + acct_dict[ds_acct]["ds_api_key"],
+                    "Authorization": "Bearer " + ds_api_key,
                     "User-Agent": get_user_agent(),
                 }
             except Exception as e:
+                logger.error("Cannot extract configuration: %s", e, exc_info=True)
                 search_error_exit(
                     self,
-                    "Splunk configuration error, see search log for details.error={}"
-                    .format(e),
+                    "Splunk configuration error when extracting account configuration,"
+                    " see search log for details. error={}".format(e),
                 )
 
             try:
@@ -478,8 +488,10 @@ def generate(self):
                     )
                     GeneratingCommand.flush
             except APIException as e:
+                logger.error("API exception", e, exc_info=True)
                 search_error_exit(self, e.payload)
             except Exception as e:
+                logger.error("Cannot perform dataset command", e, exc_info=True)
                 search_error_exit(self, str(e))