Module: Sfn::CommandModule::Template::InstanceMethods

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

Instance Method Summary collapse

Instance Method Details

#dump_stack_for_storage(template) ⇒ Hash

Remove internally used ‘Stack` property from Stack resources and and generate compiled Hash

Parameters:

  • template (SparkleFormation)

Returns:

  • (Hash) 


414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/sfn/command_module/template.rb', line 414

def dump_stack_for_storage(template)
  nested_stacks = template.nested_stacks(:with_resource, :with_name).map do |nested_stack, nested_resource, nested_name|
    [nested_name, nested_resource, nested_resource.properties.delete!(:stack)]
  end
  stack_definition = template.dump
  if config[:plan]
    nested_stacks.each do |nested_name, nested_resource, nested_data|
      nested_resource.properties.set!(:stack, nested_data)
    end
  end
  stack_definition
end

#extract_current_nested_template_parameters(template, stack_name, c_stack = nil) ⇒ Hash

Extract currently defined parameters for nested template

Parameters:

  • template (SparkleFormation)
  • stack_name (String)
  • c_stack (Miasma::Models::Orchestration::Stack) (defaults to: nil)

Returns:

  • (Hash) 


373
374
375
376
377
378
379
380
 
# File 'lib/sfn/command_module/template.rb', line 373

def extract_current_nested_template_parameters(template, stack_name, c_stack = nil)
  if template.parent
    current_parameters = template.parent.compile.resources.set!(stack_name).properties.parameters
    current_parameters.nil? ? Smash.new : current_parameters._dump
  else
    Smash.new
  end
end

#format_nested_stack_results(provider, results) ⇒ Hash

Update the nested stack information for specific provider

Parameters:

  • provider (Symbol)
  • results (Hash)

Returns:

  • (Hash) 


446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
 
# File 'lib/sfn/command_module/template.rb', line 446

def format_nested_stack_results(provider, results)
  case provider
  when :aws
    if results[:parameters]
      results["Parameters"] = results.delete(:parameters)
    end
    if results[:url]
      url = URI.parse(results.delete(:url))
      results["TemplateURL"] = "#{url.scheme}://#{url.host}#{url.path}"
    end
    results
  when :heat, :rackspace
    results[:template] = results.delete(:url)
    results
  when :azure
    if results[:parameters]
      results[:parameters] = Smash[
        results[:parameters].map do |key, value|
          [key,
           value.is_a?(Hash) ? value : Smash.new(:value => value)]
        end
      ]
    end
    if results[:url]
      results[:templateLink] = Smash.new(
        :uri => results.delete(:url),
        :contentVersion => "1.0.0.0",
      )
    end
    results[:mode] = "Incremental"
    results
  else
    raise "Unknown stack provider value given! `#{provider}`"
  end
end

#load_template_file(*args) ⇒ Hash

Load the template file

Parameters:

  • args (Symbol) —

    options (:allow_missing)

Returns:

  • (Hash) —

    loaded template



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
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
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/sfn/command_module/template.rb', line 167

def load_template_file(*args)
  c_stack = (args.detect { |i| i.is_a?(Hash) } || {})[:stack]
  unless config[:template]
    set_paths_and_discover_file!
    unless config[:file]
      unless args.include?(:allow_missing)
        ui.fatal "Invalid formation file path provided: #{config[:file]}"
        raise IOError.new "Failed to locate file: #{config[:file]}"
      end
    end
  end
  if config[:template]
    config[:template]
  elsif config[:file]
    if config[:processing]
      sf = SparkleFormation.compile(config[:file], :sparkle)
      if name_args.first
        sf.name = name_args.first
      end
      compile_state = merge_compile_time_parameters(sf.root?)
      sf.compile_time_parameter_setter do |formation|
        f_name = formation.root_path.map(&:name).map(&:to_s)
        pathed_name = f_name.join(" > ")
        f_name = f_name.join("__")
        if formation.root? && compile_state[f_name].nil?
          current_state = compile_state
        else
          current_state = compile_state.fetch(f_name, Smash.new)
        end

        # NOTE: Prevent nesting stack compile state within stack compile state
        current_state.delete("#{f_name}__#{f_name}")

        if formation.compile_state
          current_state = current_state.merge(formation.compile_state)
        end
        unless formation.parameters.empty?
          ui.info "#{ui.color("Compile time parameters:", :bold)} - template: #{ui.color(pathed_name, :green, :bold)}" unless config[:print_only]
          formation.parameters.each do |k, v|
            valid_keys = [
              "#{f_name}__#{k}",
              Bogo::Utility.camel("#{f_name}__#{k}").downcase,
              k,
              Bogo::Utility.camel(k).downcase,
            ]
            current_value = valid_keys.map do |key|
              current_state[key]
            end.compact.first
            primary_key, secondary_key = ["#{f_name}__#{k}", k]
            current_state[k] = request_compile_parameter(k, v,
                                                         current_value,
                                                         !!formation.parent)
          end
          formation.compile_state = current_state
        end
      end
      sf.sparkle.apply sparkle_collection
      custom_stack_types.each do |s_type|
        unless sf.stack_resource_types.include?(s_type)
          sf.stack_resource_types.push(s_type)
        end
      end
      run_callbacks_for(:template, :stack_name => arguments.first, :sparkle_stack => sf)
      if sf.nested? && config[:apply_nesting]
        validate_nesting_bucket!
        if config[:apply_nesting] == true
          config[:apply_nesting] = :deep
        end
        case config[:apply_nesting].to_sym
        when :deep
          process_nested_stack_deep(sf, c_stack)
        when :shallow
          process_nested_stack_shallow(sf, c_stack)
        when :none
          sf
        else
          raise ArgumentError.new "Unknown nesting style requested: #{config[:apply_nesting].inspect}!"
        end
        sf
      else
        sf
      end
    else
      template = _from_json(File.read(config[:file]))
      run_callbacks_for(:template, :stack_name => arguments.first, :hash_stack => template)
      template
    end
  else
    raise ArgumentError.new "Failed to locate template for processing!"
  end
end

#merge_compile_time_parameters(root_template = false) ⇒ Object

Merge parameters provided directly via configuration into core parameter set



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

def merge_compile_time_parameters(root_template = false)
  compile_state = config.fetch(:compile_parameters, Smash.new)
  ui.debug "Initial compile parameters - #{compile_state}"
  compile_state.keys.each do |cs_key|
    unless cs_key.to_s.start_with?("#{arguments.first}__")
      named_cs_key = [arguments.first, cs_key].compact.join("__")
      if root_template
        non_named = compile_state[cs_key]
      else
        non_named = compile_state.delete(cs_key)
      end
      if non_named && !compile_state.key?(named_cs_key)
        ui.debug "Setting non-named compile parameter `#{cs_key}` into `#{named_cs_key}`"
        compile_state[named_cs_key] = non_named
      elsif non_named && compile_state.key?(named_cs_key)
        ui.debug "Merging none-named `#{cs_key}` with named `#{named_cs_key}`"
        compile_state[named_cs_key].merge!(non_named)
      else
        ui.debug "Discarding non-named compile parameter due to set named - `#{cs_key}` </> `#{named_cs_key}`"
      end
    end
  end
  ui.debug "Merged compile parameters - #{compile_state}"
  compile_state
end

#process_nested_stack_deep(sf, c_stack = nil) ⇒ SparkleFormation::SparkleStruct

Processes template using new deep workflow

Parameters:

  • sf (SparkleFormation) —

    stack

  • c_stack (Miasma::Models::Orchestration::Stack) (defaults to: nil) —

    existing stack

Returns:

  • (SparkleFormation::SparkleStruct) —

    compiled structure



330
331
332
333
334
335
336
337
338
339
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
 
# File 'lib/sfn/command_module/template.rb', line 330

def process_nested_stack_deep(sf, c_stack = nil)
  sf.apply_nesting(:deep) do |stack_name, stack, resource|
    run_callbacks_for(:template, :stack_name => stack_name, :sparkle_stack => stack)
    stack_resource = resource._dump
    current_stack = c_stack ? c_stack.nested_stacks.detect { |s| s.data[:logical_id] == stack_name } : nil
    current_parameters = extract_current_nested_template_parameters(stack, stack_name, current_stack)
    if current_stack && current_stack.data[:parent_stack]
      current_parameters.merge!(
        current_stack.data[:parent_stack].template.fetch(
          "Resources", stack_name, "Properties", "Parameters", current_stack.data[:parent_stack].template.fetch(
            "resources", stack_name, "properties", "parameters", Smash.new
          )
        )
      )
    end
    full_stack_name = [
      config[:nesting_prefix],
      stack.root_path.map(&:name).map(&:to_s).join("_"),
    ].compact.join("/")
    unless config[:print_only]
      result = Smash.new(
        :parameters => populate_parameters!(stack,
                                            :stack => current_stack,
                                            :current_parameters => current_parameters),
      )
      store_template(full_stack_name, stack, result)
    else
      result = Smash.new(
        :url => "http://example.com/bucket/#{full_stack_name}.json",
      )
    end
    format_nested_stack_results(resource._self.provider, result).each do |k, v|
      resource.properties.set!(k, v)
    end
  end
end

#process_nested_stack_shallow(sf, c_stack = nil) ⇒ Hash

Processes template using the original shallow workflow

Parameters:

  • sf (SparkleFormation) —

    stack formation

  • c_stack (Miasma::Models::Orchestration::Stack) (defaults to: nil) —

    existing stack

Returns:

  • (Hash) —

    dumped stack



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/sfn/command_module/template.rb', line 300

def process_nested_stack_shallow(sf, c_stack = nil)
  sf.apply_nesting(:shallow) do |stack_name, stack, resource|
    run_callbacks_for(:template, :stack_name => stack_name, :sparkle_stack => stack)
    if config[:print_only]
      template_url = "http://example.com/bucket/#{name_args.first}_#{stack_name}.json"
    else
      bucket = provider.connection.api_for(:storage).buckets.get(
        config[:nesting_bucket]
      )
      stack_definition = dump_stack_for_storage(stack)
      unless bucket
        raise "Failed to locate configured bucket for stack template storage (#{bucket})!"
      end
      file = bucket.files.build
      file.name = "#{name_args.first}_#{stack_name}.json"
      file.content_type = "text/json"
      file.body = MultiJson.dump(parameter_scrub!(stack_definition))
      file.save
      url = URI.parse(file.url)
      template_url = "#{url.scheme}://#{url.host}#{url.path}"
    end
    resource.properties.set!("TemplateURL", template_url)
  end
end

#prompt_for_template(prefix = nil) ⇒ String

Prompt user for template selection

Parameters:

  • prefix (String) (defaults to: nil) —

    prefix filter for names

Returns:

  • (String) —

    path to template



539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
 
# File 'lib/sfn/command_module/template.rb', line 539

def prompt_for_template(prefix = nil)
  if prefix
    collection_name = prefix.split("__").map do |c_name|
      c_name.split("_").map(&:capitalize).join(" ")
    end.join(" / ")
    ui.info "Viewing collection: #{ui.color(collection_name, :bold)}"
    template_names = sparkle_collection.templates.fetch(provider.connection.provider, {}).keys.find_all do |t_name|
      t_name.to_s.start_with?(prefix.to_s)
    end
  else
    template_names = sparkle_collection.templates.fetch(provider.connection.provider, {}).keys
  end
  collections = template_names.map do |t_name|
    t_name = t_name.to_s.sub(/^#{Regexp.escape(prefix.to_s)}/, "")
    if t_name.include?("__")
      c_name = t_name.split("__").first
      [[prefix, c_name].compact.join("") + "__", c_name]
    end
  end.compact.uniq(&:first)
  templates = template_names.map do |t_name|
    t_name = t_name.to_s.sub(/^#{Regexp.escape(prefix.to_s)}/, "")
    unless t_name.include?("__")
      [[prefix, t_name].compact.join(""), t_name]
    end
  end.compact
  if collections.empty? && templates.empty?
    ui.error "Failed to locate any templates!"
    return nil
  end
  ui.info "Please select an entry#{"(or collection to list)" unless collections.empty?}:"
  output = []
  idx = 1
  valid = {}
  unless collections.empty?
    output << ui.color("Collections:", :bold)
    collections.each do |full_name, part_name|
      valid[idx] = {:name => full_name, :type => :collection}
      output << [idx, part_name.split("_").map(&:capitalize).join(" ")]
      idx += 1
    end
  end
  unless templates.empty?
    output << ui.color("Templates:", :bold)
    templates.each do |full_name, part_name|
      valid[idx] = {:name => full_name, :type => :template}
      output << [idx, part_name.split("_").map(&:capitalize).join(" ")]
      idx += 1
    end
  end
  max = idx.to_s.length
  output.map! do |line|
    if line.is_a?(Array)
      "  #{line.first}.#{" " * (max - line.first.to_s.length)} #{line.last}"
    else
      line
    end
  end
  ui.puts "#{output.join("\n")}\n"
  response = nil
  until valid[response]
    if config[:interactive_parameters]
      response = ui.ask_question("Enter selection").to_i
    else
      raise Error::InteractionDisabled
    end
  end
  entry = valid[response]
  if entry[:type] == :collection
    prompt_for_template(entry[:name])
  else
    sparkle_collection.get(:template, entry[:name])[:path]
  end
end

#request_compile_parameter(p_name, p_config, cur_val, nested = false) ⇒ Object

Request compile time parameter value

Parameters:

  • p_name (String, Symbol) —

    name of parameter

  • p_config (Hash) —

    parameter meta information

  • cur_val (Object, NilClass) —

    current value assigned to parameter

  • nested (TrueClass, FalseClass) (defaults to: false) —

    template is nested

Options Hash (p_config):

  • :type (String, Symbol)
  • :default (String, Symbol)
  • :description (String, Symbol)
  • :multiple (String, Symbol)

Returns:

  • (Object) 


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

def request_compile_parameter(p_name, p_config, cur_val, nested = false)
  result = nil
  attempts = 0
  ui.debug "Fetching compile time param named #{p_name}"
  parameter_type = p_config.fetch(:type, "string").to_s.downcase.to_sym
  if parameter_type == :complex
    ui.debug "Compile time parameter `#{p_name}` is a complex type. Not requesting value from user."
    if cur_val.nil?
      raise ArgumentError.new "No value provided for `#{p_name}` parameter (Complex data type)"
    else
      cur_val
    end
  else
    unless cur_val || p_config[:default].nil?
      cur_val = p_config[:default]
    end
    if cur_val.is_a?(Array)
      cur_val = cur_val.map(&:to_s).join(",")
    end
    until result && (!result.respond_to?(:empty?) || !result.empty?)
      attempts += 1
      if config[:interactive_parameters] && (!nested || !p_config.key?(:prompt_when_nested) || p_config[:prompt_when_nested] == true)
        result = ui.ask_question(
          p_name.to_s.split("_").map(&:capitalize).join,
          :default => cur_val.to_s.empty? ? nil : cur_val.to_s,
        )
      else
        result = cur_val.to_s
      end
      case parameter_type
      when :string
        if p_config[:multiple]
          result = result.split(",").map(&:strip)
        end
      when :number
        if p_config[:multiple]
          result = result.split(",").map(&:strip)
          new_result = result.map do |item|
            new_item = item.to_i
            new_item if new_item.to_s == item
          end
          result = new_result.size == result.size ? new_result : []
        else
          new_result = result.to_i
          result = new_result.to_s == result ? new_result : nil
        end
      else
        raise ArgumentError.new "Unknown compile time parameter type provided: `#{p_config[:type].inspect}` (Parameter: #{p_name})"
      end
      valid = validate_parameter(result, p_config.to_smash)
      unless valid == true
        result = nil
        valid.each do |invalid_msg|
          ui.error "#{p_name}: #{invalid_msg.last}"
        end
      end
      if result.nil? || (result.respond_to?(:empty?) && result.empty?)
        if attempts > MAX_PARAMETER_ATTEMPTS
          ui.fatal "Failed to receive allowed parameter! (Parameter: #{p_name})"
          exit 1
        end
      end
    end
    result
  end
end

#scrub_template(template) ⇒ Hash

Scrub sparkle/sfn customizations from the stack resource data

Parameters:

  • template (Hash)

Returns:

  • (Hash) 


431
432
433
434
435
436
437
438
439
 
# File 'lib/sfn/command_module/template.rb', line 431

def scrub_template(template)
  template = parameter_scrub!(template)
  (template["Resources"] || {}).each do |r_name, r_content|
    if valid_stack_types.include?(r_content["Type"])
      result = (r_content["Properties"] || {}).delete("Stack")
    end
  end
  template
end

#set_paths_and_discover_file! ⇒ TrueClass

Set SparkleFormation paths and locate tempate

Returns:

  • (TrueClass) 


510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
 
# File 'lib/sfn/command_module/template.rb', line 510

def set_paths_and_discover_file!
  if config[:processing]
    if !config[:file] && config[:file_path_prompt]
      config[:file] = prompt_for_template
    else
      file_lookup_path = File.expand_path(config[:file])
      unless File.exists?(file_lookup_path)
        file_lookup_path = config[:file]
      end
      config[:file] = sparkle_collection.get(
        :template, file_lookup_path
      )[:path]
    end
  else
    if config[:file]
      unless File.exists?(config[:file])
        raise Errno::ENOENT.new("No such file - #{config[:file]}")
      end
    else
      raise "Template processing is disabled. Path to serialized template via `--file` required!"
    end
  end
  true
end

#sparkle_collection ⇒ SparkleFormation::SparkleCollection

Returns:

  • (SparkleFormation::SparkleCollection) 


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

def sparkle_collection
  memoize(:sparkle_collection) do
    collection = SparkleFormation::SparkleCollection.new(
      :provider => config.fetch(:credentials, :provider, DEFAULT_PROVIDER_NAME),
    )
    begin
      if config[:base_directory]
        root_pack = SparkleFormation::SparklePack.new(
          :root => config[:base_directory],
          :provider => config.fetch(:credentials, :provider, DEFAULT_PROVIDER_NAME),
        )
      else
        root_pack = SparkleFormation::SparklePack.new(
          :provider => config.fetch(:credentials, :provider, DEFAULT_PROVIDER_NAME),
        )
      end
      collection.set_root(root_pack)
    rescue Errno::ENOENT
      ui.warn "No local SparkleFormation files detected"
    end
    sparkle_packs.each do |pack|
      collection.add_sparkle(pack)
    end
    collection
  end
end

#sparkle_packs ⇒ Array<SparkleFormation::SparklePack>

Returns:

  • (Array<SparkleFormation::SparklePack>) 


116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/sfn/command_module/template.rb', line 116

def sparkle_packs
  memoize(:sparkle_packs) do
    [config.fetch(:sparkle_pack, [])].flatten.compact.map do |sparkle_name|
      begin
        require sparkle_name
      rescue LoadError
        ui.fatal "Failed to locate sparkle pack `#{sparkle_name}` for loading!"
        raise
      end
      begin
        SparkleFormation::Sparkle.new(:name => sparkle_name)
      rescue ArgumentError
        ui.fatal "Failed to properly setup sparkle pack `#{sparkle_name}`. Check implementation."
        raise
      end
    end
  end
end

#store_template(full_stack_name, template, result) ⇒ Hash

Store template in remote bucket and update given result hash

Parameters:

  • full_stack_name (String) —

    unique resource name for template

  • template (SparkleFormation, Hash) —

    template instance

  • result (Hash)

Returns:

  • (Hash) 


388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/sfn/command_module/template.rb', line 388

def store_template(full_stack_name, template, result)
  stack_definition = template.is_a?(SparkleFormation) ? dump_stack_for_storage(template) : template
  if config[:nesting_bucket].to_s.empty?
    raise "Missing required value for option `nesting_bucket`."
  end
  bucket = provider.connection.api_for(:storage).buckets.get(
    config[:nesting_bucket]
  )
  unless bucket
    raise "Failed to locate configured bucket for stack template storage (#{config[:nesting_bucket]})!"
  end
  file = bucket.files.build
  file.name = "#{full_stack_name}.json"
  file.content_type = "text/json"
  file.body = MultiJson.dump(parameter_scrub!(stack_definition))
  file.save
  result.merge!(
    :url => file.url,
  )
end

#template_content(thing, scrub = false) ⇒ Hash

Extract template content based on type

Parameters:

  • thing (SparkleFormation, Hash)
  • scrub (Truthy, Falsey) (defaults to: false) —

    scrub nested templates

Returns:

  • (Hash) 


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

def template_content(thing, scrub = false)
  if thing.is_a?(SparkleFormation)
    if scrub
      dump_stack_for_storage(thing)
    else
      config[:sparkle_dump] ? thing.sparkle_dump : thing.dump
    end
  else
    thing
  end
end

#translate_template(template) ⇒ Hash

Apply template translation

Parameters:

  • template (Hash)

Returns:

  • (Hash) 


486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
 
# File 'lib/sfn/command_module/template.rb', line 486

def translate_template(template)
  if klass_name = config[:translate]
    klass = SparkleFormation::Translation.const_get(camel(klass_name))
    args = {
      :parameters => config.fetch(:options, :parameters, Smash.new),
    }
    if chunk_size = config[:translate_chunk_size]
      args.merge!(
        :options => {
          :serialization_chunk_size => chunk_size,
        },
      )
    end
    translator = klass.new(template, args)
    translator.translate!
    template = translator.translated
    ui.info "#{ui.color("Translation applied:", :bold)} #{ui.color(klass_name, :yellow)}"
  end
  template
end

#validate_nesting_bucket! ⇒ Object

Force user friendly error if nesting bucket is not set within configuration



288
289
290
291
292
293
 
# File 'lib/sfn/command_module/template.rb', line 288

def validate_nesting_bucket!
  if config[:nesting_bucket].to_s.empty?
    ui.error "Missing required configuration value for `nesting_bucket`. Cannot generated nested templates!"
    raise ArgumentError.new "Required configuration value for `nesting_bucket` not provided."
  end
end