Class: CfnStatus

Inherits:
Object
  • Object
show all
Includes:
AwsService
Defined in:
lib/cfn_status.rb,
lib/cfn_status/version.rb,
lib/cfn_status/aws_service.rb

Defined Under Namespace

Modules: AwsService Classes: Error

Constant Summary collapse

VERSION = 
"0.3.0"

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from AwsService

#cfn, #find_stack, #rollback_complete?, #stack_exists?

Constructor Details

#initialize(stack_name, options = {}) ⇒ CfnStatus

Returns a new instance of CfnStatus.



10
11
12
13
14
 
# File 'lib/cfn_status.rb', line 10

def initialize(stack_name, options={})
  @stack_name = stack_name
  @options = options
  reset
end

Instance Attribute Details

#events ⇒ Object (readonly)

Returns the value of attribute events.



9
10
11
 
# File 'lib/cfn_status.rb', line 9

def events
  @events
end

Instance Method Details

#add_events_pages(resp, index_method) ⇒ Object

Examples:

add_events_pages(:start_index)
add_events_pages(:last_shown_index)

if index_method is start_index

loops add_events_pagess through describe_stack_events until "User Initiated" is found

if index_method is last_shown_index

loops add_events_pagess through describe_stack_events until last_shown_index is found



168
169
170
171
172
173
174
175
 
# File 'lib/cfn_status.rb', line 168

def add_events_pages(resp, index_method)
  found = !!send(index_method)
  until found
    resp = cfn.describe_stack_events(stack_name: @stack_name, next_token: resp["next_token"])
    @events += resp["stack_events"]
    found = !!send(index_method)
  end
end

#completed ⇒ Object 



80
81
82
83
84
 
# File 'lib/cfn_status.rb', line 80

def completed
  last_event_status =~ /(_COMPLETE|_FAILED)$/ &&
  @events[0]["logical_resource_id"] == @stack_name &&
  @events[0]["resource_type"] == "AWS::CloudFormation::Stack"
end

#event_time(timestamp) ⇒ Object

stackoverflow.com/questions/18000432/rails-12-hour-am-pm-range-for-a-day



128
129
130
 
# File 'lib/cfn_status.rb', line 128

def event_time(timestamp)
  Time.parse(timestamp.to_s).localtime.strftime("%I:%M:%S%p")
end

#find_update_failed_event ⇒ Object 



200
201
202
203
204
205
206
207
208
209
 
# File 'lib/cfn_status.rb', line 200

def find_update_failed_event
  i = @events.find_index do |event|
    event["resource_type"] == "AWS::CloudFormation::Stack" &&
    event["resource_status_reason"] == "User Initiated"
  end

  @events[0..i].reverse.find do |e|
    e["resource_status"] == "UPDATE_FAILED"
  end
end

#last_event_status ⇒ Object 



86
87
88
 
# File 'lib/cfn_status.rb', line 86

def last_event_status
  @events.dig(0, "resource_status")
end

#last_shown_index ⇒ Object 



185
186
187
188
189
 
# File 'lib/cfn_status.rb', line 185

def last_shown_index
  @events.find_index do |event|
    event["event_id"] == @last_shown_event_id
  end
end

#messages_map ⇒ Object 



227
228
229
230
231
232
233
 
# File 'lib/cfn_status.rb', line 227

def messages_map
  {
    /CloudFormation cannot update a stack when a custom-named resource requires replacing/ => "A workaround is to run ufo again with STATIC_NAME=0 and to switch to dynamic names for resources. Then run ufo again with STATIC_NAME=1 to get back to statically name resources. Note, there are caveats with the workaround.",
    /cannot be associated with more than one load balancer/ => "There's was an issue updating the stack. Target groups can only be associated with one load balancer at a time. The workaround for this is to use UFO_FORCE_TARGET_GROUP=1 and run the command again. This will force the recreation of the target group resource.",
    /SetSubnets is not supported for load balancers of type/ => "Changing subnets for Network Load Balancers is currently not supported. You can try workarouding this with UFO_FORCE_ELB=1 and run the command again. This will force the recreation of the elb resource."
  }
end

#pretty_time(total_seconds) ⇒ Object

stackoverflow.com/questions/4175733/convert-duration-to-hoursminutesseconds-or-similar-in-rails-3-or-ruby



236
237
238
239
240
241
242
243
244
 
# File 'lib/cfn_status.rb', line 236

def pretty_time(total_seconds)
  minutes = (total_seconds / 60) % 60
  seconds = total_seconds % 60
  if total_seconds < 60
    "#{seconds.to_i}s"
  else
    "#{minutes.to_i}m #{seconds.to_i}s"
  end
end

#print_event(e) ⇒ Object 



115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/cfn_status.rb', line 115

def print_event(e)
  message = [
    event_time(e["timestamp"]),
    e["resource_status"],
    e["resource_type"],
    e["logical_resource_id"],
    e["resource_status_reason"]
  ].join(" ")
  message = message.color(:red) if e["resource_status"] =~ /_FAILED/
  puts message
end

#print_events(i) ⇒ Object 



106
107
108
109
110
111
112
113
 
# File 'lib/cfn_status.rb', line 106

def print_events(i)
  @events[0..i].reverse.each do |e|
    print_event(e)
  end

  @last_shown_event_id = @events[0]["event_id"]
  # puts "@last_shown_event_id #{@last_shown_event_id.inspect}"
end

#refresh_events ⇒ Object

Refreshes the @events in memory.



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/cfn_status.rb', line 134

def refresh_events
  resp = cfn.describe_stack_events(stack_name: @stack_name)
  @events = resp["stack_events"]

  # refresh_events uses add_events_pages and resp["next_token"] to load all events until:
  #
  #     1. @last_shown_event_id found - if @last_shown_event_id is set
  #     2. User Initiated Event found - fallback when @last_shown_event_id is not set
  #
  if @last_shown_event_id
    add_events_pages(resp, :last_shown_index)
  else
    add_events_pages(resp, :start_index)
  end

rescue Aws::CloudFormation::Errors::ValidationError => e
  if e.message =~ /Stack .* does not exis/
    @stack_deletion_completed = true
  else
    raise
  end
end

#reset ⇒ Object 



40
41
42
43
44
 
# File 'lib/cfn_status.rb', line 40

def reset
  @events = [] # constantly replaced with recent events
  @last_shown_event_id = nil
  @stack_deletion_completed = nil
end

#rollback_error_message ⇒ Object 



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/cfn_status.rb', line 211

def rollback_error_message
  return unless update_rollback?

  event = find_update_failed_event
  return unless event

  reason = event["resource_status_reason"]
  messages_map.each do |pattern, message|
    if reason =~ pattern
      return message
    end
  end

  reason # default message is original reason if not found in messages map
end

#run ⇒ Object 



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/cfn_status.rb', line 16

def run
  unless stack_exists?(@stack_name)
    puts "The stack #{@stack_name.color(:green)} does not exist."
    return true
  end

  resp = cfn.describe_stacks(stack_name: @stack_name)
  stack = resp.stacks.first

  puts "The current status for the stack #{@stack_name.color(:green)} is #{stack.stack_status.color(:green)}"
  if stack.stack_status =~ /_IN_PROGRESS$/
    puts "Stack events (tailing):"
    # tail all events until done
    @hide_time_took = true
    wait
  else
    puts "Stack events:"
    # show the last events that was user initiated
    refresh_events
    show_events(final: true)
  end
  success?
end

#show_events(final: false) ⇒ Object

Only shows new events



91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/cfn_status.rb', line 91

def show_events(final: false)
  if @last_shown_event_id.nil?
    i = start_index
    print_events(i)
  else
    i = last_shown_index
    # puts "last_shown index #{i}"
    print_events(i-1) unless i == 0
  end

  return if final
  sleep 5 unless ENV['TEST']
  refresh_events
end

#start_index ⇒ Object

Should always find a “User Initiated” stack event when @last_shown_index is not set



178
179
180
181
182
183
 
# File 'lib/cfn_status.rb', line 178

def start_index
  @events.find_index do |event|
    event["resource_type"] == "AWS::CloudFormation::Stack" &&
    event["resource_status_reason"] == "User Initiated"
  end
end

#success? ⇒ Boolean

Returns:

  • (Boolean) 


191
192
193
194
 
# File 'lib/cfn_status.rb', line 191

def success?
  resource_status = @events[0]["resource_status"]
  %w[CREATE_COMPLETE UPDATE_COMPLETE].include?(resource_status)
end

#update_rollback? ⇒ Boolean

Returns:

  • (Boolean) 


196
197
198
 
# File 'lib/cfn_status.rb', line 196

def update_rollback?
  @events[0]["resource_status"] == "UPDATE_ROLLBACK_COMPLETE"
end

#wait ⇒ Object

check for /(_COMPLETE|_FAILED)$/ status



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

def wait
  puts "Waiting for stack to complete"
  start_time = Time.now

  refresh_events
  until completed || @stack_deletion_completed
    show_events(final: false)
  end
  show_events(final: true) # show the final event

  if @stack_deletion_completed
    puts "Stack #{@stack_name} deleted."
    return
  end

  # Never gets beyond here when deleting a stack because the describe stack returns nothing
  # once the stack is deleted. Gets here for stack create and update though.

  if last_event_status =~ /_FAILED/
    puts "Stack failed: #{last_event_status}".color(:red)
    puts "Stack reason #{@events[0]["resource_status_reason"]}".color(:red)
  elsif last_event_status =~ /_ROLLBACK_/
    puts "Stack rolled back: #{last_event_status}".color(:red)
  else # success
    puts "Stack success status: #{last_event_status}".color(:green)
  end

  return if @hide_time_took # set in run
  took = Time.now - start_time
  puts "Time took for stack deployment: #{pretty_time(took).color(:green)}."
  success?
end