Merge pull request #1658 from aws-samples/msk-go-iam

Msk go iam

msk-lambda-iam-go-sam/HandlerKafka/go.mod

@@ -0,0 +1,7 @@
+require github.com/aws/aws-lambda-go v1.36.1
+
+replace gopkg.in/yaml.v2 => gopkg.in/yaml.v2 v2.2.8
+
+module HandlerKafka
+
+go 1.16

msk-lambda-iam-go-sam/HandlerKafka/go.sum

@@ -0,0 +1,13 @@
+github.com/aws/aws-lambda-go v1.36.1 h1:CJxGkL9uKszIASRDxzcOcLX6juzTLoTKtCIgUGcTjTU=
+github.com/aws/aws-lambda-go v1.36.1/go.mod h1:jwFe2KmMsHmffA1X2R09hH6lFzJQxzI8qK17ewzbQMM=
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/testify v1.7.2 h1:4jaiDzPyXQvSd7D0EjG45355tLlV3VOECpq10pLC+8s=
+github.com/stretchr/testify v1.7.2/go.mod h1:R6va5+xMeoiuVRoj+gSkQ7d3FALtqAAGI1FQKckRals=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

msk-lambda-iam-go-sam/HandlerKafka/main.go

@@ -0,0 +1,68 @@
+package main
+
+import (
+	"context"
+	b64 "encoding/base64"
+	"fmt"
+	"github.com/aws/aws-lambda-go/events"
+	"github.com/aws/aws-lambda-go/lambda"
+)
+
+//Core lambda Kafka event handling logic
+
+func handler(ctx context.Context, kafkaEvent events.KafkaEvent) error {
+
+	//Lambda Runtime delivers a batch of messages to the lambda function
+	//Each batch of messages has two fields EventSource and EventSourceARN
+	//Each batch of messages also has a field called Records
+	//The Records is a map with multiple keys and values
+	//Each key is a combination of the Topic Name and the Partition Number
+	//One batch of messages can contain messages from multiple partitions
+	eventSource := kafkaEvent.EventSource
+	eventSourceARN := kafkaEvent.EventSourceARN
+	records := kafkaEvent.Records
+	fmt.Println("EventSource = ", eventSource)
+	fmt.Println("EventSourceARN = ", eventSourceARN)
+	//Defining a variable to keep track of the message number in the batch
+	var i = 1
+	//Now looping through the keys in the map
+	for key, arrayOfKafkaMessage := range records {
+		fmt.Println("This Key = ", key)
+		//Each key (topic-partition) can in turn have a number of messages
+		//Now looping through the messages in a particular key and getting fields in the message
+		for _, thisKafkaMessage := range arrayOfKafkaMessage {
+			fmt.Println("**********")
+			fmt.Println("Start of message ", i)
+			fmt.Println("Topic = ", thisKafkaMessage.Topic)
+			fmt.Println("Partition = ", thisKafkaMessage.Partition)
+			fmt.Println("Offset = ", thisKafkaMessage.Offset)
+			fmt.Println("Timestamp = ", thisKafkaMessage.Timestamp)
+			fmt.Println("TimestampType = ", thisKafkaMessage.TimestampType)
+			//Each message in turn has a key and a value which are base64 encoded and need to be decoded
+			var thisKafkaMessageKey = "null"
+			if thisKafkaMessage.Key != "" {
+				var thisKafkaMessageKeyBase64 = thisKafkaMessage.Key
+				var thisKafkaMessageKeyDecodedInByteArray, _ = b64.StdEncoding.DecodeString(thisKafkaMessageKeyBase64)
+				thisKafkaMessageKey = string(thisKafkaMessageKeyDecodedInByteArray)
+			}
+			fmt.Println("Key = ", thisKafkaMessageKey)
+			var thisKafkaMessageValue = "null"
+			if thisKafkaMessage.Value != "" {
+				var thisKafkaMessageValueBase64 = thisKafkaMessage.Value
+				var thisKafkaMessageValueDecodedInByteArray, _ = b64.StdEncoding.DecodeString(thisKafkaMessageValueBase64)
+				thisKafkaMessageValue = string(thisKafkaMessageValueDecodedInByteArray)
+
+			}
+			fmt.Println("Value = ", thisKafkaMessageValue)
+			fmt.Println("End of message ", i)
+			fmt.Println("**********")
+			i = i + 1
+		}
+	}
+
+	return nil
+}
+
+func main() {
+	lambda.Start(handler)
+}

msk-lambda-iam-go-sam/HandlerKafka/main_test.go

@@ -0,0 +1,64 @@
+package main
+
+import (
+	"fmt"
+	"net/http"
+	"net/http/httptest"
+	"testing"
+
+	"github.com/aws/aws-lambda-go/events"
+)
+
+func TestHandler(t *testing.T) {
+	t.Run("Unable to get IP", func(t *testing.T) {
+		DefaultHTTPGetAddress = "http://127.0.0.1:12345"
+
+		_, err := handler(events.APIGatewayProxyRequest{})
+		if err == nil {
+			t.Fatal("Error failed to trigger with an invalid request")
+		}
+	})
+
+	t.Run("Non 200 Response", func(t *testing.T) {
+		ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+			w.WriteHeader(500)
+		}))
+		defer ts.Close()
+
+		DefaultHTTPGetAddress = ts.URL
+
+		_, err := handler(events.APIGatewayProxyRequest{})
+		if err != nil && err.Error() != ErrNon200Response.Error() {
+			t.Fatalf("Error failed to trigger with an invalid HTTP response: %v", err)
+		}
+	})
+
+	t.Run("Unable decode IP", func(t *testing.T) {
+		ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+			w.WriteHeader(500)
+		}))
+		defer ts.Close()
+
+		DefaultHTTPGetAddress = ts.URL
+
+		_, err := handler(events.APIGatewayProxyRequest{})
+		if err == nil {
+			t.Fatal("Error failed to trigger with an invalid HTTP response")
+		}
+	})
+
+	t.Run("Successful Request", func(t *testing.T) {
+		ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+			w.WriteHeader(200)
+			fmt.Fprintf(w, "127.0.0.1")
+		}))
+		defer ts.Close()
+
+		DefaultHTTPGetAddress = ts.URL
+
+		_, err := handler(events.APIGatewayProxyRequest{})
+		if err != nil {
+			t.Fatal("Everything should be ok")
+		}
+	})
+}

msk-lambda-iam-go-sam/Makefile

@@ -0,0 +1,4 @@
+.PHONY: build
+
+build:
+	sam build

msk-lambda-iam-go-sam/README.md

@@ -0,0 +1,170 @@
+# Golang AWS Lambda Kafka consumer with IAM auth, using AWS SAM
+
+This pattern is an example of a Lambda function that consumes messages from an Amazon Managed Streaming for Kafka (Amazon MSK) topic, where the MSK Cluster has been configured to use IAM authentication. This pattern assumes you already have an MSK cluster with a topic configured, if you need a sample pattern to deploy an MSK cluster either in Provisioned or Serverless modes please see the [msk-cfn-sasl-lambda pattern](https://serverlessland.com/patterns/msk-cfn-sasl-lambda). 
+
+This project contains source code and supporting files for a serverless application that you can deploy with the AWS Serverless Application Model (AWS SAM) CLI. It includes the following files and folders.
+
+- HandlerKafka - Code for the application's Lambda function.
+- events - Invocation events that you can use to invoke the function.
+- template.yaml - An AWS SAM template that defines the application's AWS resources.
+
+The application creates a Lambda function that listens to Kafka messages on a topic of an MSK Cluster. These resources are defined in the `template.yaml` file in this project. You can update the template to add AWS resources through the same deployment process that updates your application code.
+
+Important: this application uses various AWS services and there are costs associated with these services after the Free Tier usage - please see the [AWS Pricing page](https://aws.amazon.com/pricing/) for details. You are responsible for any AWS costs incurred. No warranty is implied in this example.
+
+## Requirements
+
+* [Create an AWS account](https://portal.aws.amazon.com/gp/aws/developer/registration/index.html) if you do not already have one and log in. The IAM user that you use must have sufficient permissions to make necessary AWS service calls and manage AWS resources.
+* [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2.html) installed and configured
+* [Git installed](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
+* [AWS Serverless Application Model](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-install.html) (AWS SAM) installed
+* [Golang](https://golang.org)
+* Create MSK cluster and topic that will be used for testing. It is important to create the topic before deploying the Lambda function, otherwise the event source mapping will stay disabled. 
+
+## Deploy the sample application
+
+The AWS SAM CLI is a serverless tool for building and testing Lambda applications. It uses Docker to locally test your functions in an Amazon Linux environment that resembles the Lambda execution environment. It can also emulate your application's build environment and API.
+
+To use the AWS SAM CLI, you need the following tools.
+
+* AWS SAM CLI - [Install the AWS SAM CLI](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-install.html)
+* Docker - [Install Docker community edition](https://hub.docker.com/search/?type=edition&offering=community)
+
+In this example we use the built-in `sam build` to automatically download all the dependencies and package our build target.   
+Read more about [SAM Build here](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-cli-command-reference-sam-build.html) 
+
+1. Create a new directory, navigate to that directory in a terminal and clone the GitHub repository:
+    ``` 
+    git clone https://github.com/aws-samples/serverless-patterns.git
+    ```
+1. Change directory to the pattern directory:
+    ```
+    cd msk-lambda-iam-go-sam
+    ```
+
+This solution uses the AWS Lambda [custom runtime](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-custom.html) `provided.al2` which is the prefered way to run Go applications in Lambda. For more information, see [https://aws.amazon.com/blogs/compute/migrating-aws-lambda-functions-from-the-go1-x-runtime-to-the-custom-runtime-on-amazon-linux-2/](https://aws.amazon.com/blogs/compute/migrating-aws-lambda-functions-from-the-go1-x-runtime-to-the-custom-runtime-on-amazon-linux-2/).
+
+The AWS SAM template configures the `provided.al2` runtime and builds the Go function using the following syntax.
+
+```yaml
+...
+  HelloWorldGoKafkaFunction:
+    Type: AWS::Serverless::Function
+    Metadata:
+      BuildMethod: go1.x 
+    Properties:
+      CodeUri: HandlerKafka/
+      Handler: bootstrap
+      Runtime: provided.al2
+```
+You can also use the managed Go.1 runtime by amending the AWS SAM template:
+
+AWS Lambda Golang runtime requires a flat folder with the executable generated on build step. SAM will use `CodeUri` property to know where to look up for the application:
+
+```yaml
+...
+  HelloWorldGoKafkaFunction:
+    Type: AWS::Serverless::Function 
+    Properties:
+      CodeUri: HandlerKafka/
+      Handler: handler
+      Runtime: go1.x            
+```
+
+1. From the command line, use AWS SAM to deploy the AWS resources for the pattern as specified in the template.yml file:
+    ```
+    sam build
+    sam deploy --guided
+    ```
+
+1. During the prompts:
+* **Stack Name**: The name of the stack to deploy to CloudFormation. This should be unique to your account and region, and a good starting point would be something matching your project name.
+* **AWS Region**: The AWS region you want to deploy your app to.
+* **Parameter MSKClusterName**: The name of the MSKCluster, eg. msk-test-cluster
+
+* **Parameter MSKClusterId**: The unique ID of the MSKCluster, eg. a4e132c8-6ad0-4334-a313-123456789012-s2
+* **Parameter MSKTopic**: The Kafka topic on which the lambda function will listen on
+* **Confirm changes before deploy**: If set to yes, any change sets will be shown to you before execution for manual review. If set to no, the AWS SAM CLI will automatically deploy application changes.
+* **Allow SAM CLI IAM role creation**: Many AWS SAM templates, including this example, create AWS IAM roles required for the AWS Lambda function(s) included to access AWS services. By default, these are scoped down to minimum required permissions. To deploy an AWS CloudFormation stack which creates or modifies IAM roles, the `CAPABILITY_IAM` value for `capabilities` must be provided. If permission isn't provided through this prompt, to deploy this example you must explicitly pass `--capabilities CAPABILITY_IAM` to the `sam deploy` command.
+* **Disable rollback**: Defaults to No and it preserves the state of previously provisioned resources when an operation fails
+* **Save arguments to configuration file**: If set to yes, your choices will be saved to a configuration file inside the project, so that in the future you can just re-run `sam deploy` without parameters to deploy changes to your application.
+* **SAM configuration file [samconfig.toml]**: Name of the configuration file to store configuration information locally
+* **SAM configuration environment [default]**: Environment for storing deployment information locally
+
+You should get a message "Successfully created/updated stack - <StackName> in <Region>" if all goes well.
+
+Once you have run `sam deploy --guided` mode once and saved arguments to a configuration file (samconfig.toml), you can use `sam deploy` in future to use these defaults.
+
+## How it works
+
+This pattern creates a Lambda function along with a Lambda Event Source Mapping(ESM) resource. This maps a Kafka topic on an MSK Cluster as a trigger to a Lambda function. The ESM takes care of polling the Kafka topic and then invokes the Lambda function with a batch of messages.
+
+## Test the sample application
+
+Once the Lambda function is deployed, send some Kafka messages to the topic that you configured in the Lambda function trigger.
+
+Either send at least 10 messages or wait for 300 seconds (check the values of BatchSize: 10 and MaximumBatchingWindowInSeconds: 300 in the template.yaml file)
+
+Then check Amazon CloudWatch logs and you should see messages in the CloudWatch Log Group with the name of the deployed Lambda function.
+
+The Lambda code parses the Kafka messages and outputs the fields in the Kafka messages to CloudWatch logs.
+
+A single Lambda function receives a batch of messages. The messages are received as a map with each key being a combination of the topic and the partition, as a single batch can receive messages from multiple partitions.
+
+Each key has a list of messages. Each Kafka message has the following properties - `Topic`, `Partition`, `Offset`, `TimeStamp`, `TimeStampType`, `Key`, and `Value`.
+
+The `Key` and `Value` are base64 encoded and have to be decoded. A message can also have a list of headers, each header having a key and a value.
+
+The code in this example prints out the fields in the Kafka message and also decrypts the key and the value and logs them to CloudWatch logs.
+
+
+### Local development
+
+**You can invoke the function locally using `sam local`**
+
+```bash
+sam local invoke --event=events/event.json
+```
+
+You should see a response similar to the below
+
+START RequestId: ec2a36a6-5b5e-40c8-bff6-e6237babd613 Version: $LATEST
+EventSource =  aws:kafka
+EventSourceARN =  arn:aws:kafka:us-west-2:123456789012:cluster/MSKWorkshopCluster/a93759a9-c9d0-4952-984c-492c6bfa2be8-13
+This Key =  myTopic-0
+**********
+Start of message  1
+Topic =  myTopic
+Partition =  0
+Offset =  250
+Timestamp =  2023-03-06 03:08:30.111 +0000 UTC
+TimestampType =  CREATE_TIME
+Key =  null
+Value =  f
+End of message  1
+**********
+**********
+Start of message  2
+Topic =  myTopic
+Partition =  0
+Offset =  251
+Timestamp =  2023-03-06 03:08:31.086 +0000 UTC
+TimestampType =  CREATE_TIME
+Key =  null
+Value =  g
+End of message  2
+**********
+END RequestId: ec2a36a6-5b5e-40c8-bff6-e6237babd613
+REPORT RequestId: ec2a36a6-5b5e-40c8-bff6-e6237babd613	Init Duration: 1.38 ms	Duration: 651.86 ms	Billed Duration: 652 ms	Memory Size: 128 MB	Max Memory Used: 128 MB
+
+## Cleanup
+
+1. Delete the stack
+    ```bash
+    sam delete
+    ```
+
+----
+Copyright 2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+
+SPDX-License-Identifier: MIT-0

msk-lambda-iam-go-sam/events/event.json

@@ -0,0 +1,31 @@
+{
+   "records":{
+      "myTopic-0":[
+         {
+            "topic":"myTopic",
+            "partition":0,
+            "offset":250,
+            "timestamp":1678072110111,
+            "timestampType":"CREATE_TIME",
+            "value":"Zg==",
+            "headers":[
+
+            ]
+         },
+         {
+            "topic":"myTopic",
+            "partition":0,
+            "offset":251,
+            "timestamp":1678072111086,
+            "timestampType":"CREATE_TIME",
+            "value":"Zw==",
+            "headers":[
+
+            ]
+         }
+      ]
+   },
+   "eventSource":"aws:kafka",
+   "eventSourceArn":"arn:aws:kafka:us-west-2:123456789012:cluster/MSKWorkshopCluster/a93759a9-c9d0-4952-984c-492c6bfa2be8-13",
+   "bootstrapServers":"b-2.mskworkshopcluster.z9kc4f.c13.kafka.us-west-2.amazonaws.com:9098,b-3.mskworkshopcluster.z9kc4f.c13.kafka.us-west-2.amazonaws.com:9098,b-1.mskworkshopcluster.z9kc4f.c13.kafka.us-west-2.amazonaws.com:9098"
+}