Skip to main content

Protect your AWS credentials in unit tests

Project description

pytest_aws_config

Tiny Pytest plugin that mocks your AWS configuration in tests, making your tests independent of the configuration on the developer machine. In particular, it prevents your tests from accessing your AWS credentials.

Why is this useful?

Developers often use AWS configuration files to store (temporary) credentials to IAM users/roles. This is very useful to access the AWS account from the command line. But it also means that tests will run with these credentials.

> export AWS_PROFILE=production
> aws logs describe-log-groups  # analyze some issue on production
> ... time passes ...
> ... write some code ...
> pytest tests  # execute tests

Whoops! These tests just ran with access to your production account. Hopefully everything was correctly mocked or patched.

Installation

Just install this plugin with pip install pytest_aws_config. No configuration necessary.

What about functional tests?

Of course, some of your tests may actually need AWS credentials. You have two options:

  • Disable the plugin when running functional tests: pytest -p no:pytest_aws_config
  • Keep the plugin and use some other mechanism (e.g. a pytest fixture) to set the configuration in the test. Then your tests remain independent of the configuration on the developer machine.

Links

AWS documentation on configuration files and environment variables.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pytest_aws_config-0.1.0.tar.gz (3.1 kB view hashes)

Uploaded source

Built Distribution

pytest_aws_config-0.1.0-py3-none-any.whl (3.7 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page