stuboto 0.2

Stub boto3 clients to avoid hitting real AWS endpoints in tests

Stuboto

Stub boto3 clients to avoid hitting real AWS endpoints in tests.

Usage

You can use Stuboto instances as if they were botocore.stub.Stubber:

import boto3
from stuboto import stub

def test_create_bucket():
    s3 = boto3.client("s3")
    stubber = stub(s3)

    response = {"Location": "my-bucket"}
    expected_params = {
        "Bucket": "my-bucket",
        "ACL": "private",
    }

    stubber.add_response("create_bucket", response, expected_params)
    service_response = s3.create_bucket(Bucket="my-bucket", ACL="private")
    assert service_response == response

Stuboto instances also are decorated with all the same methods as the original boto3 client so you can also stub responses with the arguably more readable:

import boto3
from stuboto import stub

  def test_create_bucket():
      s3 = boto3.client("s3")
      stubber = stub(s3)

      response = {"Location": "my-bucket"}

      stubber.create_bucket(Bucket="my-bucket", ACL="private").with_response(response)
      service_response = s3.create_bucket(Bucket="my-bucket", ACL="private")
      assert service_response == response

Because you almost always activate botocore.stub.Stubber as soon as you instantiate it, Stuboto instances come pre-activated. However, you can still call stubber.activate() and stubber.deactivate() to your heart's content.

botocore.stub.Stubber documentation suggests:

It should be noted, however, that while missing attributes are often considered correct, your code may not function properly if you leave them out. Therefore you should always fill in every value you see in a typical response for your particular request.

But I won't tell anybody if you leave some values out in favor of writing more readable tests.

Calling a Stuboto method without any arguments is equivalent to passing botocore.stub.ANY for all required parameters.