Move examples to a central directory (aws#487)

* Move examples to a central directory

Signed-off-by: David Calavera <[email protected]>

* Remove duplicated gitignore files.

Signed-off-by: David Calavera <[email protected]>

Author: calavera

.github/workflows/build.yml

@@ -81,6 +81,20 @@ jobs:
       - name: Run clippy check
         run: cargo clippy
 
+  check-examples:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          components: clippy
+          override: true
+      - name: Check examples
+        working-directory: examples
+        shell: bash
+        run: ./check-examples.sh
+
   # publish rustdoc to a gh-pages branch on pushes to main
   # this can be helpful to those depending on the mainline branch
   publish-docs:

.gitignore

@@ -1,4 +1,4 @@
-/target
+target
 /.cargo
 lambda-runtime/libtest.rmeta
 lambda-integration-tests/target

Cargo.toml

@@ -5,4 +5,6 @@ members = [
     "lambda-runtime-api-client",
     "lambda-runtime",
     "lambda-extension"
-]
+]
+
+exclude = ["examples"]

examples/basic-error-handling/Cargo.toml

@@ -0,0 +1,22 @@
+[package]
+name = "error-handling"
+version = "0.1.0"
+edition = "2021"
+
+
+# Use cargo-edit(https://github.com/killercup/cargo-edit#installation)
+# to manage dependencies.
+# Running `cargo add DEPENDENCY_NAME` will
+# add the latest version of a dependency to the list,
+# and it will keep the alphabetic ordering for you.
+
+[dependencies]
+lambda_runtime = { path = "../../lambda-runtime" }
+serde = "1.0.136"
+serde_json = "1.0.81"
+simple-error = "0.2.3"
+tokio = { version = "1", features = ["macros"] }
+tracing = { version = "0.1", features = ["log"] }
+tracing-subscriber = { version = "0.3", default-features = false, features = ["fmt"] }
+
+

examples/basic-error-handling/README.md

@@ -0,0 +1,11 @@
+# AWS Lambda Function example
+
+## Build & Deploy
+
+1. Install [cargo-lambda](https://github.com/cargo-lambda/cargo-lambda#installation)
+2. Build the function with `cargo lambda build --release` 
+3. Deploy the function to AWS Lambda with `cargo lambda deploy --iam-role YOUR_ROLE`
+
+## Build for ARM 64
+
+Build the function with `cargo lambda build --release --arm64` 

lambda-runtime/examples/error-handling.rs renamed to examples/basic-error-handling/src/main.rs

@@ -53,9 +53,6 @@ async fn main() -> Result<(), Error> {
     // While `tracing` is used internally, `log` can be used as well if preferred.
     tracing_subscriber::fmt()
         .with_max_level(tracing::Level::INFO)
-        // this needs to be set to false, otherwise ANSI color codes will
-        // show up in a confusing manner in CloudWatch logs.
-        .with_ansi(false)
         // disabling time is handy because CloudWatch will add the ingestion time.
         .without_time()
         .init();

examples/basic-lambda/Cargo.toml

@@ -0,0 +1,20 @@
+[package]
+name = "basic-lambda"
+version = "0.1.0"
+edition = "2021"
+
+
+# Use cargo-edit(https://github.com/killercup/cargo-edit#installation)
+# to manage dependencies.
+# Running `cargo add DEPENDENCY_NAME` will
+# add the latest version of a dependency to the list,
+# and it will keep the alphabetic ordering for you.
+
+[dependencies]
+lambda_runtime = { path = "../../lambda-runtime" }
+serde = "1.0.136"
+tokio = { version = "1", features = ["macros"] }
+tracing = { version = "0.1", features = ["log"] }
+tracing-subscriber = { version = "0.3", default-features = false, features = ["fmt"] }
+
+

examples/basic-lambda/README.md

@@ -0,0 +1,11 @@
+# AWS Lambda Function example
+
+## Build & Deploy
+
+1. Install [cargo-lambda](https://github.com/cargo-lambda/cargo-lambda#installation)
+2. Build the function with `cargo lambda build --release` 
+3. Deploy the function to AWS Lambda with `cargo lambda deploy --iam-role YOUR_ROLE`
+
+## Build for ARM 64
+
+Build the function with `cargo lambda build --release --arm64` 

lambda-runtime/examples/basic.rs renamed to examples/basic-lambda/src/main.rs

@@ -26,9 +26,6 @@ struct Response {
 async fn main() -> Result<(), Error> {
     tracing_subscriber::fmt()
         .with_max_level(tracing::Level::INFO)
-        // this needs to be set to false, otherwise ANSI color codes will
-        // show up in a confusing manner in CloudWatch logs.
-        .with_ansi(false)
         // disabling time is handy because CloudWatch will add the ingestion time.
         .without_time()
         .init();

examples/basic-shared-resource/Cargo.toml

@@ -0,0 +1,20 @@
+[package]
+name = "shared-resource"
+version = "0.1.0"
+edition = "2021"
+
+
+# Use cargo-edit(https://github.com/killercup/cargo-edit#installation)
+# to manage dependencies.
+# Running `cargo add DEPENDENCY_NAME` will
+# add the latest version of a dependency to the list,
+# and it will keep the alphabetic ordering for you.
+
+[dependencies]
+lambda_runtime = { path = "../../lambda-runtime" }
+serde = "1.0.136"
+tokio = { version = "1", features = ["macros"] }
+tracing = { version = "0.1", features = ["log"] }
+tracing-subscriber = { version = "0.3", default-features = false, features = ["fmt"] }
+
+