feat(examples): added sam example to workflows (#849)

* feat: added sam example to workflows

* chore: added package-lock

* Modified symlink

* Fix import

* Added jest to sam

* Added jest to sam

.github/workflows/on-merge-to-main.yml

@@ -34,11 +34,16 @@ jobs:
       # This installs all the dependencies of ./packages/*
       # See https://github.com/npm/cli/issues/4475 to see why --foreground-scripts
       run: npm ci --foreground-scripts
-    - name: Install example packages
-      # Since we are not managing the cdk examples with npm workspaces we install
+    - name: Install CDK example packages
+      # Since we are not managing the CDK examples with npm workspaces we install
       # the dependencies in a separate step
       working-directory: ./examples/cdk
-      run: npm ci 
+      run: npm ci
+    - name: Install SAM example packages
+      # Since we are not managing the SAM examples with npm workspaces we install
+      # the dependencies in a separate step
+      working-directory: ./examples/sam
+      run: npm ci
     - name: Run lint
       run: npm run lerna-lint
     - name: Run tests

.github/workflows/on-release-prod.yml

@@ -34,11 +34,16 @@ jobs:
       # This installs all the dependencies of ./packages/*
       # See https://github.com/npm/cli/issues/4475 to see why --foreground-scripts
       run: npm ci --foreground-scripts
-    - name: Install example packages
-      # Since we are not managing the cdk examples with npm workspaces we install
+    - name: Install CDK example packages
+      # Since we are not managing the CDK examples with npm workspaces we install
       # the dependencies in a separate step
       working-directory: ./examples/cdk
-      run: npm ci 
+      run: npm ci
+    - name: Install SAM example packages
+      # Since we are not managing the SAM examples with npm workspaces we install
+      # the dependencies in a separate step
+      working-directory: ./examples/sam
+      run: npm ci
     - name: Run lint
       run: npm run lerna-lint
     - name: Run tests

.github/workflows/pr_lint_and_test.yml

@@ -22,11 +22,16 @@ jobs:
         # This installs all the dependencies of ./packages/*
         # See https://github.com/npm/cli/issues/4475 to see why --foreground-scripts
         run: npm ci --foreground-scripts
-      - name: Install example packages
-        # Since we are not managing the cdk examples with npm workspaces we install
+      - name: Install CDK example packages
+        # Since we are not managing the CDK examples with npm workspaces we install
         # the dependencies in a separate step
         working-directory: ./examples/cdk
-        run: npm ci 
+        run: npm ci
+      - name: Install SAM example packages
+        # Since we are not managing the SAM examples with npm workspaces we install
+        # the dependencies in a separate step
+        working-directory: ./examples/sam
+        run: npm ci
       - name: Run lint
         run: npm run lerna-lint
       - name: Run tests

.github/workflows/run-e2e-tests.yml

@@ -20,11 +20,16 @@ jobs:
         # This installs all the dependencies of ./packages/*
         # See https://github.com/npm/cli/issues/4475 to see why --foreground-scripts
         run: npm ci --foreground-scripts
-      - name: "Install example packages"
-        # Since we are not managing the cdk examples with npm workspaces we install
+      - name: Install CDK example packages
+        # Since we are not managing the CDK examples with npm workspaces we install
         # the dependencies in a separate step
         working-directory: ./examples/cdk
         run: npm ci
+      - name: Install SAM example packages
+        # Since we are not managing the SAM examples with npm workspaces we install
+        # the dependencies in a separate step
+        working-directory: ./examples/sam
+        run: npm ci
       - name: "Test packaging"
         run: |
           npm run lerna-package

examples/cdk/package.json

@@ -1,6 +1,12 @@
 {
   "name": "cdk-app",
   "version": "0.8.1",
+  "author": {
+    "name": "Amazon Web Services",
+    "url": "https://aws.amazon.com"
+  },
+  "description": "This project contains source code and supporting files for a serverless application that you can deploy with CDK.",
+  "license": "MIT-0",
   "bin": {
     "cdk-app": "bin/cdk-app.js"
   },
@@ -36,4 +42,4 @@
     "constructs": "^10.0.82",
     "source-map-support": "^0.5.16"
   }
-}
+}

examples/lambda-functions/get-by-id.ts

@@ -59,10 +59,10 @@ export const getByIdHandler = async (event: APIGatewayProxyEvent, context: Conte
       throw new Error('SAMPLE_TABLE environment variable is not set');
     }
     if (!event.pathParameters) {
-      throw new Error('event does not contain pathParameters')
+      throw new Error('event does not contain pathParameters');
     }
     if (!event.pathParameters.id) {
-      throw new Error('PathParameter id is missing')
+      throw new Error('PathParameter id is missing');
     }
 
     const data = await docClient.get({

examples/lambda-functions/put-item.ts

@@ -59,7 +59,7 @@ export const putItemHandler = async (event: APIGatewayProxyEvent, context: Conte
       throw new Error('SAMPLE_TABLE environment variable is not set');
     }
     if (!event.body) {
-      throw new Error('Event does not contain body')
+      throw new Error('Event does not contain body');
     }
 
     // Get id and name from the body of the request

examples/sam/README.md

@@ -4,7 +4,7 @@ This project contains source code and supporting files for a serverless applicat
 
 This project includes the following files and folders:
 
-- `src/handlers` - Code for the application's Lambda function written in TypeScript. See "Prepare the project" below for instructions on how to copy the Lambda handler code here.
+- `src` - Code for the application's Lambda function written in TypeScript. See "Prepare the project" below for instructions on how to copy the Lambda handler code here.
 - `events` - Invocation events that you can use to invoke the function.
 - `template.yaml` - A template that defines the application's AWS resources.
 
@@ -110,7 +110,7 @@ Build your application with the `sam build` command.
 sam build --beta-features
 ```
 
-The SAM CLI installs dependencies defined in `src/handlers/package.json`, compiles TypeScript with esbuild, creates a deployment package, and saves it in the `.aws-sam/build` folder.
+The SAM CLI installs dependencies defined in `package.json`, compiles TypeScript with esbuild, creates a deployment package, and saves it in the `.aws-sam/build` folder.
 
 Test a single function by invoking it directly with a test event. An event is a JSON document that represents the input that the function receives from the event source. Test events are included in the `events` folder in this project.
 
@@ -130,12 +130,12 @@ curl http://localhost:3000/
 The SAM CLI reads the application template to determine the API's routes and the functions that they invoke. The `Events` property on each function's definition includes the route and method for each path.
 
 ```yaml
-      Events:
-        HelloWorld:
-          Type: Api
-          Properties:
-            Path: /
-            Method: get
+Events:
+  HelloWorld:
+    Type: Api
+    Properties:
+      Path: /
+      Method: get
 ```
 
 ## Fetch, tail, and filter Lambda function logs

examples/sam/jest.config.js

@@ -0,0 +1,8 @@
+module.exports = {
+  testEnvironment: 'node',
+  roots: ['<rootDir>/tests'],
+  testMatch: ['**/*.test.ts'],
+  transform: {
+    '^.+\\.tsx?$': 'ts-jest'
+  }
+};