holado 0.13.22__py3-none-any.whl

holado_ais/tests/behave/steps/__init__.py

@@ -0,0 +1,17 @@
+# -*- 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 .ais.ais_manager_steps import *
+from .ais.ais_messages_steps import *

holado_ais/tests/behave/steps/ais/ais_manager_steps.py

@@ -0,0 +1,50 @@
+# -*- 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_test.scenario.step_tools import StepTools
+from holado.common.context.session_context import SessionContext
+import logging
+from holado_test.behave.behave import *  # @UnusedWildImport
+
+logger = logging.getLogger(__name__)
+
+
+def __get_scenario_context():
+    return SessionContext.instance().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()
+
+def __get_ais_manager():
+    return SessionContext.instance().ais_manager
+
+
+@Step(r"(?P<var_name>{Variable}) = new unique MMSI number")
+def step_impl(context, var_name):
+    """
+    Decode an AIS message from NMEA format
+    """
+    var_name = StepTools.evaluate_variable_name(var_name)
+    
+    res = __get_ais_manager().new_unique_mmsi_number()
+    
+    __get_variable_manager().register_variable(var_name, res)
+
+
+
+

holado_ais/tests/behave/steps/ais/ais_messages_steps.py

@@ -0,0 +1,237 @@
+# -*- 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_test.scenario.step_tools import StepTools
+from holado.common.context.session_context import SessionContext
+import logging
+from holado_test.behave.scenario.behave_step_tools import BehaveStepTools
+from holado_ais.ais.ais_messages import AISMessages
+from holado_test.behave.behave import *  # @UnusedWildImport
+from holado_ais.ais.enums import AISMessageType
+from holado_core.common.tools.string_tools import StrTools
+from holado_value.common.tables.converters.value_table_converter import ValueTableConverter
+from holado_core.common.block.function import Function
+from holado_core.common.exceptions.functional_exception import FunctionalException
+
+logger = logging.getLogger(__name__)
+
+
+def __get_scenario_context():
+    return SessionContext.instance().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()
+
+def __get_ais_messages():
+    return SessionContext.instance().ais_messages
+
+
+if AISMessages.is_available():
+    @Step(r"(?P<var_name>{Variable}) = decode AIS message of type (?P<msg_type>{Str}) from bitarray (?P<msg_bitarray>{Str})")
+    def step_impl(context, var_name, msg_type, msg_bitarray):
+        var_name = StepTools.evaluate_variable_name(var_name)
+        msg_type = StepTools.evaluate_scenario_parameter(msg_type)
+        msg_bitarray = StepTools.evaluate_scenario_parameter(msg_bitarray)
+        
+        res = __get_ais_messages().decode_message(msg_type, msg_bitarray)
+        
+        __get_variable_manager().register_variable(var_name, res)
+    
+    @Step(r"(?P<var_name>{Variable}) = encode AIS message")
+    def step_impl(context, var_name):
+        """
+        Encode an AIS message to NMEA format
+        """
+        var_name = StepTools.evaluate_variable_name(var_name)
+        table = BehaveStepTools.get_step_table(context)
+        
+        res = __get_ais_messages().encode(table)
+        
+        __get_variable_manager().register_variable(var_name, res)
+    
+    @Step(r"(?P<var_name>{Variable}) = encode AIS message (?P<message>{Any})")
+    def step_impl(context, var_name, message):
+        """
+        Encode an AIS message to NMEA format
+        """
+        var_name = StepTools.evaluate_variable_name(var_name)
+        msg = StepTools.evaluate_scenario_parameter(message)
+        table = BehaveStepTools.get_step_table(context)
+        
+        if table is not None:
+            kwargs = ValueTableConverter.convert_table_with_header_to_dict(table)
+        else:
+            kwargs = {}
+        res = __get_ais_messages().encode(msg, **kwargs)
+        
+        __get_variable_manager().register_variable(var_name, res)
+    
+    @Step(r"(?P<var_name>{Variable}) = encode AIS raw payload (?P<raw_payload>{Any}) to NMEA")
+    def step_impl(context, var_name, raw_payload):
+        """
+        Encode an AIS message to NMEA format
+        """
+        var_name = StepTools.evaluate_variable_name(var_name)
+        raw_payload = StepTools.evaluate_scenario_parameter(raw_payload)
+        table = BehaveStepTools.convert_step_table_2_value_table_with_header(context.table)
+        
+        if table is not None:
+            kwargs = ValueTableConverter.convert_table_with_header_to_dict(table)
+        else:
+            kwargs = {}
+        res = __get_ais_messages().encode_raw_payload(raw_payload, **kwargs)
+        
+        __get_variable_manager().register_variable(var_name, res)
+    
+    @Step(r"(?P<var_name>{Variable}) = new AIS message of type (?P<ais_message_type>{Str}) as bitarray bytes")
+    def step_impl(context, var_name, ais_message_type):
+        var_name = StepTools.evaluate_variable_name(var_name)
+        msg_type = StepTools.evaluate_scenario_parameter(ais_message_type)
+        
+        if hasattr(context, 'table') and context.table is not None:
+            table = BehaveStepTools.convert_step_table_2_value_table_with_header(context.table)
+        else:
+            table = {}
+        
+        res = __get_ais_messages().new_message_as_bitarray_bytes(msg_type, table)
+        
+        __get_variable_manager().register_variable(var_name, res)
+        
+    @Step(r"(?P<var_name>{Variable}) = new AIS message of type (?P<msg_type>{Int})")
+    def step_impl(context, var_name, msg_type:int):
+        var_name = StepTools.evaluate_variable_name(var_name)
+        msg_type = StepTools.evaluate_scenario_parameter(msg_type)
+        table = BehaveStepTools.convert_step_table_2_value_table_with_header(context.table)
+        
+        res = __get_ais_messages().new_message(msg_type, table)
+        
+        __get_variable_manager().register_variable(var_name, res)
+
+    @Step(r"(?P<var_name>{Variable}) = convert AIS message (?P<msg>{Str}) to binary string")
+    def step_impl(context, var_name, msg):
+        var_name = StepTools.evaluate_variable_name(var_name)
+        msg = StepTools.evaluate_scenario_parameter(msg)
+        
+        res = __get_ais_messages().convert_message_to_binary_str(msg)
+        
+        __get_variable_manager().register_variable(var_name, res)
+
+    @Step(r"(?P<var_name>{Variable}) = convert AIS message (?P<msg>{Str}) to bytes")
+    def step_impl(context, var_name, msg):
+        var_name = StepTools.evaluate_variable_name(var_name)
+        msg = StepTools.evaluate_scenario_parameter(msg)
+        
+        res = __get_ais_messages().convert_message_to_bytes(msg)
+        
+        __get_variable_manager().register_variable(var_name, res)
+
+    @Step(r"(?P<var_name>{Variable}) = convert AIS message (?P<msg>{Str}) to hexadecimal string")
+    def step_impl(context, var_name, msg):
+        var_name = StepTools.evaluate_variable_name(var_name)
+        msg = StepTools.evaluate_scenario_parameter(msg)
+        
+        res = __get_ais_messages().convert_message_to_bytes(msg)
+        res = StrTools.to_hex(res)
+        
+        __get_variable_manager().register_variable(var_name, res)
+    
+    @Step(r"(?:(?P<tagblock_var_name>{Variable}), )?(?P<var_name>{Variable}) = decode NMEA AIS raw (?P<ais_raw>{Bytes}|{Str}) as dictionary(?: \((?P<merge_tag_block_and_message_dicts_str>merge tag block and message dictionaries)?\))?")
+    def step_impl(context, tagblock_var_name, var_name, ais_raw, merge_tag_block_and_message_dicts_str):
+        var_name = StepTools.evaluate_variable_name(var_name)
+        ais_raw = StepTools.evaluate_scenario_parameter(ais_raw)
+        merge_tag_block_and_message_dicts = merge_tag_block_and_message_dicts_str is not None
+        
+        res = __get_ais_messages().decode_nmea_raw_as_dict(ais_raw, merge_tag_block_and_message_dicts=merge_tag_block_and_message_dicts)
+        
+        if tagblock_var_name is None:
+            __get_variable_manager().register_variable(var_name, res)
+        else:
+            if len(res) == 2:
+                tb_dict, msg_dict = res
+            else:
+                tb_dict, msg_dict = None, res
+            __get_variable_manager().register_variable(tagblock_var_name, tb_dict)
+            __get_variable_manager().register_variable(var_name, msg_dict)
+    
+    @Step(r"(?P<var_name>{Variable}) = decode NMEA AIS message (?P<encoded_ais_message>{Str})(?P<dictionary_str> as dictionary)?")
+    def step_impl(context, var_name, encoded_ais_message, dictionary_str):
+        var_name = StepTools.evaluate_variable_name(var_name)
+        encoded_ais_message = StepTools.evaluate_scenario_parameter(encoded_ais_message)
+        
+        if isinstance(encoded_ais_message, list):
+            res = __get_ais_messages().decode(*encoded_ais_message)
+        else:
+            res = __get_ais_messages().decode(encoded_msg=encoded_ais_message)
+            
+        if dictionary_str is not None:
+            res = res.asdict()
+            
+        __get_variable_manager().register_variable(var_name, res)
+    
+    #TODO EKL: rename step
+    @Given(r"(?P<var_name>{Variable}) = split NMEA AIS message (?P<ais_message>{Bytes}|{Str}) to fields")
+    def step_impl(context, var_name, ais_message):
+        var_name = StepTools.evaluate_variable_name(var_name)
+        ais_message = StepTools.evaluate_scenario_parameter(ais_message)
+        
+        res = __get_ais_messages().split_message_to_fields(ais_message)
+        
+        __get_variable_manager().register_variable(var_name, res)
+    
+    @Given(r"(?P<var_name>{Variable}) = split (?P<ais_raw>{Bytes}|{Str}) to NMEA AIS sentences")
+    def step_impl(context, var_name, ais_raw):
+        var_name = StepTools.evaluate_variable_name(var_name)
+        ais_raw = StepTools.evaluate_scenario_parameter(ais_raw)
+        
+        res = __get_ais_messages().split_raw_to_sentences(ais_raw)
+        
+        __get_variable_manager().register_variable(var_name, res)
+        
+    @Given(r"(?P<tb_var_name>{Variable}), (?P<msg_var_name>{Variable}) = split NMEA AIS sentence (?P<ais_sentence>{Bytes}|{Str}) to tag block and message")
+    def step_impl(context, tb_var_name, msg_var_name, ais_sentence):
+        tb_var_name = StepTools.evaluate_variable_name(tb_var_name)
+        msg_var_name = StepTools.evaluate_variable_name(msg_var_name)
+        ais_sentence = StepTools.evaluate_scenario_parameter(ais_sentence)
+        
+        tb, msg = __get_ais_messages().split_sentence_to_tag_block_and_message(ais_sentence)
+        
+        __get_variable_manager().register_variable(tb_var_name, tb)
+        __get_variable_manager().register_variable(msg_var_name, msg)
+        
+    @Given(r"(?P<var_name>{Variable}) = split NMEA AIS Tag Block (?P<tag_block>{Bytes}|{Str}) to dict")
+    def step_impl(context, var_name, tag_block):
+        var_name = StepTools.evaluate_variable_name(var_name)
+        tag_block = StepTools.evaluate_scenario_parameter(tag_block)
+        
+        res = __get_ais_messages().convert_tag_block_to_dict(tag_block)
+        
+        __get_variable_manager().register_variable(var_name, res)
+        
+    @Given(r"(?P<var_name>{Variable}) = NMEA AIS message (?P<ais_message>{Bytes}|{Str}) with message ID replaced by (?P<replacement_id>{Bytes}|{Str})")
+    def step_impl(context, var_name, ais_message, replacement_id):
+        var_name = StepTools.evaluate_variable_name(var_name)
+        ais_message = StepTools.evaluate_scenario_parameter(ais_message)
+        replacement_id = StepTools.evaluate_scenario_parameter(replacement_id)
+        
+        res = __get_ais_messages().replace_message_id_in_message(ais_message, replacement_id)
+        
+        __get_variable_manager().register_variable(var_name, res)
+    
+    
+
+

holado_binary/__init__.py

@@ -0,0 +1,17 @@
+# -*- 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.
+#################################################
+
+
+
+

holado_binary/ipc/binary.py

@@ -0,0 +1,125 @@
+
+#################################################
+# 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.string_tools import StrTools
+
+logger = logging.getLogger(__name__)
+
+
+class Binary():
+    """
+    Tools to manipulate binary data.
+    """
+    
+    @classmethod
+    def convert_bin_str_to_hex_str(cls, bin_str, right_padding=False, nbbits_by_block=8):
+        """
+        Convert binary string to hexadecimal string (ex: 'A2FF').
+        
+        If binary string has a length that is not a multiple of nbbits_by_block, a padding with zeros is made at left or right, depending on parameter right_padding.
+        """
+        # Manage padding for bits out of blocks of nbbits_by_block bits
+        nb_bits_out_of_block = len(bin_str) % nbbits_by_block
+        if nb_bits_out_of_block > 0:
+            padding_bits = "0" * (nbbits_by_block - nb_bits_out_of_block)
+            if right_padding:
+                bin_str += padding_bits
+            else:
+                bin_str = padding_bits + bin_str
+        if len(bin_str) % nbbits_by_block != 0:
+            raise TechnicalException("Failed to pad binary series")
+        
+        # Manage 4-bits blocks
+        res_list = []
+        for i in range(len(bin_str) // 4):
+            res_list.append("{:X}".format(int(bin_str[i*4:i*4+4],2)))
+        return "".join(res_list)
+    
+    @classmethod
+    def convert_hex_str_to_bin_str(cls, hex_str, bit_length=None, right_padded=False):
+        """
+        Convert hexadecimal string to binary string (ex: '10001101').
+        """
+        res = "".join(["{:04b}".format(int(hc, 16)) for hc in hex_str])
+        
+        if bit_length is not None:
+            if bit_length > len(hex_str) * 4:
+                raise FunctionalException(f"Data bit length ({bit_length}) is greater than data size ({len(hex_str) * 4})")
+            if right_padded:
+                res = res[:bit_length]
+            else:
+                res = res[-bit_length:]
+        
+        return res
+        
+    @classmethod
+    def pad_bin_str_with_itself(cls, bin_str, bit_length, right_padding=False):
+        if len(bin_str) == 0:
+            raise FunctionalException(f"Binary string is empty, it is not possible to pad it with itself")
+        if bit_length < len(bin_str):
+            raise FunctionalException(f"Binary string has a length ({len(bin_str)}) greater than expected length ({bit_length}) after padding")
+        
+        res = bin_str
+        while len(res) < bit_length:
+            missing_len = bit_length - len(res)
+            if len(bin_str) <= missing_len:
+                pad_str = bin_str
+            else:
+                pad_str = bin_str[:missing_len]
+            if right_padding:
+                res += pad_str
+            else:
+                res = pad_str + res
+        
+        return res
+
+    @classmethod
+    def pad_data(cls, data_str, data_length, padding_char='0', right_padding=False):
+        if data_length < len(data_str):
+            raise FunctionalException(f"Data has a length ({len(data_str)}) greater than expected length ({data_length}) after padding")
+        
+        pad_str = padding_char * (data_length - len(data_str))
+        if right_padding:
+            return data_str + pad_str
+        else:
+            return pad_str + data_str
+
+    @classmethod
+    def data_length_after_padding(cls, data_length, multiple_of_length):
+        if data_length == 0:
+            return 0
+        else:
+            return ((data_length - 1) // multiple_of_length + 1) * multiple_of_length
+
+    @classmethod
+    def get_data_bit_length(cls, data):
+        """Return number of bits of data after conversion in binary format.
+        Note: for string data type, data is supposed to be in hexadecimal format.
+        """
+        if isinstance(data, int):
+            return len(f"{data:b}")
+        elif isinstance(data, bytes):
+            return len(data) * 8
+        elif isinstance(data, str):
+            if StrTools.is_hex(data):
+                return len(data) * 4
+            else:
+                raise TechnicalException(f"String data must be in hexadecimal format: [{data}]")
+        else:
+            raise TechnicalException(f"Unmanaged data of type {type(data)}")
+
+
+