Module: Aws::ClientStubs

Included in:
Client
Defined in:
lib/aws-sdk-core/client_stubs.rb

Overview

This module provides the ability to specify the data and/or errors to return when a client is using stubbed responses. Pass ‘:stub_responses => true` to a client constructor to enable this behavior.

Instance Method Summary collapse

Instance Method Details

#initialize(*args) ⇒ Object 



11
12
13
14
15
16
17
18
19
20
21
 
# File 'lib/aws-sdk-core/client_stubs.rb', line 11

def initialize(*args)
  @stubs = {}
  @stub_mutex = Mutex.new
  super
  if Hash === @config.stub_responses
    @config.stub_responses.each do |operation_name, stubs|
      apply_stubs(operation_name, Array === stubs ? stubs : [stubs])
    end
    @config.stub_responses = true
  end
end

#next_stub(operation_name) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/aws-sdk-core/client_stubs.rb', line 163

def next_stub(operation_name)
  operation_name = operation_name.to_sym
  @stub_mutex.synchronize do
    stubs = @stubs[operation_name] || []
    case stubs.length
    when 0 then default_stub(operation_name)
    when 1 then stubs.first
    else stubs.shift
    end
  end
end

#stub_data(operation_name, data = {}) ⇒ Structure

Generates and returns stubbed response data from the named operation.

s3 = Aws::S3::Client.new
s3.stub_data(:list_buckets)
#=> #<struct Aws::S3::Types::ListBucketsOutput buckets=[], owner=#<struct Aws::S3::Types::Owner display_name="DisplayName", id="ID">>

In addition to generating default stubs, you can provide data to apply to the response stub.

s3.stub_data(:list_buckets, buckets:[{name:'aws-sdk'}])
#=> #<struct Aws::S3::Types::ListBucketsOutput
  buckets=[#<struct Aws::S3::Types::Bucket name="aws-sdk", creation_date=nil>],
  owner=#<struct Aws::S3::Types::Owner display_name="DisplayName", id="ID">>

Parameters:

  • operation_name (Symbol)
  • data (Hash) (defaults to: {})

Returns:

  • (Structure) —

    Returns a stubbed response data structure. The actual class returned will depend on the given ‘operation_name`.



158
159
160
 
# File 'lib/aws-sdk-core/client_stubs.rb', line 158

def stub_data(operation_name, data = {})
  Stubbing::StubData.new(operation(operation_name)).stub(data)
end

#stub_responses(operation_name, *stubs) ⇒ void

This method returns an undefined value.

Configures what data / errors should be returned from the named operation when response stubbing is enabled.

## Basic usage

When you enable response stubbing, the client will generate fake responses and will not make any HTTP requests.

client = Aws::S3::Client.new(stub_responses: true)
client.list_buckets
#=> #<struct Aws::S3::Types::ListBucketsOutput buckets=[], owner=nil>

You can provide stub data that will be returned by the client.

# stub data in the constructor
client = Aws::S3::Client.new(stub_responses: {
  list_buckets: { bukets: [{name: 'my-bucket' }] },
  get_object: { body: 'data' },
})

client.list_buckets.buckets.map(&:name) #=> ['my-bucket']
client.get_object(bucket:'name', key:'key').body.read #=> 'data'

You can also specify the stub data using #stub_responses

client = Aws::S3::Client.new(stub_responses: true)
client.stub_resposnes(:list_buckets, {
  buckets: [{ name: 'my-bucket' }]
})

client.list_buckets.buckets.map(&:name) #=> ['my-bucket']
#=> ['aws-sdk']

Lastly, default stubs can be configured via ‘Aws.config`:

Aws.config[:s3] = {
  stub_responses: {
    list_buckets: { bukets: [{name: 'my-bucket' }] }
  }
}

Aws::S3::Client.new.list_buckets.buckets.map(&:name)
#=> ['my-bucket']

## Stubbing Errors

When stubbing is enabled, the SDK will default to generate fake responses with placeholder values. You can override the data returned. You can also specify errors it should raise.

client.stub_responses(:get_object, 'NotFound')
client.get_object(bucket:'aws-sdk', key:'foo')
#=> raises Aws::S3::Errors::NotFound

client.stub_responses(:get_object, Timeout::Error)
client.get_object(bucket:'aws-sdk', key:'foo')
#=> raises new Timeout::Error

client.stub_responses(:get_object, RuntimeError.new('custom message'))
client.get_object(bucket:'aws-sdk', key:'foo')
#=> raises the given runtime error object

## Stubbing HTTP Responses

As an alternative to providing the response data, you can provide an HTTP response.

client.stub_responses(:get_object, {
  status_code: 200,
  headers: { 'header-name' => 'header-value' },
  body: "...",
})

To stub a HTTP response, pass a Hash with all three of the following keys set:

  • **‘:status_code`** - <Integer> - The HTTP status code

  • **‘:headers`** - Hash<String,String> - A hash of HTTP header keys and values

  • **‘:body`** - <String,IO> - The HTTP response body.

## Stubbing Multiple Responses

Calling an operation multiple times will return similar responses. You can configure multiple stubs and they will be returned in sequence.

client.stub_responses(:head_object, [
  'NotFound',
  { content_length: 150 },
])

client.head_object(bucket:'aws-sdk', key:'foo')
#=> raises Aws::S3::Errors::NotFound

resp = client.head_object(bucket:'aws-sdk', key:'foo')
resp.content_length #=> 150

Parameters:

  • operation_name (Symbol)
  • stubs (Mixed) —

    One or more responses to return from the named operation.

Raises:

  • (RuntimeError) —

    Raises a runtime error when called on a client that has not enabled response stubbing via ‘:stub_responses => true`.



130
131
132
133
134
135
136
137
138
 
# File 'lib/aws-sdk-core/client_stubs.rb', line 130

def stub_responses(operation_name, *stubs)
  if config.stub_responses
    apply_stubs(operation_name, stubs.flatten)
  else
    msg = 'stubbing is not enabled; enable stubbing in the constructor '
    msg << 'with `:stub_responses => true`'
    raise msg
  end
end