pytest-serverless
Automatically mocks resources defined in serverless.yml file using moto and uses them in pytest.
This way you can focus on writing tests rather than defining enormous list of fixtures.
master | PyPI | Python | pytest | Licence |
---|
![Master](https://github.com/whisller/pytest-serverless/workflows/Master/badge.svg) | ![PyPI](https://img.shields.io/pypi/v/pytest-serverless.svg) | ![](https://img.shields.io/pypi/pyversions/pytest-serverless.svg) | 6.2 | ![](https://img.shields.io/pypi/l/pytest-serverless.svg) |
Pre installation requirements
serverless
installedpytest
installed
Installation
pip install pytest-serverless
Usage
Assuming your serverless.yml
file looks like:
service: my-microservice
resources:
Resources:
TableA:
Type: 'AWS::DynamoDB::Table'
DeletionPolicy: Delete
Properties:
TableName: ${self:service}.my-table
AttributeDefinitions:
- AttributeName: id
AttributeType: S
- AttributeName: company_id
AttributeType: S
KeySchema:
- AttributeName: id
KeyType: HASH
GlobalSecondaryIndexes:
- IndexName: company_id
KeySchema:
- AttributeName: company_id
KeyType: HASH
Projection:
ProjectionType: ALL
ProvisionedThroughput:
ReadCapacityUnits: 10
WriteCapacityUnits: 30
ProvisionedThroughput:
ReadCapacityUnits: 10
WriteCapacityUnits: 30
Just mark your test with @pytest.mark.usefixtures("serverless")
and pytest-serverless
will automatically create my-microservice.my-table
dynamodb table.
import boto3
import pytest
@pytest.mark.usefixtures("serverless")
def test():
table = boto3.resource("dynamodb").Table("my-microservice.my-table")
count_of_items = len(table.scan()["Items"])
assert count_of_items == 0
You can use a custom serverless file path setting the envionmnet variable SERVERLESS_FILE_PATH
.
$ export SERVERLESS_FILE_PATH=/path/to/serverless.yml
You can use choose both sls
or serverless
command to run, settings the environment variable SERVERLESS_COMMAND
. It will only accpets sls
or serverless
values.
$ export SERVERLESS_COMMAND=sls
Supported resources
AWS::DynamoDB::Table
AWS::SQS::Queue
AWS::SNS::Topic
AWS::S3::Bucket
AWS::KMS::Key