Mocking boto3 S3 client method Python

by

Botocore has a client stubber you can use for just this purpose: docs.

Here’s an example of putting an error in:

import boto3
from botocore.stub import Stubber

client = boto3.client('s3')
stubber = Stubber(client)
stubber.add_client_error('upload_part_copy')
stubber.activate()

# Will raise a ClientError
client.upload_part_copy()

Here’s an example of putting a normal response in. Additionally, the stubber can now be used in a context. It’s important to note that the stubber will verify, so far as it is able, that your provided response matches what the service will actually return. This isn’t perfect, but it will protect you from inserting total nonsense responses.

import boto3
from botocore.stub import Stubber

client = boto3.client('s3')
stubber = Stubber(client)
list_buckets_response = {
    "Owner": {
        "DisplayName": "name",
        "ID": "EXAMPLE123"
    },
    "Buckets": [{
        "CreationDate": "2016-05-25T16:55:48.000Z",
        "Name": "foo"
    }]
}
expected_params = {}
stubber.add_response('list_buckets', list_buckets_response, expected_params)

with stubber:
    response = client.list_buckets()

assert response == list_buckets_response

More Related Contents:

  1. How to write a file or data to an S3 object using boto3
  2. How to handle errors with boto3?
  3. How to save S3 object to a file using boto3
  4. Listing contents of a bucket with boto3
  5. Can I use boto3 anonymously?
  6. Getting S3 objects’ last modified datetimes with boto
  7. Open S3 object as a string with Boto3
  8. How can I mock requests and the response?
  9. Trying to mock datetime.date.today(), but not working
  10. How to mock an import
  11. Boto3 to download all files from a S3 Bucket
  12. Python: Mocking a context manager
  13. How to upload a file to directory in S3 bucket using boto
  14. Complete scan of dynamoDb with boto3
  15. How to choose an AWS profile when using boto3 to connect to CloudFront
  16. Python mock multiple return values
  17. How can one mock/stub python module like urllib
  18. Error “Read-only file system” in AWS Lambda when downloading a file from S3
  19. Mocking a class: Mock() or patch()?
  20. Mock attributes in Python mock?
  21. Retrieving subfolders names in S3 bucket from boto3
  22. How to read a list of parquet files from S3 as a pandas dataframe using pyarrow?
  23. How to upload File in FastAPI, then to Amazon S3 and finally process it?
  24. Move files between two AWS S3 buckets using boto3
  25. How to monkeypatch python’s datetime.datetime.now with py.test?
  26. How to test or mock “if __name__ == ‘__main__'” contents
  27. python mock – patching a method without obstructing implementation
  28. Django: How to create a model dynamically just for testing
  29. Download a folder from S3 using Boto3
  30. Recommended way to manage credentials with multiple AWS accounts?

Leave a Comment