added test for changing plain text error response to json response

Author: eadwinCode

tests/test_application/test_application_functions.py

@@ -174,7 +174,10 @@ async def homepage(request: Request):
         client = TestClient(app, raise_server_exceptions=False)
         response = client.get("/")
         assert response.status_code == 500
-        assert "Internal Server Error" in response.text
+        assert response.json() == {
+            "detail": "Internal server error",
+            "status_code": 500,
+        }
         assert app.debug
 
 
@@ -199,7 +202,7 @@ def test_app_staticfiles_route(self, tmpdir):
 
         response = client.post("/static/example.txt")
         assert response.status_code == 405
-        assert response.text == "Method Not Allowed"
+        assert response.json() == {"detail": "Method Not Allowed", "status_code": 405}
 
     def test_app_staticfiles_with_different_static_path(self, tmpdir):
         path = os.path.join(tmpdir, "example.txt")

tests/test_exceptions/test_api_exception.py

@@ -1,3 +1,5 @@
+import http
+
 import pytest
 
 from ellar.common import get
@@ -33,23 +35,31 @@ def exception_():
 @pytest.mark.parametrize(
     "exception, status_code, default_detail",
     [
-        (APIException, APIException.status_code, APIException.default_detail),
+        (
+            APIException,
+            APIException.status_code,
+            http.HTTPStatus(APIException.status_code).phrase,
+        ),
         (
             AuthenticationFailed,
             AuthenticationFailed.status_code,
-            AuthenticationFailed.default_detail,
+            "Incorrect authentication credentials.",
+        ),
+        (
+            NotAcceptable,
+            NotAcceptable.status_code,
+            http.HTTPStatus(NotAcceptable.status_code).phrase,
         ),
-        (NotAcceptable, NotAcceptable.status_code, NotAcceptable.default_detail),
         (
             NotAuthenticated,
             NotAuthenticated.status_code,
-            NotAuthenticated.default_detail,
+            http.HTTPStatus(NotAuthenticated.status_code).phrase,
         ),
-        (NotFound, NotFound.status_code, NotFound.default_detail),
+        (NotFound, NotFound.status_code, http.HTTPStatus(NotFound.status_code).phrase),
         (
             PermissionDenied,
             PermissionDenied.status_code,
-            PermissionDenied.default_detail,
+            http.HTTPStatus(PermissionDenied.status_code).phrase,
         ),
     ],
 )
@@ -64,21 +74,17 @@ def test_api_exception(exception, status_code, default_detail):
 
 def test_unsupported_media_type_api_exception():
     global _exception_runner
-    media_type = "application/json/sx"
-    _exception_runner = ExceptionRunner(UnsupportedMediaType, media_type=media_type)
+    _exception_runner = ExceptionRunner(UnsupportedMediaType)
     response = client.get("/exception")
     data = response.json()
     assert response.status_code == UnsupportedMediaType.status_code
-    assert data["detail"] == UnsupportedMediaType.default_detail.format(
-        media_type=media_type
-    )
+    assert data["detail"] == http.HTTPStatus(UnsupportedMediaType.status_code).phrase
 
 
 def test_method_not_allowed_api_exception():
     global _exception_runner
-    method = "GET"
-    _exception_runner = ExceptionRunner(MethodNotAllowed, method=method)
+    _exception_runner = ExceptionRunner(MethodNotAllowed)
     response = client.get("/exception")
     data = response.json()
     assert response.status_code == MethodNotAllowed.status_code
-    assert data["detail"] == MethodNotAllowed.default_detail.format(method=method)
+    assert data["detail"] == http.HTTPStatus(MethodNotAllowed.status_code).phrase

tests/test_exceptions/test_custom_exceptions.py

@@ -88,7 +88,7 @@ def test_invalid_handler_raise_exception():
     ]
 
 
-def test_invalid_iexception_handler_setup_raise_exception():
+def test_invalid_exception_handler_setup_raise_exception():
     with pytest.raises(AssertionError) as ex:
 
         class InvalidExceptionSetup(IExceptionHandler):
@@ -97,7 +97,33 @@ def catch(
             ) -> t.Union[Response, t.Any]:
                 pass
 
-    assert "exception_type_or_code must be defined" in str(ex.value)
+    assert "'exception_type_or_code' must be defined" in str(ex.value)
+
+
+def test_invalid_exception_type_setup_raise_exception():
+    with pytest.raises(AssertionError) as ex:
+
+        class InvalidExceptionSetup(IExceptionHandler):
+            exception_type_or_code = ""
+
+            def catch(
+                self, ctx: IExecutionContext, exc: t.Any
+            ) -> t.Union[Response, t.Any]:
+                pass
+
+        assert "'exception_type_or_code' must be defined" in str(ex.value)
+
+    with pytest.raises(AssertionError) as ex:
+
+        class InvalidExceptionSetup2(IExceptionHandler):
+            exception_type_or_code = InvalidExceptionHandler
+
+            def catch(
+                self, ctx: IExecutionContext, exc: t.Any
+            ) -> t.Union[Response, t.Any]:
+                pass
+
+        assert "'exception_type_or_code' is not a valid type" in str(ex.value)
 
 
 def test_custom_exception_works():
@@ -167,7 +193,7 @@ def homepage():
     client = tm.get_client()
     res = client.get("/")
     assert res.status_code == 400
-    assert res.text == "Bad Request"
+    assert res.json() == {"detail": "Bad Request", "status_code": 400}
 
 
 @pytest.mark.parametrize("status_code", [204, 304])

tests/test_exceptions/test_error_details.py

@@ -1,33 +1,33 @@
-from ellar.core.exceptions.base import ErrorDetail
-
-
-class TestErrorDetail:
-    def test_eq(self):
-        assert ErrorDetail("msg") == ErrorDetail("msg")
-        assert ErrorDetail("msg", "code") == ErrorDetail("msg", code="code")
-
-        assert ErrorDetail("msg") == "msg"
-        assert ErrorDetail("msg", "code") == "msg"
-
-    def test_ne(self):
-        assert ErrorDetail("msg1") != ErrorDetail("msg2")
-        assert ErrorDetail("msg") != ErrorDetail("msg", code="invalid")
-
-        assert ErrorDetail("msg1") != "msg2"
-        assert ErrorDetail("msg1", "code") != "msg2"
-
-    def test_repr(self):
-        assert repr(
-            ErrorDetail("msg1")
-        ) == "ErrorDetail(string={!r}, code=None)".format("msg1")
-        assert repr(
-            ErrorDetail("msg1", "code")
-        ) == "ErrorDetail(string={!r}, code={!r})".format("msg1", "code")
-
-    def test_str(self):
-        assert str(ErrorDetail("msg1")) == "msg1"
-        assert str(ErrorDetail("msg1", "code")) == "msg1"
-
-    def test_hash(self):
-        assert hash(ErrorDetail("msg")) == hash("msg")
-        assert hash(ErrorDetail("msg", "code")) == hash("msg")
+# from ellar.core.exceptions.base import ErrorDetail
+#
+#
+# class TestErrorDetail:
+#     def test_eq(self):
+#         assert ErrorDetail("msg") == ErrorDetail("msg")
+#         assert ErrorDetail("msg", "code") == ErrorDetail("msg", code="code")
+#
+#         assert ErrorDetail("msg") == "msg"
+#         assert ErrorDetail("msg", "code") == "msg"
+#
+#     def test_ne(self):
+#         assert ErrorDetail("msg1") != ErrorDetail("msg2")
+#         assert ErrorDetail("msg") != ErrorDetail("msg", code="invalid")
+#
+#         assert ErrorDetail("msg1") != "msg2"
+#         assert ErrorDetail("msg1", "code") != "msg2"
+#
+#     def test_repr(self):
+#         assert repr(
+#             ErrorDetail("msg1")
+#         ) == "ErrorDetail(string={!r}, code=None)".format("msg1")
+#         assert repr(
+#             ErrorDetail("msg1", "code")
+#         ) == "ErrorDetail(string={!r}, code={!r})".format("msg1", "code")
+#
+#     def test_str(self):
+#         assert str(ErrorDetail("msg1")) == "msg1"
+#         assert str(ErrorDetail("msg1", "code")) == "msg1"
+#
+#     def test_hash(self):
+#         assert hash(ErrorDetail("msg")) == hash("msg")
+#         assert hash(ErrorDetail("msg", "code")) == hash("msg")

tests/test_openapi/test_module.py

@@ -106,12 +106,12 @@ def test_openapi_module_with_route_guards():
 
     response = client.get("openapi.json")
     assert response.status_code == 403
-    assert response.text == "Not Allowed"
+    assert response.json() == {"detail": "Not Allowed", "status_code": 403}
 
     response = client.get("docs")
     assert response.status_code == 403
-    assert response.text == "Not Allowed"
+    assert response.json() == {"detail": "Not Allowed", "status_code": 403}
 
     response = client.get("redoc")
     assert response.status_code == 403
-    assert response.text == "Not Allowed"
+    assert response.json() == {"detail": "Not Allowed", "status_code": 403}

tests/test_routing/test_path.py

@@ -256,12 +256,32 @@ def test_get_path(path, expected_status, expected_response):
         ("/path/param-starlette-str/foobar", 200, "foobar"),
         ("/path/param-starlette-int/0", 200, 0),
         ("/path/param-starlette-int/42", 200, 42),
-        ("/path/param-starlette-int/42.5", 404, b"Not Found"),
-        ("/path/param-starlette-int/-1", 404, b"Not Found"),
-        ("/path/param-starlette-int/True", 404, b"Not Found"),
-        ("/path/param-starlette-int/foobar", 404, b"Not Found"),
+        (
+            "/path/param-starlette-int/42.5",
+            404,
+            {"detail": "Not Found", "status_code": 404},
+        ),
+        (
+            "/path/param-starlette-int/-1",
+            404,
+            {"detail": "Not Found", "status_code": 404},
+        ),
+        (
+            "/path/param-starlette-int/True",
+            404,
+            {"detail": "Not Found", "status_code": 404},
+        ),
+        (
+            "/path/param-starlette-int/foobar",
+            404,
+            {"detail": "Not Found", "status_code": 404},
+        ),
         ("/path/param-starlette-int-str/42", 200, "42"),
-        ("/path/param-starlette-int-str/42.5", 404, b"Not Found"),
+        (
+            "/path/param-starlette-int-str/42.5",
+            404,
+            {"detail": "Not Found", "status_code": 404},
+        ),
         (
             "/path/param-starlette-uuid/31ea378c-c052-4b4c-bf0b-679ce5cfcc2a",
             200,
@@ -270,7 +290,7 @@ def test_get_path(path, expected_status, expected_response):
         (
             "/path/param-starlette-uuid/31ea378c-c052-4b4c-bf0b-679ce5cfcc2",
             404,
-            b"Not Found",
+            {"detail": "Not Found", "status_code": 404},
         ),
     ],
 )

tests/test_staticfiles.py

@@ -79,7 +79,7 @@ def test_staticfiles_post(tmpdir):
 
     response = client.post("/example.txt")
     assert response.status_code == 405
-    assert response.text == "Method Not Allowed"
+    assert response.json() == {"detail": "Method Not Allowed", "status_code": 405}
 
 
 def test_staticfiles_with_directory_returns_404(tmpdir):
@@ -93,7 +93,7 @@ def test_staticfiles_with_directory_returns_404(tmpdir):
 
     response = client.get("/")
     assert response.status_code == 404
-    assert response.text == "Not Found"
+    assert response.json() == {"detail": "Not Found", "status_code": 404}
 
 
 def test_staticfiles_with_missing_file_returns_404(tmpdir):
@@ -107,7 +107,7 @@ def test_staticfiles_with_missing_file_returns_404(tmpdir):
 
     response = client.get("/404.txt")
     assert response.status_code == 404
-    assert response.text == "Not Found"
+    assert response.json() == {"detail": "Not Found", "status_code": 404}
 
 
 def test_staticfiles_instantiated_with_missing_directory(tmpdir):
@@ -375,7 +375,7 @@ def test_staticfiles_with_invalid_dir_permissions_returns_401(tmpdir):
 
     response = client.get("/example.txt")
     assert response.status_code == 401
-    assert response.text == "Unauthorized"
+    assert response.json() == {"detail": "Unauthorized", "status_code": 401}
 
 
 def test_staticfiles_with_missing_dir_returns_404(tmpdir):
@@ -389,7 +389,7 @@ def test_staticfiles_with_missing_dir_returns_404(tmpdir):
 
     response = client.get("/foo/example.txt")
     assert response.status_code == 404
-    assert response.text == "Not Found"
+    assert response.json() == {"detail": "Not Found", "status_code": 404}
 
 
 def test_staticfiles_access_file_as_dir_returns_404(tmpdir):
@@ -403,7 +403,7 @@ def test_staticfiles_access_file_as_dir_returns_404(tmpdir):
 
     response = client.get("/example.txt/foo")
     assert response.status_code == 404
-    assert response.text == "Not Found"
+    assert response.json() == {"detail": "Not Found", "status_code": 404}
 
 
 def test_staticfiles_unhandled_os_error_returns_500(tmpdir, monkeypatch):
@@ -422,4 +422,4 @@ def mock_timeout(*args, **kwargs):
 
     response = client.get("/example.txt")
     assert response.status_code == 500
-    assert response.text == "Internal Server Error"
+    assert response.json() == {"detail": "Internal server error", "status_code": 500}