Lambda関数をローカルで実行する方法を教えてください

Question

##解決したいこと
下記のコードをローカルで実行したいです。

package main

import (
	"fmt"

	"github.com/aws/aws-lambda-go/lambda"
)

type MyEvent struct {
	Name string `json:"What is your name?"`
	Age  int    `json:"How old are you?"`
}

type MyResponse struct {
	Message string `json:"Answer:"`
}

func HandleLambdaEvent(event MyEvent) (MyResponse, error) {
	return MyResponse{Message: fmt.Sprintf("%s is %d years old!", event.Name, event.Age)}, nil
}

func main() {
    lambda.Start(HandleLambdaEvent)
}

Go言語で書いたAWS Lambda関数をローカルで実行する方法を知りたいです。既にSAM(Serverless Application Model)を使用すればローカルでプログラムを実行できそうなことは調べております。が、SAMを使用しなくてもできるとシニアエンジニアの方に言われました。

ヒントとして、下記のlambda.start()を

func main() {
    lambda.Start(HandleLambdaEvent)
}

func main() {
    ctx := context.Background()
    hogehoge(ctx)
}

にすることで、ローカルでも実行できると言われております。
なぜ、hogehogeに引数としてctxを入力する必要があるのか？
hogehogeに引数としてctxを入力することで、ローカルでも実行できるようになるのか？
がわかりません。

調べたら出てくるかと思い、質問せずに終わりましたが、そのとき質問をすればよかったと深く後悔しております。

調べたこと・理解していること

• Lambda関数は、リクエストなどのイベントを処理するためのもの
• main関数の中にあるLambda.start(ハンドラー)によってLambda関数が実行される
• Contextに関して↓

Context は、APIのサーバーやクライアントを使うときに、コンテキストを提供してキャンセルや、タイムアウト、値を渡したり出来る仕組み。

Go の Context を学ぶ
とのことですが、理解できませんでした。

次に、この下記のサイトをみました。

環境と呼び出しリクエストに関するメタデータへのアクセス

Go の AWS Lambda context オブジェクト

要するにリクエストが処理されるときにメタデータが作成？されていて、それにアクセスできるという理解です。

背景

AWS Lambdaコンソールを開いて、Goの圧縮した実行ファイルをアップロードして、動作確認&テストをするのはデバッグができないし、手間がかかるからです。

環境

• VsCode Version: 1.56.0
• Mac M1
• Delve Debugger Version: 1.6.0
• Go version: go1.16.3 darwin/arm64
• aws-cli/2.2.0 Python/3.9.4 Darwin/20.3.0 source/arm64 prompt/off

AWSやGoを使い始めたばかりであり、わからないことがたくさんあります。その上で一つずつ学び、何とか目的を実現したいと思っています。

指針を示していただくだけでもありがたいので、どうぞよろしくお願いいたします

Answer 1

func main() {
    ctx := context.Background()
    hogehoge(ctx)
}

にすることで、ローカルでも実行できると言われております。

"ローカルでも実行" という意味が、デプロイしたLambdaをローカルで動かしたいのか、ハンドラのロジックをローカルで動かしたいのか、にもよりますが、後者を仮定して回答します。

ます aws-lambda-go を用いてLambdaを実装するには Start などの関数を用いる必要があります。

そのため

func main() {
    ctx := context.Background()
    hogehoge(ctx)
}

のようにするとLambdaのエントリポイントとして意味をなさないため、不適切です。また Context はLambdaをローカルで実行することに対して無関係です。

---

ローカルで動かす方法

大きく2つの方法が考えられます。

1.ハンドラのロジックを別パッケージに分離する方法
2.環境変数 AWS_EXECUTION_ENV を見て判断する方法

1.ハンドラのロジックを別パッケージに分離する方法

ハンドラのロジックをローカルで動かしたいとき、ないしはハンドラの単体テストを実施したいときは、Lambdaの起動ポイントとハンドラのロジック部分を別のパッケージに分離する手法がよくあります。lambda.Start を main パッケージで実装し、ハンドラは app (など)のパッケージで実装する、ということです。以下が一例です。

• ディレクトリ構成

.
├── cmd
│   └── main.go
├── go.mod
├── go.sum
├── handle.go
└── handle_test.go

• handle.go

package app

import "fmt"

type MyEvent struct {
	Name string `json:"What is your name?"`
	Age  int    `json:"How old are you?"`
}

type MyResponse struct {
	Message string `json:"Answer:"`
}

func HandleLambdaEvent(event MyEvent) (MyResponse, error) {
	return MyResponse{Message: fmt.Sprintf("%s is %d years old!", event.Name, event.Age)}, nil
}

• handle_test.go

package app

import (
	"reflect"
	"testing"
)

func TestHandleLambdaEvent(t *testing.T) {
	type args struct {
		event MyEvent
	}
	tests := []struct {
		name    string
		args    args
		want    MyResponse
		wantErr bool
	}{
		{
			name: "正常系",
			args: args{event: MyEvent{Name: "Gopher", Age: 11}},
			want: MyResponse{
				Message: "Gopher is 11 years old!",
			},
			wantErr: false,
		},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			got, err := HandleLambdaEvent(tt.args.event)
			if (err != nil) != tt.wantErr {
				t.Errorf("HandleLambdaEvent() error = %v, wantErr %v", err, tt.wantErr)
				return
			}
			if !reflect.DeepEqual(got, tt.want) {
				t.Errorf("HandleLambdaEvent() got = %v, want %v", got, tt.want)
			}
		})
	}
}

• cmd/main.go

package main

import (
	"github.com/aws/aws-lambda-go/lambda"
	app "github.com/d-tsuji/go-sandbox/teratail"
)

func main() {
	lambda.Start(app.HandleLambdaEvent)
}

上記のようにすると、ハンドラ (HandleLambdaEvent) をローカルでテストできるようになります。

2.環境変数 AWS_EXECUTION_ENV を見て判断する方法

もう一つの方法として AWS_EXECUTION_ENV を見て、AWS Lambda上で動いているかローカルで動いているか判断して分岐する方法があります。

AWS Lambdaとして動いている場合は AWS_EXECUTION_ENV のプレフィクスに AWS_Lambda_ が含まれます。

https://docs.aws.amazon.com/ja_jp/lambda/latest/dg/configuration-envvars.html

そのため以下のようにして、ローカルの場合は直接ハンドラを動かすことができます。

func main() {
	if strings.HasPrefix(os.Getenv("AWS_EXECUTION_ENV"), "AWS_Lambda") {
		lambda.Start(HandleLambdaEvent)
	} else {
		// AWS Lambda上で動いていない
		_, err := HandleLambdaEvent(MyEvent{"Gopher", 11})
		if err != nil {
			log.Fatal(err)
		}
	}
}

Comments

[rapsody]

回答していただきありがとうございます！

main()の中は、lambda.Start(app.HandleLambdaEvent)
ではなく、

lambda.Start(app.TestHandleLambdaEvent)

ではないでしょうか？

Lambda.start()で、
HandleLambdaEventが呼ばれて、

HandleLambdaEventメソッドが実行されて、なぜ、TestHandleLambdaEventが実行されるのでしょうか？

すいません、
理解力がなく申し訳ございません。

[d_tutuz]

lambda.Start(app.HandleLambdaEvent) ですね。AWS LambdaとしてデプロイしてLambdaを実行したときは app.HandleLambdaEvent が呼び出されます。

ローカルでテストしたいときは go test -v などとして TestHandleLambdaEvent を実行することで、テストの中で HandleLambdaEvent を呼び出すことができる、ということです。TestHandleLambdaEvent はローカルでのテスト(go test を実行したとき)以外は TestHandleLambdaEvent は実行されません

[rapsody]

ありがとうございます!!