holado 0.8.2__tar.gz → 0.8.4__tar.gz

{holado-0.8.2 → holado-0.8.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: holado
-Version: 0.8.2
+Version: 0.8.4
 Summary: HolAdo framework
 Project-URL: Homepage, https://gitlab.com/holado_framework/python
 Project-URL: Issues, https://gitlab.com/holado_framework/python/-/issues

holado-0.8.4/packaging/VERSION

@@ -0,0 +1 @@
+0.8.4

{holado-0.8.2 → holado-0.8.4}/src/holado/common/handlers/undefined.py

@@ -39,12 +39,12 @@ not_applicable = Undefined("Not Applicable", 2)
 to_be_defined = Undefined("To be defined", 3)               # Usage: initial variable value defining it is to be defined. It is useful when undefined_value can be a possible value.
 
 
-
 # Define specific default values
 # Note: Real value is defined by methods managing these values as argument.
 
-default_value = Undefined("Default value", 10)
-default_context = Undefined("Default context", 11)      # Example of real value: for ThreadsManager it means "current ScenarioContext" if a scenario context exists else "SessionContext".
+default = Undefined("Default", 10)
+default_value = Undefined("Default value", 11)
+default_context = Undefined("Default context", 12)      # Example of real value: for ThreadsManager it means "current ScenarioContext" if a scenario context exists else "SessionContext".
 
 
 # Define symbolic values

{holado-0.8.2 → holado-0.8.4}/src/holado_docker/tools/docker_controller/client/rest/docker_controller_client.py

@@ -13,6 +13,7 @@
 
 import logging
 from holado_rest.api.rest.rest_client import RestClient
+from holado.common.handlers.undefined import default_value
 
 logger = logging.getLogger(__name__)
 
@@ -29,8 +30,8 @@ class DockerControllerClient(RestClient):
         response = self.get(f"os/env", json=data)
         return self.response_result(response, status_ok=[200])
     
-    def get_directory_filenames(self, path):
-        data = {'path':path}
+    def get_directory_filenames(self, path, extension='.yml'):
+        data = {'path':path, 'extension':extension}
         response = self.get(f"os/ls", json=data)
         return self.response_result(response, status_ok=[200])
     
@@ -45,11 +46,14 @@ class DockerControllerClient(RestClient):
         return self.response_result(response, status_ok=[200,204])
     
     def get_container_info(self, name, all_=False):
+        """Get container info
+        @return container info if found, else None
+        """
         if all_:
             response = self.get(f"container/{name}?all=true")
         else:
             response = self.get(f"container/{name}")
-        return self.response_result(response, status_ok=[200,204])
+        return self.response_result(response, status_ok=[200,204], result_on_statuses={204:None, default_value:None})
     
     def restart_container(self, name, start_if_gone=False):
         response = self.put(f"container/{name}/restart")

{holado-0.8.2 → holado-0.8.4}/src/holado_docker/tools/docker_controller/server/rest/api/os.py

@@ -29,9 +29,15 @@ class LsView(MethodView):
     
     def get(self, body: dict):
         dir_path = body['path']
+        extension = body.get('extension', None)
+        
+        if not os.path.exists(dir_path) or not os.path.isdir(dir_path):
+            return f"Directory '{dir_path}' doesn't exist", 406
         
         res = []
         for filename in os.listdir(dir_path):
+            if extension is not None and not filename.endswith(extension):
+                continue
             if os.path.isfile(os.path.join(dir_path, filename)):
                 res.append(filename)
         

{holado-0.8.2 → holado-0.8.4}/src/holado_docker/tools/docker_controller/server/rest/openapi.yaml

@@ -40,11 +40,14 @@ paths:
               properties:
                 path:
                   type: string
+                extension:
+                  type: string
+                  nullable: true
       responses:
         200:
           description: "Directory filenames"
           content:
-            application/text:
+            application/json:
               schema:
                 type: "array"
                 items:

{holado-0.8.2 → holado-0.8.4}/src/holado_logging/common/logging/holado_logger.py

@@ -12,6 +12,7 @@
 #################################################
 
 import logging
+from holado.common.handlers.undefined import default_value
 
 logger = logging.getLogger(__name__)
 
@@ -22,7 +23,7 @@ class HALogger(logging.Logger):
     def __init__(self, name, level=logging.NOTSET):
         super().__init__(name, level)
     
-    def _log(self, level, msg, args, exc_info=None, extra=None, stack_info=False, stacklevel=1, msg_size_limit=None):
+    def _log(self, level, msg, args, exc_info=None, extra=None, stack_info=False, stacklevel=1, msg_size_limit=default_value):
         # def find_handlers(logger_):
         #     index = 0
         #     while len(logger_.handlers) == 0:
@@ -41,7 +42,7 @@ class HALogger(logging.Logger):
             else:
                 raise exc
         
-        if msg_size_limit is None:
+        if msg_size_limit is default_value:
             msg_size_limit = HALogger.default_message_size_limit
         msg_to_log = Tools.truncate_text(msg, msg_size_limit)
             

{holado-0.8.2 → holado-0.8.4}/src/holado_rest/api/rest/rest_client.py

@@ -20,6 +20,7 @@ from holado_core.common.tools.converters.converter import Converter
 from holado_json.ipc.json_converter import JsonConverter
 from holado.common.handlers.object import Object
 from holado.holado_config import Config
+from holado.common.handlers.undefined import to_be_defined, default
 
 logger = logging.getLogger(__name__)
 
@@ -38,6 +39,11 @@ class RestClient(Object):
     REST client
     """
     
+    default_result_on_statuses = {
+        # 204 == "No Content" => result is None
+        204: None
+        }
+    
     @classmethod
     def is_available(cls):
         return with_requests
@@ -82,12 +88,34 @@ class RestClient(Object):
             res += "&".join([f"{k}={v}" for k,v in parameters.items()])
         return res
     
-    def response_result(self, response, status_ok=200):
-        # Get result
-        if response.status_code == 204:
-            # 204 == "No Content" => return None
-            res = None
-        else:
+    def response_result(self, response, status_ok=200, result_on_statuses=default_result_on_statuses):
+        """Return the result of the request associated to given response
+        @param response Response of the request
+        @param status_ok The status code, or a list of status codes, for which the request is considered in success
+        @param result_on_statuses A dictionary with defined result associated to a status
+        Notes:
+          - If response status is not status_ok (or in status_ok if it is a list), an exception is raised telling request has failed
+          - result_on_statuses is by default RestClient.default_result_on_statuses (={204: None})
+          - When holado.common.handlers.undefined.default is in result_on_statuses as status, the associated result is returned in any other case and no failing exception is raised
+        """
+        res = to_be_defined
+        is_res_default = False
+        is_ok = isinstance(status_ok, list) and response.status_code in status_ok or response.status_code == status_ok
+        
+        # Find a result associated to response status
+        if result_on_statuses is not None:
+            for status, status_result in result_on_statuses.items():
+                if response.status_code == status:
+                    res = status_result
+                    break
+                elif status is default and not is_ok:
+                    res = status_result
+                    is_res_default = True
+                    break
+                    
+        
+        # If result is not defined, get it from response
+        if res is to_be_defined:
             if "application/json" in response.headers['Content-Type'] and len(response.content) > 0:
                 res = response.json()
             elif response.headers['Content-Type'].startswith('text'):
@@ -96,8 +124,7 @@ class RestClient(Object):
                 res = response.content
         
         # Verify status
-        is_ok = isinstance(status_ok, list) and response.status_code in status_ok or response.status_code == status_ok
-        if not is_ok:
+        if not is_ok and not is_res_default:
             raise FunctionalException(f"[{self.name}] Request failed with status {response.status_code} (expected success status: {status_ok}) on error: {res}")
         
         return res
@@ -115,7 +142,7 @@ class RestClient(Object):
             raise TechnicalException(f"[{self.name}] Failed to process {method} '{url}' with arguments {r_kwargs}") from exc
         
         if Tools.do_log(logger, logging.TRACE):  # @UndefinedVariable
-            logger.trace(f"[{self.name}] {method} on url '{url}' => {Tools.represent_object(res, 4)}")
+            logger.trace(f"[{self.name}] {method} on url '{url}' => {Tools.represent_object(res, 4)}", msg_size_limit=None)
         elif Tools.do_log(logger, self.request_log_level):
             logger.log(self.request_log_level, f"[{self.name}] {method} on url '{url}' => {Tools.represent_object(res, 4, max_level=1)}")
         return res

{holado-0.8.2 → holado-0.8.4}/src/holado_rest/tests/behave/steps/private/api/rest_steps.py

@@ -17,6 +17,7 @@ from holado_test.behave.behave import *  # @UnusedWildImport
 import os.path
 import logging
 from holado_test.scenario.step_tools import StepTools
+from holado_system.system.global_system import GlobalSystem
 
 logger = logging.getLogger(__name__)
 
@@ -42,26 +43,33 @@ def step_impl(context, var_name):
     here = os.path.abspath(os.path.dirname(__file__))
     django_project_path = os.path.normpath(os.path.join(here, "..", "..", "..", "..", "..", "..", "..", "tests", "behave", "test_holado", "tools", "django", "api_rest"))
     
+    if 8000 in GlobalSystem.get_used_ports():
+        port = GlobalSystem.get_first_available_anonymous_port()
+    else:
+        port = 8000
+    __get_variable_manager().register_variable("__INTERNAL_REST_SERVER_PORT__", port)
+    
     execute_steps(u"""
         Given {var_name} = new Django server
             | Name                   | Value                          |
             | 'name'                 | 'REST server for holado tests' |
             | 'django_project_path'  | '{django_project_path}'        |
-            | 'port'                 | 8000                           |
+            | 'port'                 | {port}                         |
         When start (Django server: {var_name})
-        """.format(var_name=var_name, django_project_path=django_project_path))
+        """.format(var_name=var_name, django_project_path=django_project_path, port=port))
     
 
 
 @Given(r"(?P<var_name>{Variable}) = new internal REST client")
 def step_impl(context, var_name):
     var_name = StepTools.evaluate_variable_name(var_name)
+    port = __get_variable_manager().get_variable_value("__INTERNAL_REST_SERVER_PORT__")
     execute_steps(u"""
         Given {var_name} = new REST client
-            | Name                      | Value                   |
-            | 'url'                     | 'http://localhost:8000' |
-            | 'headers.Content-Type'    | 'application/json'      |
-            | 'authentication.user'     | ('admin', 'admin')      |
-        """.format(var_name=var_name))
+            | Name                      | Value                     |
+            | 'url'                     | 'http://localhost:{port}' |
+            | 'headers.Content-Type'    | 'application/json'        |
+            | 'authentication.user'     | ('admin', 'admin')        |
+        """.format(var_name=var_name, port=port))
         
     

{holado-0.8.2 → holado-0.8.4}/src/holado_system/system/global_system.py

@@ -171,7 +171,7 @@ class GlobalSystem(object):
         if cls.get_os_type() == OSTypes.Linux:
             cmd = "netstat -tunlep | grep LISTEN | awk '{print $4}' | awk '{gsub(\".*:\",\"\");print}'"
             result = cls.execute_command(cmd, do_log_output=False, do_raise_on_stderr=False)
-            res = [Converter.to_integer(v) for v in result.output.split('\n') if len(v) > 0]
+            res = {Converter.to_integer(v) for v in result.output.split('\n') if len(v) > 0}
             return res
         else:
             raise NotImplementedError(f"Not implemented for OS type '{cls.get_os_type().name}'")

holado-0.8.2/packaging/VERSION

@@ -1 +0,0 @@
-0.8.2