update blueprint (#48)

Author: fogfish

.github/workflows/build.yml

@@ -16,12 +16,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
 
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4.1.1
 
       - id: deploy
         uses: fogfish/deploy-cdk-go@latest
         with:
-          go-version: "1.20"
+          go-version: "1.21"
           stack: ${{ matrix.stack }}
           version: latest
           issue-to-create: ./.github/issue-spawn-latest.md

.github/workflows/carry.yml

@@ -13,12 +13,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
 
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4.1.1
 
       - id: deploy
         uses: fogfish/deploy-cdk-go@latest
         with:
-          go-version: "1.20"
+          go-version: "1.21"
           stack: ${{ matrix.stack }}
           version: ${{ github.event.release.name }}
           issue-to-create: ./.github/issue-spawn-release.md

.github/workflows/check-clean.yml

@@ -17,11 +17,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
 
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4.1.1
 
       - uses: fogfish/deploy-cdk-go@latest
         with:
-          go-version: "1.20"
+          go-version: "1.21"
           command: destroy
           stack: ${{ matrix.stack }}
           version: pr${{ github.event.number }}

.github/workflows/check-code.yml

@@ -14,13 +14,13 @@ jobs:
     runs-on: ubuntu-latest
     steps:
 
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4.1.1
 
-      - uses: actions/setup-go@v3
+      - uses: actions/setup-go@v5
         with:
-          go-version: "1.20"
+          go-version: "1.21"
           cache: true
 
-      - uses: dominikh/staticcheck-action@v1.2.0
+      - uses: dominikh/staticcheck-action@v1.3.0
         with:
           install-go: false

.github/workflows/check-spawn.yml

@@ -18,12 +18,12 @@ jobs:
 
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4.1.1
 
       - id: deploy
         uses: fogfish/deploy-cdk-go@latest
         with:
-          go-version: "1.20"
+          go-version: "1.21"
           stack: ${{ matrix.stack }}
           version: pr${{ github.event.number }}
           issue-to-comment: ${{ github.event.number }}

.github/workflows/check-test.yml

@@ -19,11 +19,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
 
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4.1.1
 
-      - uses: actions/setup-go@v3
+      - uses: actions/setup-go@v5
         with:
-          go-version: "1.20"
+          go-version: "1.21"
           cache: true
 
       - name: go build
@@ -34,10 +34,8 @@ jobs:
         run: |
           go test -v -coverprofile=profile.cov $(go list ./... | grep -v /examples/)
         env:
-          ## GOPATH required to build serverless app inside unittest
-          GOPATH: /home/runner/go
-          GOCACHE: /home/runner/.cache/go-build
-          GOMODCACHE: /home/runner/go/pkg/mod
+          ## GOPATH required to build serverless app inside unittest 
+          GOPATH: /home/runner/work/${{ github.event.repository.name }}/go
 
       - uses: shogo82148/actions-goveralls@v1
         continue-on-error: true

.gitignore

@@ -18,3 +18,5 @@ node_modules/
 .vscode/
 
 assay-it/
+
+cdk.context.json

README.md

@@ -122,6 +122,8 @@ github.com/.../the-beautiful-app
 |  | 
 |  ├─ api                      // public objects used by API
 |  |  └─ pet.go
+|  ├─ curl                     // client library
+|  |  └─ petshop.go
 |  └─ suites                   // testing suites for api endpoint(s)
 |
 ├─ cmd                         // executables of the project
@@ -176,10 +178,24 @@ cdk deploy
 
 In few seconds, the application becomes available at
 
-```
+```bash
 curl https://xxxxxxxxxx.execute-api.eu-west-1.amazonaws.com/api
 ```
 
+The api is protected by AWS IAM, request has to be signed.
+Either use example client `cmd/petshop-cli` or curl directly
+
+```bash
+curl $BLUEPRINT/petshop/pets \
+  -XGET \
+  -H "Accept: application/json" \
+  --aws-sigv4 "aws:amz:eu-west-1:execute-api" \
+  --user "$AWS_ACCESS_KEY_ID":"$AWS_SECRET_ACCESS_KEY"
+```
+
+See [all available endpoints](./http/petshop.go). 
+
+
 **test in production**
 
 ```bash

cloud/blueprint.go

@@ -5,7 +5,7 @@ import (
 	"os"
 
 	"github.com/aws/aws-cdk-go/awscdk/v2"
-	"github.com/aws/aws-cdk-go/awscdk/v2/awsapigateway"
+	"github.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2"
 	"github.com/aws/constructs-go/constructs/v10"
 	"github.com/aws/jsii-runtime-go"
 	"github.com/fogfish/scud"
@@ -35,8 +35,11 @@ func main() {
 	//
 	// Stack
 	//
-	stackID := fmt.Sprintf("blueprint-golang-%s", vsn(app))
-	stack := awscdk.NewStack(app, jsii.String(stackID), config)
+	vsn := vsn(app)
+	stack := awscdk.NewStack(app,
+		jsii.String(fmt.Sprintf("blueprint-golang-%s", vsn)),
+		config,
+	)
 
 	NewBlueprint(stack)
 
@@ -46,16 +49,17 @@ func main() {
 // NewBlueprint create example REST api
 func NewBlueprint(scope constructs.Construct) {
 	gateway := scud.NewGateway(scope, jsii.String("Gateway"),
-		&awsapigateway.RestApiProps{
-			RestApiName: jsii.String("petshop"),
+		&scud.GatewayProps{
+			HttpApiProps: &awsapigatewayv2.HttpApiProps{},
 		},
 	)
+	gateway.WithAuthorizerIAM()
 
-	myfun := scud.NewFunctionGo(scope, jsii.String("MyFun"),
+	handler := scud.NewFunctionGo(scope, jsii.String("Handler"),
 		&scud.FunctionGoProps{
 			SourceCodePackage: "github.com/fogfish/blueprint-serverless-golang",
 			SourceCodeLambda:  "cmd/lambda/petshop",
 		},
 	)
-	gateway.AddResource("petshop", myfun)
+	gateway.AddResource("/petshop", handler)
 }

cloud/blueprint_test.go

@@ -15,13 +15,12 @@ func TestBlueprint(t *testing.T) {
 	NewBlueprint(stack)
 
 	require := map[*string]*float64{
-		jsii.String("AWS::ApiGateway::RestApi"):    jsii.Number(1),
-		jsii.String("AWS::ApiGateway::Deployment"): jsii.Number(1),
-		jsii.String("AWS::ApiGateway::Stage"):      jsii.Number(1),
-		jsii.String("AWS::ApiGateway::Method"):     jsii.Number(5),
-		jsii.String("AWS::IAM::Role"):              jsii.Number(3),
-		jsii.String("AWS::Lambda::Function"):       jsii.Number(2),
-		jsii.String("Custom::LogRetention"):        jsii.Number(1),
+		jsii.String("AWS::ApiGatewayV2::Api"):   jsii.Number(1),
+		jsii.String("AWS::ApiGatewayV2::Stage"): jsii.Number(2),
+		jsii.String("AWS::ApiGatewayV2::Route"): jsii.Number(1),
+		jsii.String("AWS::IAM::Role"):           jsii.Number(2),
+		jsii.String("AWS::Lambda::Function"):    jsii.Number(2),
+		jsii.String("Custom::LogRetention"):     jsii.Number(1),
 	}
 
 	template := assertions.Template_FromStack(stack, nil)