Merge pull request #32 from bakdata/feature/api-gateway-support

Feature/api gateway support

Author: philipp94831

.gitignore

@@ -4,4 +4,5 @@ __pycache__/
 .idea/
 *.iml
 build/
-venv/
+venv/
+packaged.yaml

README.md

@@ -40,7 +40,7 @@ cat response.txt
 
 The expected result should look similar to this:
 ```json
-{"result":2}
+2
 ```
 
 ### Using packages
@@ -77,7 +77,7 @@ cat response.txt
 
 The expected result should look similar to this:
 ```json
-{"result":[4,5,6]}
+[4,5,6]
 ```
 
 ## Provided layers
@@ -213,7 +213,7 @@ The handler must be separated by `.`, e.g., `script.handler`.
 
 The lambda payload is unwrapped as named arguments to the R function to call, e.g., `{"x":1}` is unwrapped to `handler(x=1)`.
 
-The lambda function returns whatever is returned by the R function as a JSON object with `result` as a root element.
+The lambda function returns whatever is returned by the R function as a JSON object.
 
 ### Building custom layers
 

runtime/src/runtime.R

@@ -64,7 +64,7 @@ throwRuntimeError <- function(error, REQUEST_ID) {
 
 postResult <- function(result, REQUEST_ID) {
     url <- paste0(API_ENDPOINT, "invocation/", REQUEST_ID, "/response")
-    res <- POST(url, body = list(result = result), encode = "json")
+    res <- POST(url, body = toJSON(result, auto_unbox = TRUE), encode = "raw", content_type_json())
     loginfo("Posted result:\n%s", to_str(res))
 }
 

template.yaml

@@ -3,7 +3,6 @@ Transform: 'AWS::Serverless-2016-10-31'
 Globals:
   Function:
     Runtime: provided
-    CodeUri: tests/R/
     Timeout: 300
     MemorySize: 3008
     Layers:
@@ -13,42 +12,72 @@ Resources:
     Type: 'AWS::Serverless::Function'
     Properties:
       Handler: script.handler
+      CodeUri: tests/R/
+      FunctionName: ExampleFunction
   LowerCaseExtensionFunction:
     Type: 'AWS::Serverless::Function'
     Properties:
       Handler: lowercase.handler
+      CodeUri: tests/R/
+      FunctionName: LowerCaseExtensionFunction
   MissingFunctionFunction:
     Type: 'AWS::Serverless::Function'
     Properties:
       Handler: script.handler_missing
+      CodeUri: tests/R/
+      FunctionName: MissingFunctionFunction
   MissingSourceFileFunction:
     Type: 'AWS::Serverless::Function'
     Properties:
       Handler: missing.handler
+      CodeUri: tests/R/
+      FunctionName: MissingSourceFileFunction
   MultipleArgumentsFunction:
     Type: 'AWS::Serverless::Function'
     Properties:
       Handler: script.handler_with_multiple_arguments
+      CodeUri: tests/R/
+      FunctionName: MultipleArgumentsFunction
   VariableArgumentsFunction:
     Type: 'AWS::Serverless::Function'
     Properties:
       Handler: script.handler_with_variable_arguments
+      CodeUri: tests/R/
+      FunctionName: VariableArgumentsFunction
   MatrixFunction:
     Type: 'AWS::Serverless::Function'
     Properties:
       Handler: matrix.handler
+      CodeUri: tests/R/
       Layers:
         - !Ref RecommendedLayer
+      FunctionName: MatrixFunction
   MissingLibraryFunction:
     Type: 'AWS::Serverless::Function'
     Properties:
       Handler: matrix.handler
+      CodeUri: tests/R/
+      FunctionName: MissingLibraryFunction
   AWSFunction:
     Type: 'AWS::Serverless::Function'
     Properties:
       Handler: aws.handler
+      CodeUri: tests/R/
       Layers:
         - !Ref AWSLayer
+      FunctionName: AWSFunction
+  ApiFunction:
+    Type: 'AWS::Serverless::Function'
+    Properties:
+      Handler: api.handler
+      CodeUri: tests/R/
+      FunctionName: ApiFunction
+      Events:
+        Api:
+          Type: Api
+          Properties:
+            Path: '/hello'
+            Method: GET
   RuntimeLayer:
     Type: AWS::Serverless::LayerVersion
     Properties:

tests/R/api.R

@@ -0,0 +1,11 @@
+library(jsonlite)
+
+handler <- function(headers, multiValueHeaders, queryStringParameters, multiValueQueryStringParameters, pathParameters, body, ...) {
+    return(
+        list(
+            statusCode = 200,
+            headers = list("Content-Type" = "application/json"),
+            body = toJSON(list(hello = queryStringParameters$who), auto_unbox = TRUE)
+        )
+    )
+}

tests/aws_lambda.py tests/sam.pytests/aws_lambda.py renamed to tests/sam.py

@@ -7,6 +7,31 @@
 from tests import wait_for_port
 
 
+class LocalApi:
+
+    def __init__(self, host: str = '127.0.0.1', port: int = 3000):
+        self.host = host
+        self.port = port
+        self.process = Popen(['sam', 'local', 'start-api', '--host', self.host, '--port', str(self.port)])
+
+    def kill(self):
+        self.process.kill()
+        return_code = self.process.wait()
+        logging.info('Killed server with code %s', return_code)
+
+    def wait(self, interval: int = 10, retries: int = 6):
+        wait_for_port(self.port, self.host, interval=interval, retries=retries)
+
+    def get_uri(self) -> str:
+        return 'http://{}:{}'.format(self.host, self.port)
+
+
+def start_local_api() -> LocalApi:
+    server = LocalApi()
+    server.wait()
+    return server
+
+
 class LocalLambdaServer:
 
     def __init__(self, host: str = '127.0.0.1', port: int = 3001):

tests/test_api.py

@@ -0,0 +1,22 @@
+import unittest
+
+import requests
+
+from tests.sam import LocalApi, start_local_api
+
+
+class TestApi(unittest.TestCase):
+    api: LocalApi = None
+
+    @classmethod
+    def setUpClass(cls):
+        cls.api = start_local_api()
+
+    def test_matrix(self):
+        response = requests.get('%s/hello' % self.api.get_uri(), params={'who': 'World'})
+        result = response.json()
+        self.assertDictEqual({'hello': 'World'}, result)
+
+    @classmethod
+    def tearDownClass(cls):
+        cls.api.kill()

tests/test_aws.py

@@ -1,7 +1,7 @@
 import json
 import unittest
 
-from tests.aws_lambda import LocalLambdaServer, start_local_lambda
+from tests.sam import LocalLambdaServer, start_local_lambda
 
 
 class TestAWSLayer(unittest.TestCase):
@@ -15,8 +15,7 @@ def test_s3_get_object(self):
         lambda_client = self.lambda_server.get_client()
         response = lambda_client.invoke(FunctionName="AWSFunction")
         raw_payload = response['Payload'].read().decode('utf-8')
-        json_payload = json.loads(raw_payload)
-        result = json_payload['result']
+        result = json.loads(raw_payload)
         self.assertEqual(len(result), 1)
         self.assertDictEqual(result[0], {
             "DRG.Definition": "039 - EXTRACRANIAL PROCEDURES W/O CC/MCC",

tests/test_matrix.py

@@ -1,7 +1,7 @@
 import json
 import unittest
 
-from tests.aws_lambda import LocalLambdaServer, start_local_lambda
+from tests.sam import LocalLambdaServer, start_local_lambda
 
 
 class TestRecommendedLayer(unittest.TestCase):
@@ -15,8 +15,7 @@ def test_matrix(self):
         lambda_client = self.lambda_server.get_client()
         response = lambda_client.invoke(FunctionName="MatrixFunction")
         raw_payload = response['Payload'].read().decode('utf-8')
-        json_payload = json.loads(raw_payload)
-        result = json_payload['result']
+        result = json.loads(raw_payload)
         self.assertEqual(len(result), 3)
         self.assertIn(4, result)
         self.assertIn(5, result)

tests/test_runtime.py

@@ -1,44 +1,51 @@
 import json
 import unittest
 
-from tests.aws_lambda import LocalLambdaServer, start_local_lambda
+import boto3
+
+from tests.sam import LocalLambdaServer, start_local_lambda
 
 
 class TestRuntimeLayer(unittest.TestCase):
     lambda_server: LocalLambdaServer = None
 
+    @classmethod
+    def isLocal(cls) -> bool:
+        return True
+
     @classmethod
     def setUpClass(cls):
-        cls.lambda_server = start_local_lambda()
+        if cls.isLocal():
+            cls.lambda_server = start_local_lambda()
 
     def test_script(self):
-        lambda_client = self.lambda_server.get_client()
+        lambda_client = self.get_client()
         response = lambda_client.invoke(FunctionName="ExampleFunction", Payload=json.dumps({'x': 1}))
         raw_payload = response['Payload'].read().decode('utf-8')
-        json_payload = json.loads(raw_payload)
-        result = json_payload['result']
+        result = json.loads(raw_payload)
         self.assertEqual(result, 2)
 
+    def get_client(self):
+        return self.lambda_server.get_client() if self.isLocal() else boto3.client('lambda')
+
     def test_lowercase_extension(self):
-        lambda_client = self.lambda_server.get_client()
+        lambda_client = self.get_client()
         response = lambda_client.invoke(FunctionName="LowerCaseExtensionFunction", Payload=json.dumps({'x': 1}))
         raw_payload = response['Payload'].read().decode('utf-8')
-        json_payload = json.loads(raw_payload)
-        result = json_payload['result']
+        result = json.loads(raw_payload)
         self.assertEqual(result, 2)
 
     def test_multiple_arguments(self):
-        lambda_client = self.lambda_server.get_client()
+        lambda_client = self.get_client()
         payload = {'x': 'bar', 'y': 1}
         response = lambda_client.invoke(FunctionName="MultipleArgumentsFunction", Payload=json.dumps(payload))
         raw_payload = response['Payload'].read().decode('utf-8')
-        json_payload = json.loads(raw_payload)
-        result = json_payload['result']
+        result = json.loads(raw_payload)
         self.assertDictEqual(result, payload)
 
     @unittest.skip('Lambda local does not pass errors properly')
     def test_missing_source_file(self):
-        lambda_client = self.lambda_server.get_client()
+        lambda_client = self.get_client()
         response = lambda_client.invoke(FunctionName="MissingSourceFileFunction", Payload=json.dumps({'y': 1}))
         raw_payload = response['Payload'].read().decode('utf-8')
         json_payload = json.loads(raw_payload)
@@ -47,7 +54,7 @@ def test_missing_source_file(self):
 
     @unittest.skip('Lambda local does not pass errors properly')
     def test_missing_function(self):
-        lambda_client = self.lambda_server.get_client()
+        lambda_client = self.get_client()
         response = lambda_client.invoke(FunctionName="MissingFunctionFunction", Payload=json.dumps({'y': 1}))
         raw_payload = response['Payload'].read().decode('utf-8')
         json_payload = json.loads(raw_payload)
@@ -56,7 +63,7 @@ def test_missing_function(self):
 
     @unittest.skip('Lambda local does not pass errors properly')
     def test_missing_argument(self):
-        lambda_client = self.lambda_server.get_client()
+        lambda_client = self.get_client()
         response = lambda_client.invoke(FunctionName="ExampleFunction")
         raw_payload = response['Payload'].read().decode('utf-8')
         json_payload = json.loads(raw_payload)
@@ -65,7 +72,7 @@ def test_missing_argument(self):
 
     @unittest.skip('Lambda local does not pass errors properly')
     def test_unused_argument(self):
-        lambda_client = self.lambda_server.get_client()
+        lambda_client = self.get_client()
         response = lambda_client.invoke(FunctionName="ExampleFunction", Payload=json.dumps({'x': 1, 'y': 1}))
         raw_payload = response['Payload'].read().decode('utf-8')
         json_payload = json.loads(raw_payload)
@@ -74,7 +81,7 @@ def test_unused_argument(self):
 
     @unittest.skip('Lambda local does not pass errors properly')
     def test_long_argument(self):
-        lambda_client = self.lambda_server.get_client()
+        lambda_client = self.get_client()
         payload = {x: x for x in range(0, 100000)}
         response = lambda_client.invoke(FunctionName="VariableArgumentsFunction", Payload=json.dumps(payload))
         raw_payload = response['Payload'].read().decode('utf-8')
@@ -83,7 +90,7 @@ def test_long_argument(self):
 
     @unittest.skip('Lambda local does not pass errors properly')
     def test_missing_library(self):
-        lambda_client = self.lambda_server.get_client()
+        lambda_client = self.get_client()
         response = lambda_client.invoke(FunctionName="MissingLibraryFunction", Payload=json.dumps({'y': 1}))
         raw_payload = response['Payload'].read().decode('utf-8')
         json_payload = json.loads(raw_payload)
@@ -92,4 +99,5 @@ def test_missing_library(self):
 
     @classmethod
     def tearDownClass(cls):
-        cls.lambda_server.kill()
+        if cls.isLocal():
+            cls.lambda_server.kill()