Refine APIGatewayProxy schema + test

Author: trueangle

lambda-events/src/commonMain/kotlin/io/github/trueangle/knative/lambda/runtime/events/apigateway/APIGatewayProxy.kt

@@ -5,7 +5,6 @@ import kotlinx.serialization.Serializable
 
 @Serializable
 data class APIGatewayProxy(
-    @SerialName("version") val version: String?,
     @SerialName("resource") val resource: String?,
     @SerialName("path") val path: String?,
     @SerialName("httpMethod") val httpMethod: String,
@@ -25,14 +24,12 @@ data class APIGatewayProxy(
         @SerialName("stage") val stage: String?,
         @SerialName("resourceId") val resourceId: String?,
         @SerialName("requestId") val requestId: String?,
-        @SerialName("operationName") val operationName: String?,
-        @SerialName("identity") val identity: RequestIdentity?,
+        @SerialName("identity") val identity: Identity?,
         @SerialName("resourcePath") val resourcePath: String?,
         @SerialName("httpMethod") val httpMethod: String,
         @SerialName("apiId") val apiId: String?,
-        @SerialName("deploymentId") val deploymentId: String?,
         @SerialName("path") val path: String?,
-        @SerialName("authorizer") val authorizer: Map<String, Map<String, String>>?,
+        @SerialName("authorizer") val authorizer: Authorizer?,
         @SerialName("extendedRequestId") val extendedRequestId: String?,
         @SerialName("requestTime") val requestTime: String?,
         @SerialName("requestTimeEpoch") val requestTimeEpoch: Long,
@@ -42,19 +39,40 @@ data class APIGatewayProxy(
     )
 
     @Serializable
-    data class RequestIdentity(
+    data class Authorizer(
+        @SerialName("claims") val claims: Map<String, String?>?,
+        @SerialName("scopes") val scopes: String?
+    )
+
+    @Serializable
+    data class Identity(
         @SerialName("cognitoIdentityPoolId") val cognitoIdentityPoolId: String?,
         @SerialName("accountId") val accountId: String?,
         @SerialName("cognitoIdentityId") val cognitoIdentityId: String?,
         @SerialName("caller") val caller: String?,
-        @SerialName("apiKey") val apiKey: String?,
         @SerialName("principalOrgId") val principalOrgId: String?,
         @SerialName("sourceIp") val sourceIp: String?,
         @SerialName("cognitoAuthenticationType") val cognitoAuthenticationType: String?,
         @SerialName("cognitoAuthenticationProvider") val cognitoAuthenticationProvider: String?,
         @SerialName("userArn") val userArn: String?,
         @SerialName("userAgent") val userAgent: String?,
         @SerialName("user") val user: String?,
-        @SerialName("accessKey") val accessKey: String?
+        @SerialName("accessKey") val accessKey: String?,
+        @SerialName("clientCert") val clientCert: ClientCert?
+    )
+
+    @Serializable
+    data class ClientCert(
+        @SerialName("clientCertPem") val clientCertPem: String?,
+        @SerialName("subjectDN") val subjectDN: String?,
+        @SerialName("issuerDN") val issuerDN: String?,
+        @SerialName("serialNumber") val serialNumber: String?,
+        @SerialName("validity") val validity: Validity?
+    )
+
+    @Serializable
+    data class Validity(
+        @SerialName("notBefore") val notBefore: String?,
+        @SerialName("notAfter") val notAfter: String?
     )
 }

lambda-events/src/nativeTest/kotlin/io/github/trueangle/knative/lambda/runtime/events/apigateway/APIGatewayTest.kt

@@ -19,4 +19,11 @@ class APIGatewayTest {
         val jsonString = Resource("$RESOURCES_PATH/example-apigw-v2-custom-authorizer-v1-request.json").readText()
         Json.decodeFromString<APIGatewayCustomAuthorizer>(jsonString)
     }
+
+    @Test
+    fun `WHEN APIGatewayProxy json THEN parse`() {
+        // https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-lambda-proxy-integrations.html#api-gateway-simple-proxy-for-lambda-input-format
+        val jsonString = Resource("$RESOURCES_PATH/example-apigw-proxy-request.json").readText()
+        Json.decodeFromString<APIGatewayProxy>(jsonString)
+    }
 }

lambda-events/src/nativeTest/resources/example-apigw-proxy-request.json

@@ -0,0 +1,79 @@
+{
+  "resource": "/my/path",
+  "path": "/my/path",
+  "httpMethod": "GET",
+  "headers": {
+    "header1": "value1",
+    "header2": "value1,value2"
+  },
+  "multiValueHeaders": {
+    "header1": [
+      "value1"
+    ],
+    "header2": [
+      "value1",
+      "value2"
+    ]
+  },
+  "queryStringParameters": {
+    "parameter1": "value1,value2",
+    "parameter2": "value"
+  },
+  "multiValueQueryStringParameters": {
+    "parameter1": [
+      "value1",
+      "value2"
+    ],
+    "parameter2": [
+      "value"
+    ]
+  },
+  "requestContext": {
+    "accountId": "123456789012",
+    "apiId": "id",
+    "authorizer": {
+      "claims": null,
+      "scopes": null
+    },
+    "domainName": "id.execute-api.us-east-1.amazonaws.com",
+    "domainPrefix": "id",
+    "extendedRequestId": "request-id",
+    "httpMethod": "GET",
+    "identity": {
+      "accessKey": null,
+      "accountId": null,
+      "caller": null,
+      "cognitoAuthenticationProvider": null,
+      "cognitoAuthenticationType": null,
+      "cognitoIdentityId": null,
+      "cognitoIdentityPoolId": null,
+      "principalOrgId": null,
+      "sourceIp": "IP",
+      "user": null,
+      "userAgent": "user-agent",
+      "userArn": null,
+      "clientCert": {
+        "clientCertPem": "CERT_CONTENT",
+        "subjectDN": "www.example.com",
+        "issuerDN": "Example issuer",
+        "serialNumber": "a1:a1:a1:a1:a1:a1:a1:a1:a1:a1:a1:a1:a1:a1:a1:a1",
+        "validity": {
+          "notBefore": "May 28 12:30:02 2019 GMT",
+          "notAfter": "Aug  5 09:36:04 2021 GMT"
+        }
+      }
+    },
+    "path": "/my/path",
+    "protocol": "HTTP/1.1",
+    "requestId": "id=",
+    "requestTime": "04/Mar/2020:19:15:17 +0000",
+    "requestTimeEpoch": 1583349317135,
+    "resourceId": null,
+    "resourcePath": "/my/path",
+    "stage": "$default"
+  },
+  "pathParameters": null,
+  "stageVariables": null,
+  "body": "Hello from Lambda!",
+  "isBase64Encoded": false
+}