aws-e2e-tests

This repository is step by step guide in creating a serverless environment using AWS CDK, while creating end2end tests and unit tests.

If you need help / copy-paste code, check file step-tips.md

To follow the progress, check out TODO list

Check the Testing Strategy to understand the end goals

BEFORE:

To start this, you need access to an AWS Account, both to Console and programmatic access.

step 0: development environment

Setup direnv

Make sure you have direnv installed.

Then you have 2 options,

copy example 1 .envrc.example file as .envrc file, and set your credentials there.
copy .envrc.script as .envrc and create file .aws_profile with your profile information
- you could also encrypt that file contents with AES_ENC_KEY (you need to setup that env variable) to file .aws_profile.enc, which would then be used to set up your AWS environment variables.

When direnv is used correctly, you should see

   $ direnv allow
   direnv: export +AWS_ACCESS_KEY_ID +AWS_DEFAULT_REGION +AWS_SECRET_ACCESS_KEY +AWS_SESSION_TOKEN_DURATION

and you'll see the AWS keys in your environment variables, when on the given directory:

   $ env | grep AWS

Install AWS-CLI (version 2)

To install AWS CLI, follow the official install instructions

Test

This step is ready, when running command

   npx cdk --profile=e2e list

fails with message "--app is required either in command-line, in cdk.json or in ~/.cdk.json"

later, you migth want to install CDK as global node module by running npm install -g cdk after which you can run cdk commands without npx: cdk --profile=e2e list

$ aws lambda list-functions --profile e2e
{
    "Functions": []
}

Harder way - using AWS profiles and installing AWS CLI version 1

AWS account

You start by creating and AWS account or use existing. Also, setup your AWS profile configs according to what is expected.

in ~/.aws/config file the following should apply

[profile e2e]
region = eu-central-1
output = json
source_profile = e2e

and ~/.aws/credentials the following details you get on your AWS Console -> IAM -> Security Credentials

[e2e]
aws_access_key_id=<access key id>
aws_secret_access_key=<secret access key>

Install AWS-CLI (version 1 - depracated).

To do stuff on command line, we need AWS Command Line Interface. To install that, I've used the following procedure

install PyENV and pyenv-virtualenv from

   https://github.com/pyenv/pyenv 
   https://github.com/pyenv/pyenv-virtualenv

Install python version 3.7.6 (or later)

    pyenv install -- list #get list of possible python installations
    pyenv install 3.7.6

set python as version and create a virtualenv

    pyenv local 3.7.6
    pyenv virtualenv aws

activate newly created virtualenv

    pyenv activate aws

install AWS CLI

    pip install awscli

alphpkeemik / aws-e2e-tests