configure sample to work with LocalStack (#1)

* run sample against LocalStack + add query-lambda function for testing

* polish readme, add license note, add Makefile

* add sample workflow

* README updates

* add diagram for the application architecture

* replace diagram with a better centered one

* fix nits

* Update README.md

Co-authored-by: steffyP <steffyP@users.noreply.github.com>

* Update README.md

Co-authored-by: steffyP <steffyP@users.noreply.github.com>

---------

Co-authored-by: AncaGhenade <ancaghenade@gmail.com>
Co-authored-by: HarshCasper <erbeusgriffincasper@gmail.com>

Author: 3 people

.github/workflows/main.yml

@@ -0,0 +1,82 @@
+name: Deploy on LocalStack 
+
+on:
+  push:
+    paths-ignore:
+      - 'README.md'
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  smoke-test:
+    name: Setup infrastructure
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.9'
+
+      - name: Setup Nodejs
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+
+      - name: Install dependencies
+        run: |
+          make install
+
+      - name: Start LocalStack
+        env:
+          LOCALSTACK_API_KEY: ${{ secrets.LOCALSTACK_API_KEY }}
+          LOCALSTACK_VOLUME_DIR: ${{ github.workspace }}/ls_test
+        run: |
+          mkdir ls_test
+          docker pull localstack/localstack-pro:latest
+          # Start LocalStack in the background
+          DEBUG=1 RDS_MYSQL_DOCKER=1 localstack start -d
+          # Wait 30 seconds for the LocalStack container to become ready before timing out
+          echo "Waiting for LocalStack startup..."
+          localstack wait -t 15
+          echo "Startup complete"
+
+      - name: Deploy the application
+        env: 
+          AWS_ACCESS_KEY_ID: test
+          AWS_SECRET_ACCESS_KEY: test
+          AWS_DEFAULT_REGION: us-east-1
+        run: |
+          make build
+          make bootstrap
+          make deploy
+
+      - name: Show Logs
+        if: failure()
+        run: |
+          localstack logs
+
+      - name: Smoke Test
+        run: |
+          awslocal --version
+          awslocal lambda invoke --cli-binary-format raw-in-base64-out --function-name my-lambda-rds-query-helper --payload '{"sqlQuery": "show tables", "secretName":"/rdsinitexample/rds/creds/mysql-01"}' output
+          echo "show tables:"
+          cat output
+          awslocal lambda invoke --cli-binary-format raw-in-base64-out --function-name my-lambda-rds-query-helper --payload '{"sqlQuery": "select Author from Books", "secretName":"/rdsinitexample/rds/creds/mysql-01"}' output
+          echo "select Author from Books:"
+          cat output
+          return_status=$(cat output | jq -r .status)
+          if [ "SUCCESS" !=  ${return_status} ]; then
+            echo "unexpected response: ${return_status}"
+            cat output
+            exit 1
+          fi
+      - name: Show Logs
+        if: failure()
+        run: |
+          localstack logs

LICENSE

@@ -13,3 +13,18 @@ COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
+
+Copyright 2023 LocalStack. All Rights Reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Makefile

@@ -0,0 +1,46 @@
+export AWS_ACCESS_KEY_ID ?= test
+export AWS_SECRET_ACCESS_KEY ?= test
+export AWS_DEFAULT_REGION=us-east-1
+SHELL := /bin/bash
+
+## Show this help
+usage:
+		@fgrep -h "##" $(MAKEFILE_LIST) | fgrep -v fgrep | sed -e 's/\\$$//' | sed -e 's/##//'
+
+## Install dependencies
+install:
+		@which localstack || pip install localstack
+		@which awslocal || pip install awscli-local
+		@which cdklocal || npm install -g aws-cdk-local aws-cdk
+
+## Deploy the infrastructure
+build:
+		npm install && cd demos/rds-query-fn-code && npm install
+
+## Bootstap the CDK sample
+bootstrap:
+		cdklocal bootstrap
+
+## Deploy the CDK sample
+deploy:
+		cdklocal deploy --require-approval never
+
+## Start LocalStack in detached mode
+start:
+		RDS_MYSQL_DOCKER=1 localstack start -d
+
+## Stop the Running LocalStack container
+stop:
+		@echo
+		localstack stop
+
+## Make sure the LocalStack container is up
+ready:
+		@echo Waiting on the LocalStack container...
+		@localstack wait -t 30 && echo LocalStack is ready to use! || (echo Gave up waiting on LocalStack, exiting. && exit 1)
+
+## Save the logs in a separate file, since the LS container will only contain the logs of the last sample run.
+logs:
+		@localstack logs > logs.txt
+
+.PHONY: usage install bootstrap build deploy deploy start stop ready logs