fix(fields): unknown fields should be excluded

Author: jguerreiro

pygitguardian/models.py

@@ -18,6 +18,7 @@
 class BaseSchema(Schema):
     class Meta:
         ordered = True
+        unknown = EXCLUDE
 
 
 class Base:
@@ -47,9 +48,6 @@ def __bool__(self) -> bool:
 
 
 class DocumentSchema(BaseSchema):
-    class Meta:
-        unknown = EXCLUDE
-
     filename = fields.String(validate=validate.Length(max=256), allow_none=True)
     document = fields.String(required=True)
 

tests/test_models.py

@@ -1,11 +1,39 @@
-from unittest import TestCase
+from typing import OrderedDict
 
-from pygitguardian.models import Document
+from pygitguardian.models import Document, DocumentSchema, Match, MatchSchema
 
 
-class TestModel(TestCase):
+class TestModel:
     def test_document_model(self):
+        """
+        GIVEN a simple document
+        THEN base model methods should produce the appropriate types.
+        """
         document = Document("hello", "hello")
-        self.assertIsInstance(document.to_json(), str)
-        self.assertIsInstance(document.to_dict(), dict)
-        self.assertIsInstance(str(document), str)
+        assert isinstance(document.to_json(), str)
+        assert isinstance(document.to_dict(), dict)
+        assert isinstance(str(document), str)
+
+    def test_schema_excludes(self):
+        """
+        GIVEN a simple document and an extra field in dict format
+        WHEN loading using the schema
+        THEN the extra field should be excluded
+        """
+        document = {"filename": "hello", "document": "hello", "extra": "field"}
+        schema = DocumentSchema()
+
+        document_obj = schema.load(document)
+        assert isinstance(document_obj, OrderedDict)
+
+    def test_schema_loads(self):
+        """
+        GIVEN a simple match and an extra field in dict format
+        WHEN loading using the schema
+        THEN the extra field should be excluded and the result should be a Match
+        """
+        match = {"match": "hello", "type": "hello", "extra": "field"}
+        schema = MatchSchema()
+
+        match_obj = schema.load(match)
+        assert isinstance(match_obj, Match)