holado 0.2.2__py3-none-any.whl → 0.2.3__py3-none-any.whl

holado_report/report/builders/summary_report_builder.py

@@ -0,0 +1,89 @@
+
+#################################################
+# HolAdo (Holistic Automation do)
+#
+# (C) Copyright 2021-2025 by Eric Klumpp
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+# The Software is provided “as is”, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the Software.
+#################################################
+
+import logging
+from holado_report.report.builders.report_builder import ReportBuilder
+import weakref
+
+logger = logging.getLogger(__name__)
+
+
+
+class SummaryByExecutionHistoricReportBuilder(ReportBuilder):
+    def __init__(self, execution_historic, filepath):
+        self.__execution_historic_weakref = weakref.ref(execution_historic)
+        self.__filepath = filepath
+
+    @property
+    def __execution_historic(self):
+        return self.__execution_historic_weakref()
+
+    def build(self):
+        features = {}
+        scenarios = {}
+        for eh_feat in self.__execution_historic:
+            status_name = eh_feat.feature.status.name
+            if status_name not in features:
+                features[status_name] = 0
+            features[status_name] += 1
+            
+            for eh_sce in eh_feat.scenarios:
+                status_name = eh_sce.status_validation
+                # status_name = eh_sce[0].status.name.lower()
+                if status_name not in scenarios:
+                    scenarios[status_name] = 0
+                scenarios[status_name] += 1
+            
+        with open(self.__filepath, "wt") as feh:
+            feh.write("features: " + ", ".join([f"{v} {k}" for k, v in dict(sorted(features.items())).items()]) + "\n")
+            feh.write("scenarios: " + ", ".join([f"{v} {k}" for k, v in dict(sorted(scenarios.items())).items()]) + "\n")
+        
+    
+class SummaryReportBuilder(ReportBuilder):
+    def __init__(self, filepath):
+        self.__filepath = filepath
+        self.__features = {}
+        self.__scenarios = {}
+
+    def build(self):
+        '''
+        The file is built after each scenario
+        '''
+        pass
+        
+    def after_scenario(self, scenario, scenario_report=None):
+        from holado_report.report.report_manager import ReportManager
+        status_name, _, _ = ReportManager.get_current_scenario_status_information(scenario)
+        
+        if status_name not in self.__scenarios:
+            self.__scenarios[status_name] = 0
+        self.__scenarios[status_name] += 1
+        
+        self.__update_file()
+    
+    def after_feature(self, feature, feature_report=None):
+        status_name = feature.status.name
+        if status_name not in self.__features:
+            self.__features[status_name] = 0
+        self.__features[status_name] += 1
+        
+        self.__update_file()
+    
+    def __update_file(self):
+        with open(self.__filepath, "wt") as feh:
+            feh.write("features: " + ", ".join([f"{v} {k}" for k, v in dict(sorted(self.__features.items())).items()]) + "\n")
+            feh.write("scenarios: " + ", ".join([f"{v} {k}" for k, v in dict(sorted(self.__scenarios.items())).items()]) + "\n")
+    
+    
+    
+    

holado_report/report/builders/summary_scenario_failed_report_builder.py

@@ -0,0 +1,56 @@
+
+#################################################
+# HolAdo (Holistic Automation do)
+#
+# (C) Copyright 2021-2025 by Eric Klumpp
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+# The Software is provided “as is”, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the Software.
+#################################################
+
+import logging
+from holado_report.report.builders.report_builder import ReportBuilder
+
+logger = logging.getLogger(__name__)
+
+
+
+class SummaryScenarioFailedReportBuilder(ReportBuilder):
+    def __init__(self, filepath):
+        self.__filepath = filepath
+        self.__file_fail = None
+        
+    def build(self):
+        '''
+        The file is built after each scenario
+        '''
+        pass
+        
+    def after_scenario(self, scenario, scenario_report=None):
+        from holado_report.report.report_manager import ReportManager
+        status_validation, step_failed, step_number = ReportManager.get_current_scenario_status_information(scenario)
+        
+        if status_validation != "Passed":
+            self.__file_fail_add_scenario(scenario, status_validation, step_failed, step_number)
+            
+    def after_all(self):
+        # Manage file fail
+        if self.__file_fail is not None:
+            self.__file_fail.close()
+            self.__file_fail = None
+        
+    def __file_fail_add_scenario(self, scenario, status_validation, step_failed, step_number):
+        self.__open_file_if_needed()
+        if step_failed is not None:
+            self.__file_fail.write(f"scenario in {scenario.filename} at l.{scenario.line} - step {step_number} (l.{step_failed.line}) - {status_validation}\n")
+        else:
+            self.__file_fail.write(f"scenario in {scenario.filename} at l.{scenario.line} - step ? (missing step implementation ?) - {status_validation}\n")
+        self.__file_fail.flush()
+    
+    def __open_file_if_needed(self):
+        if self.__file_fail is None:
+            self.__file_fail = open(self.__filepath, "wt")
+    

holado_report/report/builders/summary_scenario_report_builder.py

@@ -0,0 +1,74 @@
+
+#################################################
+# HolAdo (Holistic Automation do)
+#
+# (C) Copyright 2021-2025 by Eric Klumpp
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+# The Software is provided “as is”, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the Software.
+#################################################
+
+import logging
+from holado_report.report.builders.report_builder import ReportBuilder
+from holado_python.common.tools.datetime import DateTime,\
+    FORMAT_DATETIME_HUMAN_SECOND
+
+logger = logging.getLogger(__name__)
+
+
+
+class SummaryScenarioReportBuilder(ReportBuilder):
+    def __init__(self, filepath):
+        self.__filepath = filepath
+        self.__file = None
+        
+    def build(self):
+        '''
+        The file is built after each scenario
+        '''
+        pass
+        
+    def after_scenario(self, scenario, scenario_report=None):
+        from holado_report.report.report_manager import ReportManager
+        status_validation, step_failed, step_number = ReportManager.get_current_scenario_status_information(scenario)
+        
+        if status_validation == "Passed":
+            self.__file_add_scenario_success(scenario, status_validation)
+        else:
+            self.__file_add_scenario_fail(scenario, status_validation, step_failed, step_number)
+            
+    def after_all(self):
+        # Manage file fail
+        if self.__file is not None:
+            self.__file.close()
+            self.__file = None
+        
+    def __file_add_scenario_success(self, scenario, status_validation):
+        self.__open_file_if_needed()
+        self.__file_write(scenario, None, status_validation)
+        self.__file.flush()
+        
+    def __file_add_scenario_fail(self, scenario, status_validation, step_failed, step_number):
+        self.__open_file_if_needed()
+        if step_failed is not None:
+            self.__file_write(scenario, f"step {step_number} (l.{step_failed.line})", status_validation)
+        else:
+            self.__file_write(scenario, f"step ? (missing step implementation ?)", status_validation)
+        self.__file.flush()
+    
+    def __file_write(self, scenario, text, status_validation):
+        dt = DateTime.now()
+        dt_str = DateTime.datetime_2_str(dt, FORMAT_DATETIME_HUMAN_SECOND)
+        
+        if text:
+            self.__file.write(f"{dt_str} - {scenario.filename} at l.{scenario.line} - {text} - {status_validation}\n")
+        else:
+            self.__file.write(f"{dt_str} - {scenario.filename} at l.{scenario.line} - {status_validation}\n")
+    
+    def __open_file_if_needed(self):
+        if self.__file is None:
+            self.__file = open(self.__filepath, "wt")
+    

holado_report/report/execution_historic.py

@@ -0,0 +1,141 @@
+
+#################################################
+# HolAdo (Holistic Automation do)
+#
+# (C) Copyright 2021-2025 by Eric Klumpp
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+# The Software is provided “as is”, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the Software.
+#################################################
+
+import logging
+from holado_core.common.exceptions.technical_exception import TechnicalException
+from typing import NamedTuple
+from holado.common.context.session_context import SessionContext
+
+logger = logging.getLogger(__name__)
+
+
+
+class ExecutionHistoric():
+    def __init__(self):
+        self.__execution_historic = []
+    
+    def __iter__(self):
+        return self.__execution_historic.__iter__()
+
+    def __next__(self):
+        return self.__execution_historic.__next__()
+
+    def __has_scenario_context(self):
+        return SessionContext.instance().has_scenario_context()
+    
+    @property
+    def __multitask_manager(self):
+        return SessionContext.instance().multitask_manager
+    
+    def before_all(self):
+        pass
+    
+    def before_feature(self, feature_context, feature, feature_report=None):
+        self.__execution_historic.append( self.__new_FeatureExecutionHistoric(feature_context, feature, feature_report) )
+    
+    def __new_FeatureExecutionHistoric(self, feature_context, feature, feature_report=None):
+        res = NamedTuple("FeatureExecutionHistoric", feature_context=object, feature=object, feature_report=object, scenarios=list)
+        res.feature_context = feature_context
+        res.feature = feature
+        res.feature_report = feature_report
+        res.scenarios = []
+        return res
+    
+    def before_scenario(self, scenario_context, scenario, scenario_report=None):
+        seh = self.__new_ScenarioExecutionHistoric(scenario_context, scenario, scenario_report)
+        self.__get_execution_historic_current_feature_scenarios().append(seh)
+    
+    def __new_ScenarioExecutionHistoric(self, scenario_context, scenario, scenario_report):
+        res = NamedTuple("ScenarioExecutionHistoric", scenario_context=object, scenario=object, scenario_report=object, steps_by_scope=dict, status_validation=str, step_failed=object, step_failed_number=int)
+        res.scenario_context = scenario_context
+        res.scenario = scenario
+        res.scenario_report = scenario_report
+        res.steps_by_scope = {}
+        res.status_validation = None
+        res.step_failed = None
+        res.step_failed_number = None
+        return res
+    
+    def before_step(self, step_context, step, step_level):
+        seh = self.__new_StepExecutionHistoric(step_context, step)
+        self.__get_execution_historic_current_scenario_steps(step_level).append(seh)
+    
+    def __new_StepExecutionHistoric(self, step_context, step, step_description=None):
+        if step_description is None and step is not None:
+            from holado_report.report.report_manager import ReportManager
+            step_description = ReportManager.get_step_description(step)
+        
+        res = NamedTuple("StepExecutionHistoric", step_context=object, step=object, step_description=str, sub_steps=list)
+        res.step_context = step_context
+        res.step = step
+        res.step_description = step_description
+        res.sub_steps = []
+        return res
+    
+    def after_step(self, step_context, step, step_level):
+        pass
+    
+    def after_scenario(self, scenario, scenario_report=None):
+        from holado_report.report.report_manager import ReportManager
+        status_validation, step_failed, step_number = ReportManager.get_current_scenario_status_information(scenario)
+        
+        # Update execution historic
+        current_scenario = self.__get_execution_historic_current_scenario()
+        current_scenario.status_validation = status_validation
+        current_scenario.step_failed = step_failed
+        current_scenario.step_failed_number = step_number
+        
+        # Prepare after scenario steps
+        seh = self.__new_StepExecutionHistoric(step_context=None, step=None, step_description="After scenario steps")
+        self.__get_execution_historic_current_scenario_steps(0).append(seh)
+        
+        
+    def after_feature(self, feature, feature_report=None):
+        pass
+    
+    def after_all(self):
+        # logger.info(f"++++++++++ Execution historic size: {len(self.__execution_historic)}")
+        pass
+        
+    def __get_execution_historic_current_feature_scenarios(self):
+        if len(self.__execution_historic) > 0:
+            return self.__execution_historic[-1].scenarios
+        else:
+            raise TechnicalException(f"No feature in execution historic")
+        
+    def __get_execution_historic_current_scenario(self):
+        scenario_list = self.__get_execution_historic_current_feature_scenarios()
+        if len(scenario_list) > 0:
+            return scenario_list[-1]
+        else:
+            raise TechnicalException(f"No scenario in current feature in execution historic")
+        
+    def __get_execution_historic_current_scenario_steps(self, step_level):
+        steps_by_scope = self.__get_execution_historic_current_scenario().steps_by_scope
+        
+        if self.__multitask_manager.is_main_thread:
+            scope_name = "main"
+        else:
+            scope_name = self.__multitask_manager.get_thread_id()
+        if scope_name not in steps_by_scope:
+            steps_by_scope[scope_name] = []
+        res = steps_by_scope[scope_name]
+        
+        for level in range(step_level):
+            if len(res) == 0:
+                logger.warning(f"Failed to get current scenario step list of level {step_level} (step list of level {level}: {res}) ; Add a fake step with description '[Missing step]'")
+                res.append( self.__new_StepExecutionHistoric(None, None, "[Missing step]") )
+            res = res[-1].sub_steps
+        return res
+    
+    

holado_report/report/report_manager.py

@@ -0,0 +1,256 @@
+
+#################################################
+# HolAdo (Holistic Automation do)
+#
+# (C) Copyright 2021-2025 by Eric Klumpp
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+# The Software is provided “as is”, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the Software.
+#################################################
+
+from holado.common.context.session_context import SessionContext
+from behave.model_core import Status
+from holado_core.common.tools.tools import Tools
+import logging
+# from holado_report.report.builders.json_execution_historic_report_builder import JsonExecutionHistoricReportBuilder
+from holado_report.report.builders.detailed_scenario_failed_report_builder import DetailedScenarioFailedReportBuilder
+from holado_report.report.builders.summary_report_builder import SummaryReportBuilder
+from holado_report.report.builders.summary_scenario_failed_report_builder import SummaryScenarioFailedReportBuilder
+from holado_report.report.builders.short_scenario_failed_report_builder import ShortScenarioFailedReportBuilder
+from holado_report.report.reports.base_report import BaseReport
+from holado_scripting.common.tools.evaluate_parameters import EvaluateParameters
+from holado_report.report.builders.summary_scenario_report_builder import SummaryScenarioReportBuilder
+# from holado_core.scenario.scenario_duration_manager import ScenarioDurationManager
+
+logger = logging.getLogger(__name__)
+
+
+
+
+class ReportManager(BaseReport):
+    TFeatureReport = None
+    TStepTools = None
+    
+    def __init__(self):
+        super().__init__()
+        
+        self.__multitask_manager = None
+        
+        # Auto configuration
+        self.configure()
+    
+    def configure(self):
+        from holado_report.report.reports.feature_report import FeatureReport
+        ReportManager.TFeatureReport = FeatureReport
+        
+        from holado_test.behave.scenario.behave_step_tools import BehaveStepTools
+        ReportManager.TStepTools = BehaveStepTools
+    
+    def initialize(self, multitask_manager):
+        self.__multitask_manager = multitask_manager
+        
+    def initialize_reports(self):
+        # self.set_execution_historic()
+        
+        if self.has_report_path:
+            # fn = self.get_path("execution_historic.json")
+            # self.add_report_builder(JsonExecutionHistoricReportBuilder(self.execution_historic, fn))
+            
+            fn = self.get_path("report_summary_scenario_failed.txt")
+            self.add_report_builder(SummaryScenarioFailedReportBuilder(fn))
+            
+            fn = self.get_path("report_summary_scenario_all.txt")
+            self.add_report_builder(SummaryScenarioReportBuilder(fn))
+            
+            fn = self.get_path("report_short_scenario_failed.txt")
+            self.add_report_builder(ShortScenarioFailedReportBuilder(fn))
+            
+            # fn = self.get_path("report_detailed_scenario_failed.txt")
+            fn = self.get_path("report_detailed_scenario_failed.xml")
+            self.add_report_builder(DetailedScenarioFailedReportBuilder(fn))
+            
+            fn = self.get_path("report_summary.txt")
+            self.add_report_builder(SummaryReportBuilder(fn))
+        
+    @property
+    def __feature_reports(self):
+        return self.children_reports("feature")
+    
+    @property
+    def current_feature_report(self):
+        # if self.__feature_reports:
+        #     return self.__feature_reports[-1][1]
+        # else:
+        #     return None
+        if SessionContext.instance().has_feature_context():
+            feature_context = SessionContext.instance().get_feature_context()
+            if feature_context.has_object("feature_report"):
+                return feature_context.get_object("feature_report")
+        return None
+    
+    @property
+    def current_scenario_report(self):
+        cfr = self.current_feature_report
+        if cfr:
+            return cfr.current_scenario_report
+        else:
+            return None
+    
+    def new_session(self, report_path):
+        self.report_path = report_path
+        if self.has_report_path:
+            SessionContext.instance().path_manager.makedirs(self.report_path, is_directory=True)
+        
+        self.initialize_reports()
+    
+    def before_all(self):
+        super().before_all()
+    
+    def before_feature(self, feature_context, feature):
+        # Create new feature report
+        fr = ReportManager.TFeatureReport(self, feature_context, feature)
+        self.add_child_report(fr, "feature", feature.name, feature.filename)
+        fr.initialize_reports()
+        
+        # Process self reports
+        super().before_feature(feature_context, feature, feature_report=fr)
+        
+        # Store feature report in current feature context
+        self.__multitask_manager.get_feature_context().set_object("feature_report", fr)
+        
+    def before_scenario(self, scenario_context, scenario):
+        # Create new scenario report in feature report
+        sr = self.current_feature_report.new_scenario_report(scenario_context, scenario)
+        
+        # Process feature report
+        self.current_feature_report.before_scenario(scenario_context, scenario, scenario_report=sr)
+        
+        # Process self reports
+        super().before_scenario(scenario_context, scenario, scenario_report=sr)
+        
+        # Change active log file to scenario one
+        self.__enter_current_scenario_log_file()
+    
+    def before_step(self, step_context, step, step_level):
+        super().before_step(step_context, step, step_level)
+        
+        # Note: A step can be executed without scenario report (ex: post processes after scenario) 
+        if self.current_scenario_report:
+            self.current_scenario_report.before_step(step_context, step, step_level)
+    
+    def after_step(self, step_context, step, step_level):
+        super().after_step(step_context, step, step_level)
+        
+        # Note: A step can be executed without scenario report (ex: post processes after scenario) 
+        if self.current_scenario_report:
+            self.current_scenario_report.after_step(step_context, step, step_level)
+    
+    def after_scenario(self, scenario):
+        self.current_feature_report.after_scenario(scenario, self.current_scenario_report)
+        super().after_scenario(scenario, self.current_scenario_report)
+        
+        # Change active log file to root one
+        self.__leave_current_scenario_log_file()
+        
+        self.current_scenario_report.release_resources()
+    
+    def after_feature(self, feature):
+        super().after_feature(feature, self.current_feature_report)
+        
+        self.current_feature_report.release_resources()
+    
+    def after_all(self):
+        super().after_all(build_reports=True)
+            
+        # Create files using execution historic as input
+        # fn_eh = self.get_path("execution_historic.json")
+        # sdm = ScenarioDurationManager()
+        # sdm.import_execution_historic(fn_eh)
+        #
+        # fn = self.get_path("scenario_durations.csv")
+        # scenario_duration_limits = sdm.compute_scenario_duration_limits()
+        # sdm.create_file_scenario_duration_limits(fn, scenario_duration_limits)
+        #
+        # fn = self.get_path("scenario_duration_tags.csv")
+        # duration_limit_tags = [(1, "fast"), (5, "rapid"), (60, "slow")]
+        # scenario_duration_tags = sdm.compute_scenario_duration_tags(duration_limit_tags, "long", missing_tag=True, new_tag=True, unchanged_tag=True, with_failed=True)
+        # sdm.create_file_scenario_duration_tags(fn, scenario_duration_tags)
+        
+    def __enter_current_scenario_log_file(self):
+        if SessionContext.instance().log_manager.in_file and self.has_report_path:
+            log_filename = self.current_scenario_report.get_path("logs", "report.log")
+            SessionContext.instance().path_manager.makedirs(log_filename)
+            # Note: do_remove_other_file_handlers is set to True, in case leaving previous scenario log file has failed.
+            #       Normally this case shouldn't appear but it was already observed. And when it appeared, execution slowdowned drastically.
+            SessionContext.instance().log_manager.enter_log_file(log_filename, do_remove_other_file_handlers=True)
+        
+    def __leave_current_scenario_log_file(self):
+        if SessionContext.instance().log_manager.in_file and self.has_report_path:
+            log_filename = self.current_scenario_report.get_path("logs", "report.log")
+            SessionContext.instance().log_manager.leave_log_file(log_filename, do_remove_log_file=True)
+        
+    @classmethod
+    def get_current_scenario_status_information(cls, scenario):
+        step_failed, step_nb = cls.get_step_failed_info(scenario)
+        
+        if step_failed is not None and hasattr(SessionContext.instance().get_scenario_context(), "is_in_preconditions") and SessionContext.instance().get_scenario_context().is_in_preconditions:
+            status = "Failed in Preconditions"
+        elif step_failed is not None and step_failed.keyword == "Given":
+            status = "Failed in Given"
+        elif step_failed is not None or scenario.status.has_failed():
+            status = "Failed"
+        else:
+            status = scenario.status.name.capitalize()
+            
+        return [status, step_failed, step_nb]
+        
+    @classmethod
+    def get_step_failed_info(cls, scenario):
+        res_step, res_step_number = None, None
+        for ind, step in enumerate(scenario.steps):
+            if step.status.has_failed():
+                res_step, res_step_number = step, ind+1
+                break
+        return res_step, res_step_number
+    
+    @classmethod
+    def get_step_description(cls, step):
+        res = "{} {}".format(step.keyword, step.name)
+        text = cls.TStepTools.get_step_multiline_text(step, eval_params=EvaluateParameters.nothing(), raise_exception_if_none=False, log_level=logging.TRACE)  # @UndefinedVariable
+        if text is not None:
+            res += "\n\"\"\"\n{}\n\"\"\"".format(text) 
+        if step.table:
+            res += "\n{}".format(cls.TStepTools.represent_step_table(step.table, 4)) 
+        return res
+    
+    @classmethod
+    def get_step_error_message(cls, step):
+        if step:
+            if step.exception:
+                return str(step.exception)
+            elif step.error_message:
+                return step.error_message
+            elif step.status.is_undefined():
+                return "Undefined step"
+            elif step.status.is_pending():
+                return "Step exists but is not implemented"
+            elif step.status.has_failed():
+                return "Unknown error (unexpected error case)"
+        return None
+    
+    @classmethod
+    def get_step_error(cls, step):
+        if step:
+            if step.exception:
+                formatted_exception = Tools.represent_exception(step.exception)
+                return "exception:\n{}".format(Tools.indent_string(4, formatted_exception))
+            elif step.error_message:
+                return "error_message:\n{}".format(Tools.indent_string(4, step.error_message))
+            else:
+                return cls.get_step_error_message(step)
+        return None
+    
+