Class: SparkleFormation

Inherits:
Object
  • Object
show all
Extended by:
Utils::AnimalStrings, Utils::TypeCheckers
Includes:
Bogo::Memoization, Utils::AnimalStrings
Defined in:
lib/sparkle_formation.rb,
lib/sparkle_formation/error.rb,
lib/sparkle_formation/utils.rb,
lib/sparkle_formation/sparkle.rb,
lib/sparkle_formation/version.rb,
lib/sparkle_formation/provider.rb,
lib/sparkle_formation/audit_log.rb,
lib/sparkle_formation/resources.rb,
lib/sparkle_formation/composition.rb,
lib/sparkle_formation/translation.rb,
lib/sparkle_formation/provider/aws.rb,
lib/sparkle_formation/provider/heat.rb,
lib/sparkle_formation/resources/aws.rb,
lib/sparkle_formation/provider/azure.rb,
lib/sparkle_formation/resources/heat.rb,
lib/sparkle_formation/sparkle_struct.rb,
lib/sparkle_formation/function_struct.rb,
lib/sparkle_formation/provider/google.rb,
lib/sparkle_formation/resources/azure.rb,
lib/sparkle_formation/resources/google.rb,
lib/sparkle_formation/translation/heat.rb,
lib/sparkle_formation/sparkle_attribute.rb,
lib/sparkle_formation/sparkle_formation.rb,
lib/sparkle_formation/provider/terraform.rb,
lib/sparkle_formation/sparkle_collection.rb,
lib/sparkle_formation/resources/rackspace.rb,
lib/sparkle_formation/resources/terraform.rb,
lib/sparkle_formation/sparkle_attribute/aws.rb,
lib/sparkle_formation/translation/rackspace.rb,
lib/sparkle_formation/sparkle_attribute/heat.rb,
lib/sparkle_formation/sparkle_attribute/azure.rb,
lib/sparkle_formation/sparkle_attribute/google.rb,
lib/sparkle_formation/sparkle_collection/rainbow.rb,
lib/sparkle_formation/sparkle_attribute/rackspace.rb,
lib/sparkle_formation/sparkle_attribute/terraform.rb

Overview

Formation container

Defined Under Namespace

Modules: Provider, SparkleAttribute, Utils Classes: AuditLog, AzureVariableStruct, Cache, Composition, Error, FunctionStruct, GoogleStruct, JinjaExpressionStruct, JinjaStatementStruct, Registry, Resources, Sparkle, SparkleCollection, SparkleStruct, TerraformStruct, Translation

Constant Summary collapse

SparklePack =

Alias for interfacing naming

Sparkle
VERSION =

Current library version

Gem::Version.new("3.0.40")
IGNORE_DIRECTORIES =

Returns directory names to ignore.

Returns:

  • (Array<String>) —

    directory names to ignore

[
  "components",
  "dynamics",
  "registry",
]
SPARKLEFORMATION_ROOT_LIBRARY =

Returns path to root of this library.

Returns:

  • (String) —

    path to root of this library

File.dirname(File.dirname(File.dirname(__FILE__)))
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]
PROVIDER_MAPPINGS =

Returns name mappings for providers used in lookups (resources/sparkles).

Returns:

  • (Hash) —

    name mappings for providers used in lookups (resources/sparkles)

Smash.new(
  :open_stack => :heat,
).freeze
ALLOWED_GENERATION_PARAMETERS =

Attributes allowed for generation parameter definitions

[
  "type", "default", "description", "multiple", "prompt_when_nested",
  "allowed_values", "allowed_pattern", "max_length", "min_length",
  "max_value", "min_value",
]
VALID_GENERATION_PARAMETER_TYPES =

Allowed data types for parameters

["String", "Number", "Complex"]

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Utils::TypeCheckers

__t_check, __t_hashish, __t_stringish

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



473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 473

def initialize(name, options = {}, &base_block)
  @name = name.to_sym
  @component_paths = []
  if options[:sparkle_collection]
    @sparkle = options[:sparkle_collection]
    if options[:sparkle]
      @sparkle.add_sparkle(options[:sparkle])
    end
  else
    @sparkle = SparkleCollection.new
    if options[:sparkle]
      @sparkle.set_root(options[:sparkle])
    else
      @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
            else
              h[:root] = :none
            end
          }
        )
      )
    end
  end
  self.provider = options.fetch(:provider, @parent ? @parent.provider : :aws)
  if provider == :aws || !options[:disable_aws_builtins]
    require "sparkle_formation/aws"
  end
  @parameters = set_generation_parameters!(
    options.fetch(:compile_time_parameters,
                  options.fetch(:parameters, {}))
  )
  @stack_resource_types = [
    stack_resource_type,
    *options.fetch(:stack_resource_types, []),
  ].compact.uniq
  @blacklisted_templates = [name]
  @composition = Composition.new(self)
  @parent = options[:parent]
  @seed = Smash.new(
    :inherit => options[:inherit],
    :layering => options[:layering],
  )
  if base_block
    load_block(base_block)
  end
  @audit_log = AuditLog.new
  @compiled = nil
end

Instance Attribute Details

#audit_log ⇒ AuditLog

Returns records of template composition.

Returns:

  • (AuditLog) —

    records of template composition



430
431
432
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 430

def audit_log
  @audit_log
end

#blacklisted_templates ⇒ Array<String> (readonly)

Returns black listed templates.

Returns:

  • (Array<String>) —

    black listed templates



458
459
460
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 458

def blacklisted_templates
  @blacklisted_templates
end

#compile_state ⇒ Hash

Returns state hash for compile time parameters.

Returns:

  • (Hash) —

    state hash for compile time parameters



450
451
452
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 450

def compile_state
  @compile_state
end

#components_directory ⇒ String (readonly)

Returns components path.

Returns:

  • (String) —

    components path



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

def components_directory
  @components_directory
end

#composition ⇒ Composition (readonly)

Returns:



460
461
462
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 460

def composition
  @composition
end

#dynamics_directory ⇒ String (readonly)

Returns dynamics path.

Returns:

  • (String) —

    dynamics path



440
441
442
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 440

def dynamics_directory
  @dynamics_directory
end

#name ⇒ Symbol

Returns name of formation.

Returns:

  • (Symbol) —

    name of formation



432
433
434
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 432

def name
  @name
end

#parameters ⇒ Hash (readonly)

Returns parameters for stack generation.

Returns:

  • (Hash) —

    parameters for stack generation



444
445
446
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 444

def parameters
  @parameters
end

#parent ⇒ SparkleFormation

Returns parent stack.

Returns:



446
447
448
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 446

def parent
  @parent
end

#provider ⇒ Symbol

Returns target provider.

Returns:

  • (Symbol) —

    target provider



452
453
454
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 452

def provider
  @provider
end

#provider_resources ⇒ Class (readonly)

Returns Provider resources.

Returns:

  • (Class) —

    Provider resources



454
455
456
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 454

def provider_resources
  @provider_resources
end

#registry_directory ⇒ String (readonly)

Returns registry path.

Returns:

  • (String) —

    registry path



442
443
444
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 442

def registry_directory
  @registry_directory
end

#sparkle ⇒ Sparkle (readonly)

Returns parts store.

Returns:



434
435
436
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 434

def sparkle
  @sparkle
end

#sparkle_path ⇒ String (readonly)

Returns base path.

Returns:

  • (String) —

    base path



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

def sparkle_path
  @sparkle_path
end

#stack_resource_types ⇒ Array<String> (readonly)

Returns valid stack resource types.

Returns:

  • (Array<String>) —

    valid stack resource types



448
449
450
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 448

def stack_resource_types
  @stack_resource_types
end

#template_path ⇒ String

Returns local path to template.

Returns:

  • (String) —

    local path to template



456
457
458
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 456

def template_path
  @template_path
end

Class Method Details

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

Execute given block within struct context

Parameters:

Yields:

  • block to execute

Returns:



125
126
127
128
129
130
131
132
133
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 125

def build(base = nil, &block)
  if base || block.nil?
    struct = base || SparkleStruct.new
    struct.instance_exec(&block)
    struct
  else
    block
  end
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:



377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 377

def builtin_insert(dynamic_name, struct, *args, &block)
  if struct._self.provider_resources && lookup_key = struct._self.provider_resources.registry_key(dynamic_name)
    _name, _config = *args
    _config ||= {}
    __t_hashish(_config)
    unless _name.is_a?(SparkleFormation::FunctionStruct)
      __t_stringish(_name)
      resource_name = [
        _name,
        _config.fetch(:resource_name_suffix, dynamic_name),
      ].compact.join("_").to_sym
    else
      resource_name = _name._root
    end
    _config.delete(:resource_name_suffix)
    new_resource = struct.resources.set!(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("_", "") })
    struct._self.provider_resources.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.set!(prop_name, &value)
        else
          properties.set!(prop_name, value)
        end
      end
    end
    new_resource.instance_exec(&block) if block
    struct._self.provider_resources.resource_customizer(new_resource, lookup_key)
    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:



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 103

def compile(path, *args)
  opts = args.detect { |i| i.is_a?(Hash) } || {}
  unless path.is_a?(String) && File.file?(path.to_s)
    if spath = (opts.delete(:sparkle_path) || SparkleFormation.custom_paths[:sparkle_path])
      container = Sparkle.new(:root => spath)
      path = container.get(:template, path)[:path]
    end
  end
  formation = instance_eval(IO.read(path), path, 1)
  formation.template_path = path
  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



62
63
64
65
66
67
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 62

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



37
38
39
40
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 37

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) 


182
183
184
185
186
187
188
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 182

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



194
195
196
197
198
199
200
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 194

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



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

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



75
76
77
78
79
80
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 75

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

.extract_caller(cinfo) ⇒ Array<String, Integer>

Extract the origin of the caller outside this library

Parameters:

  • cinfo (Array<String>) —

    caller info

Returns:

  • (Array<String, Integer>) —

    caller path and line number



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 208

def extract_caller(cinfo)
  res = cinfo.detect { |c|
    !c.include?(SPARKLEFORMATION_ROOT_LIBRARY)
  }.to_s.split(":")[0, 2]
  if res.size != 2
    line = res.last
    if line.to_i.to_s != line
      res << 0
    end
    if res != 2
      res.unshift(:unknown)
    end
  end
  res
end

.from_hash(hash) ⇒ SparkleStruct

Note:

will do best effort on camel key auto discovery

Convert hash to SparkleStruct instance

Parameters:

  • hash (Hashish)

Returns:



418
419
420
421
422
423
424
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 418

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:



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
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 251

def insert(dynamic_name, struct, *args, &block)
  __t_stringish(dynamic_name)
  result = false
  begin
    opts = args.detect { |i| i.is_a?(Hash) } || {}
    dyn = struct._self.sparkle.get(:dynamic, dynamic_name, opts[:provider])
    opts = nil
    raise dyn if dyn.is_a?(Exception)
    result = nil
    dyn.monochrome.each do |dynamic_item|
      record = struct._self.audit_log.push(
        type: :dynamic,
        name: dynamic_name,
        caller: extract_caller(caller),
        location: dynamic_item[:block].source_location,
      )
      struct._self.wrapped_audit(record) do
        if result
          opts = args.detect { |i| i.is_a?(Hash) }
          if opts
            opts[:previous_layer_result] = result
          else
            args.push(:previous_layer_result => result)
          end
        end
        result = struct.instance_exec(*args, &dynamic_item[:block])
      end
    end
    if block_given?
      result.instance_exec(&block)
    end
  rescue Error::NotFound::Dynamic
    record = struct._self.audit_log.push(
      type: :dynamic,
      name: dynamic_name,
      location: [:builtin, 0],
      caller: extract_caller(caller),
    )
    result = struct._self.wrapped_audit(record) do
      builtin_insert(dynamic_name, struct, *args, &block)
    end
    unless result
      message = "Failed to locate requested dynamic block for insertion: #{dynamic_name} " \
      "(valid: #{struct._self.sparkle.dynamics.fetch(struct._self.sparkle.provider, {}).keys.sort.join(", ")})"
      if struct._self.provider_resources && struct._self.provider_resources.registry.keys.size > 1
        t_name = struct._self.provider_resources.registry.keys.first
        valid_t_name = Bogo::Utility.snake(
          t_name.split(
            struct._self.provider_resources.resource_type_splitter
          ).join("_")
        )
        message << "\nBuiltin dynamics pattern `#{t_name}` -> `:#{Bogo::Utility.snake(valid_t_name)}`"
      end
      raise message
    end
  end
  result
end

.load_component(path) ⇒ SparkleStruct

Load component

Parameters:

  • path (String) —

    path to component

Returns:



139
140
141
142
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 139

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

.load_dynamics!(directory) ⇒ TrueClass

Load all dynamics within a directory

Parameters:

  • directory (String)

Returns:

  • (TrueClass) 


148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 148

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)
    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) 


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

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:



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
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 318

def nest(template, struct, *args, &block)
  options = args.detect { |i| i.is_a?(Hash) }
  if options
    args.delete(options)
  else
    options = {}
  end
  [template, *args].compact.each do |item|
    __t_stringish(item)
  end
  to_nest = struct._self.sparkle.get(:template, template, options[:provider])
  resource_name = template.to_s.gsub("__", "_")
  unless args.empty?
    resource_name = [
      options.delete(:overwrite_name) ? nil : resource_name,
      args.map { |a| Bogo::Utility.snake(a) }.join("_"),
    ].flatten.compact.join("_").to_sym
  end
  record = struct._self.audit_log.push(
    type: :template,
    caller: extract_caller(caller),
    name: resource_name,
    location: to_nest[:path],
  )
  struct._self.wrapped_audit(record) do
    resource_name = struct._process_key(resource_name.to_sym)
    nested_template = compile(to_nest[:path], :sparkle)
    nested_template.parent = struct._self
    nested_template.audit_log = record.audit_log
    nested_template.name = resource_name
    if options[:parameters]
      nested_template.compile_state = options[:parameters]
    end
    unless struct._self.sparkle.empty?
      nested_template.sparkle.apply(struct._self.sparkle)
    end
    nested_resource = struct.dynamic!(
      struct._self.stack_resource_type,
      resource_name,
      {:resource_name_suffix => nil},
      &block
    )
    # Ignore the stack resource that we generated in the
    # audit log since the wrapping template record will
    # provide the context with actual information
    record.audit_log.list.pop
    nested_resource.properties.stack nested_template
    # Force compilation to properly record audit log times
    nested_template.compile
    nested_resource
  end
end

.registry(registry_name, struct, *args) ⇒ 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:



230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 230

def registry(registry_name, struct, *args)
  __t_stringish(registry_name)
  opts = args.detect { |item| item.is_a?(Hash) } || {}
  reg = struct._self.sparkle.get(:registry, registry_name, opts[:provider])
  record = struct._self.audit_log.push(
    type: :registry,
    name: registry_name,
    location: reg[:block].source_location,
    caller: extract_caller(caller),
  )
  struct._self.wrapped_audit(record) do
    struct.instance_exec(*args, &reg[:block])
  end
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



88
89
90
91
92
93
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 88

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



46
47
48
49
50
51
52
53
54
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 46

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| ... } ⇒ SparkleFormation::SparkleStruct

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:



1003
1004
1005
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 1003

def apply_deep_nesting(*args, &block)
  compile
end

#apply_nesting(*args, &block) ⇒ SparkleFormation::SparkleStruct

Note:

see specific version for expected block parameters

Apply nesting logic to stack

Parameters:

  • nest_type (Symbol) —

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

Returns:



985
986
987
988
989
990
991
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 985

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| ... } ⇒ SparkleFormation::SparkleStruct

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:



1064
1065
1066
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 1064

def apply_shallow_nesting(*args, &block)
  compile
end

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

Add block to load order

Parameters:

  • block (Proc)

Returns:

  • (TrueClass) 


747
748
749
750
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 747

def block(block)
  composition.new_component(:__base__, &block)
  true
end

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

Returns:

  • (Smash<output_name:SparkleFormation>) 


1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 1069

def collect_outputs(*args)
  if args.include?(:force) || root?
    if !compile.outputs.nil? && !root?
      outputs = Smash[
        compile.outputs.keys!.zip(
          [self] * compile.outputs.keys!.size
        )
      ]
    else
      outputs = Smash.new
    end
    nested_stacks.each do |nested_stack|
      if nested_stack.is_a?(self.class) === true
        n_stack = nested_stack
      else
        n_stack = nested_stack._self
      end
      outputs = n_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:



789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 789

def compile(args = {})
  if args.key?(:state) && args.is_a?(Hash)
    @compile_state = args[:state].to_smash
    unmemoize(:compile)
  end
  memoize(:compile) do
    # NOTE: this is where we inject inherit or layering
    seed_self

    set_compile_time_parameters!
    if provider && SparkleStruct.const_defined?(camel(provider))
      struct_class = SparkleStruct.const_get(camel(provider))
      struct_name = [SparkleStruct.name, camel(provider)].join("::")
      struct_class.define_singleton_method(:name) { struct_name }
      struct_class.define_singleton_method(:to_s) { struct_name }
    else
      struct_class = SparkleStruct
    end
    load_resources!
    compiled = struct_class.new
    compiled._set_self(self)
    compiled._struct_class = struct_class
    if struct_class.const_defined?(:CAMEL_KEYS)
      compiled._camel_keys = struct_class.const_get(:CAMEL_KEYS)
    end
    if struct_class.const_defined?(:CAMEL_STYLE)
      compiled._camel_style = struct_class.const_get(:CAMEL_STYLE)
    end
    if compile_state
      compiled.set_state!(compile_state)
    end
    composition.each do |item|
      case item
      when Composition::Component
        record = nil
        if item.block
          if item.key == "__base__"
            if parent.nil?
              record = audit_log.push(
                type: :template,
                name: name,
                location: item.block.source_location.first,
                caller: [:template, 0],
              )
              # NOTE: Move audit log records under new record's
              # audit log. This allows components to be listed
              # logically under the template record instead of
              # at the same level.
              record.audit_log.list.replace(audit_log.list)
              record.audit_log.list.delete(record)

              audit_log.list.clear
              audit_log.list << record
            end
          else
            record = audit_log.push(
              type: :component,
              name: item.key,
              location: item.block.source_location.first,
              caller: [:template, 0],
            )
          end
          wrapped_audit(record) do
            self.class.build(compiled, &item.block)
          end
        else
          sparkle.get(:component, item.key).monochrome.each do |component_block|
            record = audit_log.push(
              type: :component,
              name: item.key,
              location: component_block[:block].source_location.first,
              caller: [:template, 0],
            )
            wrapped_audit(record) do
              self.class.build(compiled, &component_block[:block])
            end
          end
        end
      when Composition::Override
        record = audit_log.push(
          type: :component,
          name: :override,
          location: item.block.source_location.first,
          caller: [:template, 0],
        )
        if item.args && !item.args.empty?
          compiled._set_state(item.args)
        end
        wrapped_audit(record) do
          self.class.build(compiled, &item.block)
        end
      end
    end
    if compile_state && !compile_state.empty?
      set_compiled_state(compiled)
    end
    compiled
  end
end

#compile_time_parameter_setter {|| ... } ⇒ Proc, NilClass

Get or set the compile time parameter setting block. If a get request the ancestor path will be searched to root

Yields:

  • block to set compile time parameters

Yield Parameters:

Returns:

  • (Proc, NilClass) 


705
706
707
708
709
710
711
712
713
714
715
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 705

def compile_time_parameter_setter(&block)
  if block
    @compile_time_parameter_setter = block
  else
    if @compile_time_parameter_setter
      @compile_time_parameter_setter
    else
      parent.nil? ? nil : parent.compile_time_parameter_setter
    end
  end
end

#dump ⇒ Hash

Returns dumped hash.

Returns:

  • (Hash) —

    dumped hash



1113
1114
1115
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 1113

def dump
  MultiJson.load(to_json)
end

#extract_template_data(template) ⇒ self

Extract information from given template and integrate with current instance

Parameters:

Returns:

  • (self) 


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

def extract_template_data(template)
  # TODO: Should allow forced override here for cases like: openstack -> rackspace
  if provider != template.provider
    raise TypeError.new "This template `#{name}` cannot inherit template `#{template.name}`! Provider mismatch: `#{provider}` != `#{template.provider}`" # rubocop:disable Metrics/LineLength
  end
  template.sparkle.apply(sparkle)
  template.seed_self
  blacklisted_templates.replace(
    (blacklisted_templates + template.blacklisted_templates).map(&:to_s).uniq
  )
  @parameters = template.parameters.to_smash.deep_merge(parameters.to_smash)
  new_composition = Composition.new(self,
                                    :components => template.composition.composite,
                                    :overrides => composition.overrides)
  composition.components.each do |item|
    if item.respond_to?(:key) && item.key == "__base__"
      item.key = Smash.new(
        :template => name,
        :component => :__base__,
        :object_id => object_id,
      ).checksum.to_s
    end
    new_composition.add_component(item)
  end
  @composition = new_composition
  self
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



1035
1036
1037
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 1035

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

#generate_policy ⇒ Hash

Generate policy for stack

Returns:

  • (Hash) 


976
977
978
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 976

def generate_policy
  Smash.new
end

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

Returns policies defined.

Returns:

  • (TrueClass, FalseClass) —

    policies defined



962
963
964
965
966
967
968
969
970
971
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 962

def includes_policies?(stack_hash = nil)
  if stack_hash
    raise Error::Deprecated.new "Hash parameter no longer valid for this method (`#{self.class}##{__callee__}`)"
  end
  unless compile.resources.nil?
    compile.resources._data.any? do |r_name, r_value|
      !r_value.policy.nil?
    end
  end
end

#inherit_from(template_name) ⇒ self

Inhert template structure

Parameters:

  • template_name (String) —

    name of template to inherit

Returns:

  • (self) 


591
592
593
594
595
596
597
598
599
600
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 591

def inherit_from(template_name)
  if blacklisted_templates.map(&:to_s).include?(template_name.to_s)
    raise Error::CircularInheritance.new "Circular inheritance detected between templates `#{template_name}` and `#{name}`" # rubocop:disable Metrics/LineLength
  end
  template = self.class.compile(sparkle.get(:template, template_name)[:path], :sparkle)
  template.blacklisted_templates.replace(
    (template.blacklisted_templates + blacklisted_templates).map(&:to_s).uniq
  )
  extract_template_data(template)
end

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

Returns includes only nested stacks.

Returns:

  • (TrueClass, FalseClass) —

    includes only nested stacks



950
951
952
953
954
955
956
957
958
959
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 950

def isolated_nests?(stack_hash = nil)
  if stack_hash
    raise Error::Deprecated.new "Hash parameter no longer valid for this method (`#{self.class}##{__callee__}`)"
  end
  unless compile.resources.nil?
    compile.resources._data.all? do |r_name, r_value|
      stack_resource_type?(r_value.type)
    end
  end
end

#load(*args, &user_block) ⇒ self

Load components into instance

Parameters:

  • args (String, Symbol) —

    Symbol component names or String paths

Returns:

  • (self) 


758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 758

def load(*args, &user_block)
  args.each do |thing|
    if thing.is_a?(String)
      # NOTE: This needs to be deprecated and removed
      # TODO: deprecate
      key = File.basename(thing.to_s).sub(".rb", "")
      composition.new_component(key, &self.class.load_component(thing))
    else
      composition.new_component(thing)
    end
  end
  if block_given?
    block(user_block)
  end
  self
end

#make_output_available(output_name, outputs) ⇒ Hash

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

Returns:

  • (Hash) —

    reference to output value (used for setting parameter)



1025
1026
1027
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 1025

def make_output_available(output_name, outputs)
  {}
end

#merge_previous! ⇒ self

Merge previous layer template structure

Returns:

  • (self) 


579
580
581
582
583
584
585
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 579

def merge_previous!
  my_index = sparkle.get(:template, name).spectrum.find_index do |item|
    item[:path] == template_path
  end
  template = self.class.compile(sparkle.get(:template, name).layer_at(my_index - 1)[:path], :sparkle)
  extract_template_data(template)
end

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

Returns includes nested stacks.

Returns:

  • (TrueClass, FalseClass) —

    includes nested stacks



938
939
940
941
942
943
944
945
946
947
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 938

def nested?(stack_hash = nil)
  if stack_hash
    raise Error::Deprecated.new "Hash parameter no longer valid for this method (`#{self.class}##{__callee__}`)"
  end
  unless compile.resources.nil?
    compile.resources._data.any? do |r_name, r_value|
      stack_resource_type?(r_value.type)
    end
  end
end

#nested_stacks(*args) ⇒ Array<SparkleFormation>

Returns:



916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 916

def nested_stacks(*args)
  if compile[:resources]
    compile.resources.keys!.map do |key|
      if stack_resource_type?(compile.resources[key].type)
        if !compile.resources[key].properties.stack.nil?
          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
    end.compact
  else
    []
  end
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



1013
1014
1015
1016
1017
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 1013

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



779
780
781
782
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 779

def overrides(args = {}, &block)
  composition.new_override(args, &block)
  self
end

#recompile ⇒ SparkleStruct

Clear compiled stack if cached and perform compilation again

Returns:



910
911
912
913
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 910

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) 


1108
1109
1110
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 1108

def remap_nested_parameters(template, parameters, stack_name, stack_resource, output_map)
  true
end

#root ⇒ SparkleFormation

Returns root stack.

Returns:



668
669
670
671
672
673
674
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 668

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



686
687
688
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 686

def root?
  root == self
end

#root_path ⇒ Array<SparkleFormation] path to root

Returns Array<SparkleFormation] path to root.

Returns:



677
678
679
680
681
682
683
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 677

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

#seed_self ⇒ self

Update underlying data structures based on inherit or layering behavior if defined for this template

Parameters:

  • options (Hash)

Returns:

  • (self) 


560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 560

def seed_self
  memoize(:seed) do
    options = @seed
    if options[:inherit] && options[:layering].to_s == "merge"
      raise ArgumentError.new "Cannot merge and inherit!"
    end
    if options[:inherit]
      inherit_from(options[:inherit])
    elsif options[:layering].to_s == "merge"
      merge_previous!
    end
    true
  end
  self
end

#set_compile_time_parameters! ⇒ Object

Set the compile time parameters for the stack if the setter proc is available



719
720
721
722
723
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 719

def set_compile_time_parameters!
  if compile_time_parameter_setter
    compile_time_parameter_setter.call(self)
  end
end

#set_compiled_state(compiled) ⇒ AttributeStruct

Set the current compile_state into the compiled result

Parameters:

  • compiled (AttributeStruct)

Returns:

  • (AttributeStruct) 


894
895
896
897
898
899
900
901
902
903
904
905
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 894

def set_compiled_state(compiled)
  storage_compile_state = Smash.new
  parameters.each do |param_key, param_config|
    if param_config.fetch(:type, "string").to_s.downcase.to_sym != :complex
      storage_compile_state[param_key] = compile_state[param_key]
    end
  end
  unless storage_compile_state.empty?
    compiled.outputs.compile_state.value MultiJson.dump(storage_compile_state)
  end
  compiled
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

Raises:

  • (ArgumentError) 


731
732
733
734
735
736
737
738
739
740
741
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 731

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

#sparkle_dump ⇒ Hash

Returns dumped hash.

Returns:

  • (Hash) —

    dumped hash



1118
1119
1120
1121
1122
1123
1124
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 1118

def sparkle_dump
  MultiJson.load(
    MultiJson.dump(
      compile.sparkle_dump!
    )
  )
end

#stack_resource_type ⇒ String

Returns provider stack resource type.

Returns:

  • (String) —

    provider stack resource type



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

def stack_resource_type
  DEFAULT_STACK_RESOURCE
end

#stack_resource_type?(type) ⇒ TrueClass, FalseClass

Check if type is a registered stack type

Parameters:

  • type (String)

Returns:

  • (TrueClass, FalseClass) 


663
664
665
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 663

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

#stack_template_extractor(x_stacks, &block) ⇒ Object

Run the stack extraction

Parameters:



1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 1042

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._delete(:stack)
    s_parent = resource.properties.stack
    stack.compile._parent(s_parent)
    resource.properties.set!(:stack, stack.compile)
    block.call(s_name, stack, resource)
  end
end

#to_json(*args) ⇒ String

Returns dumped hash JSON.

Returns:

  • (String) —

    dumped hash JSON



1127
1128
1129
1130
1131
1132
1133
1134
1135
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 1127

def to_json(*args)
  # NOTE: Ported in from batali
  # Prevent stupid conversion errors of
  # JSON::Ext::Generator::State into Hash
  args = args.map do |argument|
    argument.respond_to?(:to_h) ? argument.to_h : argument
  end
  MultiJson.dump(compile.dump!, *args)
end

#wrapped_audit(record) ⇒ Object

Wrap given block within audit log of given record

Parameters:

Returns:

  • (Object) —

    result of yield



544
545
546
547
548
549
550
551
552
553
 
# File 'lib/sparkle_formation/sparkle_formation.rb', line 544

def wrapped_audit(record)
  start_log = audit_log
  start_time = Time.now.to_f
  @audit_log = record ? record.audit_log : start_log
  result = yield if block_given?
  record.compile_duration = Time.now.to_f - start_time if record
  result
ensure
  @audit_log = start_log
end