Module: Smash::CloudPowers::AwsStubs

Defined in:
lib/cloud_powers/stubs/aws_stubs.rb

Overview

Provides stubbing for development work in CloudPowers or in a project that uses is. Here’s a little bit of a deeper picture, so this all makes sense… The AWS SDK makes HTTP requests to get things done but if you want to do some development on your project, it might get pretty expensive. In steps “stubbing”. In order to get the SDK to not make any real HTTP requests and at the same time allow the SDK to respond to your code as if it were really making the requests you have to give the client that makes the request in question some fake data that it can use when it builds a response to return to your code. So to stub your client, follow these simple steps:

  1. pick the appropriate client e.g. sqs for Amazon’s queue service, ec2 for their EC2 instances, etc

  2. use the Smash::CloudPowers::AwsResources.<your chosen client> method to create the client and automatically set an appropriate instance variable to that value. This method caches the client so once you’ve stubbed it, you can make any call against it that you stubbed. That method should be called before you need to make any HTTP requests using the client.

and that’s it. You have a stubbed client that you can use for development in your own projects that use the CloudPowers gem or you can screw around with CloudPowers itself, in the console or something like that by stubbing the client and making Smash::CloudPowers method calls that use the client you stubbed.

Class Method Summary collapse

Class Method Details

.broadcast_stub(opts = {}) ⇒ Object

Stub data for a SNS client

Parameters

  • opts Hash

    • stub_responses: defaulted to false but it can be overriden with the desired responses for local testing

    • region: defaulted to use the ‘#region()` method

    • AWS::Credentials object, which will also scour the context and environment for your keys

Returns AWS::SNS client

Example

sns(Smash::CloudPowers::AwsStubs.broadcast_stub) # sets and gets an Kinesis client

create_channel!('testBroadcast')
# => true

Notes

  • defaults can’t be overriden or don’t have good support for for it yet but you can use this hash as a guide for your own custom configuration



132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/cloud_powers/stubs/aws_stubs.rb', line 132

def self.broadcast_stub(opts = {})
  arn = "arn:aws:sns:us-west-2:8123456789:#{opts[:name] || 'testChannel'}"
 stub = {
    stub_responses: {
      create_topic: { topic_arn: arn },
      delete_topic: {},
      list_topics: { topics: [{ topic_arn: arn }], next_token: '1234asdf' },
      publish: { message_id: 'msgidmsgidmsgidmsgid' },
      subscribe: { subscription_arn: 'subarnsubarnsubarn' }
    }
  }
  stub.merge(opts.select { |k,v| stub.key? k })
end

.instance_metadata_stub(opts = {}) ⇒ Object

Stub metadata for EC2 instance

Notes

  • defaults can’t be overriden or don’t have good support for for it yet but you can use this hash as a guide for your own custom configuration



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/cloud_powers/stubs/aws_stubs.rb', line 28

def self.instance_metadata_stub(opts = {})
  {
    'ami-id' => 'ami-1234',
    'ami-launch-index' => '1',
    'ami-manifest-path' => '',
    'block-device-mapping/' => '',
    'hostname' => '',
    'instance-action' => '',
    'instance-id' => 'asd-1234',
    'instance-type' => 't2.nano',
    'kernel-id' => '',
    'local-hostname' => 'ip-10-251-50-12.ec2.internal',
    'local-ipv4' => '',
    'mac network/' => '',
    'placement/' => 'boogers',
    'public-hostname' => 'ec2-203-0-113-25.compute-1.amazonaws.com',
    'public-ipv4' => 'adsfasdfasfd',
    'public-keys/' => 'jfakdsjfkdlsajfkldsajflkasjdfklajsdflkajsldkfjalsdfjaklsdjflasjfklasjdfkals',
    'public-keys/0' => 'asdjfkasdjfkasdjflasjdfklsajdlkfjaldkgfjalkdfgjklsdfjgklsdjfklsjlkdfjakdlfjalskdfjlas',
    'reservation-id' => 'r-fea54097',
    'security-groups' => 'groupidygroupgroupgroup',
    'services/' => ''
  }.merge(opts)
end

.instance_tags_stub(opts = {}) ⇒ Object

Stub metadata for EC2 tags

Notes

  • defaults can’t be overriden or don’t have good support for for it yet but you can use this hash as a guide for your own custom configuration



422
423
424
425
426
427
428
429
 
# File 'lib/cloud_powers/stubs/aws_stubs.rb', line 422

def self.instance_tags_stub(opts = {})
  {
    tags: [
      { key: 'tag_one_key', value: 'tag_one_value' },
      { key: 'tag_two_key', value: 'tag_two_value' }
    ]
  }.merge(opts)
end

.node_stub(opts = {}) ⇒ Object

Get or create an EC2 client and cache that client so that a Context is more well tied together

Parameters

  • opts Hash (optional)

    • stub_responses - defaulted to false but it can be overriden with the desired responses for local testing

    • region - defaulted to use the #region() method

    • AWS::Credentials object, which will also scour the context and environment for your keys

Returns AWS::EC2::Client

Example

ec2(Smash::CloudPowers::AwsStubs.node_stub) # sets and gets an <tt>EC2::Client</tt> that is stubbed with the return data in the config <tt>Hash</tt>

images = ec2.describe_images
images.first[:image_id]
# => 'asdf'

Notes

  • defaults can’t be overriden or don’t have good support for for it yet but you can use this hash as a guide for your own custom configuration



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/cloud_powers/stubs/aws_stubs.rb', line 75

def self.node_stub(opts = {})
  time = opts[:launch_time] || Time.new((Time.now.utc.to_i / 86400 * 86400)) # midnight
  tags = [{key: 'job', value: 'test'}]
  {
    stub_responses: {
      create_tags: {},
      run_instances: {
        instances: [
          { instance_id: 'asd-1234', launch_time: time, state: { name: 'running' } },
          { instance_id: 'qwe-4323', launch_time: time , state: { name: 'running' } },
          { instance_id: 'tee-4322', launch_time: time, state: { name: 'running' } },
          { instance_id: 'bbf-6969', launch_time: time, state: { name: 'running' } },
          { instance_id: 'lkj-0987', launch_time: time, state: { name: 'running' } },
      ]},
      describe_instances: {
        reservations: [
          { instances: [
            { instance_id: 'asd-1234', state: { code: 200, name: 'running' }, tags: tags },
            { instance_id: 'qwe-4323', state: { code: 200, name: 'running' }, tags: tags },
            { instance_id: 'tee-4322', state: { code: 200, name: 'running' }, tags: tags },
            { instance_id: 'bbf-6969', state: { code: 200, name: 'running' }, tags: tags },
            { instance_id: 'lkj-0987', state: { code: 200, name: 'running' }, tags: tags }
      ] }] },
      describe_images: {
        images: [
          { image_id: 'asdf', state: 'available' },
          { image_id: 'fdas', state: 'available' },
          { image_id: 'fdadg', state: 'available' },
          { image_id: 'aswre', state: 'available' },
          { image_id: 'fsnkv', state: 'available' },
        ]
      }
    }
  }
end

.pipe_stub(opts = {}) ⇒ Object

Get or create an Kinesis client and cache that client so that a Context is more well tied together Parameters

  • opts Hash

    • stub_responses: defaulted to false but it can be overriden with the desired responses for local testing

    • region: defaulted to use the ‘#region()` method

    • AWS::Credentials object, which will also scour the context and environment for your keys

Returns AWS::Kinesis client

Example

# sets and gets an Kinesis client.  No need to set a variable because
  one was
# just created as +@kinesis+ and is set to the client
kinesis(Smash::CloudPowers::AwsStubs.pipe_stub)

pipe_to('somePipe') { update_body(status: 'waHoo') }
# => sequence_number: '1676151970'

Notes

  • defaults can’t be overriden or don’t have good support for for it yet but you can use this hash as a guide for your own custom configuration



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/cloud_powers/stubs/aws_stubs.rb', line 172

def self.pipe_stub(opts = {})
  stub = {
    stub_responses: {
      create_stream: {},
      put_record: {
        shard_id: opts[:shard_id] || 'idididididididid',
        sequence_number: opts[:sequence_number] || '1676151970'
      },
      describe_stream: {
        stream_description: {
          stream_creation_timestamp: Time.now - 10,
          stream_name: opts[:name] || 'testPipe',
          stream_arn:  'arnarnarnarnar',
          stream_status: 'ACTIVE',
          shards: [
            { shard_id: '1',
              parent_shard_id: 'wowza',
              hash_key_range: {
                starting_hash_key: 'starting',
                ending_hash_key: 'ending'
              },
              sequence_number_range: {
                starting_sequence_number: '1'
              }
            }
          ],
          has_more_shards: true,
          retention_period_hours: 1,
          enhanced_monitoring: []
        }
      }
    }
  }
  stub.merge(opts.select { |k| stub.key?(k) })
end

.queue_stub(opts = {}) ⇒ Object

Stub data for an SQS client

Parameters

  • opts Hash (optional)

    • :stub_responses - defaulted to false but it can be overriden with the desired responses for local testing

    • :region - defaulted to use the #region() method

    • AWS::Credentials object, which will also scour the context and environment for your keys

Returns AWS::SQS client

Example

sqs(Smash::CloudPowers::AwsStubs.queue_stub(name: 'someQueue'))
create_queue('someQueue') # uses AWS::SQS
# => 'https://sqs.us-west-2.amazonaws.com/12345678/someQueue'

Notes

  • defaults can’t be overriden or don’t have good support for for it yet but you can use this hash as a guide for your own custom configuration



352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/cloud_powers/stubs/aws_stubs.rb', line 352

def self.queue_stub(opts = {})
  msg_body = if opts[:body]
    begin
      if opts[:body].kind_of? Hash
        opts[:body] = opts[:body].to_json
      elsif JSON.parse(opts[:body])
          opts[:body]
      end
    rescue JSON::ParserError
      {foo: 'bar'}.to_json
    end
  end
  {
    stub_responses: {
      create_queue: {
        queue_url: "https://sqs.us-west-2.amazonaws.com/12345678/#{opts[:name] || 'testQueue'}"
      },
      delete_message: {}, # #delete_message() returns nothing
      delete_queue: {}, # #delete_queue() returns nothing
      get_queue_attributes: {
        attributes: { 'ApproximateNumberOfMessages' => rand(1..10).to_s }
      },
      get_queue_url: {
        queue_url: "https://sqs.us-west-2.amazonaws.com/12345678/#{opts[:name] || 'testQueue'}"
      },
      list_queues: {
        queue_urls: ["https://sqs.us-west-2.amazonaws.com/12345678/#{opts[:name] || 'testQueue'}"]
      },
      receive_message: {
        messages: [
          {
            attributes: {
              "ApproximateFirstReceiveTimestamp" => "1442428276921",
              "ApproximateReceiveCount" => "5",
              "SenderId" => "AIDAIAZKMSNQ7TEXAMPLE",
              "SentTimestamp" => "1442428276921"
            },
            body: msg_body || "{\"foo\":\"bar\"}",
            md5_of_body: "51b0a325...39163aa0",
            md5_of_message_attributes: "00484c68...59e48f06",
            message_attributes: {
              "City" => {
                data_type: "String",
                string_value: "Any City"
              },
              "PostalCode" => {
                data_type: "String",
                string_value: "ABC123"
              }
            },
            message_id: "da68f62c-0c07-4bee-bf5f-7e856EXAMPLE",
            receipt_handle: "AQEBzbVv...fqNzFw=="
          }
        ]
      },
      send_message: {
        md5_of_message_attributes: "00484c68...59e48f06",
        md5_of_message_body: "51b0a325...39163aa0",
        message_id: "da68f62c-0c07-4bee-bf5f-7e856EXAMPLE"
      }
    }
  }.merge(opts)
end

.storage_stub(opts = {}) ⇒ Object

Get or create an S3 client and cache that client so that a Context is more well tied together

Parameters

  • opts Hash

    • stub_responses: defaulted to false but it can be overriden with the desired responses for local testing

    • region: defaulted to use the ‘#region()` method

    • AWS::Credentials object, which will also scour the context and environment for your keys

Returns AWS::S3 client

Example

s3(Smash::CloudPowers::AwsStubs.storage_stub)
expect(s3.head_bucket).to be_empty
# passing expectation

Notes

  • defaults can’t be overriden or don’t have good support for for it yet but you can use this hash as a guide for your own custom configuration



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/cloud_powers/stubs/aws_stubs.rb', line 228

def self.storage_stub(opts = {})
  {
    stub_responses: {
      head_bucket: {},
      get_object: {
        body: "require 'cloud_powers'\nclass Testinz; end\n"
      },
      list_objects: {
        is_truncated: false,
        contents: [
          {
            key: 'testinz.rb',
            last_modified: Time.now,
            etag: 'asdf1234',
            size: 123,
            storage_class: 'STANDARD',
            owner: { display_name: 'snargle', id: 'id-bargle132' }
          },
          {
            key: 'file1',
            last_modified: Time.now,
            etag: 'etagerino1',
            size: 1231,
            storage_class: 'STANDARD',
          },
          {
            key: 'file2',
            last_modified: Time.now,
            etag: 'etagerino2',
            size: 1232,
            storage_class: 'STANDARD'
          },
          {
            key: 'file3',
            last_modified: Time.now,
            etag: 'etagerino3',
            size: 1233,
            storage_class: 'STANDARD'
          }
        ],
        name: 'testFile',
        prefix: 'test',
        delimiter: '/',
        max_keys: 1234,
        common_prefixes: [{ prefix: 'test' }, { prefix: '/' }, { prefix: ''}]
      },
      list_buckets: {
        buckets: [
          { creation_date: Time.now, name: (opts[:bucket] || 'test') },
          { creation_date: Time.now, name: (opts[:bucket1] || 'test_bucket1') },
          { creation_date: Time.now, name: (opts[:bucket2] || 'jobs') },
          { creation_date: Time.now, name: (opts[:bucket3] || 'workflows') },
          { creation_date: Time.now, name: (opts[:bucket4] || 'results') },
          { creation_date: Time.now, name: (opts[:bucket5] || 'cloudPowers') },
          { creation_date: Time.now, name: (opts[:bucket6] || 'cloud_powers') },
          { creation_date: Time.now, name: (opts[:bucket7] || 'testBucket') },
          { creation_date: Time.now, name: (opts[:bucket8] || 'zlib') }
        ],
        owner: {display_name: 'snargle', id: 'id-bargle132'}
      },
      list_objects_v2: {
        is_truncated: false,
        contents: [
          { key: 'file1',
            last_modified: Time.now,
            etag: 'etagerino1',
            size: 1231,
            storage_class: 'STANDARD'
          },
          { key: 'file2',
            last_modified: Time.now,
            etag: 'etagerino2',
            size: 1232,
            storage_class: 'STANDARD'
          },
          { key: 'file3',
            last_modified: Time.now,
            etag: 'etagerino3',
            size: 1233,
            storage_class: 'STANDARD'
          },
          {
            key: 'testinz',
            last_modified: Time.now,
            etag: 'asdf1234',
            size: 123,
            storage_class: 'STANDARD',
            owner: { display_name: 'snargle', id: 'id-bargle132' }
          }
        ],
        name: 'name-what?',
        prefix: opts[:prefix] || '/',
        delimiter: opts[:delimiter] || '/',
        max_keys: 9999999999,
        encoding_type: 'String',
        key_count: 3,
        continuation_token: 'continuation-token-12345',
        next_continuation_token: 'continuation-token-12346',
        start_after: '0'
      }
    }
  }
end