Module: Sumomo

Defined in:
lib/sumomo.rb,
lib/sumomo/api.rb,
lib/sumomo/cdn.rb,
lib/sumomo/dns.rb,
lib/sumomo/ec2.rb,
lib/sumomo/ecs.rb,
lib/sumomo/stack.rb,
lib/sumomo/network.rb,
lib/sumomo/version.rb

Defined Under Namespace

Modules: Stack Classes: APITester

Constant Summary collapse

VERSION = 
'0.10.8'

Class Method Summary collapse

Class Method Details

.curtimestr ⇒ Object 



336
337
338
 
# File 'lib/sumomo.rb', line 336

def self.curtimestr
  Time.now.strftime('%Y%m%d%H%M%S')
end

.delete_stack(name:, region:, retain_bucket: false) ⇒ Object 



447
448
449
450
451
452
453
454
455
456
457
458
459
460
 
# File 'lib/sumomo.rb', line 447

def self.delete_stack(name:, region:, retain_bucket: false)
  cf = Aws::CloudFormation::Client.new(region: region)
  ec2 = Aws::EC2::Client.new(region: region)

  cf.delete_stack(stack_name: name)
  ec2.delete_key_pair(key_name: make_master_key_name(name: name))

  unless retain_bucket
    wait_for_stack(name: name, region: region)
    s3 = Aws::S3::Resource.new(region: region)
    bucket = s3.bucket(name)
    bucket.delete!
  end
end

.get_drifts(templatedata, cf, stack_name) ⇒ Object 



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/sumomo.rb', line 205

def self.get_drifts(templatedata, cf, stack_name)
  drifts = {}

  templatedata['Resources'].each do |k,info|
    puts "detect drift for #{k}"

    rd = cf.detect_stack_resource_drift({
      stack_name: stack_name, # required
      logical_resource_id: k, # required
    })

    diffinfo = {}
    differences = []

    rd.stack_resource_drift.property_differences.each do |pd|
      res = {}

      %w[property_path expected_value actual_value difference_type].each do |att|
        res[att] = pd.send(att.to_sym)
      end

      differences << res
    end

    %w[resource_type expected_properties actual_properties stack_resource_drift_status].each do |key|
      diffinfo[key] = rd.stack_resource_drift.send(key.to_sym)
    end

    diffinfo['differences'] = differences

    drifts[k] = diffinfo

  rescue Aws::CloudFormation::Errors::ValidationError => e
    drifts[k] = {
      "exception" => e.message
    }

  end

  drifts
end

.get_stack_outputs(name:, region:) ⇒ Object 



468
469
470
471
472
473
474
475
476
477
 
# File 'lib/sumomo.rb', line 468

def self.get_stack_outputs(name:, region:)
  cf = Aws::CloudFormation::Client.new(region: region)

  map = {}
  cf.describe_stacks(stack_name: name).stacks[0].outputs.each do |x|
    map[x.output_key] = x.output_value
  end

  map
end

.humanize_changeset_response(clist, drifts, templatedata) ⇒ Object 



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
331
332
333
334
 
# File 'lib/sumomo.rb', line 282

def self.humanize_changeset_response(clist, drifts, templatedata)
  # refs
  # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CloudFormation/Types/ResourceChange.html
  # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CloudFormation/Types/ResourceTargetDefinition.html

  result = {}

  clist.each do |k,info|

    if info['action'] == 'Modify'

      z = if info['replacement'] != 'False'
        result['Replace'] ||= {}
      else
        result['Modify'] ||= {}
      end

      z[k] = {}

      info['details'].each do |detail|

        propname = detail['attribute'] 
        if detail['attribute'] == 'Properties'
          propname = detail['name']
        end

        fr = templatedata['Resources'][k]
        tr = drifts[k]

        fromprops = fr['Properties']
        toprops = {}

        if tr['actual_properties']
          toprops = JSON.parse(tr['actual_properties'])
        end


        z[k][propname] = {
          'From' => toprops[propname],
          'To' => fromprops[propname]
        }
      end
    else
      z = result[info['action']] ||= {}

      z[k] = {}
    end

  end

  result

end

.make_master_key_key(name:) ⇒ Object 



25
26
27
 
# File 'lib/sumomo.rb', line 25

def self.make_master_key_key(name:)
  "cloudformation/#{make_master_key_name(name: name)}.pem"
end

.make_master_key_name(name:) ⇒ Object 



21
22
23
 
# File 'lib/sumomo.rb', line 21

def self.make_master_key_name(name:)
  "#{name}_master_key"
end

.manage_stack(name:, region:, cmd: 'update', sns_arn: nil, rollback: :unspecified, changeset: false, &block) ⇒ Object 



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
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
 
# File 'lib/sumomo.rb', line 29

def self.manage_stack(
  name:, 
  region:, 
  cmd:'update', 
  sns_arn: nil, 
  rollback: :unspecified, 
  changeset: false, &block)

  cf = Aws::CloudFormation::Client.new(region: region)
  s3 = Aws::S3::Client.new(region: region)
  ec2 = Aws::EC2::Client.new(region: region)

  begin
    s3.head_bucket(bucket: name)
  rescue Aws::S3::Errors::NotFound => e
    s3.create_bucket(bucket: name)
  rescue => e
    puts "Error: #{e}"
    exit 1
  end

  store = S3Cabinet::S3Cabinet.new(nil, nil, name, region)

  master_key_name = make_master_key_name(name: name)
  master_key_key = make_master_key_key(name: name)

  unless store.get(master_key_key)

    resp = nil
    begin
      puts 'No master key found, creating...'
      resp = ec2.create_key_pair(key_name: master_key_name)
    rescue StandardError
      puts 'Master key conflict! Deleting old one'
      ec2.delete_key_pair(key_name: master_key_name)
      resp = ec2.create_key_pair(key_name: master_key_name)
    end

    store.set(master_key_key, resp.key_material)
    store.set("#{master_key_key}.fingerprint", resp.key_fingerprint)

  end

  dummy_number = store.get('cloudformation/dummy_number')
  dummy_number = 0 if dummy_number.nil?
  dummy_number += 1
  store.set('cloudformation/dummy_number', dummy_number)

  hidden_values = []

  template = Momo.cfl do
    inject Sumomo::Stack

    @region = region
    @version_number = dummy_number
    @custom_resources = {}
    @bucket_name = name
    @store = store
    @master_key_name = master_key_name
    @ec2 = ec2
    @cf = cf
    @s3 = s3
    @has_dummy = true
    @dummy_vpc = nil
    @timeout = nil

    instance_eval(&block)

    dummy_vpc = @dummy_vpc

    if @has_dummy
      make 'AWS::EC2::SecurityGroup', name: 'DummyResource' do
        GroupDescription 'Dummy resource for tracking Cloudformation Deployment.'
        VpcId dummy_vpc unless dummy_vpc.nil?
        Tags [{ 'Key' => 'Name', 'Value' => "dummyfordeploy#{dummy_number}" }]
      end
    end

    hidden_values = @hidden_values
  end.templatize

  templatedata = JSON.parse(template)

  if cmd == 'show'
    puts templatedata.to_yaml
    return
  end

  if cmd == 'diff'
    store.set_raw('cloudformation/temporary_template', template)
    update_options = {
      stack_name: name,
      template_url: store.url('cloudformation/temporary_template'),
      parameters: hidden_values,
      capabilities: ['CAPABILITY_IAM', 'CAPABILITY_NAMED_IAM']
    }

    change_set_name = "CanaryChange#{curtimestr}"

    puts "Create change set"

    cf.create_change_set(
      **update_options,
      change_set_name: change_set_name
    )

    resp = nil

    puts "Wait for change set"

    loop do
      sleep 5
      resp = cf.describe_change_set({
        change_set_name: change_set_name,
        stack_name: name
      })
      puts "#{change_set_name} #{resp.status}"

      break unless resp.status.end_with? 'IN_PROGRESS'
    end

    puts "Cleaning up..."

    cf.delete_change_set({
      change_set_name: change_set_name,
      stack_name: name,
    })

    puts 'Change list'

    clist = process_changeset_response(resp)
    drifts = get_drifts(templatedata, cf, name)

    # puts clist.to_yaml
    # puts drifts.to_yaml
    puts humanize_changeset_response(clist, drifts, templatedata).to_yaml

    return
  end

  # TODO: if the template is too big, split it into nested templates

  store.set_raw('cloudformation/template', template)

  update_options = {
    stack_name: name,
    template_url: store.url('cloudformation/template'),
    parameters: hidden_values,
    capabilities: ['CAPABILITY_IAM', 'CAPABILITY_NAMED_IAM']
  }

  begin
    if changeset
      cf.create_change_set(
        **update_options,
        change_set_name: "Change#{curtimestr}"
      )
    else
      cf.update_stack({
        disable_rollback: rollback == :disable,
        **update_options
      })
    end

  rescue StandardError => e
    if e.message.end_with? 'does not exist'
      update_options[:timeout_in_minutes] = @timeout if @timeout
      update_options[:notification_arns] = sns_arn if sns_arn
      cf.create_stack(update_options)
    else
      p update_options
      puts "Error: #{e.message}"
    end
  end
end

.process_changeset_response(resp) ⇒ Object 



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
 
# File 'lib/sumomo.rb', line 247

def self.process_changeset_response(resp)
  result = {}

  resp.changes.each do |change|
    info = {}

    %w[action physical_resource_id resource_type replacement].each do |k|
      info[k] = change.resource_change.send(k.to_sym)
    end

    details = []

    change.resource_change.details.each do |detail|

      detailinfo = {}

      %w[attribute name requires_recreation].each do |k|
        detailinfo[k] = detail.target.send(k.to_sym)
      end

      %w[evaluation change_source causing_entity].each do |k|
        detailinfo[k] = detail.send(k.to_sym)
      end

      details << detailinfo
    end

    info['details'] = details

    result[change.resource_change.logical_resource_id] = info
  end

  result
end

.rollback_stack(name:, region:) ⇒ Object 



462
463
464
465
466
 
# File 'lib/sumomo.rb', line 462

def self.rollback_stack(name:, region:)
  cf = Aws::CloudFormation::Client.new(region: region)

  cf.rollback_stack(stack_name: name)
end

.test_api(apiname, pretty_print, &block) ⇒ Object 



417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
 
# File 'lib/sumomo.rb', line 417

def self.test_api(apiname, pretty_print, &block)
  tester = APITester.new(&block)
  test_name = nil
  if tester.apis.length == 1
    test_name = tester.apis.keys.first
  elsif apiname
    if tester.apis.key? apiname
      test_name = apiname
    else
      puts "Unknown API name. Please choose from one of the APIs: #{tester.apis.keys.inspect}"
    end
  else
    puts "Please choose from one of the APIs: #{tester.apis.keys.inspect}"
  end

  if test_name
    puts "Testing API #{test_name}"
    apigen = Stack::APIGenerator.new(pretty_print: pretty_print, &tester.apis[test_name])

    script = File.read(File.join(Gem.loaded_specs['sumomo'].full_gem_path, 'data', 'sumomo', 'api_modules', 'test_script.js'))
    script.sub!('// {{ ROUTES }}', apigen.generate)
    script.gsub!('{{ SCRIPT }}', apigen.init_script)

    File.write('.test.js', script)
    Stack::APIGenerator.combine_modules('.test_modules')

    exec 'NODE_PATH=.test_modules node .test.js'
  end
end

.wait_for_stack(name:, region:) ⇒ Object 



340
341
342
343
344
345
346
347
348
349
350
351
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
 
# File 'lib/sumomo.rb', line 340

def self.wait_for_stack(name:, region:)
  cf = Aws::CloudFormation::Client.new(region: region)

  stack_id = name

  begin
    resp = cf.describe_stack_events(stack_name: stack_id)
    top_event = resp.stack_events[0]
    top_event_id = top_event.event_id
    puts "#{top_event.logical_resource_id} #{top_event.resource_status} #{top_event.resource_status_reason}"
  rescue StandardError => e
    puts "describe_stack_events: #{e.message}"
  end

  failure_count = 0
  loop do
    begin
      unless /^arn\:/.match(stack_id)
        stack_id = cf.describe_stacks(stack_name: stack_id).stacks[0].stack_id
        # puts "Unique Stack ID: #{stack_id}"
      end

      resp = cf.describe_stack_events(stack_name: stack_id)
      curr = 0
      lines = []
      loop do
        curr_event = resp.stack_events[curr]
        break if curr_event.event_id == top_event_id

        lines << "#{curr_event.logical_resource_id} #{curr_event.resource_status} #{curr_event.resource_status_reason}"
        break if curr == resp.stack_events.length - 1

        curr += 1
      end

      lines.reverse.each { |x| puts x }

      top_event_id = resp.stack_events[0].event_id
    rescue StandardError => e
      puts "describe_stack_events: #{e.message}"
      failure_count += 1
      break if failure_count > 5
    end

    sleep 1
    begin
      resp = cf.describe_stacks(stack_name: stack_id)

      break if /(COMPLETE$)|(FAILED$)/.match(resp.stacks[0].stack_status)
    rescue StandardError => e
      puts "describe_stacks: #{e.message}"
      break
    end
  end
end