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

holado_report/report/reports/base_report.py

@@ -0,0 +1,163 @@
+
+#################################################
+# 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 os
+import logging
+from holado_report.report.execution_historic import ExecutionHistoric
+from holado.common.context.session_context import SessionContext
+from holado_core.common.tools.tools import Tools
+import threading
+
+logger = logging.getLogger(__name__)
+
+
+
+class BaseReport():
+    def __init__(self):
+        self.__report_path = None
+        self.__execution_historic = None
+        self.__report_builders = []
+        
+        self.__children_reports_lock = threading.RLock()
+        self.__children_reports_by_prefix = {}
+        
+    def initialize(self):
+        """
+        Implement this method to initialize report.
+        """
+        pass
+        
+    def initialize_reports(self):
+        """
+        Implement this method to configure and initialize execution historic and report builders.
+        """
+        pass
+    
+    @property
+    def has_report_path(self):
+        return self.__report_path is not None
+    
+    @property
+    def report_path(self):
+        return self.__report_path
+    
+    @report_path.setter
+    def report_path(self, report_path):
+        self.__report_path = report_path
+    
+    @property
+    def execution_historic(self):
+        return self.__execution_historic
+    
+    @property
+    def report_builders(self):
+        return self.__report_builders
+    
+    def children_reports(self, prefix):
+        with self.__children_reports_lock:
+            if prefix in self.__children_reports_by_prefix:
+                return self.__children_reports_by_prefix[prefix]
+            else:
+                return None
+        
+    def get_path(self, *args):
+        return os.path.join(self.__report_path, *args)
+        
+    def set_execution_historic(self):
+        self.__execution_historic = ExecutionHistoric()
+        
+    def add_report_builder(self, report_builder):
+        self.__report_builders.append(report_builder)
+        
+    def build_reports(self):
+        for rb in self.__report_builders:
+            rb.build()
+
+    def add_child_report(self, report, report_prefix, report_name, report_details=None):
+        with self.__children_reports_lock:
+            if report_prefix not in self.__children_reports_by_prefix:
+                self.__children_reports_by_prefix[report_prefix] = []
+                
+            # Define child report path
+            if self.has_report_path:
+                report_dir_name = f"{report_prefix}_{len(self.__children_reports_by_prefix[report_prefix])+1:03d}"
+                report.report_path = self.get_path(f"{report_prefix}s".capitalize(), report_dir_name)
+                SessionContext.instance().path_manager.makedirs(report.report_path, is_directory=True)
+            
+            # Add child report
+            self.__children_reports_by_prefix[report_prefix].append((report_name, report))
+            
+            # Update text file describing children reports
+            if self.has_report_path:
+                with open(self.get_path(f"{report_prefix}s".capitalize(), f"{report_prefix}_names.txt"), "at") as f:
+                    f.write(f"{report_dir_name}: {report_name}\n")
+                    if report_details:
+                        f.write(Tools.indent_string(len(report_dir_name)+2, report_details) + "\n")
+            
+
+    def before_all(self):
+        if self.__execution_historic:
+            self.__execution_historic.before_all()
+        for rb in self.__report_builders:
+            rb.before_all()
+    
+    def before_feature(self, feature_context, feature, feature_report=None):
+        if self.__execution_historic:
+            self.__execution_historic.before_feature(feature_context, feature, feature_report)
+        for rb in self.__report_builders:
+            rb.before_feature(feature_context, feature, feature_report)
+    
+    def before_scenario(self, scenario_context, scenario, scenario_report=None):
+        if self.__execution_historic:
+            self.__execution_historic.before_scenario(scenario_context, scenario, scenario_report)
+        for rb in self.__report_builders:
+            rb.before_scenario(scenario_context, scenario, scenario_report)
+    
+    def before_step(self, step_context, step, step_level):
+        if self.__execution_historic:
+            self.__execution_historic.before_step(step_context, step, step_level)
+        for rb in self.__report_builders:
+            rb.before_step(step_context, step, step_level)
+    
+    def after_step(self, step_context, step, step_level):
+        if self.__execution_historic:
+            self.__execution_historic.after_step(step_context, step, step_level)
+        for rb in self.__report_builders:
+            rb.after_step(step_context, step, step_level)
+    
+    def after_scenario(self, scenario, scenario_report=None):
+        if self.__execution_historic:
+            self.__execution_historic.after_scenario(scenario, scenario_report)
+        for rb in self.__report_builders:
+            rb.after_scenario(scenario, scenario_report)
+    
+    def after_feature(self, feature, feature_report=None):
+        if self.__execution_historic:
+            self.__execution_historic.after_feature(feature, feature_report)
+        for rb in self.__report_builders:
+            rb.after_feature(feature, feature_report)
+    
+    def after_all(self, build_reports=True):
+        if self.__execution_historic:
+            self.__execution_historic.after_all()
+        for rb in self.__report_builders:
+            rb.after_all()
+        
+        if build_reports:
+            self.build_reports()
+        
+    def release_resources(self):
+        if self.__execution_historic:
+            self.__execution_historic = None
+
+

holado_report/report/reports/feature_report.py

@@ -0,0 +1,106 @@
+
+#################################################
+# 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.report_manager import BaseReport
+from holado_core.common.exceptions.technical_exception import TechnicalException
+import weakref
+# from holado_core.scenario.scenario_duration_manager import ScenarioDurationManager
+
+logger = logging.getLogger(__name__)
+
+
+
+class FeatureReport(BaseReport):
+    TScenarioReport = None
+    
+    def __init__(self, report_manager, feature_context, feature):
+        super().__init__()
+        
+        self.__report_manager_weakref = weakref.ref(report_manager)
+        self.__feature_context = feature_context
+        self.__feature = feature
+        
+        # Auto configuration
+        self.configure()
+        
+    def configure(self):
+        from holado_report.report.reports.scenario_report import ScenarioReport
+        FeatureReport.TScenarioReport = ScenarioReport
+        
+    def initialize_reports(self):
+    #     self.__execution_historic = ExecutionHistoric()
+    #
+    #     fn = self.get_path("execution_historic.json")
+    #     self.__report_builders.append(JsonExecutionHistoricReportBuilder(self.__execution_historic, fn))
+    #
+    #     fn = self.get_path("report_summary_scenario_failed.txt")
+    #     self.__report_builders.append(SummaryDetailedScenarioFailedReportBuilder(fn))
+    #
+    #     fn = self.get_path("report_short_scenario_failed.txt")
+    #     self.__report_builders.append(ShortDetailedScenarioFailedReportBuilder(fn))
+    #
+    #     # fn = self.get_path("report_detailed_scenario_failed.txt")
+    #     fn = self.get_path("report_detailed_scenario_failed.xml")
+    #     self.__report_builders.append(DetailedScenarioFailedReportBuilder(fn))
+    #
+    #     fn = self.get_path("report_summary.txt")
+    #     self.__report_builders.append(SummaryReportBuilder(self.__execution_historic, fn))
+        
+        # Initialize reports
+        self.before_all()
+        self.before_feature(self.feature_context, self.feature, self)
+    
+    @property
+    def feature(self):
+        return self.__feature
+    
+    @property
+    def feature_context(self):
+        return self.__feature_context
+    
+    @property
+    def report_manager(self):
+        return self.__report_manager_weakref()
+    
+    @property
+    def scenario_reports(self):
+        return self.children_reports("scenario")
+    
+    @property
+    def current_scenario_report(self):
+        if self.scenario_reports:
+            return self.scenario_reports[-1][1]
+        else:
+            return None
+    
+    def new_scenario_report(self, scenario_context, scenario):
+        res = FeatureReport.TScenarioReport(self, scenario_context, scenario)
+        self.add_child_report(res, "scenario", scenario.name, f"{scenario.filename} - l.{scenario.line}")
+        res.initialize_reports()
+        return res
+        
+    def before_scenario(self, scenario_context, scenario, scenario_report=None):
+        super().before_scenario(scenario_context, scenario, scenario_report)
+    
+    def after_scenario(self, scenario, scenario_report=None):
+        if self.current_scenario_report.scenario != scenario:
+            raise TechnicalException(f"Processing after scenario '{scenario.name}' whereas current scenario is '{self.current_scenario_report.scenario.name}'")
+        if self.current_scenario_report is not scenario_report:
+            raise TechnicalException(f"Processing after scenario report '{scenario_report}' whereas current scenario report is '{self.current_scenario_report}'")
+        self.current_scenario_report.build_reports()
+
+        super().after_scenario(scenario, scenario_report)
+    
+    
+    

holado_report/report/reports/scenario_report.py

@@ -0,0 +1,64 @@
+
+#################################################
+# 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.json_execution_historic_report_builder import JsonExecutionHistoricReportBuilder
+from holado_report.report.builders.detailed_scenario_failed_report_builder import DetailedScenarioFailedReportBuilder
+from holado_report.report.report_manager import BaseReport
+import weakref
+
+logger = logging.getLogger(__name__)
+
+
+
+class ScenarioReport(BaseReport):
+    def __init__(self, feature_report, scenario_context, scenario):
+        super().__init__()
+        
+        self.__feature_report_weakref = weakref.ref(feature_report)
+        self.__scenario_context = scenario_context
+        self.__scenario = scenario
+        
+    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_detailed_scenario_failed.xml")
+            self.add_report_builder(DetailedScenarioFailedReportBuilder(fn))
+        
+        # Initialize reports
+        self.before_all()
+        self.before_feature(self.feature_report.feature_context, self.feature_report.feature, self.feature_report)
+        self.before_scenario(self.scenario_context, self.scenario, self)
+        
+    @property
+    def feature_report(self):
+        return self.__feature_report_weakref()
+        
+    @property
+    def report_manager(self):
+        return self.feature_report.report_manager
+    
+    @property
+    def scenario(self):
+        return self.__scenario
+    
+    @property
+    def scenario_context(self):
+        return self.__scenario_context
+    
+    
+    

holado_rest/__init__.py

@@ -0,0 +1,24 @@
+# -*- coding: utf-8 -*-
+
+#################################################
+# 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.
+#################################################
+
+
+def dependencies():
+    return None
+
+def register():
+    from holado.common.context.session_context import SessionContext
+    
+    from holado_rest.api.rest.rest_manager import RestManager
+    SessionContext.instance().services.register_service_type("rest_manager", RestManager)
+

holado_rest/api/rest/TODO.txt

@@ -0,0 +1,2 @@
+Client with library "requests"
+Client with library "httpx"

holado_rest/api/rest/rest_client.py

@@ -0,0 +1,113 @@
+
+#################################################
+# 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_core.common.exceptions.functional_exception import FunctionalException
+from holado_core.common.exceptions.technical_exception import TechnicalException
+import logging
+from holado_core.common.tools.tools import Tools
+
+logger = logging.getLogger(__name__)
+
+try:
+    import requests
+    from requests.auth import HTTPBasicAuth
+    with_requests = True
+except Exception as exc:
+    if Tools.do_log(logger, logging.DEBUG):
+        logger.debug(f"RestClient is not available. Initialization failed on error: {exc}")
+    with_requests = False
+
+
+class RestClient(object):
+    """
+    REST client
+    """
+    
+    @classmethod
+    def is_available(cls):
+        return with_requests
+    
+    def __init__(self, name, url, headers=None):
+        self.__name = name
+        self.__url = url.rstrip('/')
+        self.__headers = headers if headers is not None else {}
+        self.__kwargs = {}
+    
+    @property
+    def name(self):
+        return self.__name
+    
+    def authenticate_by_user(self, user, pwd):
+        if Tools.do_log(logger, logging.DEBUG):
+            logger.debug(f"[{self.name}] Authenticate with user ({user},{pwd})")
+        self.__kwargs['auth'] = HTTPBasicAuth(user, pwd)
+    
+    def authenticate_by_token(self, token_type, access_token):
+        if Tools.do_log(logger, logging.DEBUG):
+            logger.debug(f"[{self.name}] Authenticate with token type '{token_type}' and access token '{access_token}'")
+        self.__headers['Authorization'] = f'{token_type} {access_token}'
+        
+    def response_result(self, response, status_ok=200):
+        if response.status_code != status_ok:
+            raise FunctionalException(f"[{self.name}] Request failed with status {response.status_code} (expected success status: {status_ok}")
+        
+        if "application/json" in response.headers['Content-Type']:
+            return response.json()
+        else:
+            return response.text
+    
+    def request(self, method, path, **kwargs):
+        url = self.__build_url(path=path)
+        r_kwargs = self.__build_kwargs(**kwargs)
+        
+        if Tools.do_log(logger, logging.DEBUG):
+            logger.debug(f"[{self.name}] Calling {method} on url '{url}' with arguments {r_kwargs}")
+        try:
+            res = requests.request(method, url, **r_kwargs)
+        except Exception as exc:
+            raise TechnicalException(f"[{self.name}] Failed to process {method} '{url}' with arguments {r_kwargs}") from exc
+        
+        if Tools.do_log(logger, logging.DEBUG):
+            logger.debug(f"[{self.name}] {method} on url '{url}' => {res}")
+        return res
+        
+    def delete(self, path, data=None, **kwargs):
+        return self.request("DELETE", path, data=data, **kwargs)
+        
+    def get(self, path, data=None, **kwargs):
+        return self.request("GET", path, data=data, **kwargs)
+        
+    def patch(self, path, data=None, **kwargs):
+        return self.request("PATCH", path, data=data, **kwargs)
+        
+    def post(self, path, data=None, json=None, **kwargs):
+        return self.request("POST", path, data=data, json=json, **kwargs)
+        
+    def put(self, path, data=None, **kwargs):
+        return self.request("PUT", path, data=data, **kwargs)
+        
+    def __build_url(self, path):
+        return f"{self.__url}/{path.lstrip('/')}" 
+        
+    def __build_kwargs(self, **request_kwargs):
+        res = dict(self.__kwargs)
+        if self.__headers:
+            res['headers'] = self.__headers
+        if request_kwargs:
+            for key in list(request_kwargs.keys()):
+                if key in res and isinstance(res[key], dict):
+                    res[key].update(request_kwargs.pop(key))
+            res.update(request_kwargs)
+        return res 
+        
+        

holado_rest/api/rest/rest_manager.py

@@ -0,0 +1,62 @@
+
+#################################################
+# 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 holado_core.common.exceptions.functional_exception import FunctionalException
+from holado_core.common.tools.tools import Tools
+from holado_rest.api.rest.rest_client import RestClient
+
+
+logger = logging.getLogger(__name__)
+
+
+
+class RestManager(object):
+    """
+    Manage REST features, agnostic to internal REST library.
+    """
+    
+    def new_client(self, name, **kwargs):
+        if name is None:
+            name = f"RestClient({kwargs})"
+        url = kwargs.pop("url")
+        headers = Tools.pop_sub_kwargs(kwargs, "headers.")
+        authentication = Tools.pop_sub_kwargs(kwargs, "authentication.")
+        if len(kwargs) > 0:
+            raise TechnicalException(f"Unmanaged arguments: {kwargs}")
+    
+        res = self._new_rest_client(name, url, headers)
+        
+        # Manage authentication if needed
+        if len(authentication) > 0:
+            if 'user' in authentication:
+                if type(authentication['user']) is tuple and len(authentication['user']) == 2:
+                    res.authenticate_by_user(authentication['user'][0], authentication['user'][1])
+                else:
+                    raise FunctionalException(f"When authenticating by user, the value has to be in format: ('{{USER}}', '{{PASSWORD}}')  (obtained: {authentication['user']})")
+            elif 'token' in authentication:
+                if type(authentication['token']) is tuple and len(authentication['token']) == 2:
+                    res.authenticate_by_token(authentication['token'][0], authentication['token'][1])
+                else:
+                    raise FunctionalException(f"When authenticating by user, the value has to be in format: ('{{TOKEN_TYPE}}', '{{ACCESS_TOKEN}}')  (obtained: {authentication['token']})")
+            else:
+                raise TechnicalException(f"Unmanaged authentication type '{authentication.keys()}' (possible authentication types: 'user', 'token'")
+        
+        return res
+    
+    def _new_rest_client(self, name, url, headers):
+        return RestClient(name, url, headers=headers)
+    
+    
+            

holado_rest/tests/behave/steps/__init__.py

@@ -0,0 +1,16 @@
+# -*- coding: utf-8 -*-
+
+#################################################
+# 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 .api.rest_client_steps import *