Improved tests for from_binary methods

Author: ankane

tests/test_bit.py

@@ -1,7 +1,7 @@
 from pgvector import Bit
 import pytest
 import random
-from struct import pack
+import struct
 from .conftest import numpy as np
 
 
@@ -104,14 +104,22 @@ def test_from_text(self) -> None:
         assert vec.to_text() == '101'
 
     def test_from_binary(self) -> None:
-        data = pack('>iB', 3, 5 << 5)
+        data = struct.pack('>iB', 3, 5 << 5)
         vec = Bit.from_binary(data)
         assert vec.to_list() == [True, False, True]
         if np is not None:
             assert np.array_equal(vec.to_numpy(), [True, False, True])
         assert vec.to_binary() == data
 
+    def test_from_binary_zero_length(self) -> None:
+        # TODO change to ValueError('invalid length') in 0.6.0
+        with pytest.raises(struct.error, match='unpack_from requires a buffer of at least 4 bytes'):
+            Bit.from_binary(b'')
+
     def test_from_binary_negative_length(self) -> None:
-        with pytest.raises(ValueError) as error:
-            Bit.from_binary(pack('>i', -1))
-        assert str(error.value) == 'invalid length'
+        with pytest.raises(ValueError, match='invalid length'):
+            Bit.from_binary(struct.pack('>i', -1))
+
+    def test_from_binary_invalid_length(self) -> None:
+        with pytest.raises(ValueError, match='invalid length'):
+            Bit.from_binary(struct.pack('>i', 1))

tests/test_half_vector.py

@@ -1,6 +1,6 @@
 from pgvector import HalfVector
 import pytest
-from struct import pack
+import struct
 from .conftest import numpy as np
 
 
@@ -68,9 +68,22 @@ def test_from_text(self) -> None:
         assert vec.to_text() == '[1.5,2.0,3.0]'
 
     def test_from_binary(self) -> None:
-        data = pack('>HH3e', 3, 0, 1.5, 2, 3)
+        data = struct.pack('>HH3e', 3, 0, 1.5, 2, 3)
         vec = HalfVector.from_binary(data)
         assert vec.to_list() == [1.5, 2, 3]
         if np is not None:
             assert np.array_equal(vec.to_numpy(), [1.5, 2, 3])
         assert vec.to_binary() == data
+
+    def test_from_binary_zero_length(self) -> None:
+        # TODO change to ValueError('invalid length') in 0.6.0
+        with pytest.raises(struct.error, match='unpack_from requires a buffer of at least 4 bytes'):
+            HalfVector.from_binary(b'')
+
+    def test_from_binary_negative_dimensions(self) -> None:
+        with pytest.raises(ValueError, match='invalid length'):
+            HalfVector.from_binary(struct.pack('>hh', -1, 0))
+
+    def test_from_binary_non_zero_unused(self) -> None:
+        with pytest.raises(ValueError, match='expected unused to be 0'):
+            HalfVector.from_binary(struct.pack('>hh', 0, 1))

tests/test_sparse_vector.py

@@ -1,6 +1,6 @@
 from pgvector import SparseVector
 import pytest
-from struct import pack
+import struct
 from .conftest import numpy as np
 
 try:
@@ -180,7 +180,7 @@ def test_from_text(self) -> None:
     #         SparseVector.from_text('{2:1,2:1}/3')
 
     def test_from_binary(self) -> None:
-        data = pack('>iii3i3f', 6, 3, 0, 0, 2, 4, 1.5, 2, 3)
+        data = struct.pack('>iii3i3f', 6, 3, 0, 0, 2, 4, 1.5, 2, 3)
         vec = SparseVector.from_binary(data)
         assert vec.dimensions() == 6
         assert vec.indices() == [0, 2, 4]
@@ -189,3 +189,16 @@ def test_from_binary(self) -> None:
         if np is not None:
             assert np.array_equal(vec.to_numpy(), [1.5, 0, 2, 0, 3, 0])
         assert vec.to_binary() == data
+
+    def test_from_binary_zero_length(self) -> None:
+        # TODO change to ValueError('invalid length') in 0.6.0
+        with pytest.raises(struct.error, match='unpack_from requires a buffer of at least 12 bytes'):
+            SparseVector.from_binary(b'')
+
+    def test_from_binary_negative_nnz(self) -> None:
+        with pytest.raises(ValueError, match='invalid length'):
+            SparseVector.from_binary(struct.pack('>iii', 0, -1, 0))
+
+    def test_from_binary_non_zero_unused(self) -> None:
+        with pytest.raises(ValueError, match='expected unused to be 0'):
+            SparseVector.from_binary(struct.pack('>iii', 0, 0, 1))

tests/test_vector.py

@@ -1,6 +1,6 @@
 from pgvector import Vector
 import pytest
-from struct import pack
+import struct
 from .conftest import numpy as np
 
 
@@ -68,9 +68,22 @@ def test_from_text(self) -> None:
         assert vec.to_text() == '[1.5,2.0,3.0]'
 
     def test_from_binary(self) -> None:
-        data = pack('>HH3f', 3, 0, 1.5, 2, 3)
+        data = struct.pack('>hh3f', 3, 0, 1.5, 2, 3)
         vec = Vector.from_binary(data)
         assert vec.to_list() == [1.5, 2, 3]
         if np is not None:
             assert np.array_equal(vec.to_numpy(), [1.5, 2, 3])
         assert vec.to_binary() == data
+
+    def test_from_binary_zero_length(self) -> None:
+        # TODO change to ValueError('invalid length') in 0.6.0
+        with pytest.raises(struct.error, match='unpack_from requires a buffer of at least 4 bytes'):
+            Vector.from_binary(b'')
+
+    def test_from_binary_negative_dimensions(self) -> None:
+        with pytest.raises(ValueError, match='invalid length'):
+            Vector.from_binary(struct.pack('>hh', -1, 0))
+
+    def test_from_binary_non_zero_unused(self) -> None:
+        with pytest.raises(ValueError, match='expected unused to be 0'):
+            Vector.from_binary(struct.pack('>hh', 0, 1))