serverless-step-offline.

Currently in beta, but you can play with it.

IMPORTANT: This plugin works only with runtime node.js and only with callback. It does not work with context object.

Install

using npm:

npm install serverless-step-functions-offline --save-dev

or yarn:

yarn serverless-step-functions-offline

Setup

Add the plugin to your serverless.yml

# serverless.yml

plugins:
  - serverless-step-functions-offline

To verify that the plugin works, run this in your command line:

sls step-functions-offline

Requirements

This plugin works only with serverless-step-functions. You must have this plugin installed and correctly specified statemachine definition using Amazon States Language. Example of statemachine definition you can see here

Usage

After all steps are done, need to add to section custom in serverless.yml the key stepFunctionsOffline with properties stateName: path to lambda function. For Example

service: ServerlessStepPlugin
frameworkVersion: ">=1.13.0 <2.0.0"
plugins:
   - serverless-step-functions-offline
...

custom:
  stepFunctionsOffline:
    FirstLambda: firstLambda/index.handler
    ...
    ...
    SecondLambda: myDir/index.main

stepFunctions:
  stateMachines:
    foo:
      definition:
        Comment: "An example of the Amazon States Language using wait states"
        StartAt: FirstLambda
        States:
            FirstLambda:
              Type: Task
              Resource: arn:aws:lambda:eu-west-1:123456789:function:TheFirstLambda
              Next: SecondLambda
            SecondLambda:
              Type: Task
              Resource: arn:aws:lambda:eu-west-1:123456789:function:TheSecondLambda
              End: true

Where FirstLambda is the name of step in state machine The firstLambda/index.handler - it's path to lambda

Run Plugin

 sls step-functions-offline --stateMachine={{name}} --event={{path to event file}}

name - name of state machine in section state functions. In example above it's foo

event file - input values for execution in JSON format (optional)

What does plugin support ?

Future plans

• Support context object
• Support fields Retry, Catch
• Support other languages except node.js
• Improve performance
• Bug Fixing

License

MIT