Return list of ValidationError in all cases from REST API upon HTTP 422

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to this project from version 0.9.3 onwards are documented in this file.
 
+## 0.9.8 - 2023-11-21
+
+### Fixes
+
+- HTTP 422 errors from REST API do not return a list of ValidationErrors in some cases (#54)
+
 ## 0.9.7 - 2023-11-03
 
 ### Fixes

VERSION.txt

@@ -1 +1 @@
-0.9.7
+0.9.8

pkilint/rest/cabf_serverauth.py

@@ -1,5 +1,6 @@
 from fastapi import HTTPException
 from pyasn1.error import PyAsn1Error
+from starlette import status
 
 from pkilint.cabf import serverauth
 from pkilint.cabf.serverauth import serverauth_constants
@@ -17,7 +18,10 @@ def determine_linter(self, doc):
         except (ValueError, PyAsn1Error) as e:
             message = f'Parsing error occurred: {e}'
 
-            raise HTTPException(status_code=422, detail=message)
+            raise HTTPException(
+                status_code=status.HTTP_422_UNPROCESSABLE_ENTITY,
+                detail=model.create_unprocessable_entity_error_detail(message)
+            )
 
         # this doesn't fail, so we don't need to guard against not being able to determine the certificate type
         return next((l for l in self.linters if l.name.casefold() == cert_type.to_option_str.casefold()))

pkilint/rest/cabf_smime.py

@@ -1,5 +1,6 @@
 from fastapi import HTTPException
 from pyasn1.error import PyAsn1Error
+from starlette import status
 
 from pkilint.cabf import smime
 from pkilint.cabf.smime import smime_constants
@@ -17,10 +18,16 @@ def determine_linter(self, doc):
         except (ValueError, PyAsn1Error) as e:
             message = f'Parsing error occurred: {e}'
 
-            raise HTTPException(status_code=422, detail=message)
+            raise HTTPException(
+                status_code=status.HTTP_422_UNPROCESSABLE_ENTITY,
+                detail=model.create_unprocessable_entity_error_detail(message)
+            )
 
         if v_g is None:
-            raise HTTPException(status_code=422, detail='Could not determine certificate type')
+            raise HTTPException(
+                status_code=status.HTTP_422_UNPROCESSABLE_ENTITY,
+                detail=model.create_unprocessable_entity_error_detail('Could not determine certificate type')
+            )
 
         v, g = v_g
 

pkilint/rest/model.py

@@ -128,3 +128,13 @@ def validate(self) -> 'CertificateModel':
     @property
     def parsed_document(self):
         return self._parsed_document
+
+
+def create_unprocessable_entity_error_detail(message: str, error_type: str = 'value_error'):
+    return [
+        {
+            'loc': ['body'],
+            'type': error_type,
+            'message': message,
+        }
+    ]

tests/test_server.py

@@ -142,6 +142,18 @@ def test_version(client):
 '''
 
 
+def _assert_validationerror_list_present(resp):
+    j = resp.json()
+
+    detail_list = j['detail']
+    assert len(detail_list) == 1
+
+    detail_0 = detail_list[0]
+    assert detail_0['loc'] == ['body']
+    assert detail_0['type'] == 'value_error'
+    assert 'message' in detail_0
+
+
 def test_groups(client):
     resp = client.get('/certificate')
     assert resp.status_code == HTTPStatus.OK
@@ -199,11 +211,15 @@ def test_smime_detect_bad_extension_der(client):
     resp = client.post('/certificate/cabf-smime', json={'pem': _BAD_CERT_POLICIES_DER_PEM})
     assert resp.status_code == HTTPStatus.UNPROCESSABLE_ENTITY
 
+    _assert_validationerror_list_present(resp)
+
 
 def test_smime_detect_not_smime(client):
     resp = client.post('/certificate/cabf-smime', json={'pem': _OV_FINAL_CLEAN_PEM})
     assert resp.status_code == HTTPStatus.UNPROCESSABLE_ENTITY
 
+    _assert_validationerror_list_present(resp)
+
 
 def test_lint_smime_unknown_linter(client):
     resp = client.post('/certificate/cabf-smime/lint/FOOMASTER-BAR', json={'pem': _SMBR_SPONSORED_STRICT_PEM})
@@ -251,6 +267,8 @@ def test_detect_and_lint_smime_with_tls(client):
     resp = client.post('/certificate/cabf-smime', json={'pem': _OV_FINAL_CLEAN_PEM})
     assert resp.status_code == HTTPStatus.UNPROCESSABLE_ENTITY
 
+    _assert_validationerror_list_present(resp)
+
 
 def test_serverauth_no_cert(client):
     resp = client.post('/certificate/cabf-serverauth', json={})
@@ -288,6 +306,8 @@ def test_serverauth_detect_bad_extension_der(client):
     resp = client.post('/certificate/cabf-serverauth', json={'pem': _BAD_CERT_POLICIES_DER_PEM})
     assert resp.status_code == HTTPStatus.UNPROCESSABLE_ENTITY
 
+    _assert_validationerror_list_present(resp)
+
 
 def test_lint_serverauth_unknown_linter(client):
     resp = client.post('/certificate/cabf-serverauth/FOOMASTER-BAR', json={'pem': _OV_FINAL_CLEAN_PEM})