test: improve coverage for the test suite

MrIndeciso · MrIndeciso · commit 2e16fd072140 · 2024-09-10T18:01:25.000+02:00
diff --git a/libdestruct/__init__.py b/libdestruct/__init__.py
@@ -4,11 +4,11 @@
 # Licensed under the MIT license. See LICENSE file in the project root for details.
 #
 
-try:
+try: # pragma: no cover
     from rich.traceback import install
 
     install()
-except ImportError:
+except ImportError: # pragma: no cover
     pass
 
 from libdestruct.c import c_int, c_long, c_str, c_uint, c_ulong
diff --git a/libdestruct/backing/memory_resolver.py b/libdestruct/backing/memory_resolver.py
@@ -10,7 +10,7 @@
 
 from libdestruct.backing.resolver import Resolver
 
-if TYPE_CHECKING:
+if TYPE_CHECKING: # pragma: no cover
     from collections.abc import MutableSequence
 
 
diff --git a/libdestruct/common/array/array_field.py b/libdestruct/common/array/array_field.py
@@ -11,7 +11,7 @@
 
 from libdestruct.common.field import Field
 
-if TYPE_CHECKING:
+if TYPE_CHECKING: # pragma: no cover
     from libdestruct.backing.resolver import Resolver
     from libdestruct.common.array import array
 
diff --git a/libdestruct/common/array/array_field_inflater.py b/libdestruct/common/array/array_field_inflater.py
@@ -12,7 +12,7 @@
 from libdestruct.common.array.linear_array_field import LinearArrayField
 from libdestruct.common.type_registry import TypeRegistry
 
-if TYPE_CHECKING:
+if TYPE_CHECKING: # pragma: no cover
     from collections.abc import Callable
 
     from libdestruct.backing.resolver import Resolver
diff --git a/libdestruct/common/array/array_impl.py b/libdestruct/common/array/array_impl.py
@@ -11,7 +11,7 @@
 from libdestruct.common.array.array import array
 from libdestruct.common.obj import obj
 
-if TYPE_CHECKING:
+if TYPE_CHECKING: # pragma: no cover
     from collections.abc import Generator
 
     from libdestruct.backing.resolver import Resolver
diff --git a/libdestruct/common/array/array_of.py b/libdestruct/common/array/array_of.py
@@ -10,7 +10,7 @@
 
 from libdestruct.common.array.linear_array_field import LinearArrayField
 
-if TYPE_CHECKING:
+if TYPE_CHECKING: # pragma: no cover
     from libdestruct.common.array.array_field import ArrayField
     from libdestruct.common.obj import obj
 
diff --git a/libdestruct/common/array/linear_array_field.py b/libdestruct/common/array/linear_array_field.py
@@ -11,7 +11,7 @@
 from libdestruct.common.array.array_field import ArrayField
 from libdestruct.common.array.array_impl import array_impl
 
-if TYPE_CHECKING:
+if TYPE_CHECKING: # pragma: no cover
     from libdestruct.backing.resolver import Resolver
     from libdestruct.common.array.array import array
     from libdestruct.common.obj import obj
diff --git a/libdestruct/common/enum/enum.py b/libdestruct/common/enum/enum.py
@@ -11,7 +11,7 @@
 from libdestruct.common.obj import obj
 from libdestruct.common.type_registry import TypeRegistry
 
-if TYPE_CHECKING:
+if TYPE_CHECKING: # pragma: no cover
     from enum import Enum
 
     from libdestruct.backing.resolver import Resolver
diff --git a/libdestruct/common/enum/enum_field.py b/libdestruct/common/enum/enum_field.py
@@ -11,7 +11,7 @@
 
 from libdestruct.common.field import Field
 
-if TYPE_CHECKING:
+if TYPE_CHECKING: # pragma: no cover
     from libdestruct.backing.resolver import Resolver
     from libdestruct.common.enum import enum
 
diff --git a/libdestruct/common/enum/enum_field_inflater.py b/libdestruct/common/enum/enum_field_inflater.py
@@ -11,7 +11,7 @@
 from libdestruct.common.enum.int_enum_field import IntEnumField
 from libdestruct.common.type_registry import TypeRegistry
 
-if TYPE_CHECKING:
+if TYPE_CHECKING: # pragma: no cover
     from collections.abc import Callable
 
     from libdestruct.backing.resolver import Resolver
diff --git a/libdestruct/common/enum/enum_of.py b/libdestruct/common/enum/enum_of.py
@@ -11,7 +11,7 @@
 
 from libdestruct.common.enum.int_enum_field import IntEnumField
 
-if TYPE_CHECKING:
+if TYPE_CHECKING: # pragma: no cover
     from libdestruct.common.enum.enum_field import EnumField
 
 
diff --git a/libdestruct/common/enum/int_enum_field.py b/libdestruct/common/enum/int_enum_field.py
@@ -12,7 +12,7 @@
 from libdestruct.common.enum.enum import enum
 from libdestruct.common.enum.enum_field import EnumField
 
-if TYPE_CHECKING:
+if TYPE_CHECKING: # pragma: no cover
     from enum import IntEnum
 
     from libdestruct.backing.resolver import Resolver
diff --git a/libdestruct/common/field.py b/libdestruct/common/field.py
@@ -9,7 +9,7 @@
 from abc import ABC, abstractmethod
 from typing import TYPE_CHECKING
 
-if TYPE_CHECKING:
+if TYPE_CHECKING: # pragma: no cover
     from libdestruct.backing.resolver import Resolver
     from libdestruct.common.obj import obj
 
diff --git a/libdestruct/common/inflater.py b/libdestruct/common/inflater.py
@@ -11,7 +11,7 @@
 from libdestruct.backing.memory_resolver import MemoryResolver
 from libdestruct.common.type_registry import TypeRegistry
 
-if TYPE_CHECKING:
+if TYPE_CHECKING: # pragma: no cover
     from collections.abc import MutableSequence
 
     from libdestruct.backing.resolver import Resolver
diff --git a/libdestruct/common/obj.py b/libdestruct/common/obj.py
@@ -9,7 +9,7 @@
 from abc import ABC, abstractmethod
 from typing import TYPE_CHECKING
 
-if TYPE_CHECKING:
+if TYPE_CHECKING: # pragma: no cover
     from libdestruct.backing.resolver import Resolver
 
 
diff --git a/libdestruct/common/ptr.py b/libdestruct/common/ptr.py
@@ -11,7 +11,7 @@
 from libdestruct.common.field import Field
 from libdestruct.common.obj import obj
 
-if TYPE_CHECKING:
+if TYPE_CHECKING: # pragma: no cover
     from libdestruct.backing.resolver import Resolver
 
 
diff --git a/libdestruct/common/struct/ptr_factory.py b/libdestruct/common/struct/ptr_factory.py
@@ -10,7 +10,7 @@
 
 from libdestruct.common.struct.ptr_struct_field import PtrStructField
 
-if TYPE_CHECKING:
+if TYPE_CHECKING: # pragma: no cover
     from libdestruct.common.field import Field
     from libdestruct.common.obj import obj
 
diff --git a/libdestruct/common/struct/ptr_struct_field.py b/libdestruct/common/struct/ptr_struct_field.py
@@ -12,7 +12,7 @@
 from libdestruct.common.ptr import ptr
 from libdestruct.common.struct.struct_field import StructField
 
-if TYPE_CHECKING:
+if TYPE_CHECKING: # pragma: no cover
     from libdestruct.backing.resolver import Resolver
     from libdestruct.common.obj import obj
 
diff --git a/libdestruct/common/struct/struct.py b/libdestruct/common/struct/struct.py
@@ -11,7 +11,7 @@
 from libdestruct.common.obj import obj
 from libdestruct.libdestruct import inflater
 
-if TYPE_CHECKING:
+if TYPE_CHECKING: # pragma: no cover
     from libdestruct.common.struct.struct_impl import struct_impl
 
 
diff --git a/libdestruct/common/struct/struct_field.py b/libdestruct/common/struct/struct_field.py
@@ -11,7 +11,7 @@
 
 from libdestruct.common.field import Field
 
-if TYPE_CHECKING:
+if TYPE_CHECKING: # pragma: no cover
     from libdestruct.backing.resolver import Resolver
     from libdestruct.common.obj import obj
 
diff --git a/libdestruct/common/struct/struct_field_inflater.py b/libdestruct/common/struct/struct_field_inflater.py
@@ -11,7 +11,7 @@
 from libdestruct.common.struct.ptr_struct_field import PtrStructField
 from libdestruct.common.type_registry import TypeRegistry
 
-if TYPE_CHECKING:
+if TYPE_CHECKING: # pragma: no cover
     from collections.abc import Callable
 
     from libdestruct.backing.resolver import Resolver
diff --git a/libdestruct/common/struct/struct_impl.py b/libdestruct/common/struct/struct_impl.py
@@ -12,7 +12,7 @@
 from libdestruct.common.struct import struct
 from libdestruct.common.type_registry import TypeRegistry
 
-if TYPE_CHECKING:
+if TYPE_CHECKING: # pragma: no cover
     from libdestruct.backing.resolver import Resolver
 
 
@@ -37,7 +37,6 @@ def __init__(self: struct_impl, resolver: Resolver) -> None:
         obj.__init__(self, resolver)
 
         self.name = self.__class__.__name__
-        self.size = 0
         self._members = {}
 
         reference_type = self._reference_struct
diff --git a/libdestruct/common/type_registry.py b/libdestruct/common/type_registry.py
@@ -10,7 +10,7 @@
 
 from libdestruct.common.field import Field
 
-if TYPE_CHECKING:
+if TYPE_CHECKING: # pragma: no cover
     from collections.abc import Callable
 
     from typing_extensions import Self
diff --git a/libdestruct/libdestruct.py b/libdestruct/libdestruct.py
@@ -10,7 +10,7 @@
 
 from libdestruct.common.inflater import Inflater
 
-if TYPE_CHECKING:
+if TYPE_CHECKING: # pragma: no cover
     from collections.abc import MutableSequence
 
 
diff --git a/test/scripts/basic_struct_test.py b/test/scripts/basic_struct_test.py
@@ -288,3 +288,48 @@ class test_t(struct):
         self.assertEqual(test.c.unwrap().b.value, 12345678)
         self.assertEqual(test.address, 0x0)
         self.assertEqual(test.c.unwrap().address, (4 + 8 + 8))
+
+        self.assertEqual(test.size, 4 + 8 + 8)
+
+    def test_struct_equality(self):
+        class test_t(struct):
+            a: c_int
+            b: c_long
+            c: ptr = ptr_to_self()
+
+        memory = b""
+        memory += (1337).to_bytes(4, "little")
+        memory += (13371337).to_bytes(8, "little")
+        memory += (4 + 8 + 8).to_bytes(8, "little")
+        memory += (1234).to_bytes(4, "little")
+        memory += (12345678).to_bytes(8, "little")
+        memory += (0).to_bytes(8, "little")
+
+        test1 = test_t.from_bytes(memory)
+        test2 = test_t.from_bytes(memory)
+
+        self.assertEqual(test1, test2)
+
+        test2 = test1.c.unwrap()
+
+        self.assertNotEqual(test1, test2)
+        self.assertNotEqual(test1, 0xdeadbeef)
+
+        class test_t2(struct):
+            a: c_int
+            b: c_long
+            c: c_int
+            d: ptr = ptr_to_self()
+
+        test2 = test_t2.from_bytes(memory)
+
+        self.assertNotEqual(test1, test2)
+
+        class test_t3(struct):
+            x: c_int
+            y: c_long
+            z: ptr = ptr_to_self()
+
+        test2 = test_t3.from_bytes(memory)
+
+        self.assertNotEqual(test1, test2)
diff --git a/test/scripts/enum_test.py b/test/scripts/enum_test.py
@@ -0,0 +1,72 @@
+#
+# This file is part of libdestruct (https://github.com/mrindeciso/libdestruct).
+# Copyright (c) 2024 Roberto Alessandro Bertolini. All rights reserved.
+# Licensed under the MIT license. See LICENSE file in the project root for details.
+#
+
+import unittest
+
+from enum import Enum, IntEnum
+from libdestruct import inflater, enum, enum_of, struct
+
+class EnumTest(unittest.TestCase):
+    def test_enum(self):
+        class Test(IntEnum):
+            A = 0
+            B = 1
+            C = 2
+            D = 3
+
+        libdestruct = inflater((0).to_bytes(4, "little"))
+
+        a = libdestruct.inflate(enum_of(Test), 0)
+
+        self.assertEqual(a.value, Test.A)
+
+        self.assertEqual(bytes(a), b"\x00\x00\x00\x00")
+
+        class TestHolder(struct):
+            a: enum = enum_of(Test)
+            b: enum = enum_of(Test)
+            c: enum = enum_of(Test)
+            d: enum = enum_of(Test)
+
+        libdestruct = inflater(b"".join(i.to_bytes(4, "little") for i in range(4)))
+
+        test = libdestruct.inflate(TestHolder, 0)
+
+        self.assertEqual(test.a.value, Test.A)
+        self.assertEqual(test.b.value, Test.B)
+        self.assertEqual(test.c.value, Test.C)
+        self.assertEqual(test.d.value, Test.D)
+
+        self.assertEqual(bytes(test), b"".join(i.to_bytes(4, "little") for i in range(4)))
+
+        with self.assertRaises(TypeError):
+            enum_of(Enum)
+
+        # Let's try with enums of different sizes
+        class TestHolder2(struct):
+            a: enum = enum_of(Test, size=1)
+            b: enum = enum_of(Test, size=2)
+            c: enum = enum_of(Test, size=4)
+            d: enum = enum_of(Test, size=8)
+
+        memory = (1).to_bytes(1, "little") + (2).to_bytes(2, "little") + (3).to_bytes(4, "little") + (3).to_bytes(8, "little")
+
+        libdestruct = inflater(memory)
+
+        test = libdestruct.inflate(TestHolder2, 0)
+
+        self.assertEqual(test.a.value, Test.B)
+        self.assertEqual(test.b.value, Test.C)
+        self.assertEqual(test.c.value, Test.D)
+        self.assertEqual(test.d.value, Test.D)
+
+        self.assertEqual(bytes(test), memory)
+
+        with self.assertRaises(ValueError):
+            enum_of(Test, size=3)
+
+        with self.assertRaises(ValueError):
+            enum_of(Test, size=9)
