holado 0.13.22__py3-none-any.whl

holado_django/server/django_server.py

@@ -0,0 +1,110 @@
+
+#################################################
+# 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.technical_exception import TechnicalException
+import logging
+from holado_core.common.tools.tools import Tools
+import os
+from holado_core.tools.abstracts.blocking_command_service import BlockingCommandService
+from holado_system.system.command.command import CommandStates
+from holado_core.common.handlers.wait import WaitFuncResultVerifying
+from holado.common.handlers.object import DeleteableObject
+
+logger = logging.getLogger(__name__)
+
+try:
+    import django  # @UnusedImport
+    with_django = True
+except Exception as exc:
+    if Tools.do_log(logger, logging.DEBUG):
+        logger.debug(f"DjangoServer is not available. Initialization failed on error: {exc}")
+    with_django = False
+
+
+class DjangoServer(DeleteableObject):
+    """
+    Django server
+    """
+    
+    @classmethod
+    def is_available(cls):
+        return with_django
+    
+    def __init__(self, name, django_project_path, port=8000, runserver_args=None):
+        super().__init__(name)
+        
+        self.__django_project_path = django_project_path
+        self.__runserver_port = port
+        self.__runserver_args = runserver_args
+        self.__project_command = None
+        
+        if not os.path.exists(django_project_path):
+            raise TechnicalException(f"Django project doesn't exist (project path: '{django_project_path}')")
+    
+    def _delete_object(self):
+        if self.__project_command is not None and self.__project_command.status == CommandStates.Running:
+            self.stop()
+
+    @property
+    def django_project_path(self):
+        return self.__django_project_path
+
+    @property
+    def runserver_port(self):
+        return self.__runserver_port
+
+    @property
+    def runserver_args(self):
+        return self.__runserver_args
+    
+    def start(self):
+        self.__start_server_by_command()
+    
+    def __start_server_by_command(self):
+        self.__project_command = self._new_project_command()
+        self.__project_command.start()
+        self._wait_until_server_is_reachable()
+    
+    def _new_project_command(self):
+        manage_path = os.path.join(self.django_project_path, "manage.py")
+        cmd = f"python {manage_path} runserver {self.runserver_port}"
+        if self.runserver_args:
+            cmd += f" {self.runserver_args}"
+        
+        res = BlockingCommandService(f"Command running Django server '{self.name}'", cmd)
+        res.auto_stop = True
+        
+        return res
+        
+    def _wait_until_server_is_reachable(self):
+        import requests
+        url = f"http://127.0.0.1:{self.runserver_port}"
+        redo = WaitFuncResultVerifying("server is reachable", 
+                                       lambda: requests.get(url), 
+                                       lambda result: result and result.status_code == 200 )
+        redo.ignoring(Exception)
+        redo.polling_every(0.01)
+        redo.execute()
+        
+    def stop(self):
+        if self.__project_command is None or self.__project_command.status != CommandStates.Running:
+            raise TechnicalException(f"Django server of project '{self.name}' is not running (status: {self.__project_command.status if self.__project_command else 'Unkown'})")
+        self.__project_command.stop()
+    
+    def join(self, timeout=None):
+        self.__project_command.join(timeout)
+    
+
+
+
+

holado_django/server/grpc_django_server.py

@@ -0,0 +1,57 @@
+
+#################################################
+# 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
+import os
+from holado_core.tools.abstracts.blocking_command_service import BlockingCommandService
+from holado_django.server.django_server import DjangoServer
+from holado_core.common.handlers.wait import WaitFuncResultVerifying
+
+logger = logging.getLogger(__name__)
+
+
+class GrpcDjangoServer(DjangoServer):
+    """
+    gRPC Django server
+    """
+    
+    def __init__(self, name, django_project_path, runserver_args=None):
+        super().__init__(name, django_project_path, port=50051, runserver_args=runserver_args)
+    
+    def _new_project_command(self):
+        manage_path = os.path.join(self.django_project_path, "manage.py")
+        cmd = f"python {manage_path} grpcrunserver"
+        if self.runserver_args:
+            cmd += f" {self.runserver_args}"
+        
+        res = BlockingCommandService(f"Command running gRPC Django server '{self.name}'", cmd)
+        res.auto_stop = True
+        
+        return res
+        
+    def _wait_until_server_is_reachable(self):
+        import grpc_requests
+        
+        endpoint = f"localhost:{self.runserver_port}"
+        def request_is_unimplemented():
+            try:
+                grpc_requests.Client.get_by_endpoint(endpoint)
+            except Exception as exc:
+                if "status = StatusCode.UNIMPLEMENTED" in str(exc):
+                    return True
+            return False
+        redo = WaitFuncResultVerifying("server is reachable", request_is_unimplemented, lambda result: result )
+        redo.polling_every(0.01)
+        redo.execute()
+
+

holado_django/server/patch_djangogrpcframework.py

@@ -0,0 +1,46 @@
+
+#################################################
+# 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.
+#################################################
+
+
+#################################################
+#
+# Patches are done to follow ITU recommendation:
+# https://www.e-navigation.nl/sites/default/files/R-REC-M.1371-5-201402-I!!PDF-E_1.pdf
+#
+#################################################
+
+
+import logging
+
+logger = logging.getLogger(__name__)
+
+
+# Since Django 4.1, requires_system_checks cannot be a boolean anymore.
+# Framework djangogrpcframework is not maintained anymore.
+# Patch it by removing reference to requires_system_checks
+#
+# USAGE:
+#    1. If not using holado in django project, copy this file in django project
+#    2. In manage.py, import this file
+
+try:
+    import django_grpc_framework  # @UnusedImport
+    with_django_grpc_framework = True
+except:
+    with_django_grpc_framework = True
+
+if with_django_grpc_framework:
+    from django_grpc_framework.management.commands.grpcrunserver import Command  # @UnusedImport
+    del Command.requires_system_checks
+
+

holado_django/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 .django_server_steps import *

holado_django/tests/behave/steps/django_server_steps.py

@@ -0,0 +1,83 @@
+# -*- 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 holado.common.context.session_context import SessionContext
+from holado_test.behave.behave import *  # @UnusedWildImport
+import logging
+from holado_test.scenario.step_tools import StepTools
+from holado_django.server.django_server import DjangoServer
+from holado_test.behave.scenario.behave_step_tools import BehaveStepTools
+from holado_value.common.tables.converters.value_table_converter import ValueTableConverter
+from holado_core.common.exceptions.technical_exception import TechnicalException
+from holado_django.server.grpc_django_server import GrpcDjangoServer
+
+logger = logging.getLogger(__name__)
+
+
+def __get_session_context():
+    return SessionContext.instance()
+
+def __get_scenario_context():
+    return __get_session_context().get_scenario_context()
+
+def __get_text_interpreter():
+    return __get_scenario_context().get_text_interpreter()
+
+def __get_variable_manager():
+    return __get_scenario_context().get_variable_manager()
+
+
+
+@Given(r"(?P<var_name>{Variable}) = new Django server")
+def step_impl(context, var_name):
+    var_name = StepTools.evaluate_variable_name(var_name)
+    table = BehaveStepTools.get_step_table(context)
+    
+    kwargs = ValueTableConverter.convert_name_value_table_2_json_object(table)
+    if 'django_project_path' not in kwargs:
+        raise TechnicalException("Parameter 'django_project_path' is required")
+    if 'name' not in kwargs:
+        kwargs['name'] = f"Django server ({kwargs['django_project_path']})"
+    
+    server = DjangoServer(**kwargs)
+    
+    __get_variable_manager().register_variable(var_name, server)
+    
+@Given(r"(?P<var_name>{Variable}) = new gRPC Django server")
+def step_impl(context, var_name):
+    var_name = StepTools.evaluate_variable_name(var_name)
+    table = BehaveStepTools.get_step_table(context)
+    
+    kwargs = ValueTableConverter.convert_name_value_table_2_json_object(table)
+    if 'django_project_path' not in kwargs:
+        raise TechnicalException("Parameter 'django_project_path' is required")
+    if 'name' not in kwargs:
+        kwargs['name'] = f"Django server ({kwargs['django_project_path']})"
+    
+    server = GrpcDjangoServer(**kwargs)
+    
+    __get_variable_manager().register_variable(var_name, server)
+    
+
+@Step(r"start \(Django server: (?P<var_server>{Variable})\)")
+def step_impl(context, var_server):
+    server = StepTools.evaluate_variable_value(var_server)
+    server.start()
+
+@Step(r"stop \(Django server: (?P<var_server>{Variable})\)")
+def step_impl(context, var_server):
+    server = StepTools.evaluate_variable_value(var_server)
+    server.stop()
+
+    

holado_docker/__init__.py

@@ -0,0 +1,25 @@
+# -*- 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_docker.sdk.docker.docker_client import DockerClient
+    if DockerClient.is_available():
+        SessionContext.instance().services.register_service_type("docker_client", DockerClient)
+