Merge branch 'hotfix/0.2.1'

Author: pipinfitriadi

.vscode/launch.json

@@ -15,7 +15,7 @@
                 "-m", "unittest"
             ],
             "preLaunchTask": "Python: Package test linter",
-            "postDebugTask": "Python: Package test report"
+            "postDebugTask": "Python: Package test report passed 100%"
         },
         {
             "name": "RESTful API",

.vscode/tasks.json

@@ -62,6 +62,12 @@
             "command": "${command:python.interpreterPath}",
             "args": ["-m", "coverage", "report", "-m"]
         },
+        {
+            "label": "Python: Package test report passed 100%",
+            "dependsOn": "Python: Package test report",
+            "type": "shell",
+            "command": "if [ $(${command:python.interpreterPath} -m coverage json -q -o /dev/stdout | jq .totals.percent_covered) = 100 ]; then exit; else exit 1; fi"
+        },
         {
             "label": "Python: Package build",
             "type": "shell",

asicverifier/__init__.py

@@ -142,7 +142,7 @@ def asicverifier(
     member_code: str,
     subsystem_code: str,
     asice_type: AsiceType = AsiceType.REQUEST,
-    conf_refresh: bool = None
+    conf_refresh: bool = False
 ) -> dict:
     CONF_PATH: str = (
         f'asicverifier/security-server/{urlparse(security_server_url).netloc}/'
@@ -161,7 +161,15 @@ def asicverifier(
             with ZipFile(BytesIO(response.content)) as zip_file:
                 zip_file.extractall(CONF_PATH)
         except requests.exceptions.HTTPError:
-            logging.error(f"verificationconf: '{response.text}'")
+            logging.error(
+                '\n'.join([
+                    f'{key}: "{value}"'
+                    for key, value in dict(
+                        security_server_url=security_server_url,
+                        verificationconf=response.text
+                    ).items()
+                ])
+            )
             raise
 
     # Asice File
@@ -203,7 +211,20 @@ def asicverifier(
             proc_yes.kill()
             logging.debug(message)
     except requests.exceptions.HTTPError:
-        logging.error(f"Asice: '{response.text}'")
+        logging.error(
+            '\n'.join([
+                f'{key}: "{value}"'
+                for key, value in dict(
+                    security_server_url=security_server_url,
+                    query_id=query_id,
+                    x_road_instance=x_road_instance,
+                    member_class=member_class,
+                    member_code=member_code,
+                    subsystem_code=subsystem_code,
+                    asice=response.text
+                ).items()
+            ])
+        )
         raise
 
     return extract_asice(message)

asicverifier/restful_api.py

@@ -5,9 +5,9 @@
 
 from datetime import datetime
 from os import getenv
-from typing import Any, List
+from typing import List
 
-from fastapi import APIRouter, FastAPI
+from fastapi import APIRouter, FastAPI, HTTPException, Query
 from fastapi.middleware.cors import CORSMiddleware
 from pydantic import (
     BaseModel,
@@ -16,6 +16,7 @@
     HttpUrl,
     NonNegativeInt
 )
+from requests.exceptions import HTTPError
 import uvicorn
 
 from . import AsiceType, asicverifier, META_DATA, SUMMARY
@@ -95,17 +96,16 @@ class Asice(BaseModel):
     file: List[AsicFile]
 
 
-StringNoneEmptySpace: Any = Field(pattern=r'^[\w\-]+$')
+non_empty_str: str = r'^[\w\-]+$'
 
 
 class AsicVerifier(BaseModel):
-    security_server_url: HttpUrl
-    query_id: str = StringNoneEmptySpace
-    x_road_instance: str = StringNoneEmptySpace
-    member_class: str = StringNoneEmptySpace
-    member_code: str = StringNoneEmptySpace
-    subsystem_code: str = StringNoneEmptySpace
-    asice_type: AsiceType = AsiceType.REQUEST
+    security_server_url: HttpUrl = Field(alias='securityServerUrl')
+    query_id: str = Field(alias='queryId', pattern=non_empty_str)
+    x_road_instance: str = Field(alias='xRoadInstance', pattern=non_empty_str)
+    member_class: str = Field(alias='memberClass', pattern=non_empty_str)
+    member_code: str = Field(alias='memberCode', pattern=non_empty_str)
+    subsystem_code: str = Field(alias='subsystemCode', pattern=non_empty_str)
 
 
 class RestfulApi:
@@ -119,6 +119,16 @@ def app() -> FastAPI:
         api: FastAPI = FastAPI(
             title=SUMMARY,
             version=META_DATA['Version'],
+            contact=dict(
+                name=META_DATA['Author'],
+                url=META_DATA['Home-page'],
+                email=META_DATA['Author-email']
+            ),
+            license_info=dict(
+                name=META_DATA['License'],
+                identifier=META_DATA['License'],
+                url=f"{META_DATA['Home-page']}/blob/main/LICENSE"
+            ),
             docs_url=f'{RESTFUL_API_PATH}/docs',
             redoc_url=f'{RESTFUL_API_PATH}/redoc',
             openapi_url=f'{RESTFUL_API_PATH}/openapi.json'
@@ -138,15 +148,20 @@ def app() -> FastAPI:
 
         @router.post('/')
         async def verifier(
-            data: AsicVerifier, conf_refresh: bool = None
+            data: AsicVerifier,
+            asice_type: AsiceType = Query(
+                None, alias='type', description='Default is request'
+            ),
+            conf_refresh: bool = Query(None, description='Default is false')
         ) -> Asice:
-            return asicverifier(
-                **{
-                    key: value if key == 'asice_type' else f'{value}'
-                    for key, value in data
-                },
-                conf_refresh=conf_refresh
-            )
+            try:
+                return asicverifier(
+                    **{key: f'{value}' for key, value in data},
+                    asice_type=asice_type if asice_type else AsiceType.REQUEST,
+                    conf_refresh=conf_refresh
+                )
+            except HTTPError as error:
+                raise HTTPException(error.response.status_code)
 
         api.include_router(router, prefix=RESTFUL_API_PATH)
         return api

tests/test_restful_api.py

@@ -35,16 +35,31 @@ def test_app(self, _):
         self.assertDictEqual(
             client.post(
                 '/',
-                params={'conf_refresh': True},
+                params={'conf_refresh': True, 'type': ASICE_TYPE.value},
                 json={
-                    'security_server_url': URL,
-                    'query_id': QUERY_ID,
-                    'x_road_instance': X_ROAD_INSTANCE,
-                    'member_class': MEMBER_CLASS,
-                    'member_code': MEMBER_CODE,
-                    'subsystem_code': SUBSYSTEM_CODE,
-                    'asice_type': ASICE_TYPE.value
+                    'securityServerUrl': URL,
+                    'queryId': QUERY_ID,
+                    'xRoadInstance': X_ROAD_INSTANCE,
+                    'memberClass': MEMBER_CLASS,
+                    'memberCode': MEMBER_CODE,
+                    'subsystemCode': SUBSYSTEM_CODE
                 }
             ).json(object_hook=datetime_parser),
             ASIC_VERIFIER_RESPONSE
         )
+
+        with self.assertRaises(AttributeError):
+            self.assertEqual(
+                client.post(
+                    '/',
+                    params={'conf_refresh': True, 'type': ASICE_TYPE.value},
+                    json={
+                        'securityServerUrl': URL.replace('https', 'http'),
+                        'queryId': QUERY_ID,
+                        'xRoadInstance': X_ROAD_INSTANCE,
+                        'memberClass': MEMBER_CLASS,
+                        'memberCode': MEMBER_CODE,
+                        'subsystemCode': SUBSYSTEM_CODE
+                    }
+                ).status_code
+            )