stateengine plugin: improve logging (e.g. for handling released_by), …

…introducing internal prefix for log messages

stateengine/StateEngineItem.py

@@ -936,6 +936,7 @@ def update_can_release_list():
 
         self.__logger.info("".ljust(80, "_"))
         self.__logger.info("Handling released_by attributes")
+        self.__logger.increase_indent("Handling released_by... ")
         can_release = {}
         all_released_by = {}
         skip_copy = True
@@ -1037,7 +1038,7 @@ def update_can_release_list():
                 self.__release_info = {new_state.id: _can_release_list}
                 _key_releasedby = ['{}'.format(new_state.id), 'releasedby']
                 self.update_webif(_key_releasedby, _can_release_list)
-
+        self.__logger.increase_indent("")
         self.__logger.info("".ljust(80, "_"))
         return all_released_by
 
@@ -1333,6 +1334,7 @@ def __reorder_states(self, init=True):
         _reordered_states = []
         self.__logger.info("".ljust(80, "_"))
         self.__logger.info("Recalculating state order. Current order: {}", self.__states)
+        self.__logger.increase_indent()
         _copied_states = {}
         _add_order = 0
         _changed_orders = []
@@ -1398,6 +1400,7 @@ def __reorder_states(self, init=True):
                 else:
                     _reorder_webif[state.id] = self.__webif_infos[state.id]
             self.__webif_infos = _reorder_webif
+        self.__logger.decrease_indent()
         self.__logger.info("Recalculated state order. New order: {}", self.__states)
         self.__logger.info("".ljust(80, "_"))
 
@@ -1895,6 +1898,7 @@ def update_can_release_list():
 
         self.__logger.info("".ljust(80, "_"))
         self.__logger.info("Initializing released_by attributes")
+        self.__logger.increase_indent()
         can_release = {}
         state_dict = {state.id: state for state in self.__states}
         for state in self.__states:
@@ -1920,7 +1924,7 @@ def update_can_release_list():
                 self.__config_issues.update({state.id: {'issue': _issuelist, 'attribute': 'se_released_by'}})
                 state.update_releasedby_internal(_convertedlist)
                 self.__update_can_release(can_release, state)
-
+        self.__logger.decrease_indent()
         self.__logger.info("".ljust(80, "_"))
 
     # log item data

stateengine/StateEngineLogger.py

@@ -131,6 +131,7 @@ def __init__(self, item, manual=False):
         self.__name = 'stateengine.{}'.format(item.property.path)
         self.__section = item.property.path.replace(".", "_").replace("/", "")
         self.__indentlevel = 0
+        self.__indentprefix = ""
         if manual:
             self.__log_level_as_num = 2
         else:
@@ -151,7 +152,10 @@ def update_logfile(self):
     # Increase indentation level
     # by: number of levels to increase
     def increase_indent(self, by=1):
-        self.__indentlevel += by
+        if isinstance(by, int):
+            self.__indentlevel += by
+        else:
+            self.__indentprefix = by
 
     # Decrease indentation level
     # by: number of levels to decrease
@@ -170,7 +174,7 @@ def log(self, level, text, *args):
             indent = "\t" * self.__indentlevel
             if args:
                 text = text.format(*args)
-            logtext = "{0}{1} {2}\r\n".format(datetime.datetime.now(), indent, text)
+            logtext = "{0} {1}{2}{3}\r\n".format(datetime.datetime.now(), self.__indentprefix, indent, text)
             try:
                 with open(self.__filename, mode="a", encoding="utf-8") as f:
                     f.write(logtext)
@@ -194,7 +198,7 @@ def header(self, text):
     def info(self, text, *args):
         self.log(1, text, *args)
         indent = "\t" * self.__indentlevel
-        text = '{}{}'.format(indent, text)
+        text = '{}{}{}'.format(self.__indentprefix, indent, text)
         if args:
             text = text.format(*args)
         self.logger.info(text)
@@ -205,7 +209,7 @@ def info(self, text, *args):
     def debug(self, text, *args):
         self.log(2, text, *args)
         indent = "\t" * self.__indentlevel
-        text = '{}{}'.format(indent, text)
+        text = '{}{}{}'.format(self.__indentprefix, indent, text)
         if args:
             text = text.format(*args)
         self.logger.debug(text)
@@ -216,7 +220,7 @@ def debug(self, text, *args):
     def develop(self, text, *args):
         self.log(3, "DEV: " + text, *args)
         indent = "\t" * self.__indentlevel
-        text = '{}{}'.format(indent, text)
+        text = '{}{}{}'.format(self.__indentprefix, indent, text)
         if args:
             text = text.format(*args)
         self.logger.log(StateEngineDefaults.VERBOSE, text)
@@ -228,7 +232,7 @@ def develop(self, text, *args):
     def warning(self, text, *args):
         self.log(1, "WARNING: " + text, *args)
         indent = "\t" * self.__indentlevel
-        text = '{}{}'.format(indent, text)
+        text = '{}{}{}'.format(self.__indentprefix, indent, text)
         if args:
             text = text.format(*args)
         self.logger.warning(text)
@@ -240,7 +244,7 @@ def warning(self, text, *args):
     def error(self, text, *args):
         self.log(1, "ERROR: " + text, *args)
         indent = "\t" * self.__indentlevel
-        text = '{}{}'.format(indent, text)
+        text = '{}{}{}'.format(self.__indentprefix, indent, text)
         if args:
             text = text.format(*args)
         self.logger.error(text)