Class: SparkleFormation

Inherits:
Object
  • Object
show all
Extended by:
Utils::AnimalStrings
Includes:
Bogo::Memoization, Utils::AnimalStrings
Defined in:
lib/sparkle_formation/sparkle_formation.rb,
lib/sparkle_formation.rb,
lib/sparkle_formation/aws.rb,
lib/sparkle_formation/error.rb,
lib/sparkle_formation/utils.rb,
lib/sparkle_formation/sparkle.rb,
lib/sparkle_formation/version.rb,
lib/sparkle_formation/translation.rb,
lib/sparkle_formation/sparkle_struct.rb,
lib/sparkle_formation/translation/heat.rb,
lib/sparkle_formation/sparkle_attribute.rb,
lib/sparkle_formation/sparkle_collection.rb,
lib/sparkle_formation/translation/rackspace.rb

Overview

Formation container

Defined Under Namespace

Modules: SparkleAttribute, Utils Classes: Aws, Cache, Error, Registry, Sparkle, SparkleCollection, SparkleStruct, Translation

Constant Summary collapse

SparklePack =

Alias for interfacing naming

Sparkle
VERSION =

Current library version

Gem::Version.new('1.0.4')
IGNORE_DIRECTORIES =

Returns directory names to ignore.

Returns:

  • (Array<String>) —

    directory names to ignore

[
  'components',
  'dynamics',
  'registry'
]
DEFAULT_STACK_RESOURCE =

Returns default stack resource name.

Returns:

  • (String) —

    default stack resource name

'AWS::CloudFormation::Stack'
VALID_STACK_RESOURCES =

Returns collection of valid stack resource types.

Returns:

  • (Array<String>) —

    collection of valid stack resource types

[DEFAULT_STACK_RESOURCE]
ALLOWED_GENERATION_PARAMETERS = 
['type', 'default']
VALID_GENERATION_PARAMETER_TYPES = 
['String', 'Number']

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Utils::AnimalStrings

camel, snake

Constructor Details

#initialize(name, options = {}) { ... } ⇒ SparkleFormation

Create new instance

Parameters:

  • name (String, Symbol) —

    name of formation

  • options (Hash) (defaults to: {}) —

    options

Options Hash (options):

  • :sparkle_path (String) —

    custom base path

  • :components_directory (String) —

    custom components path

  • :dynamics_directory (String) —

    custom dynamics path

  • :registry_directory (String) —

    custom registry path

  • :parameters (Hash) —

    parameters for stack generation

  • :disable_aws_builtins (Truthy, Falsey) —

    do not load builtins

Yields:

  • base context



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 317

def initialize(name, options={}, &block)
  @name = name.to_sym
  @component_paths = []
  @sparkle = SparkleCollection.new
  @sparkle.set_root(
    Sparkle.new(
      Smash.new.tap{|h|
        s_path = options.fetch(:sparkle_path,
          self.class.custom_paths[:sparkle_path]
        )
        if(s_path)
          h[:root] = s_path
        end
      }
    )
  )
  unless(options[:disable_aws_builtins])
    require 'sparkle_formation/aws'
    SfnAws.load!
  end
  @parameters = set_generation_parameters!(options.fetch(:parameters, {}))
  @stack_resource_types = (
    VALID_STACK_RESOURCES +
    options.fetch(:stack_resource_types, [])
  ).uniq
  @components = Smash.new
  @load_order = []
  @overrides = []
  @parent = options[:parent]
  if(block)
    load_block(block)
  end
  @compiled = nil
end

Instance Attribute Details

#components ⇒ Array (readonly)

Returns components to load.

Returns:

  • (Array) —

    components to load



296
297
298
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 296

def components
  @components
end

#components_directory ⇒ String (readonly)

Returns components path.

Returns:

  • (String) —

    components path



290
291
292
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 290

def components_directory
  @components_directory
end

#dynamics_directory ⇒ String (readonly)

Returns dynamics path.

Returns:

  • (String) —

    dynamics path



292
293
294
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 292

def dynamics_directory
  @dynamics_directory
end

#load_order ⇒ Array (readonly)

Returns order of loading.

Returns:

  • (Array) —

    order of loading



298
299
300
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 298

def load_order
  @load_order
end

#name ⇒ Symbol (readonly)

Returns name of formation.

Returns:

  • (Symbol) —

    name of formation



284
285
286
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 284

def name
  @name
end

#parameters ⇒ Hash (readonly)

Returns parameters for stack generation.

Returns:

  • (Hash) —

    parameters for stack generation



300
301
302
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 300

def parameters
  @parameters
end

#parent ⇒ SparkleFormation

Returns parent stack.

Returns:



302
303
304
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 302

def parent
  @parent
end

#registry_directory ⇒ String (readonly)

Returns registry path.

Returns:

  • (String) —

    registry path



294
295
296
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 294

def registry_directory
  @registry_directory
end

#sparkle ⇒ Sparkle (readonly)

Returns parts store.

Returns:



286
287
288
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 286

def sparkle
  @sparkle
end

#sparkle_path ⇒ String (readonly)

Returns base path.

Returns:

  • (String) —

    base path



288
289
290
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 288

def sparkle_path
  @sparkle_path
end

#stack_resource_types ⇒ Array<String> (readonly)

Returns valid stack resource types.

Returns:

  • (Array<String>) —

    valid stack resource types



304
305
306
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 304

def stack_resource_types
  @stack_resource_types
end

Class Method Details

.build(base = nil) { ... } ⇒ SparkleStruct

Execute given block within struct context

Parameters:

Yields:

  • block to execute

Returns:



112
113
114
115
116
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 112

def build(base=nil, &block)
  struct = base || SparkleStruct.new
  struct.instance_exec(&block)
  struct
end

.builtin_insert(dynamic_name, struct, *args, &block) ⇒ SparkleStruct

Insert a builtin dynamic into a context

Parameters:

  • dynamic_name (String, Symbol) —

    dynamic name

  • struct (SparkleStruct) —

    context for insertion

  • args (Object) —

    parameters for dynamic

Returns:



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

def builtin_insert(dynamic_name, struct, *args, &block)
  if(defined?(SfnAws) && lookup_key = SfnAws.registry_key(dynamic_name))
    _name, _config = *args
    _config ||= {}
    return unless _name
    resource_name = "#{_name}_#{_config.delete(:resource_name_suffix) || dynamic_name}".to_sym
    struct.resources.set!(resource_name)
    new_resource = struct.resources[resource_name]
    new_resource.type lookup_key
    properties = new_resource.properties
    config_keys = _config.keys.zip(_config.keys.map{|k| snake(k).to_s.tr('_', '')})
    SfnAws.resource(dynamic_name, :properties).each do |prop_name|
      key = (config_keys.detect{|k| k.last == snake(prop_name).to_s.tr('_', '')} || []).first
      value = _config[key] if key
      if(value)
        if(value.is_a?(Proc))
          properties[prop_name].to_sym.instance_exec(&value)
        else
          properties.set!(prop_name, value)
        end
      end
    end
    new_resource.instance_exec(&block) if block
    new_resource
  end
end

.compile(path, *args) ⇒ Hashish, SparkleStruct

Compile file

Parameters:

  • path (String) —

    path to file

  • args (Object) —

    use :sparkle to return struct. provide Hash to pass through when compiling (=> {})

Returns:



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

def compile(path, *args)
  opts = args.detect{|i| i.is_a?(Hash) } || {}
  if(spath = (opts.delete(:sparkle_path) || SparkleFormation.sparkle_path))
    container = Sparkle.new(:root => spath)
    path = container.get(:template, path)[:path]
  end
  formation = self.instance_eval(IO.read(path), path, 1)
  if(args.delete(:sparkle))
    formation
  else
    formation.compile(opts)._dump
  end
end

.components_path=(path = nil) ⇒ String Also known as: components_path

Get/set path to component files

Parameters:

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

    path to component files

Returns:

  • (String) —

    path to component files



55
56
57
58
59
60
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 55

def components_path=(path=nil)
  if(path)
    custom_paths[:components_directory] = path
  end
  custom_paths[:components_directory]
end

.custom_paths ⇒ Hashish

Returns custom paths.

Returns:

  • (Hashish) —

    custom paths



31
32
33
34
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 31

def custom_paths
  @_paths ||= SparkleStruct.hashish.new
  @_paths
end

.dynamic(name, args = {}) { ... } ⇒ TrueClass

Define and register new dynamic

Examples:

metadata describes dynamic parameters for _config hash:
:item_name => {:description => 'Defines item name', :type => 'String'}

Parameters:

  • name (String, Symbol) —

    name of dynamic

  • args (Hash) (defaults to: {}) —

    dynamic metadata

Options Hash (args):

  • :parameters (Hash) —

    description of _config parameters

Yields:

  • dynamic block

Returns:

  • (TrueClass) 


165
166
167
168
169
170
171
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 165

def dynamic(name, args={}, &block)
  @dynamics ||= SparkleStruct.hashish.new
  dynamics[name] = SparkleStruct.hashish[
    :block, block, :args, SparkleStruct.hashish[args.map(&:to_a)]
  ]
  true
end

.dynamic_info(name) ⇒ Hashish Also known as: dynamic_information

Metadata for dynamic

Parameters:

  • name (String, Symbol) —

    dynamic name

Returns:

  • (Hashish) —

    metadata information



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

def dynamic_info(name)
  if(dynamics[name])
    dynamics[name][:args] ||= SparkleStruct.hashish.new
  else
    raise KeyError.new("No dynamic registered with provided name (#{name})")
  end
end

.dynamics ⇒ Hashish

Returns loaded dynamics.

Returns:

  • (Hashish) —

    loaded dynamics



26
27
28
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 26

def dynamics
  @dynamics ||= SparkleStruct.hashish.new
end

.dynamics_path=(path = nil) ⇒ String Also known as: dynamics_path

Get/set path to dynamic files

Parameters:

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

    path to dynamic files

Returns:

  • (String) —

    path to dynamic files



67
68
69
70
71
72
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 67

def dynamics_path=(path=nil)
  if(path)
    custom_paths[:dynamics_directory] = path
  end
  custom_paths[:dynamics_directory]
end

.from_hash(hash) ⇒ SparkleStruct

Note:

will do best effort on camel key auto discovery

Convert hash to SparkleStruct instance

Parameters:

  • hash (Hashish)

Returns:



272
273
274
275
276
277
278
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 272

def from_hash(hash)
  struct = SparkleStruct.new
  struct._camel_keys_set(:auto_discovery)
  struct._load(hash)
  struct._camel_keys_set(nil)
  struct
end

.insert(dynamic_name, struct, *args, &block) ⇒ SparkleStruct

Insert a dynamic into a context

Parameters:

  • dynamic_name (String, Symbol) —

    dynamic name

  • struct (SparkleStruct) —

    context for insertion

  • args (Object) —

    parameters for dynamic

Returns:



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 192

def insert(dynamic_name, struct, *args, &block)
  result = false
  begin
    dyn = struct._self.sparkle.get(:dynamic, dynamic_name)
    raise dyn if dyn.is_a?(Exception)
    result = struct.instance_exec(*args, &dyn[:block])
    if(block_given?)
      result.instance_exec(&block)
    end
    result = struct
  rescue Error::NotFound::Dynamic
    result = builtin_insert(dynamic_name, struct, *args, &block)
  end
  unless(result)
    raise "Failed to locate requested dynamic block for insertion: #{dynamic_name} (valid: #{struct._self.sparkle.dynamics.keys.sort.join(', ')})"
  end
  result
end

.load_component(path) ⇒ SparkleStruct

Load component

Parameters:

  • path (String) —

    path to component

Returns:



122
123
124
125
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 122

def load_component(path)
  self.instance_eval(IO.read(path), path, 1)
  @_struct
end

.load_dynamics!(directory) ⇒ TrueClass

Load all dynamics within a directory

Parameters:

  • directory (String)

Returns:

  • (TrueClass) 


131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 131

def load_dynamics!(directory)
  @loaded_dynamics ||= []
  Dir.glob(File.join(directory, '*.rb')).each do |dyn|
    dyn = File.expand_path(dyn)
    next if @loaded_dynamics.include?(dyn)
    self.instance_eval(IO.read(dyn), dyn, 1)
    @loaded_dynamics << dyn
  end
  @loaded_dynamics.uniq!
  true
end

.load_registry!(directory) ⇒ TrueClass

Load all registry entries within a directory

Parameters:

  • directory (String)

Returns:

  • (TrueClass) 


147
148
149
150
151
152
153
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 147

def load_registry!(directory)
  Dir.glob(File.join(directory, '*.rb')).each do |reg|
    reg = File.expand_path(reg)
    require reg
  end
  true
end

.nest(template, struct, *args, &block) ⇒ SparkleStruct

Note:

if symbol is provided for template, double underscores will be used for directory separator and dashes will match underscores

Nest a template into a context

Parameters:

  • template (String, Symbol) —

    template to nest

  • struct (SparkleStruct) —

    context for nesting

  • args (String, Symbol) —

    stringified and underscore joined for name

Returns:



219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 219

def nest(template, struct, *args, &block)
  to_nest = struct._self.sparkle.get(:template, template)
  resource_name = (args.empty? ? template.to_s.gsub('__', '_') : args.map{|a| Bogo::Utility.snake(a)}.join('_')).to_sym
  nested_template = self.compile(to_nest[:path], :sparkle)
  nested_template.parent = struct._self
  struct.resources.set!(resource_name) do
    type DEFAULT_STACK_RESOURCE
  end
  struct.resources[resource_name].properties.stack nested_template
  if(block_given?)
    struct.resources[resource_name].instance_exec(&block)
  end
  struct.resources[resource_name]
end

.registry_path=(path = nil) ⇒ String Also known as: registry_path

Get/set path to registry files

Parameters:

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

    path to registry files

Returns:

  • (String) —

    path to registry files



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

def registry_path=(path=nil)
  if(path)
    custom_paths[:registry_directory] = path
  end
  custom_paths[:registry_directory]
end

.sparkle_path=(path = nil) ⇒ String Also known as: sparkle_path

Get/set path to sparkle directory

Parameters:

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

    path to directory

Returns:

  • (String) —

    path to directory



40
41
42
43
44
45
46
47
48
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 40

def sparkle_path=(path=nil)
  if(path)
    custom_paths[:sparkle_path] = path
    custom_paths[:components_directory] = File.join(path, 'components')
    custom_paths[:dynamics_directory] = File.join(path, 'dynamics')
    custom_paths[:registry_directory] = File.join(path, 'registry')
  end
  custom_paths[:sparkle_path]
end

Instance Method Details

#apply_deep_nesting(*args) {|stack, resource, s_name| ... } ⇒ Hash

Apply deeply nested stacks. This is the new nesting approach and does not bubble parameters up to the root stack. Parameters are isolated to the stack resource itself and output mapping is automatically applied.

Yield Parameters:

  • stack (SparkleFormation) —

    stack instance

  • resource (AttributeStruct) —

    the stack resource

  • s_name (String) —

    stack resource name

Yield Returns:

  • (Hash) —

    key/values to be merged into resource properties

Returns:

  • (Hash) —

    dumped stack



568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 568

def apply_deep_nesting(*args, &block)
  outputs = collect_outputs
  nested_stacks(:with_resource).each do |stack, resource|
    unless(stack.nested_stacks.empty?)
      stack.apply_deep_nesting(*args)
    end
    stack.compile.parameters.keys!.each do |parameter_name|
      if(output_name = output_matched?(parameter_name, outputs.keys))
        next if outputs[output_name] == stack
        stack_output = stack.make_output_available(output_name, outputs)
        resource.properties.parameters.set!(parameter_name, stack_output)
      end
    end
  end
  if(block_given?)
    extract_templates(&block)
  end
  compile.dump!
end

#apply_nesting(*args, &block) ⇒ Hash

Note:

see specific version for expected block parameters

Apply nesting logic to stack

Parameters:

  • nest_type (Symbol) —

    values: :shallow, :deep (default: :deep)

Returns:

  • (Hash) —

    dumped stack



550
551
552
553
554
555
556
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 550

def apply_nesting(*args, &block)
  if(args.include?(:shallow))
    apply_shallow_nesting(&block)
  else
    apply_deep_nesting(&block)
  end
end

#apply_shallow_nesting(*args) {|resource_name, stack| ... } ⇒ Hash

Apply shallow nesting. This style of nesting will bubble parameters up to the root stack. This type of nesting is the original and now deprecated, but remains for compat issues so any existing usage won’t be automatically busted.

Yield Parameters:

  • resource_name (String) —

    name of stack resource

  • stack (SparkleFormation) —

    nested stack

Yield Returns:

  • (String) —

    Remote URL storage for template

Returns:

  • (Hash) 


662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 662

def apply_shallow_nesting(*args, &block)
  parameters = compile[:parameters] ? compile[:parameters]._dump : {}
  output_map = {}
  nested_stacks(:with_resource, :with_name).each do |stack, stack_resource, stack_name|
    remap_nested_parameters(compile, parameters, stack_name, stack_resource, output_map)
  end
  extract_templates(&block)
  compile.parameters parameters
  if(args.include?(:bubble_outputs))
    outputs_hash = Hash[
      output_map do |name, value|
        [name, {'Value' => {'Fn::GetAtt' => value}}]
      end
    ]
    if(compile.outputs)
      compile._merge(SparkleStruct.new(outputs_hash))
    else
      compile.outputs output_hash
    end
  end
  compile.dump!
end

#block(block) ⇒ TrueClass Also known as: load_block

Add block to load order

Parameters:

  • block (Proc)

Returns:

  • (TrueClass) 


408
409
410
411
412
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 408

def block(block)
  @components[:__base__] = block
  @load_order << :__base__
  true
end

#collect_outputs(*args) ⇒ Smash<output_name:SparkleFormation>

Returns:

  • (Smash<output_name:SparkleFormation>) 


686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 686

def collect_outputs(*args)
  if(args.include?(:force) || root?)
    if(compile.outputs)
      outputs = Smash[
        compile.outputs.keys!.zip(
          [self] * compile.outputs.keys!.size
        )
      ]
    else
      outputs = Smash.new
    end
    nested_stacks.each do |nested_stack|
      outputs = nested_stack.collect_outputs(:force).merge(outputs)
    end
    outputs
  else
    root.collect_outputs(:force)
  end
end

#compile(args = {}) ⇒ SparkleStruct

Compile the formation

Parameters:

  • args (Hash) (defaults to: {})

Options Hash (args):

  • :state (Hash) —

    local state parameters

Returns:



447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 447

def compile(args={})
  unless(@compiled)
    compiled = SparkleStruct.new
    compiled._set_self(self)
    if(args[:state])
      compiled.set_state!(args[:state])
    end
    @load_order.each do |key|
      self.class.build(compiled, &components[key])
    end
    @overrides.each do |override|
      if(override[:args] && !override[:args].empty?)
        compiled._set_state(override[:args])
      end
      self.class.build(compiled, &override[:block])
    end
    @compiled = compiled
  end
  @compiled
end

#dump ⇒ Hash

Returns dumped hash.

Returns:

  • (Hash) —

    dumped hash



758
759
760
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 758

def dump
  MultiJson.load(self.to_json)
end

#extract_templates {|stack, resource, s_name| ... } ⇒ Object

Extract and process nested stacks

Yield Parameters:

  • stack (SparkleFormation) —

    stack instance

  • resource (AttributeStruct) —

    the stack resource

  • s_name (String) —

    stack resource name

Yield Returns:

  • (Hash) —

    key/values to be merged into resource properties



636
637
638
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 636

def extract_templates(&block)
  stack_template_extractor(nested_stacks(:with_resource, :with_name), &block)
end

#generate_policy ⇒ Hash

TODO:

this is very AWS specific, so make this easy for swapping

Generate policy for stack

Returns:

  • (Hash) 


520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 520

def generate_policy
  statements = []
  compile.resources.keys!.each do |r_name|
    r_object = compile.resources[r_name]
    if(r_object['Policy'])
      r_object['Policy'].keys!.each do |effect|
        statements.push(
          'Effect' => effect.to_s.capitalize,
          'Action' => [r_object['Policy'][effect]].flatten.compact.map{|i| "Update:#{i}"},
          'Resource' => "LogicalResourceId/#{r_name}",
          'Principal' => '*'
        )
      end
      r_object.delete!('Policy')
    end
  end
  statements.push(
    'Effect' => 'Allow',
    'Action' => 'Update:*',
    'Resource' => '*',
    'Principal' => '*'
  )
  Smash.new('Statement' => statements)
end

#includes_policies?(stack_hash = nil) ⇒ TrueClass, FalseClass

Returns policies defined.

Returns:

  • (TrueClass, FalseClass) —

    policies defined



509
510
511
512
513
514
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 509

def includes_policies?(stack_hash=nil)
  stack_hash = compile.dump! unless stack_hash
  stack_hash.fetch('Resources', {}).any? do |name, resource|
    resource.has_key?('Policy')
  end
end

#isolated_nests?(stack_hash = nil) ⇒ TrueClass, FalseClass

Returns includes only nested stacks.

Returns:

  • (TrueClass, FalseClass) —

    includes only nested stacks



501
502
503
504
505
506
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 501

def isolated_nests?(stack_hash=nil)
  stack_hash = compile.dump! unless stack_hash
  stack_hash.fetch('Resources', {}).all? do |name, resource|
    stack_resource_type?(resource['Type'])
  end
end

#load(*args) ⇒ self

Load components into instance

Parameters:

  • args (String, Symbol) —

    Symbol component names or String paths

Returns:

  • (self) 


419
420
421
422
423
424
425
426
427
428
429
430
431
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 419

def load(*args)
  args.each do |thing|
    key = File.basename(thing.to_s).sub('.rb', '')
    if(thing.is_a?(String))
      # TODO: Test this!
      components[key] = ->{ self.class.load_component(thing) }
    else
      components[key] = sparkle.get(:component, thing)[:block]
    end
    @load_order << key
  end
  self
end

#make_output_available(output_name, outputs) ⇒ Object

Extract output to make available for stack parameter usage at the current depth

Parameters:

  • output_name (String) —

    name of output

  • outputs (Hash) —

    listing of outputs



606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 606

def make_output_available(output_name, outputs)
  bubble_path = outputs[output_name].root_path - root_path
  drip_path = root_path - outputs[output_name].root_path
  bubble_path.each_slice(2) do |base_sparkle, ref_sparkle|
    next unless ref_sparkle
    base_sparkle.compile.outputs.set!(output_name).set!(:value, base_sparkle.compile.attr!(ref_sparkle.name, "Outputs.#{output_name}"))
  end
  if(bubble_path.empty?)
    raise ArgumentError.new "Failed to detect available bubbling path for output `#{output_name}`. This may be due to a circular dependency!"
  end
  result = compile.attr!(bubble_path.first.name, "Outputs.#{output_name}")
  if(drip_path.size > 1)
    parent = drip_path.first.parent
    drip_path.unshift(parent) if parent
    drip_path.each_slice(2) do |base_sparkle, ref_sparkle|
      next unless ref_sparkle
      base_sparkle.compile.resources[ref_sparkle.name].properties.parameters.set!(output_name, result)
      ref_sparkle.compile.parameters.set!(output_name){ type 'String' } # TODO <<<<------ type check and prop
      result = compile.ref!(output_name)
    end
  end
  result
end

#nested?(stack_hash = nil) ⇒ TrueClass, FalseClass

Returns includes nested stacks.

Returns:

  • (TrueClass, FalseClass) —

    includes nested stacks



493
494
495
496
497
498
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 493

def nested?(stack_hash=nil)
  stack_hash = compile.dump! unless stack_hash
  !!stack_hash.fetch('Resources', {}).detect do |r_name, resource|
    stack_resource_type?(resource['Type'])
  end
end

#nested_stacks(*args) ⇒ Array<SparkleFormation>

Returns:



477
478
479
480
481
482
483
484
485
486
487
488
489
490
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 477

def nested_stacks(*args)
  compile.resources.keys!.map do |key|
    if(stack_resource_type?(compile.resources[key].type))
      result = [compile.resources[key].properties.stack]
      if(args.include?(:with_resource))
        result.push(compile[:resources][key])
      end
      if(args.include?(:with_name))
        result.push(key)
      end
      result.size == 1 ? result.first : result
    end
  end.compact
end

#output_matched?(p_name, output_names) ⇒ String, NilClass

Note:

will auto downcase name prior to comparison

Check if parameter name matches an output name

Parameters:

  • p_name (String, Symbol) —

    parameter name

  • output_names (Array<String>) —

    list of available outputs

Returns:

  • (String, NilClass) —

    matching output name



594
595
596
597
598
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 594

def output_matched?(p_name, output_names)
  output_names.detect do |o_name|
    Bogo::Utility.snake(o_name).tr('_', '') == Bogo::Utility.snake(p_name).tr('_', '')
  end
end

#overrides(args = {}) { ... } ⇒ Object

Registers block into overrides

Parameters:

  • args (Hash) (defaults to: {}) —

    optional arguments to provide state

Yields:

  • override block



437
438
439
440
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 437

def overrides(args={}, &block)
  @overrides << {:args => args, :block => block}
  self
end

#recompile ⇒ SparkleStruct

Clear compiled stack if cached and perform compilation again

Returns:



471
472
473
474
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 471

def recompile
  unmemoize(:compile)
  compile
end

#remap_nested_parameters(template, parameters, stack_name, stack_resource, output_map) ⇒ TrueClass

Note:

if parameter has includes ‘StackUnique` a new parameter will be added to container stack and it will not use outputs

Extract parameters from nested stacks. Check for previous nested stack outputs that match parameter. If match, set parameter to use output. If no match, check container stack parameters for match. If match, set to use ref. If no match, add parameter to container stack parameters and set to use ref.

Parameters:

  • template (Hash) —

    template being processed

  • parameters (Hash) —

    top level parameter set being built

  • stack_name (String) —

    name of stack resource

  • stack_resource (Hash) —

    duplicate of stack resource contents

  • output_map (Hash) —

    mapping of output names to required stack output access

Returns:

  • (TrueClass) 


720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 720

def remap_nested_parameters(template, parameters, stack_name, stack_resource, output_map)
  stack_parameters = stack_resource.properties.stack.compile.parameters
  unless(stack_parameters.nil?)
    stack_parameters._dump.each do |pname, pval|
      if(pval['StackUnique'])
        check_name = [stack_name, pname].join
      else
        check_name = pname
      end
      if(parameters.keys.include?(check_name))
        if(parameters[check_name]['Type'] == 'CommaDelimitedList')
          new_val = {'Fn::Join' => [',', {'Ref' => check_name}]}
        else
          new_val = {'Ref' => check_name}
        end
        template.resources.set!(stack_name).properties.parameters.set!(pname, new_val)
      elsif(output_map[check_name])
        template.resources.set!(stack_name).properties.parameters.set!(pname, 'Fn::GetAtt' => output_map[check_name])
      else
        if(pval['Type'] == 'CommaDelimitedList')
          new_val = {'Fn::Join' => [',', {'Ref' => check_name}]}
        else
          new_val = {'Ref' => check_name}
        end
        template.resources.set!(stack_name).properties.parameters.set!(pname, new_val)
        parameters[check_name] = pval
      end
    end
  end
  unless(stack_resource.properties.stack.compile.outputs.nil?)
    stack_resource.properties.stack.compile.outputs.keys!.each do |oname|
      output_map[oname] = [stack_name, "Outputs.#{oname}"]
    end
  end
  true
end

#root ⇒ SparkleFormation

Returns root stack.

Returns:



361
362
363
364
365
366
367
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 361

def root
  if(parent)
    parent.root
  else
    self
  end
end

#root? ⇒ TrueClass, FalseClass

Returns current stack is root.

Returns:

  • (TrueClass, FalseClass) —

    current stack is root



379
380
381
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 379

def root?
  root == self
end

#root_path ⇒ Array<SparkleFormation] path to root

Returns Array<SparkleFormation] path to root.

Returns:



370
371
372
373
374
375
376
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 370

def root_path
  if(parent)
    [*parent.root_path, self].compact
  else
    [self]
  end
end

#set_generation_parameters!(params) ⇒ Hash

Validation parameters used for template generation to ensure they are in the expected format

Parameters:

  • params (Hash) —

    parameter set

Returns:

  • (Hash) —

    parameter set



392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 392

def set_generation_parameters!(params)
  params.each do |name, value|
    unless(value.is_a?(Hash))
      raise TypeError.new("Expecting `Hash` type. Received `#{value.class}`")
    end
    if(key = value.keys.detect{|k| !ALLOWED_GENERATION_PARAMETERS.include?(k.to_s) })
      raise ArgumentError.new("Invalid generation parameter key provided `#{key}`")
    end
  end
  params
end

#stack_resource_type?(type) ⇒ TrueClass, FalseClass

Check if type is a registered stack type

Parameters:

  • type (String)

Returns:

  • (TrueClass, FalseClass) 


356
357
358
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 356

def stack_resource_type?(type)
  stack_resource_types.include?(type)
end

#stack_template_extractor(x_stacks, &block) ⇒ Object

Run the stack extraction

Parameters:



643
644
645
646
647
648
649
650
651
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 643

def stack_template_extractor(x_stacks, &block)
  x_stacks.each do |stack, resource, s_name|
    unless(stack.nested_stacks.empty?)
      stack_template_extractor(stack.nested_stacks(:with_resource, :with_name), &block)
    end
    resource.properties.set!(:stack, stack.compile.dump!)
    block.call(s_name, stack, resource)
  end
end

#to_json(*args) ⇒ String

Returns dumped hash JSON.

Returns:

  • (String) —

    dumped hash JSON



763
764
765
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 763

def to_json(*args)
  MultiJson.dump(compile.dump!, *args)
end