VBT.Aws.Test (vbt v0.1.0) View Source

Helpers for testing AWS interaction.

Usage

# test_helper.exs
VBT.Aws.Test.setup()

# some_test.exs
test "..." do
  VBT.Aws.Test.stub_request(response)

  assert perform_aws_operation(...) == {:ok, response}

  assert_received {:aws_request, req, config}
  # do something with req and config
end

Link to this section Summary

Functions

setup()

Sets up test mock which implements ExAws.Behaviour.

stub_request(response)

Stubs the :request function of the module returned by VBT.Aws.client/0.

Link to this section Functions

setup()

Specs

setup() :: :ok

Sets up test mock which implements ExAws.Behaviour.

Invoke this function in test_helper.exs to setup the mock. Then, in your tests you can use stub_request/1. If you need a finer grained control, you can also use Mox. See stub_request/1 for details.

stub_request(response)

Specs

stub_request(VBT.Aws.response() | binary()) :: :ok

Stubs the :request function of the module returned by VBT.Aws.client/0.

The response argument can be either VBT.Aws.response/0, which represents the response of the operation, or a binary, in which case the response will be {:ok, %{body: response, headers: [], status_code: 200}}.

This function will also send a message in the shape of {:aws_request, req, config} to the caller process. Therefore, you can use ExUnit.Assertions.assert_receive/3 to retrieve the request, and make further assertions. Note that this will only work if assert_receive/3 is invoked in the same process as stub_request/0. Consequently, this approach will work if this function is invoked from test, or setup blocks, but not from setup_all.

This function is a lightweight wrapper around Mox. If you need more control, you can mock AWS client directly as follows:

Mox.stub(VBT.Aws.client(), :request, fn req, config -> ... end)