Merge pull request #283 from krcb197/272-split-into-the-lib_test-base-classes-into-classes-per-type-of-thing

272 split into the lib test base classes into classes per type of thing

Author: krcb197

src/peakrdl_python/lib_test/__init__.py

@@ -18,8 +18,8 @@
 This package is intended to distributed as part of automatically generated code by the PeakRDL
 Python tool. It provides a set of base test classes to reduce the size of the auto generated code
 """
-from .base_reg_test_class import LibTestBase
-from .async_reg_base_test_class import AsyncLibTestBase
+from .test_class import LibTestBase
+from .async_test_class import AsyncLibTestBase
 
 from .utilities import reverse_bits
 

src/peakrdl_python/lib_test/_async_base_test_class.py

@@ -0,0 +1,61 @@
+"""
+peakrdl-python is a tool to generate Python Register Access Layer (RAL) from SystemRDL
+Copyright (C) 2021 - 2025
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as
+published by the Free Software Foundation, either version 3 of
+the License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+This package is intended to distributed as part of automatically generated code by the PeakRDL
+Python tool. It provide the base class for the autogenerated tests
+"""
+# this module is very similar to the non-async version, a lot of code has been put into common
+# methods but it did not make sense to do everything as it would destroy readability
+# pylint:disable=duplicate-code
+
+import unittest
+from abc import ABC, abstractmethod
+
+from ._common_base_test_class import CommonTestBase
+
+class AsyncLibTestCommon(unittest.IsolatedAsyncioTestCase, CommonTestBase, ABC):
+    """
+    Base Test class for the autogenerated register test when in async mode
+    """
+
+    # The following may look odd by a second layer of indirection is required to effectively patch
+    # the read and write within tests
+
+    # pylint:disable=missing-function-docstring
+
+    async def outer_read_callback(self, addr: int, width: int, accesswidth: int) -> int:
+        return await self.read_callback(addr=addr,
+                                        width=width,
+                                        accesswidth=accesswidth)
+
+    @abstractmethod
+    async def read_callback(self, addr: int, width: int, accesswidth: int) -> int:
+        ...
+
+    async def outer_write_callback(self, addr: int,
+                                   width: int, accesswidth: int,
+                                   data: int) -> None:
+        return await self.write_callback(addr=addr,
+                                         width=width,
+                                         accesswidth=accesswidth,
+                                         data=data)
+
+    @abstractmethod
+    async def write_callback(self, addr: int, width: int, accesswidth: int, data: int) -> None:
+        ...
+
+    # pylint:enable=missing-function-docstring

src/peakrdl_python/lib_test/_base_test_class.py

@@ -0,0 +1,53 @@
+"""
+peakrdl-python is a tool to generate Python Register Access Layer (RAL) from SystemRDL
+Copyright (C) 2021 - 2025
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as
+published by the Free Software Foundation, either version 3 of
+the License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+This package is intended to distributed as part of automatically generated code by the PeakRDL
+Python tool. It provide the base class for the autogenerated tests
+"""
+from abc import ABC, abstractmethod
+
+from ._common_base_test_class import CommonTestBase
+
+
+class LibTestCommon(CommonTestBase, ABC):
+    """
+    Base Test class for the autogenerated register test when in non-async mode
+    """
+
+    # The following may look odd by a second layer of indirection is required to effectively patch
+    # the read and write within tests
+
+    # pylint:disable=missing-function-docstring
+
+    def outer_read_callback(self, addr: int, width: int, accesswidth: int) -> int:
+        return self.read_callback(addr=addr, width=width, accesswidth=accesswidth)
+
+    @abstractmethod
+    def read_callback(self, addr: int, width: int, accesswidth: int) -> int:
+        ...
+
+    def outer_write_callback(self, addr: int, width: int, accesswidth: int,  data: int) -> None:
+        return self.write_callback(addr=addr, width=width, accesswidth=accesswidth, data=data)
+
+    @abstractmethod
+    def write_callback(self, addr: int, width: int, accesswidth: int,  data: int) -> None:
+        ...
+
+    # pylint:enable=missing-function-docstring