Module: Sfn::CommandModule::Stack::InstanceMethods

Defined in:
lib/sfn/command_module/stack.rb

Constant Summary collapse

UNPACK_NAME_JOINER =

unpacked stack name joiner/identifier

'-sfn-'
MAX_PARAMETER_ATTEMPTS =

maximum number of attempts to get valid parameter value

5
TEMPLATE_PARAMETER_LOCATIONS =

Template parameter locations

['Parameters', 'parameters']
TEMPLATE_PARAMETER_DEFAULTS =

Template parameter default value locations

['Default', 'defaultValue', 'default']

Instance Method Summary collapse

Instance Method Details

#apply_nested_stacks!(remote_stack, stack) ⇒ Miasma::Models::Orchestration::Stack

Detect nested stacks and apply

Parameters:

  • remote_stack (Miasma::Models::Orchestration::Stack) —

    stack to inspect for nested stacks

  • stack (Miasma::Models::Orchestration::Stack) —

    current stack

Returns:

  • (Miasma::Models::Orchestration::Stack) 


43
44
45
46
47
48
49
50
51
52
 
# File 'lib/sfn/command_module/stack.rb', line 43

def apply_nested_stacks!(remote_stack, stack)
  remote_stack.resources.all.each do |resource|
    if(resource.type == 'AWS::CloudFormation::Stack')
      nested_stack = resource.expand
      apply_nested_stacks!(nested_stack, stack)
      stack.apply_stack(nested_stack)
    end
  end
  stack
end

#apply_stacks!(stack) ⇒ Miasma::Models::Orchestration::Stack

Apply any defined remote stacks

Parameters:

  • stack (Miasma::Models::Orchestration::Stack)

Returns:

  • (Miasma::Models::Orchestration::Stack) 


24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/sfn/command_module/stack.rb', line 24

def apply_stacks!(stack)
  remote_stacks = [config[:apply_stack]].flatten.compact
  remote_stacks.each do |stack_name|
    remote_stack = provider.connection.stacks.get(stack_name)
    if(remote_stack)
      apply_nested_stacks!(remote_stack, stack)
      stack.apply_stack(remote_stack)
    else
      apply_unpacked_stack!(stack_name, stack)
    end
  end
  stack
end

#apply_unpacked_stack!(stack_name, stack) ⇒ Miasma::Models::Orchestration::Stack

Apply all stacks from an unpacked stack

Parameters:

  • stack_name (String) —

    name of parent stack

  • stack (Miasma::Models::Orchestration::Stack)

Returns:

  • (Miasma::Models::Orchestration::Stack) 


59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/sfn/command_module/stack.rb', line 59

def apply_unpacked_stack!(stack_name, stack)
  result = provider.connection.stacks.all.find_all do |remote_stack|
    remote_stack.name.start_with?("#{stack_name}#{UNPACK_NAME_JOINER}")
  end.sort_by(&:name).map do |remote_stack|
    stack.apply_stack(remote_stack)
  end
  unless(result.empty?)
    stack
  else
    ui.error "Failed to apply requested stack. Unable to locate. (#{stack_name})"
    raise "Failed to locate stack: #{stack_name}"
  end
end

#config_root_parameters ⇒ Hash

Returns parameters for root stack create/update.

Returns:

  • (Hash) —

    parameters for root stack create/update



219
220
221
222
223
224
225
 
# File 'lib/sfn/command_module/stack.rb', line 219

def config_root_parameters
  Hash[
    config.fetch(:parameters, {}).find_all do |k,v|
      !k.include?('__')
    end
  ]
end

#populate_parameters!(sparkle, opts = {}) ⇒ Hash

Prompt for parameter values and store result

Parameters:

  • sparkle (SparkleFormation, Hash)
  • opts (Hash) (defaults to: {})

Options Hash (opts):

  • :current_parameters (Hash) —

    current stack parameter values

  • :stack (Miasma::Models::Orchestration::Stack) —

    existing stack

Returns:

  • (Hash) 


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
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/sfn/command_module/stack.rb', line 116

def populate_parameters!(sparkle, opts={})
  current_parameters = opts.fetch(:current_parameters, {})
  current_stack = opts[:stack]
  if(sparkle.is_a?(SparkleFormation))
    parameter_prefix = sparkle.root? ? [] : (sparkle.root_path - [sparkle.root]).map do |s|
      Bogo::Utility.camel(s.name)
    end
    stack_parameters = sparkle.compile.parameters
    stack_parameters = stack_parameters.nil? ? Smash.new : stack_parameters._dump
  else
    parameter_prefix = []
    stack_parameters = TEMPLATE_PARAMETER_LOCATIONS.map do |loc_key|
      sparkle[loc_key]
    end.compact.first || Smash.new
  end
  unless(stack_parameters.empty?)
    if(config.get(:parameter).is_a?(Array))
      config[:parameter] = Smash[
        *config.get(:parameter).map(&:to_a).flatten
      ]
    end
    if(config.get(:parameters))
      config.set(:parameters,
        config.get(:parameters).merge(config.fetch(:parameter, Smash.new))
      )
    else
      config.set(:parameters, config.fetch(:parameter, Smash.new))
    end
    param_banner = false
    stack_parameters.each do |k,v|
      ns_k = (parameter_prefix + [k]).compact.join('__')
      next if config[:parameters][ns_k]
      valid = false
      # When parameter is a hash type, it is being set via
      # intrinsic function and we don't modify
      if(current_parameters[k].is_a?(Hash))
        if(current_stack)
          enable_set = validate_stack_parameter(current_stack, k, ns_k, current_parameters[k])
        else
          enable_set = true
        end
        if(enable_set)
          # NOTE: direct set dumps the stack (nfi). Smash will
          # auto dup it, and works, so yay i guess.
          config[:parameters][ns_k] = Smash.new(current_parameters[k])
          valid = true
        end
      else
        if(current_stack && current_stack.data[:parent_stack])
          use_expected = validate_stack_parameter(current_stack, k, ns_k, current_parameters[k])
          unless(use_expected)
            current_parameters[k] = current_stack.parameters[k]
          end
        end
      end
      attempt = 0
      if(!valid && !param_banner)
        if(sparkle.is_a?(SparkleFormation))
          ui.info "#{ui.color('Stack runtime parameters:', :bold)} - template: #{ui.color(sparkle.root_path.map(&:name).map(&:to_s).join(' > '), :green, :bold)}"
        else
          ui.info ui.color('Stack runtime parameters:', :bold)
        end
        param_banner = true
      end
      until(valid)
        attempt += 1
        default = config[:parameters].fetch(
          ns_k, current_parameters.fetch(
            k, TEMPLATE_PARAMETER_DEFAULTS.map{|loc_key| v[loc_key]}.compact.first
          )
        )
        if(config[:interactive_parameters])
          answer = ui.ask_question("#{k.split(/([A-Z]+[^A-Z]*)/).find_all{|s|!s.empty?}.join(' ')}", :default => default)
        else
          answer = default
        end
        validation = Sfn::Utils::StackParameterValidator.validate(answer, v)
        if(validation == true)
          config[:parameters][ns_k] = answer
          valid = true
        else
          validation.each do |validation_error|
            ui.error validation_error.last
          end
        end
        if(attempt > MAX_PARAMETER_ATTEMPTS)
          ui.fatal 'Failed to receive allowed parameter!'
          exit 1
        end
      end
    end
  end
  Smash[
    config.fetch(:parameters, {}).map do |k,v|
      strip_key = parameter_prefix ? k.sub(/#{parameter_prefix.join('__')}_{2}?/, '') : k
      unless(strip_key.include?('__'))
        [strip_key, v]
      end
    end.compact
  ]
end

#unpack_nesting(name, file, action) ⇒ TrueClass

Unpack nested stack and run action on each stack, applying the previous stacks automatically

Parameters:

  • name (String) —

    container stack name

  • file (Hash) —

    stack template

  • action (String) —

    create or update

Returns:

  • (TrueClass) 


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
 
# File 'lib/sfn/command_module/stack.rb', line 80

def unpack_nesting(name, file, action)
  config[:apply_stacks] ||= []
  stack_count = 0
  file['Resources'].each do |stack_resource_name, stack_resource|

    nested_stack_name = "#{name}#{UNPACK_NAME_JOINER}#{Kernel.sprintf('%0.3d', stack_count)}-#{stack_resource_name}"
    nested_stack_template = stack_resource['Properties']['Stack']

    namespace.const_get(action.to_s.capitalize).new(
      Smash.new(
        :print_only => config[:print_only],
        :template => nested_stack_template,
        :parameters => config.fetch(:parameters, Smash.new).to_smash,
        :apply_stacks => config[:apply_stacks],
        :options => config[:options]
      ),
      [nested_stack_name]
    ).execute!
    unless(config[:print_only])
      config[:apply_stacks].push(nested_stack_name).uniq!
    end
    config[:template] = nil
    provider.connection.stacks.reload
    stack_count += 1
  end

  true
end

#validate_stack_parameter(c_stack, p_key, p_ns_key, c_value) ⇒ TrueClass, FalseClass

Validate stack parameter is properly set via stack resource from parent stack. If not properly set, prompt user for expected behavior. This accounts for states encountered when a nested stack’s parameters are adjusted directly but the resource sets value via intrinsic function.

Parameters:

  • c_stack (Miasma::Models::Orchestration::Stack) —

    current stack

  • p_key (String) —

    stack parameter key

  • p_ns_key (String) —

    namespaced stack parameter key

  • c_value (Hash) —

    currently set value (via intrinsic function)

Returns:

  • (TrueClass, FalseClass) —

    value is validated



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
 
# File 'lib/sfn/command_module/stack.rb', line 238

def validate_stack_parameter(c_stack, p_key, p_ns_key, c_value)
  stack_value = c_stack.parameters[p_key]
  p_stack = c_stack.data[:parent_stack]
  if(c_value.is_a?(Hash))
    case c_value.keys.first
    when 'Ref'
      current_value = p_stack.parameters[c_value.values.first]
    when 'Fn::Att'
      resource_name, output_name = c_value.values.first.split('.', 2)
      ref_stack = p_stack.nested_stacks.detect{|i| i.data[:logical_id] == resource_name}
      if(ref_stack)
        output = ref_stack.outputs.detect do |o|
          o.key == output_name
        end
        if(output)
          current_value = output.value
        end
      end
    end
  else
    current_value = c_value
  end
  if(current_value && current_value.to_s != stack_value.to_s)
    ui.warn 'Nested stack has been altered directly! This update may cause unexpected modifications!'
    ui.warn "Stack name: #{c_stack.name}. Parameter: #{p_key}. Current value: #{stack_value}. Expected value: #{current_value} (via: #{c_value.inspect})"
    answer = ui.ask_question("Use current value or expected value for #{p_key} [current/expected]?", :valid => ['current', 'expected'])
    answer == 'expected'
  else
#            ui.warn "Unable to check #{p_key} for direct value modification. (Cannot auto-check expected value #{c_value.inspect})"
    true
  end
end