This package has been deprecated

Author message:

Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

terraform-artillery

This project is very similar to Nordstrom/serverless-artillery, minus using serverless to deploy the lambdas.

I created the project due to my distaste for serverless. Rather than introduce another AWS deployment tool in to my toolbox, I opted to use Terraform to deploy Artillery in to an AWS Lambda, and then run it remotely.

This project was written with the intent of load testing AWS Api Gateway and accompanying Lambdas. Since a Lambda can only have an execution time of 5 minutes, any test written longer than that will not work or produce strange results. This may be corrected in the future, but for the time being don't write any scenarios that run longer than 5 minutes (your lambda will timeout).

Beware! Executing many iterations in many regions could be an expensive mistake!

Hard Dependencies

• Tested with Terraform 0.9.4 on PATH
  • Other versions may work as long as the tfstate format has not drastically changed
  • Download

Features

• Simultaneously deploy an AWS Lambda to each of the US regions in less than 5 minutes
  • Deployment times may vary based on Lambda package size and connectivity
• Run scenarios N times against all of the deployed lambdas
  • Supports single files or recursive search of a directory
• Scenarios are executed sequentially, but responses arrive asynchronously
• Cloudwatch logging for all deployed lambdas
• Easily pass environment variables to Lambdas through commandline
• Clean up all lambdas once testing has finished
• Results are returned to the computer that executed the tests
  • Can be saved to local disk with --output and analyzed with other tools
  • Accessed programmatically if executing via nodejs
• Currently, load testing times longer than 5 minutes are not supported

Installation

• Install node modules using either
  • yarn install
  • npm install
• If installed globally, then terraform-artillery should be available from the commandline
  • If install locally, use node_modules/.bin/terraform-artillery from the project root

Usage

Create the artifacts

• Before deploying Artillery lambdas, you will need to create the deployment package
• terraform-artillery template
  • This will create a folder called lambda_template that contains the function to be published
  • This also creates a package.json that you will use to package dependencies to your Artillery lambda function
• This directory and files must exist prior to deployment
• Currently, the entry point must be a file called handler.js that exports a function called handler
  • This will probably be made configurable at some point

Quick start

• terraform-artillery template
  • Create template files for deployment
• terraform-artillery deploy --useast1 --uswest1
  • Deploy the template in to two regions
• terraform-artillery invoke --test
  • Run the default tests included with terraform-artillery
  • These tests should all complete, and logs should be available in the created Lambda CloudWatch logs

Deploy the Artillery lambdas:

• Running any deploy tasks will update/overwrite any lambdas that may already be deployed
• Running deploy and changing regions will remove lambdas from any regions no longer specified
• A new deployment package will be created automatically if the hash from the last deployment package doesn't match
• terraform-artillery deploy --all
  • Deploy to all US regions
• terraform-artillery deploy --useast1 --uswest1
  • Each region can be individually added by using the correct command line switch
  • See help for valid options
• terraform-artillery deploy -p --useast1 --uswest1
  • This will display the resources that will be deployed to AWS, but nothing is deployed
  • Useful for testing or seeing if resources have already been deployed

Passing environmental variables

• terraform-artillery deploy --useast1 --env {foo=\"bar\"}
• terraform-artillery deploy --useast1 --env {foo=\"bar\",baz=\"zap\"}
• Environment variables can only be assigned upon deployment, not invocation
  • They can be updated by running the deployment again
• When using the -e/--env switches, map pairs must be entered with quotes around the value
• Use slashes to escape these quotes so the command is interpreted correctly
• Incorrectly following these rules will result in a deployment failure, likely with the message 'variable "env_vars" should be type map, got string'

Destroy the Artillery lambdas:

• terraform-artillery destroy
• Destroys all lambdas in all regions

Invoke the Artillery lambdas:

• terraform-artillery invoke --scenario scenarios/get-aws.amazon.com --iterations 10
  • Invoke the lambdas with the given scenario, for X iterations
• terraform-artillery invoke --scenario scenarios/ --iterations 10 --output
  • Run all scenarios found in the directory specified
  • This is a recursive search so files in sub-directories will also be ran
  • Results will be saved locally into the Results directory
• Scenarios will be run against all currently deployed lambdas

Package the files for lambda deployment (for testing)

• terraform-artillery package
• This step occurs automatically when running terraform-artillery deploy [region] --overwrite
• This is useful for checking the output of your packaging

Display commandline help:

• terraform-artillery help
• terraform-artillery destroy help
• terraform-artillery deploy help
• etc...

Scenarios

• Scenarios are defined exactly the same way as Artillery scenarios
• YML or JSON formats are both acceptable
• Incorrect templates will cause the entire job to fail

Programmatic Usage

• Adding a const tfart = require('terraform-artillery') to a node file will allow you to programmatically invoke terraform-artillery
• Useful for avoiding bash scripts, and invoking the functions directly

License

• Apache 2.0
• Feel free to use any thing from this repo for your own development, just try and remember to give credit
• Original 'handler.js' file was copied from the project Nordstrom/serverless-artillery