Class: Ufo::Stack::Status

Inherits:
Object
  • Object
show all
Includes:
AwsService, Util
Defined in:
lib/ufo/stack/status.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Util

#default_cluster, #display_params, #execute, #pretty_time, #settings, #task_definition_arns, #user_params

Methods included from AwsService

#cloudformation, #cloudwatchlogs, #ec2, #ecr, #ecs, #elb

Constructor Details

#initialize(stack_name) ⇒ Status

Returns a new instance of Status.



33
34
35
36
 
# File 'lib/ufo/stack/status.rb', line 33

def initialize(stack_name)
  @stack_name = stack_name
  reset
end

Instance Attribute Details

#events ⇒ Object (readonly)

Returns the value of attribute events.



31
32
33
 
# File 'lib/ufo/stack/status.rb', line 31

def events
  @events
end

#hide_time_took=(value) ⇒ Object (writeonly)

Sets the attribute hide_time_took

Parameters:

  • value —

    the value to set the attribute hide_time_took to.



32
33
34
 
# File 'lib/ufo/stack/status.rb', line 32

def hide_time_took=(value)
  @hide_time_took = value
end

Instance Method Details

#completed ⇒ Object 



73
74
75
76
 
# File 'lib/ufo/stack/status.rb', line 73

def completed
  last_event_status =~ /(_COMPLETE|_FAILED)$/ &&
  @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



119
120
121
 
# File 'lib/ufo/stack/status.rb', line 119

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

#find_index(name) ⇒ Object 



135
136
137
 
# File 'lib/ufo/stack/status.rb', line 135

def find_index(name)
  send("#{name}_index")
end

#find_update_failed_event ⇒ Object 



161
162
163
164
165
166
167
168
169
170
 
# File 'lib/ufo/stack/status.rb', line 161

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 



78
79
80
 
# File 'lib/ufo/stack/status.rb', line 78

def last_event_status
  @events[0]["resource_status"]
end

#last_shown_index ⇒ Object 



146
147
148
149
150
 
# File 'lib/ufo/stack/status.rb', line 146

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

#messages_map ⇒ Object 



188
189
190
191
192
193
194
 
# File 'lib/ufo/stack/status.rb', line 188

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

#print_event(e) ⇒ Object 



106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/ufo/stack/status.rb', line 106

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 



98
99
100
101
102
103
104
 
# File 'lib/ufo/stack/status.rb', line 98

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 loaded events in memory



124
125
126
127
128
129
130
131
132
133
 
# File 'lib/ufo/stack/status.rb', line 124

def refresh_events
  resp = cloudformation.describe_stack_events(stack_name: @stack_name)
  @events = resp["stack_events"]
rescue Aws::CloudFormation::Errors::ValidationError => e
  if e.message =~ /Stack .* does not exis/
    @stack_deletion_completed = true
  else
    raise
  end
end

#reset ⇒ Object 



38
39
40
41
42
 
# File 'lib/ufo/stack/status.rb', line 38

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

#rollback_error_message ⇒ Object 



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/ufo/stack/status.rb', line 172

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

#show_events(final = false) ⇒ Object

Only shows new events



83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/ufo/stack/status.rb', line 83

def show_events(final=false)
  if @last_shown_event_id.nil?
    i = find_index(:start)
    print_events(i)
  else
    i = find_index(:last_shown)
    # 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 



139
140
141
142
143
144
 
# File 'lib/ufo/stack/status.rb', line 139

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) 


152
153
154
155
 
# File 'lib/ufo/stack/status.rb', line 152

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

#update_rollback? ⇒ Boolean

Returns:

  • (Boolean) 


157
158
159
 
# File 'lib/ufo/stack/status.rb', line 157

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

#wait ⇒ Object

check for /(_COMPLETE|_FAILED)$/ status



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
 
# File 'lib/ufo/stack/status.rb', line 45

def wait
  start_time = Time.now

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

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

  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
  took = Time.now - start_time
  puts "Time took for stack deployment: #{pretty_time(took).color(:green)}."
end