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

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

Instance Method Summary collapse

Instance Method Details

#load_template_file(*args) ⇒ Hash

Load the template file

Parameters:

  • args (Symbol) —

    options (:allow_missing)

Returns:

  • (Hash) —

    loaded template



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

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)
      sparkle_packs.each do |pack|
        sf.sparkle.add_sparkle(pack)
      end
      custom_stack_types.each do |s_type|
        unless(sf.stack_resource_types.include?(s_type))
          sf.stack_resource_types.push(s_type)
        end
      end
      if(sf.nested? && !sf.isolated_nests?)
        raise TypeError.new('Template does not contain isolated stack nesting! Sfn does not support mixed mixed resources within root stack!')
      end
      run_callbacks_for(:template, :stack_name => arguments.first, :sparkle_stack => sf)
      if(sf.nested? && config[:apply_nesting])
        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)
        else
          raise ArgumentError.new "Unknown nesting style requested: #{config[:apply_nesting].inspect}!"
        end
      else
        sf.dump.merge('sfn_nested_stack' => !!sf.nested?)
      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

#process_nested_stack_deep(sf, c_stack = nil) ⇒ Hash

Processes template using new deep workflow

Parameters:

  • sf (SparkleFormation) —

    stack

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

    existing stack

Returns:

  • (Hash) —

    dumped stack



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

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_definition = stack.compile.dump!
    stack_resource = resource._dump
    unless(config[:print_only])
      result = Smash.new(
        'Parameters' => populate_parameters!(stack,
          :stack => c_stack ? c_stack.nested_stacks.detect{|s| s.data[:logical_id] == stack_name} : nil,
          :current_parameters => c_stack ? c_stack.template.fetch('Resources', stack_name, 'Properties', 'Parameters', Smash.new) : stack_resource['Properties'].fetch('Parameters', {})
        )
      )
      resource.properties.delete!(:stack)
      bucket = provider.connection.api_for(:storage).buckets.get(
        config[:nesting_bucket]
      )
      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(Sfn::Utils::StackParameterScrubber.scrub!(stack_definition))
      file.save
      url = URI.parse(file.url)
      result.merge!(
        'TemplateURL' => "#{url.scheme}://#{url.host}#{url.path}"
      )
    else
      result = Smash.new(
        'TemplateURL' => "http://example.com/bucket/#{name_args.first}_#{stack_name}.json"
      )
    end
    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



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

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)
    stack_definition = stack.compile.dump!
    bucket = provider.connection.api_for(:storage).buckets.get(
      config[:nesting_bucket]
    )
    if(config[:print_only])
      template_url = "http://example.com/bucket/#{name_args.first}_#{stack_name}.json"
    else
      resource.properties.delete!(: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(Sfn::Utils::StackParameterScrubber.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



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
258
259
260
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
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/sfn/command_module/template.rb', line 229

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.keys.find_all do |t_name|
      t_name.to_s.start_with?(prefix.to_s)
    end
  else
    template_names = sparkle_collection.templates.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])
    response = ui.ask_question('Enter selection').to_i
  end
  entry = valid[response]
  if(entry[:type] == :collection)
    prompt_for_template(entry[:name])
  else
    sparkle_collection.get(:template, entry[:name])[:path]
  end
end

#set_paths_and_discover_file! ⇒ TrueClass

Set SparkleFormation paths and locate tempate

Returns:

  • (TrueClass) 


206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/sfn/command_module/template.rb', line 206

def set_paths_and_discover_file!
  if(config[:processing])
    if(!config[:file] && config[:file_path_prompt])
      config[:file] = prompt_for_template
    else
      config[:file] = sparkle_collection.get(:template, config[:file])[: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) 


26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/sfn/command_module/template.rb', line 26

def sparkle_collection
  memoize(:sparkle_collection) do
    collection = SparkleFormation::SparkleCollection.new
    begin
      if(config[:base_directory])
        root_pack = SparkleFormation::SparklePack.new(:root => config[:base_directory])
      else
        root_pack = SparkleFormation::SparklePack.new
      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>) 


17
18
19
20
21
22
23
 
# File 'lib/sfn/command_module/template.rb', line 17

def sparkle_packs
  memoize(:sparkle_packs) do
    config.fetch(:sparkle_pack, []).map do |sparkle_name|
      SparkleFormation::Sparkle.new(:name => sparkle_name)
    end
  end
end

#translate_template(template) ⇒ Hash

Apply template translation

Parameters:

  • template (Hash)

Returns:

  • (Hash) 


182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/sfn/command_module/template.rb', line 182

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