Merge pull request #88 from eadwinCode/restore_test_coverage

restored test coverage to 100%

Author: eadwinCode

ninja_extra/controllers/model/builder.py

@@ -145,7 +145,7 @@ def _register_list_endpoint(self) -> None:
                 pagination_class=self._config.pagination.klass,
                 pagination_response_schema=self._config.pagination.pagination_schema,
             )
-            if self._config.pagination.paginator_kwargs:
+            if self._config.pagination.paginator_kwargs:  # pragma: no cover
                 paginate_kwargs.update(self._config.pagination.paginator_kwargs)
 
         list_items = ModelEndpointFactory.list(

ninja_extra/controllers/model/endpoints.py

@@ -287,7 +287,7 @@ def update_item(
                 else self.service.get_one(pk=pk, **kwargs)
             )
 
-            if not obj:
+            if not obj:  # pragma: no cover
                 raise NotFound()
 
             self.check_object_permissions(obj)
@@ -362,7 +362,7 @@ def patch_item(
                 if object_getter
                 else self.service.get_one(pk=pk, **kwargs)
             )
-            if not obj:
+            if not obj:  # pragma: no cover
                 raise NotFound()
             self.check_object_permissions(obj)
             instance = (
@@ -430,7 +430,7 @@ def get_item(self: "ModelControllerBase", **kwargs: t.Any) -> t.Any:
                 if object_getter
                 else self.service.get_one(pk=pk, **kwargs)
             )
-            if not obj:
+            if not obj:  # pragma: no cover
                 raise NotFound()
             self.check_object_permissions(obj)
             return obj
@@ -579,7 +579,7 @@ def delete_item(self: "ModelControllerBase", **kwargs: t.Any) -> t.Any:
                 if object_getter
                 else self.service.get_one(pk=pk, **kwargs)
             )
-            if not obj:
+            if not obj:  # pragma: no cover
                 raise NotFound()
             self.check_object_permissions(obj)
             custom_handler(

ninja_extra/controllers/model/schemas.py

@@ -32,12 +32,6 @@ class ModelPagination(PydanticModel):
     paginator_kwargs: Optional[dict] = None
     pagination_schema: Type[PydanticModel] = PaginatedResponseSchema
 
-    @validator("klass", allow_reuse=True)
-    def validate_klass(cls, value: Any) -> Any:
-        if isinstance(value, type) and issubclass(value, PaginationBase):
-            return value
-        raise ValueError(f"{value} is not of type `PaginationBase`")
-
     @validator("pagination_schema", allow_reuse=True)
     def validate_schema(cls, value: Any) -> Any:
         if (
@@ -106,24 +100,6 @@ def validate_allow_routes(cls, value: List[Any]) -> Any:
                 raise ValueError(f"'{item}' action is not recognized in [{defaults}]")
         return value
 
-    @validator("model", allow_reuse=True)
-    def validate_model(cls, value: Any) -> Any:
-        if value and hasattr(value, "objects"):
-            return value
-        raise ValueError(f"{value} is not a valid Django model.")
-
-    @validator(
-        "create_schema",
-        "retrieve_schema",
-        "update_schema",
-        "patch_schema",
-        allow_reuse=True,
-    )
-    def validate_schemas(cls, value: Any) -> Any:
-        if value and not issubclass(value, PydanticModel):
-            raise ValueError(f"{value} is not a valid pydantic type.")
-        return value
-
     def __init__(self, **kwargs: Any) -> None:
         super().__init__(**kwargs)
         self.generate_all_schema()
@@ -162,7 +138,7 @@ def generate_all_schema(self) -> None:
         if self.schema_config.include == "__all__":
             working_fields = set(all_fields)
 
-        elif self.schema_config.include and self.schema_config.include != "__all__":
+        if self.schema_config.include and self.schema_config.include != "__all__":
             include_fields = set(self.schema_config.include)
             working_fields = include_fields
 

tests/test_model_controller/test_model_controller_configurations.py

@@ -1,6 +1,7 @@
 import pytest
+from ninja_schema.errors import ConfigError
 
-from ninja_extra import ModelConfig, ModelPagination
+from ninja_extra import ModelConfig, ModelPagination, ModelSchemaConfig
 from ninja_extra.pagination import PageNumberPaginationExtra
 from ninja_extra.schemas import PaginatedResponseSchema, RouteParameter
 
@@ -42,6 +43,98 @@ def test_default_model_config():
     }
 
 
+def test_include_gen_schema():
+    model_config = ModelConfig(
+        model=Event,
+        allowed_routes=["list", "find_one"],
+        schema_config=ModelSchemaConfig(include=["title", "start_date", "end_date"]),
+    )
+    assert model_config.create_schema is None
+    assert model_config.patch_schema is None
+    assert model_config.update_schema is None
+
+    assert model_config.retrieve_schema.schema() == {
+        "title": "EventSchema",
+        "type": "object",
+        "properties": {
+            "id": {"title": "Id", "type": "integer"},
+            "title": {"title": "Title", "maxLength": 100, "type": "string"},
+            "start_date": {"title": "Start Date", "type": "string", "format": "date"},
+            "end_date": {"title": "End Date", "type": "string", "format": "date"},
+        },
+        "required": ["id", "title", "start_date", "end_date"],
+    }
+
+
+def test_exclude_gen_schema():
+    model_config = ModelConfig(
+        model=Event,
+        allowed_routes=["list", "find_one"],
+        schema_config=ModelSchemaConfig(exclude=["start_date", "end_date"]),
+    )
+    assert model_config.create_schema is None
+    assert model_config.patch_schema is None
+    assert model_config.update_schema is None
+
+    assert model_config.retrieve_schema.schema() == {
+        "properties": {
+            "category_id": {"title": "Category", "type": "integer"},
+            "id": {"title": "Id", "type": "integer"},
+            "title": {"maxLength": 100, "title": "Title", "type": "string"},
+        },
+        "required": ["id", "title"],
+        "title": "EventSchema",
+        "type": "object",
+    }
+
+
+def test_update_schema_created_in_absence_of_create_schema():
+    model_config = ModelConfig(
+        model=Event,
+        allowed_routes=["update", "patch"],
+        schema_config=ModelSchemaConfig(include=["title", "start_date", "end_date"]),
+    )
+    assert model_config.create_schema is None
+    assert model_config.retrieve_schema is not None
+    assert model_config.patch_schema is not None
+    assert model_config.update_schema is not None
+
+
+def test_create_schema_invalid_key():
+    model_config = ModelConfig(
+        model=Event,
+        allowed_routes=["create"],
+        schema_config=ModelSchemaConfig(include=["title", "start_date", "end_date"]),
+    )
+    assert model_config.create_schema is not None
+    assert model_config.retrieve_schema is not None
+
+    assert model_config.update_schema is None
+    assert model_config.patch_schema is None
+
+    with pytest.raises(ConfigError):
+        ModelConfig(
+            model=Event,
+            allowed_routes=["update", "patch"],
+            schema_config=ModelSchemaConfig(
+                include=["title", "start_date", "end_date"],
+                write_only_fields=["invalid"],
+            ),
+        )
+
+
+def test_retrieve_schema_invalid_key():
+    with pytest.raises(ConfigError):
+        ModelConfig(
+            model=Event,
+            allowed_routes=["update", "patch"],
+            schema_config=ModelSchemaConfig(
+                include=["title", "start_date", "end_date"],
+                read_only_fields=["invalid"],
+            ),
+        )
+
+
 def test_invalid_django_model():
     with pytest.raises(ValueError):
         ModelConfig(model=InvalidTypeORSchema)

tests/test_model_controller/test_model_endpoint_factory.py

@@ -0,0 +1,8 @@
+import pytest
+
+from ninja_extra import ModelEndpointFactory
+
+
+def test_path_parameter_duplicate():
+    with pytest.raises(ValueError):
+        ModelEndpointFactory.delete(path="/{int:ex}/somewhere/{ex}", lookup_param="any")