feat: add __eq__ for Key and KeySet

Author: lepture

src/joserfc/_keys.py

@@ -120,6 +120,10 @@ def __iter__(self) -> t.Iterator[Key]:
     def __bool__(self) -> bool:
         return bool(self.keys)
 
+    def __eq__(self, other: t.Any) -> bool:
+        assert isinstance(other, KeySet)
+        return self.keys == other.keys
+
     def as_dict(self, private: bool | None = None, **params: t.Any) -> KeySetSerialization:
         keys: list[DictKey] = []
 

src/joserfc/rfc7517/models.py

@@ -99,6 +99,11 @@ def __init__(
             self.validate_dict_key(data)
             self._dict_value = data
 
+    def __eq__(self, other: t.Any) -> bool:
+        if not isinstance(other, self.__class__):
+            return False
+        return self.dict_value == other.dict_value
+
     def keys(self) -> KeysView[str]:
         return self.dict_value.keys()
 

tests/jwk/test_ec_key.py

@@ -1,5 +1,5 @@
 from unittest import TestCase
-from joserfc.jwk import ECKey
+from joserfc.jwk import ECKey, OctKey
 from joserfc.errors import InvalidExchangeKeyError
 from tests.keys import read_key
 
@@ -78,3 +78,15 @@ def test_output_with_password(self):
         )
         key2 = ECKey.import_key(pem, password="secret")
         self.assertEqual(key.as_dict(), key2.as_dict())
+
+    def test_key_eq(self):
+        key1 = ECKey.generate_key()
+        key2 = ECKey.import_key(key1.as_dict())
+        self.assertEqual(key1, key2)
+        key3 = ECKey.generate_key()
+        self.assertNotEqual(key1, key3)
+
+    def test_key_eq_with_different_types(self):
+        key1 = ECKey.generate_key()
+        key2 = OctKey.generate_key()
+        self.assertNotEqual(key1, key2)

tests/jwk/test_jwk_set.py

@@ -76,3 +76,18 @@ def test_key_set_iter(self):
         key_set = KeySet.generate_key_set('RSA', 2048)
         for k in key_set:
             self.assertEqual(k.key_type, "RSA")
+
+    def test_key_eq_with_same_keys(self):
+        key_set1 = KeySet.generate_key_set('RSA', 2048)
+        key_set2 = KeySet(key_set1.keys)
+        self.assertIsNot(key_set1, key_set2)
+        self.assertEqual(key_set1, key_set2)
+
+    def test_key_eq_with_new_keys(self):
+        key_set1 = KeySet.generate_key_set('RSA', 2048)
+        key_set2 = KeySet([
+            RSAKey.import_key(k.as_dict())
+            for k in key_set1
+        ])
+        self.assertIsNot(key_set1, key_set2)
+        self.assertEqual(key_set1, key_set2)

tests/jwk/test_oct_key.py

@@ -92,3 +92,11 @@ def test_generate_key(self):
 
         key = OctKey.generate_key(auto_kid=True)
         self.assertIsNotNone(key.kid)
+
+    def test_key_eq(self):
+        key1 = OctKey.generate_key()
+        key2 = OctKey.import_key(key1.as_dict())
+        self.assertIsNot(key1, key2)
+        self.assertEqual(key1, key2)
+        key3 = OctKey.generate_key()
+        self.assertNotEqual(key1, key3)

tests/jwk/test_okp_key.py

@@ -100,3 +100,11 @@ def test_output_with_password(self):
         )
         key2 = OKPKey.import_key(pem, password="secret")
         self.assertEqual(key.as_pem(), key2.as_pem())
+
+    def test_key_eq(self):
+        key1 = OKPKey.generate_key()
+        key2 = OKPKey.import_key(key1.as_dict())
+        self.assertIsNot(key1, key2)
+        self.assertEqual(key1, key2)
+        key3 = OKPKey.generate_key()
+        self.assertNotEqual(key1, key3)

tests/jwk/test_rsa_key.py

@@ -150,3 +150,11 @@ def test_output_with_password(self):
         )
         key2 = RSAKey.import_key(pem, password="secret")
         self.assertEqual(key.as_dict(), key2.as_dict())
+
+    def test_key_eq(self):
+        key1 = RSAKey.generate_key()
+        key2 = RSAKey.import_key(key1.as_dict())
+        self.assertIsNot(key1, key2)
+        self.assertEqual(key1, key2)
+        key3 = RSAKey.generate_key()
+        self.assertNotEqual(key1, key3)