py_canoe 3.0.3__py3-none-any.whl → 26.0.0__py3-none-any.whl

py_canoe/core/child_elements/single_file_data_source.py

@@ -0,0 +1,13 @@
+from py_canoe.core.child_elements.data_source_file import DataSourceFile
+
+
+class SingleFileDataSource:
+    """
+    Represents a data source for a single file.
+    """
+    def __init__(self, com_object) -> None:
+        self.com_object = com_object
+
+    @property
+    def file(self) -> 'DataSourceFile':
+        return DataSourceFile(self.com_object.File)

py_canoe/core/child_elements/snippet_setup.py

@@ -0,0 +1,68 @@
+import win32com.client
+
+
+class SnippetSetup:
+    def __init__(self, com_object):
+        self.com_object = com_object
+
+    @property
+    def snippet_files(self) -> 'SnippetFiles':
+        return SnippetFiles(self.com_object.SnippetFiles)
+
+
+class SnippetFiles:
+    def __init__(self, com_object):
+        self.com_object = com_object
+
+    @property
+    def count(self) -> int:
+        return self.com_object.Count
+
+    def item(self, index: int) -> 'SnippetFile':
+        return SnippetFile(self.com_object.Item(index))
+
+    def add(self, file_name: str, full_name: str) -> 'SnippetFile':
+        return SnippetFile(self.com_object.Add(file_name, full_name))
+
+    def remove(self, index: int):
+        self.com_object.Remove(index)
+
+
+class SnippetFile:
+    def __init__(self, com_object):
+        self.com_object = win32com.client.Dispatch(com_object)
+
+    @property
+    def full_name(self) -> str:
+        return self.com_object.FullName
+
+    @property
+    def snippets(self) -> 'Snippets':
+        return self.com_object.Snippets
+
+
+class Snippets:
+    def __init__(self, com_object):
+        self.com_object = com_object
+
+    @property
+    def count(self) -> int:
+        return self.com_object.Count
+
+    def item(self, index: int) -> 'Snippet':
+        return Snippet(self.com_object.Item(index))
+
+
+class Snippet:
+    def __init__(self, com_object):
+        self.com_object = win32com.client.Dispatch(com_object)
+
+    @property
+    def name(self) -> str:
+        return self.com_object.Name
+
+    def is_running(self) -> bool:
+        return self.com_object.IsRunning()
+
+    def run(self):
+        self.com_object.Run()

py_canoe/core/child_elements/test_environment.py

@@ -0,0 +1,64 @@
+import win32com.client
+
+from py_canoe.core.child_elements.test_modules import TestModules
+from py_canoe.core.child_elements.test_setup_folders import TestSetupFolders
+
+
+class TestEnvironment:
+    """The TestEnvironment object represents a test environment within CANoe's test setup."""
+    def __init__(self, com_object):
+        self.com_object = win32com.client.Dispatch(com_object)
+        self.__test_modules = TestModules(self.com_object.TestModules)
+        self.__test_setup_folders = TestSetupFolders(self.com_object.Folders)
+        self.__all_test_modules = {}
+        self.__all_test_setup_folders = {}
+
+    @property
+    def enabled(self) -> bool:
+        return self.com_object.Enabled
+
+    @enabled.setter
+    def enabled(self, value: bool) -> None:
+        self.com_object.Enabled = value
+
+    @property
+    def full_name(self) -> str:
+        return self.com_object.FullName
+
+    @property
+    def name(self) -> str:
+        return self.com_object.Name
+
+    @property
+    def path(self) -> str:
+        return self.com_object.Path
+
+    def execute_all(self) -> None:
+        self.com_object.ExecuteAll()
+
+    def save(self, name: str, prompt_user=False) -> None:
+        self.com_object.Save(name, prompt_user)
+
+    def save_as(self, name: str, major: int, minor: int, prompt_user=False) -> None:
+        self.com_object.SaveAs(name, major, minor, prompt_user)
+
+    def stop_sequence(self) -> None:
+        self.com_object.StopSequence()
+
+    def update_all_test_setup_folders(self, tsfs_instance=None):
+        if tsfs_instance is None:
+            tsfs_instance = self.__test_setup_folders
+        if tsfs_instance.count > 0:
+            test_setup_folders = tsfs_instance.fetch_test_setup_folders()
+            for tsf_name, tsf_inst in test_setup_folders.items():
+                self.__all_test_setup_folders[tsf_name] = tsf_inst
+                if tsf_inst.test_modules.count > 0:
+                    self.__all_test_modules.update(tsf_inst.test_modules.fetch_test_modules())
+                if tsf_inst.folders.count > 0:
+                    tsfs_instance = tsf_inst.folders
+                    self.update_all_test_setup_folders(tsfs_instance)
+
+    def get_all_test_modules(self):
+        self.update_all_test_setup_folders()
+        self.__all_test_modules.update(self.__test_modules.fetch_test_modules())
+        return self.__all_test_modules

py_canoe/core/child_elements/test_environments.py

@@ -0,0 +1,26 @@
+import win32com.client
+
+from py_canoe.core.child_elements.test_environment import TestEnvironment
+
+
+class TestEnvironments:
+    """The TestEnvironments object represents the test environments within CANoe's test setup."""
+    def __init__(self, com_object):
+        self.com_object = win32com.client.Dispatch(com_object)
+
+    @property
+    def count(self) -> int:
+        return self.com_object.Count
+
+    def add(self, name: str) -> 'TestEnvironment':
+        return TestEnvironment(self.com_object.Add(name))
+
+    def remove(self, index: int, prompt_user=False) -> None:
+        self.com_object.Remove(index, prompt_user)
+
+    def fetch_all_test_environments(self) -> dict['str': 'TestEnvironment']:
+        test_environments = dict()
+        for index in range(1, self.count + 1):
+            te_inst = TestEnvironment(self.com_object.Item(index))
+            test_environments[te_inst.name] = te_inst
+        return test_environments

py_canoe/core/child_elements/test_module.py

@@ -0,0 +1,213 @@
+import win32com.client
+
+from py_canoe.helpers.common import logger, wait, DoEventsUntil
+
+TEST_MODULE_START_EVENT_TIMEOUT = 5  # seconds
+
+
+class TestModuleEvents:
+    """test module events object."""
+    def __init__(self):
+        self.TM_STARTED = False
+        self.TM_PAUSED = False
+        self.TM_STOPPED = False
+        self.TM_STOP_REASON = -1
+        self.VALUE_TABLE_STOP_REASON = {
+            0: "TestModuleEnd: The test module was executed completely",
+            1: "UserAbortion: The test module was stopped by the user",
+            2: "GeneralError: The test module was stopped by measurement stop"
+        }
+        self.TM_REPORT_GENERATED = False
+        self.TEST_REPORT_INFORMATION = dict()
+        self.TC_FAIL = False
+
+    def OnStart(self):
+        self.TM_STARTED = True
+
+    def OnPause(self):
+        self.TM_PAUSED = True
+
+    def OnStop(self, reason):
+        self.TM_STOP_REASON = reason
+        self.TM_STOPPED = True
+
+    def OnReportGenerated(self, success, sourceFullName, generatedFullName):
+        self.TEST_REPORT_INFORMATION = {
+            "success": success,
+            "source_full_name": sourceFullName,
+            "generated_full_name": generatedFullName
+        }
+        self.TM_REPORT_GENERATED = True
+
+    def OnVerdictFail(self):
+        self.TC_FAIL = True
+
+
+class TestModule:
+    """The TestModule object represents a test module in CANoe's test setup."""
+
+    def __init__(self, com_object):
+        self.com_object = win32com.client.Dispatch(com_object)
+        self.test_module_events: TestModuleEvents = win32com.client.WithEvents(self.com_object, TestModuleEvents)
+        self.VALUE_TABLE_VERDICT = {
+            0: "NotAvailable",
+            1: "Passed",
+            2: "Failed",
+            3: "None",
+            4: "Inconclusive",
+            5: "ErrorInTestSystem"
+        }
+        self.VALUE_TABLE_VERDICT_IMPACT = {
+            0: "NoImpact",
+            1: "EndTestCaseOnFail",
+            2: "EndTestModuleOnFail"
+        }
+
+    @property
+    def name(self) -> str:
+        return self.com_object.Name
+
+    @property
+    def full_name(self) -> str:
+        return self.com_object.FullName
+
+    @property
+    def path(self) -> str:
+        return self.com_object.Path
+
+    @property
+    def number_of_executions(self) -> int:
+        return self.com_object.NumberOfExecutions
+
+    @number_of_executions.setter
+    def number_of_executions(self, value: int):
+        self.com_object.NumberOfExecutions = value
+
+    @property
+    def randomize_each_cycle(self) -> bool:
+        return self.com_object.RandomizeEachCycle
+
+    @randomize_each_cycle.setter
+    def randomize_each_cycle(self, value: bool):
+        self.com_object.RandomizeEachCycle = value
+
+    @property
+    def start_on_env_var(self) -> str:
+        return self.com_object.StartOnEnvVar
+
+    @start_on_env_var.setter
+    def start_on_env_var(self, value: str):
+        self.com_object.StartOnEnvVar = value
+
+    @property
+    def start_on_key(self) -> str:
+        return self.com_object.StartOnKey
+
+    @start_on_key.setter
+    def start_on_key(self, value: str):
+        self.com_object.StartOnKey = value
+
+    @property
+    def start_on_measurement(self) -> bool:
+        return self.com_object.StartOnMeasurement
+
+    @start_on_measurement.setter
+    def start_on_measurement(self, value: bool):
+        self.com_object.StartOnMeasurement = value
+
+    @property
+    def start_on_sys_var(self) -> str:
+        return self.com_object.StartOnSysVar
+
+    @start_on_sys_var.setter
+    def start_on_sys_var(self, value: str):
+        self.com_object.StartOnSysVar = value
+
+    @property
+    def test_cases_executed_in_random_order(self) -> bool:
+        return self.com_object.TestCasesExecutedInRandomOrder
+
+    @test_cases_executed_in_random_order.setter
+    def test_cases_executed_in_random_order(self, value: bool):
+        self.com_object.TestCasesExecutedInRandomOrder = value
+
+    @property
+    def test_state_sys_var(self) -> str:
+        return self.com_object.TestStateSysVar
+
+    @test_state_sys_var.setter
+    def test_state_sys_var(self, value: str):
+        self.com_object.TestStateSysVar = value
+
+    @property
+    def verdict(self) -> int:
+        return self.com_object.Verdict
+
+    @property
+    def verdict_impact(self) -> int:
+        return self.com_object.VerdictImpact
+
+    @verdict_impact.setter
+    def verdict_impact(self, value: int):
+        self.com_object.VerdictImpact = value
+
+    def _init_tm_event_variables(self):
+        self.test_module_events.TM_STARTED = False
+        self.test_module_events.TM_PAUSED = False
+        self.test_module_events.TM_STOPPED = False
+        self.test_module_events.TM_STOP_REASON = -1
+        self.test_module_events.TM_REPORT_GENERATED = False
+        self.test_module_events.TEST_REPORT_INFORMATION = dict()
+        self.test_module_events.TC_FAIL = False
+
+    def start(self):
+        self._init_tm_event_variables()
+        self.com_object.Start()
+        status = DoEventsUntil(lambda: self.test_module_events.TM_STARTED, TEST_MODULE_START_EVENT_TIMEOUT, "Test Module Start")
+        if status:
+            logger.info(f'🧪🏃‍➡️ started executing test module ({self.name})...')
+
+    def wait_for_completion(self) -> bool:
+        return_value = False
+        if self.test_module_events.TM_STARTED:
+            logger.info(f'🧪🥱 waiting for test module ({self.name}) to complete...')
+            while not self.test_module_events.TM_STOPPED:
+                wait(0.01)
+            logger.info(f'🧪🧍 test module ({self.name}) execution completed with stop reason 👉 {self.test_module_events.VALUE_TABLE_STOP_REASON[self.test_module_events.TM_STOP_REASON]}')
+            return_value = True
+        else:
+            logger.warning(f'🧪⚠️ Test Module ({self.name}) is not started. Start the Test Module first.')
+        return return_value
+
+    def pause(self) -> bool:
+        if self.test_module_events.TM_STARTED:
+            self.com_object.Pause()
+            logger.info(f'🧪🥱 pausing test module ({self.name}). please wait...')
+            while not self.test_module_events.TM_PAUSED:
+                wait(0.01)
+            logger.info(f'🧪⏸️ paused test module ({self.name}).')
+            return True
+        else:
+            logger.warning(f'🧪⚠️ Test Module ({self.name}) is not started. Start the Test Module first.')
+            return False
+
+    def resume(self) -> None:
+        self.com_object.Resume()
+
+    def stop(self) -> bool:
+        if self.test_module_events.TM_STARTED:
+            self.com_object.Stop()
+            logger.info(f'🧪🥱 stopping test module ({self.name}). please wait...')
+            while not self.test_module_events.TM_STOPPED:
+                wait(0.01)
+            logger.info(f'🧪⏹️ stopped test module ({self.name}).')
+            return True
+        else:
+            logger.warning(f'🧪⚠️ Test Module ({self.name}) is not started. Start the Test Module first.')
+            return False
+
+    def reload(self) -> None:
+        self.com_object.Reload()
+
+    def set_execution_time(self, days: int, hours: int, minutes: int):
+        self.com_object.SetExecutionTime(days, hours, minutes)

py_canoe/core/child_elements/test_modules.py

@@ -0,0 +1,23 @@
+from py_canoe.core.child_elements.test_module import TestModule
+
+
+class TestModules:
+    def __init__(self, com_object) -> None:
+        self.com_object = com_object
+
+    @property
+    def count(self) -> int:
+        return self.com_object.Count
+
+    def add(self, full_name: str) -> 'TestModule':
+        return TestModule(self.com_object.Add(full_name))
+
+    def remove(self, index: int, prompt_user=False) -> None:
+        self.com_object.Remove(index, prompt_user)
+
+    def fetch_test_modules(self) -> dict['str': 'TestModule']:
+        test_modules = dict()
+        for index in range(1, self.count + 1):
+            tm_inst = TestModule(self.com_object.Item(index))
+            test_modules[tm_inst.name] = tm_inst
+        return test_modules

py_canoe/core/child_elements/test_setup.py

@@ -0,0 +1,16 @@
+import win32com.client
+
+from py_canoe.core.child_elements.test_environments import TestEnvironments
+
+
+class TestSetup:
+    """The TestSetup object represents CANoe's test setup."""
+    def __init__(self, com_object):
+        self.com_object = win32com.client.Dispatch(com_object)
+
+    def save_all(self, prompt_user=False) -> None:
+        self.com_object.SaveAll(prompt_user)
+
+    @property
+    def test_environments(self) -> 'TestEnvironments':
+        return TestEnvironments(self.com_object.TestEnvironments)

py_canoe/core/child_elements/test_setup_folder_ext.py

@@ -0,0 +1,36 @@
+import win32com.client
+
+from py_canoe.core.child_elements.test_modules import TestModules
+
+
+class TestSetupFolderExt:
+    """The TestSetupFolderExt object represents a directory in CANoe's test setup."""
+    def __init__(self, com_object) -> None:
+        self.com_object = win32com.client.Dispatch(com_object)
+
+    @property
+    def enabled(self) -> bool:
+        return self.com_object.Enabled
+
+    @enabled.setter
+    def enabled(self, enabled: bool):
+        self.com_object.Enabled = enabled
+
+    @property
+    def name(self) -> str:
+        return self.com_object.Name
+
+    @property
+    def folders(self):
+        from py_canoe.core.child_elements.test_setup_folders import TestSetupFolders
+        return TestSetupFolders(self.com_object.Folders)
+
+    @property
+    def test_modules(self) -> 'TestModules':
+        return TestModules(self.com_object.TestModules)
+
+    def execute_all(self):
+        self.com_object.ExecuteAll()
+
+    def stop_sequence(self):
+        self.com_object.StopSequence()

py_canoe/core/child_elements/test_setup_folders.py

@@ -0,0 +1,25 @@
+from py_canoe.core.child_elements.test_setup_folder_ext import TestSetupFolderExt
+
+
+class TestSetupFolders:
+    """The TestSetupFolders object represents the folders in a test environment or in a test setup folder."""
+    def __init__(self, com_object) -> None:
+        self.com_object = com_object
+
+    @property
+    def count(self) -> int:
+        return self.com_object.Count
+
+    def add(self, full_name: str) -> 'TestSetupFolderExt':
+        return TestSetupFolderExt(self.com_object.Add(full_name))
+
+    def remove(self, index: int, prompt_user=False) -> None:
+        self.com_object.Remove(index, prompt_user)
+
+    def fetch_test_setup_folders(self) -> dict:
+        test_setup_folders = dict()
+        for index in range(1, self.count + 1):
+            tsf_com_obj = self.com_object.Item(index)
+            tsf_inst = TestSetupFolderExt(tsf_com_obj)
+            test_setup_folders[tsf_inst.name] = tsf_inst
+        return test_setup_folders

py_canoe/core/child_elements/variable.py

@@ -0,0 +1,144 @@
+from typing import Union
+import win32com.client
+
+from py_canoe.helpers.common import logger, DoEventsUntil
+from py_canoe.core.child_elements.encodings import Encodings
+from py_canoe.core.child_elements.variable_events import VariableEvents
+
+
+class Variable:
+    def __init__(self, com_object, enable_events: bool = True):
+        self.com_object = win32com.client.Dispatch(com_object)
+        self.enable_events = enable_events
+        if self.enable_events:
+            self.variable_events: VariableEvents = win32com.client.WithEvents(self.com_object, VariableEvents)
+
+    @property
+    def analysis_only(self) -> bool:
+        return self.com_object.AnalysisOnly
+
+    @analysis_only.setter
+    def analysis_only(self, value: bool = False):
+        self.com_object.AnalysisOnly = value
+
+    @property
+    def bit_count(self) -> int:
+        return self.com_object.BitCount
+
+    @property
+    def comment(self) -> str:
+        return self.com_object.Comment
+
+    @property
+    def element_count(self) -> int:
+        return self.com_object.ElementCount
+
+    @property
+    def encodings(self) -> Encodings:
+        return Encodings(self.com_object.Encodings)
+
+    @property
+    def full_name(self) -> str:
+        return self.com_object.FullName
+
+    @property
+    def init_value(self) -> Union[int, float]:
+        return self.com_object.InitValue
+
+    @property
+    def is_array(self) -> bool:
+        return self.com_object.IsArray
+
+    @property
+    def is_member(self) -> bool:
+        return self.com_object.IsMember
+
+    @property
+    def is_signed(self) -> bool:
+        return self.com_object.IsSigned
+
+    @property
+    def is_struct(self) -> bool:
+        return self.com_object.IsStruct
+
+    @property
+    def max_value(self) -> Union[int, float]:
+        return self.com_object.MaxValue
+
+    @property
+    def member_name(self) -> str:
+        return self.com_object.MemberName
+
+    @property
+    def members(self):
+        from py_canoe.core.child_elements.variables import Variables
+        return Variables(self.com_object.Members)
+
+    @property
+    def min_value(self) -> Union[int, float]:
+        return self.com_object.MinValue
+
+    @property
+    def name(self) -> str:
+        return self.com_object.Name
+
+    @property
+    def notification_type(self) -> int:
+        return self.com_object.NotificationType
+
+    @property
+    def physical_init_value(self) -> Union[int, float]:
+        return self.com_object.PhysicalInitValue
+
+    @property
+    def physical_value(self) -> Union[int, float]:
+        return self.com_object.PhysicalValue
+
+    @property
+    def read_only(self) -> bool:
+        return self.com_object.ReadOnly
+
+    @property
+    def type(self) -> int:
+        return self.com_object.Type
+
+    @property
+    def unit(self) -> str:
+        return self.com_object.Unit
+
+    def get_value(self):
+        return self.com_object.Value
+
+    def set_value(self, value, timeout: Union[int, float]):
+        status: bool = False
+        self.com_object.Value = value
+        if self.variable_events:
+            self.variable_events.VARIABLE_UPDATED = False
+            status = DoEventsUntil(lambda: self.variable_events.VARIABLE_UPDATED, timeout, "Variable Update")
+            if status:
+                logger.info(f"📢 Variable '{self.full_name}' updated successfully to: {value}")
+        return status
+
+    def begin_struct_update(self):
+        self.com_object.BeginStructUpdate()
+
+    def end_struct_update(self):
+        self.com_object.EndStructUpdate()
+
+    def get_member_phys_value(self, member_name: str) -> Union[int, float]:
+        return self.com_object.GetMemberPhysValue(member_name)
+
+    def get_member_value(self, member_name: str) -> Union[int, float]:
+        return self.com_object.GetMemberValue(member_name)
+
+    def get_symbolic_value_name(self, value: Union[int, float]) -> str:
+        return self.com_object.GetSymbolicValueName(value)
+
+    def set_member_phys_value(self, member_name: str, value: Union[int, float]):
+        self.com_object.SetMemberPhysValue(member_name, value)
+
+    def set_member_value(self, member_name: str, value: Union[int, float]):
+        self.com_object.SetMemberValue(member_name, value)
+
+    def set_symbolic_value_name(self, value: Union[int, float], name: str):
+        self.com_object.SetSymbolicValueName(value, name)

py_canoe/core/child_elements/variable_events.py

@@ -0,0 +1,14 @@
+class VariableEvents:
+    def __init__(self) -> None:
+        self.VARIABLE_INFO = {}
+        self.VARIABLE_UPDATED = False
+
+    def OnChange(self, value):
+        self.VARIABLE_INFO['value'] = value
+        self.VARIABLE_UPDATED = True
+
+    def OnChangeAndTime(self, value, timeHigh, time):
+        self.VARIABLE_INFO['value'] = value
+        self.VARIABLE_INFO['timeHigh'] = timeHigh
+        self.VARIABLE_INFO['time'] = time
+        self.VARIABLE_UPDATED = True