feat: switch to LocalStack Pro image (#286)

Author: pinzon

.github/workflows/ci.yml

@@ -54,10 +54,13 @@ jobs:
           fi
 
       - name: Start LocalStack
+        env:
+          LOCALSTACK_AUTH_TOKEN: ${{ secrets.LOCALSTACK_AUTH_TOKEN }}
         run: |
-          pip install localstack awscli-local[ver1]
-          docker pull localstack/localstack
-          localstack start -d
+          pip install localstack 
+          docker pull localstack/localstack-pro
+          localstack auth set-token $LOCALSTACK_AUTH_TOKEN
+          localstack start -d 
           localstack wait -t 30
 
       - name: Run Lint and Test

README.md

@@ -7,7 +7,7 @@
 This plugin allows Serverless applications to be deployed and tested on your local machine. Any requests to AWS to be redirected to a running LocalStack instance.
 
 Pre-requisites:
-* LocalStack
+* LocalStack Pro (requires `LOCALSTACK_AUTH_TOKEN` environment variable)
 
 ## Installation
 
@@ -56,6 +56,7 @@ custom:
       # Enable this flag to run "docker ..." commands as sudo
       sudo: False
       compose_file: /home/localstack_compose.yml # optional to use docker compose instead of docker or localstack cli
+    image: localstack/localstack-pro # Docker image to use
   stages:
     local:
       ...
@@ -64,6 +65,7 @@ custom:
 ### Configuration via environment variables
 
 The following environment variables can be configured (taking precedence over the values in `serverless.yml`):
+* `LOCALSTACK_AUTH_TOKEN`: Your LocalStack auth token for LocalStack Pro. Obtain one from [LocalStack](https://app.localstack.cloud/).
 * `AWS_ENDPOINT_URL`: LocalStack endpoint URL to connect to (default: `http://localhost:4566`). This is the recommended configuration, and replaces the deprecated config options (`EDGE_PORT`/`LOCALSTACK_HOSTNAME`/`USE_SSL`) below.
 * `EDGE_PORT`: LocalStack edge port to connect to (deprecated; default: `4566`)
 * `LOCALSTACK_HOSTNAME`: LocalStack host name to connect to (deprecated; default: `localhost`)
@@ -208,6 +210,7 @@ custom:
 ```
 
 ## Change Log
+* v1.4.0: Use LocalStack Pro image (`localstack/localstack-pro`) by default. Addition of `image` config var to set a different image
 * v1.3.1: prevent the mounting of code if the Lambda uses an ECR Image
 * v1.3.0: add support for built-in Esbuild in Serverless Framework v4 #267
 * v1.2.1: Fix custom-resource bucket compatibility with serverless >3.39.0, continue improving support for `AWS_ENDPOINT_URL`

docker-compose.yml

@@ -3,13 +3,14 @@ version: "3.8"
 services:
   localstack:
     container_name: "${LOCALSTACK_DOCKER_NAME:-localstack-main}"
-    image: localstack/localstack
+    image: localstack/localstack-pro
     ports:
       - "127.0.0.1:4566:4566"            # LocalStack Gateway
       - "127.0.0.1:4510-4559:4510-4559"  # external services port range
     environment:
       # LocalStack configuration: https://docs.localstack.cloud/references/configuration/
       - DEBUG=${DEBUG:-0}
+      - LOCALSTACK_AUTH_TOKEN=${LOCALSTACK_AUTH_TOKEN:?LOCALSTACK_AUTH_TOKEN must be set}
     volumes:
       - "${LOCALSTACK_VOLUME_DIR:-./volume}:/var/lib/localstack"
       - "/var/run/docker.sock:/var/run/docker.sock"

package.json

@@ -1,6 +1,6 @@
 {
   "name": "serverless-localstack",
-  "version": "1.3.1",
+  "version": "1.4.0",
   "description": "Connect Serverless to LocalStack!",
   "main": "src/index.js",
   "scripts": {

src/index.js

@@ -27,6 +27,9 @@ const TYPESCRIPT_PLUGIN_BUILD_DIR_BUILTIN_ESBUILD = '.serverless/build'; //TODO
 // Default AWS endpoint URL
 const DEFAULT_AWS_ENDPOINT_URL = 'http://localhost:4566';
 
+// Default LocalStack Image
+const LOCALSTACK_PRO_IMAGE = 'localstack/localstack-pro';
+
 // Cache hostname to avoid unnecessary connection checks
 let resolvedHostname = undefined;
 
@@ -425,6 +428,10 @@ class LocalstackPlugin {
   shouldRunDockerSudo() {
     return (this.config.docker || {}).sudo;
   }
+  
+  getLocalstackImage(){
+    return (this.config.image || process.env.IMAGE_NAME || LOCALSTACK_PRO_IMAGE);
+  }
 
   getStageVariable() {
     const customConfig = this.serverless.service.custom || {};
@@ -535,6 +542,10 @@ class LocalstackPlugin {
       if (this.shouldRunDockerSudo()) {
         env.DOCKER_CMD = 'sudo docker';
       }
+
+
+      env.IMAGE_NAME = this.getLocalstackImage();
+
       const options = { env: env, maxBuffer };
       return exec('localstack start -d', options)
         .then(getContainer)