Introduce SKIP_ZIPPING flag

This commit also changes the structure of `output/`.
Since it is possible to build multiple binaries it is useful to have all of them
in unzipped form. So now we put all binaries under `lambda/${PROFILE}/output/${BIN}`.
Only `boostrap` and `boostrap.debug` files reside in this dir.

Author: Veetaha

CHANGELOG.md

@@ -1,3 +1,10 @@
+# 0.3.0-rust-1.44.1
+
+* Put unzipped `boostrap` and `boostrap.debug` files under `target/lambda/${PROFILE}/output/${BIN}` dir
+to allow for using these artifacts without an intermediate `.zip` file creation step.
+* Introduce `$SKIP_ZIPPING` env var. Setting `-e SKIP_ZIPPING=1` prevents `.zip` archive from
+being created and `package` hook from running.
+
 # 0.2.7-rust-1.44.1
 
 * Upgrade to Rust [`1.44.1`](https://blog.rust-lang.org/2020/06/18/Rust.1.44.1.html)
@@ -105,4 +112,4 @@
 
 # 0.1.*
 
-* Rust versions for `python 3.6` runtime targetting [rust crowbar](https://github.com/ilianaw/rust-crowbar) and [lando](https://github.com/softprops/lando) applications
+* Rust versions for `python 3.6` runtime targetting [rust crowbar](https://github.com/ilianaw/rust-crowbar) and [lando](https://github.com/softprops/lando) applications

README.md

@@ -6,7 +6,7 @@
 This docker image extends [lambda ci `provided`](https://github.com/lambci/docker-lambda#documentation) builder docker image, a faithful reproduction of the actual AWS "**provided**" Lambda runtime environment,
 and installs [rustup](https://rustup.rs/) and the *stable* rust toolchain.
 
-This provides a build environment, consistent with your target execution environment for predicable results.
+This provides a build environment, consistent with your target execution environment for predictable results.
 
 ## 📦 install
 
@@ -21,7 +21,7 @@ You can also depend directly on `softprops/lambda-rust:latest` for the most rece
 
 ## 🤸 usage
 
-The default docker entrypoint will build a packaged release optimized version your Rust artifact under `target/lambda/release` to
+The default docker entrypoint will build a packaged release optimized version of your Rust artifact under `target/lambda/release` to
 isolate the lambda specific build artifacts from your host-local build artifacts.
 
 > **⚠️ Note:** you can switch from the `release` profile to a custom profile like `dev` by providing a `PROFILE` environment variable set to the name of the desired profile. i.e. `-e PROFILE=dev` in your docker run
@@ -30,7 +30,12 @@ isolate the lambda specific build artifacts from your host-local build artifacts
 
 You will want to volume mount `/code` to the directory containing your cargo project.
 
-You can pass additional flags to `cargo`, the Rust build tool, by setting the `CARGO_FLAGS` docker env variable
+You can pass additional flags to `cargo`, the Rust build tool, by setting the `CARGO_FLAGS` docker env variable.
+
+Unzipped `boostrap` and `boostrap.debug` files are always available
+under `target/lambda/${PROFILE}/output/${BIN}` dir. If you want only them and don't
+need a `.zip` archive (e.g. for when running lambdas locally) pass `-e SKIP_ZIPPING=1`
+flag. More on that in [local testing](#-local-testing).
 
 A typical docker run might look like the following.
 
@@ -41,7 +46,6 @@ $ docker run --rm \
     -v ${HOME}/.cargo/git:/root/.cargo/git \
     softprops/lambda-rust
 ```
-
 > 💡 The -v (volume mount) flags for `/root/.cargo/{registry,git}` are optional but when supplied, provides a much faster turn around when doing iterative development
 
 If you are using Windows, the command above may need to be modified to include
@@ -85,17 +89,32 @@ You can take a look at an example [here](./tests/test-func-with-hooks).
 
 Once you've built a Rust lambda function artifact, the `provided` runtime expects
 deployments of that artifact to be named "**bootstrap**". The `lambda-rust` docker image
-builds a zip file, named after the binary, containing your binary files renamed to "bootstrap" for you.
+builds a zip file, named after the binary, containing your binary file renamed to "bootstrap" for you, but zip file creation is unnecessary for local development.
+
+In order to prevent the creation of an intermediate `.zip` artifact when testing your lambdas locally, pass `-e SKIP_ZIPPING=1` during the build. After that the necessary
+output (not zipped) is available under `target/lambda/{profile}/output/{your-lambda-binary-name}` dir.
+You will see both `bootstrap` and `bootstrap.debug` files there.
+> **⚠️ Note:** `SKIP_ZIPPING=1` prevents `package` hook from running.
 
-You can invoke this bootstap executable with the lambda-ci docker image for the `provided` AWS lambda runtime with a one off container.
+You can then invoke this bootstap executable with the lambda-ci docker image for the `provided` AWS lambda runtime with a one off container.
 
 ```sh
+# Build your function skipping the zip creation step
+# You may pass `-e PROFILE=dev` to build using dev profile, but here we use `release`
+docker run \
+    -e SKIP_ZIPPING=1 \
+    -e BIN={your-binary-name} \
+    -v ${PWD}:/code \
+    -v ${HOME}/.cargo/registry:/root/.cargo/registry \
+    -v ${HOME}/.cargo/git:/root/.cargo/git \
+    softprops/lambda-rust
+
 # start a one-off docker container replicating the "provided" lambda runtime
 # awaiting an event to be provided via stdin
 $ docker run \
     -i -e DOCKER_LAMBDA_USE_STDIN=1 \
     --rm \
-    -v ${PWD}/target/lambda/release:/var/task:ro,delegated \
+    -v ${PWD}/target/lambda/release/output/{your-binary-name}:/var/task:ro,delegated \
     lambci/lambda:provided
 
 # provide an event payload via stdin (typically a json blob)

build.sh

@@ -52,23 +52,25 @@ export CARGO_TARGET_DIR=$PWD/target/lambda
 
 function package() {
     file="$1"
-    OUTPUT_FOLDER="output"
+    OUTPUT_FOLDER="output/${file}"
     if [[ "${PROFILE}" == "release" ]] && [[ -z "${DEBUGINFO}" ]]; then
         objcopy --only-keep-debug "$file" "$file.debug"
         objcopy --strip-debug --strip-unneeded "$file"
         objcopy --add-gnu-debuglink="$file.debug" "$file"
     fi
     rm "$file.zip" > 2&>/dev/null || true
     rm -r "${OUTPUT_FOLDER}" > 2&>/dev/null || true
-    mkdir "${OUTPUT_FOLDER}"
+    mkdir -p "${OUTPUT_FOLDER}"
     cp "${file}" "${OUTPUT_FOLDER}/bootstrap"
     cp "${file}.debug" "${OUTPUT_FOLDER}/bootstrap.debug" > 2&>/dev/null || true
-    zip -j "$file.zip" "${OUTPUT_FOLDER}/bootstrap"
 
-    if test -f "$HOOKS_DIR/$PACKAGE_HOOK"; then
-        echo "Running package hook"
-        /bin/bash "$HOOKS_DIR/$PACKAGE_HOOK" $file
-        echo "Package hook ran successfully"
+    if [[ -z "$SKIP_ZIPPING" ]]; then
+        zip -j "$file.zip" "${OUTPUT_FOLDER}/bootstrap"
+        if test -f "$HOOKS_DIR/$PACKAGE_HOOK"; then
+            echo "Running package hook"
+            /bin/bash "$HOOKS_DIR/$PACKAGE_HOOK" $file
+            echo "Package hook ran successfully"
+        fi
     fi
 }
 

tests/test.sh

@@ -8,7 +8,7 @@ IMAGE=${1:-softprops/lambda-rust}
 
 source "${HERE}"/bashtest.sh
 
-# test packaing with a single binary
+# test packaging with a single binary
 package_bin() {
     rm -rf target/lambda/release > /dev/null 2>&1
     docker run --rm \
@@ -17,7 +17,9 @@ package_bin() {
     -v "${HOME}"/.cargo/registry:/root/.cargo/registry \
     -v "${HOME}"/.cargo/git:/root/.cargo/git \
     ${IMAGE} && \
-    ls target/lambda/release/"$1".zip > /dev/null 2>&1
+    ls target/lambda/release/"${1}".zip > /dev/null 2>&1 &&
+    ls target/lambda/release/output/"${1}"/bootstrap 2>&1 &&
+    ls target/lambda/release/output/"${1}"/bootstrap.debug 2>&1
 }
 
 # test packaging all binaries
@@ -28,7 +30,23 @@ package_all() {
     -v "${HOME}"/.cargo/registry:/root/.cargo/registry \
     -v "${HOME}"/.cargo/git:/root/.cargo/git \
     ${IMAGE} && \
-    ls target/lambda/release/"${1}".zip > /dev/null 2>&1
+    ls target/lambda/release/"${1}".zip > /dev/null 2>&1 &&
+    ls target/lambda/release/output/"${1}"/bootstrap 2>&1 &&
+    ls target/lambda/release/output/"${1}"/bootstrap.debug 2>&1
+}
+
+# test SKIP_ZIPPING=1 flag
+compile_without_zipping() {
+    rm -rf target/lambda/release > /dev/null 2>&1
+    docker run --rm \
+    -e SKIP_ZIPPING=1 \
+    -v "${PWD}":/code \
+    -v "${HOME}"/.cargo/registry:/root/.cargo/registry \
+    -v "${HOME}"/.cargo/git:/root/.cargo/git \
+    ${IMAGE} &&
+    !(ls target/lambda/release/"${1}".zip > /dev/null 2>&1) &&
+    ls target/lambda/release/output/"${1}"/bootstrap 2>&1 &&
+    ls target/lambda/release/output/"${1}"/bootstrap.debug 2>&1
 }
 
 # test packaging with PROFILE=dev
@@ -40,7 +58,9 @@ package_all_dev_profile() {
     -v "${HOME}"/.cargo/registry:/root/.cargo/registry \
     -v "${HOME}"/.cargo/git:/root/.cargo/git \
     ${IMAGE} && \
-    ls target/lambda/debug/"${1}".zip > /dev/null 2>&1
+    ls target/lambda/debug/"${1}".zip > /dev/null 2>&1 &&
+    ls target/lambda/release/output/"${1}"/bootstrap 2>&1 &&
+    ls target/lambda/release/output/"${1}"/bootstrap.debug 2>&1
 }
 
 for project in test-func test-multi-func test-func-with-hooks; do
@@ -58,6 +78,8 @@ for project in test-func test-multi-func test-func-with-hooks; do
 
     assert "it packages all bins with dev profile" package_all_dev_profile "${bin_name}"
 
+    assert "it compiles the binaries without zipping when SKIP_ZIPPING=1" compile_without_zipping "${bin_name}"
+
     assert "it packages all bins" package_all "${bin_name}"
 
     # verify packaged artifact by invoking it using the lambdaci "provided" docker image