sfn 2.2.0 → 3.0.0

data/docs/configuration.md

@@ -61,109 +61,4 @@ can be accessed via:
 $ knife sparkleformation --help
 ~~~
 
-### Configuration Options
-
-| Option                     | Attribute     | Value
-|----------------------------|---------------|---------------------------------------------------------------
-| `processing`               | Description   | Enable SparkleFormation processing
-|                            | Valid         | `TrueClass`, `FalseClass`
-|                            | Default       | `true`
-|----------------------------|---------------|---------------------------------------------------------------
-| `apply_nesting`            | Description   | Style of nested stack processing
-|                            | Valid         | `"shallow"`, `"deep"`
-|                            | Default       | `"deep"`
-|----------------------------|---------------|---------------------------------------------------------------
-| `options`                  | Description   | API options for target API (see miasma)
-|                            | Valid         | `Hash`
-|                            | Default       | none
-|----------------------------|---------------|---------------------------------------------------------------
-| `merge_api_options`        | Description   | Merges API options on stack update
-|                            | Valid         | `TrueClass`, `FalseClass`
-|                            | Default       | `false`
-|----------------------------|---------------|---------------------------------------------------------------
-| `ssh_attempt_users`        | Description   | List of users to attempt SSH connection on node failure
-|                            | Valid         | `Array<String>`
-|                            | Default       | none
-|----------------------------|---------------|---------------------------------------------------------------
-| `identity_file`            | Description   | Custom SSH identity file for node failure connection
-|                            | Valid         | `String`
-|                            | Default       | none
-|----------------------------|---------------|---------------------------------------------------------------
-| `nesting_bucket`           | Description   | Name of bucket to store nested stack templates
-|                            | Valid         | `String`
-|                            | Default       | none
-|----------------------------|---------------|---------------------------------------------------------------
-| `nesting_prefix`           | Description   | Prefix to prepend to template file name within object store
-|                            | Valid         | `String`
-|                            | Default       | none
-|----------------------------|---------------|---------------------------------------------------------------
-| `sparkle_pack`             | Description   | SparklePacks to load
-|                            | Valid         | `Array<String>`
-|                            | Default       | none
-|----------------------------|---------------|---------------------------------------------------------------
-| `parameters`               | Description   | Stack runtime parameters
-|                            | Valid         | `Hash`
-|                            | Default       | none
-|----------------------------|---------------|---------------------------------------------------------------
-| `credentials`              | Description   | API credentials for target orchestration API
-|                            | Valid         | `Hash`
-|                            | Default       | none
-|----------------------------|---------------|---------------------------------------------------------------
-| `callbacks`                | Description   | Callbacks to execute around API calls
-|                            | Valid         | `Hash`
-|                            | Default       | none
-|----------------------------|---------------|---------------------------------------------------------------
-| `callbacks.before`         | Description   | Callbacks to execute before _any_ API call
-|                            | Valid         | `Array<String>`
-|                            | Default       | none
-|----------------------------|---------------|---------------------------------------------------------------
-| `callbacks.after`          | Description   | Callbacks to execute after _any_ API call
-|                            | Valid         | `Array<String>`
-|                            | Default       | none
-|----------------------------|---------------|---------------------------------------------------------------
-| `callbacks.before_COMMAND` | Description   | Callbacks to execute before specific `COMMAND` API call
-|                            | Valid         | `Array<String>`
-|                            | Default       | none
-|----------------------------|---------------|---------------------------------------------------------------
-| `callbacks.after_COMMAND`  | Description   | Callbacks to execute after specific `COMMAND` API call
-|                            | Valid         | `Array<String>`
-|                            | Default       | none
-|----------------------------|---------------|---------------------------------------------------------------
-| `callbacks.template`       | Description   | Callbacks to execute on template
-|                            | Valid         | `Array<String>`
-|                            | Default       | none
-|----------------------------|---------------|---------------------------------------------------------------
-| `callbacks.default`        | Description   | Callbacks to always execute
-|                            | Valid         | `Array<String>`
-|                            | Default       | none
-|----------------------------|---------------|---------------------------------------------------------------
-| `callbacks.require`        | Description   | List of custom libraries to load
-|                            | Valid         | `Array<String>`
-|                            | Default       | none
-|----------------------------|---------------|---------------------------------------------------------------
-| `retries`                  | Description   | Configuration of API request retries
-|                            | Valid         | `Hash`
-|                            | Default       | none
-|----------------------------|---------------|---------------------------------------------------------------
-| `retries.type`             | Description   | Retry implementation
-|                            | Valid         | `"flat"`, `"linear"`, `"exponential"`
-|                            | Default       | `"exponential"`
-|----------------------------|---------------|---------------------------------------------------------------
-| `retries.interval`         | Description   | Base wait interval for retry
-|                            | Valid         | `Numeric`
-|                            | Default       | `5`
-|----------------------------|---------------|---------------------------------------------------------------
-| `retries.max_attempts`     | Description   | Maximum number of attempts allowed (`nil` for infinite retry)
-|                            | Valid         | `Numeric`, `NilClass`
-|                            | Default       | `20`
-|----------------------------|---------------|---------------------------------------------------------------
-| `stack_types`              | Description   | Define customized stack resource types
-|                            | Valid         | `Array<String>`
-|                            | Default       | `[DEFAULT_PROVIDER_TYPE]`
-|----------------------------|---------------|---------------------------------------------------------------
-| `locations`                | Description   | API credentials for named locations (JackalStack resources)
-|                            | Valid         | `Hash`
-|                            | Default       | none
-|----------------------------|---------------|---------------------------------------------------------------
-
 [knife]: https://docs.chef.io/knife.html

data/docs/overview.md

@@ -22,6 +22,7 @@ Notable features available via the SparkleFormation CLI:
   - Eucalyptus
   - Rackspace Orchestration
   - OpenStack Heat
+  - Google Cloud Deployment Manager
 - Chef `knife` plugin support
 - Deep resource inspection
 

data/lib/sfn.rb

@@ -5,6 +5,7 @@ require 'sparkle_formation'
 
 module Sfn
 
+  autoload :ApiProvider, 'sfn/api_provider'
   autoload :Callback, 'sfn/callback'
   autoload :Provider, 'sfn/provider'
   autoload :Cache, 'sfn/cache'

data/lib/sfn/api_provider.rb

@@ -0,0 +1,9 @@
+require 'sfn'
+
+module Sfn
+  module ApiProvider
+
+    autoload :Google, 'sfn/api_provider/google'
+
+  end
+end

data/lib/sfn/api_provider/google.rb

@@ -0,0 +1,84 @@
+require 'sfn'
+
+module Sfn
+  module ApiProvider
+
+    module Google
+
+      # Disable remote template storage
+      def store_template(*_)
+      end
+
+      # No formatting required on stack results
+      def format_nested_stack_results(*_)
+        {}
+      end
+
+      # Extract current parameters from parent template
+      #
+      # @param stack [SparkleFormation]
+      # @param stack_name [String]
+      # @param c_stack [Miasma::Models::Orchestration::Stack]
+      # @return [Hash]
+      def extract_current_nested_template_parameters(stack, stack_name, c_stack)
+        if(c_stack && c_stack.data[:parent_stack])
+          c_stack.data[:parent_stack].sparkleish_template(:remove_wrapper).fetch(
+            :resources, stack_name, :properties, :parameters, Smash.new
+          )
+        elsif(stack.parent)
+          val = stack.parent.compile.resources.set!(stack_name).properties
+          val.nil? ? Smash.new : val._dump
+        else
+          Smash.new
+        end
+      end
+
+      # Disable parameter validate as we can't adjust them without template modifications
+      def validate_stack_parameter(*_)
+        true
+      end
+
+      # Determine if parameter was set via intrinsic function
+      #
+      # @param val [Object]
+      # @return [TrueClass, FalseClass]
+      def function_set_parameter?(val)
+        if(val)
+          val.start_with?('$(') || val.start_with?('{{')
+        end
+      end
+
+      # Set parameters into parent resource properites
+      def populate_parameters!(template, opts={})
+        result = super
+        result.each_pair do |key, value|
+          if(template.parent)
+            template.parent.compile.resources.set!(template.name).properties.set!(key, value)
+          else
+            template.compile.resources.set!(template.name).properties.set!(key, value)
+          end
+        end
+        {}
+      end
+
+      # Override requirement of nesting bucket
+      def validate_nesting_bucket!
+        true
+      end
+
+      # Override template content extraction to disable scrub behavior
+      #
+      # @param thing [SparkleFormation, Hash]
+      # @return [Hash]
+      def template_content(thing, *_)
+        if(thing.is_a?(SparkleFormation))
+          config[:sparkle_dump] ? thing.sparkle_dump : thing.dump
+        else
+          thing
+        end
+      end
+
+    end
+
+  end
+end

data/lib/sfn/command.rb

@@ -45,6 +45,7 @@ module Sfn
         ENV['DEBUG'] = 'true' if cli_opts[:debug]
       end
       super(cli_opts, args)
+      load_api_provider_extensions!
       run_callbacks_for(:after_config)
       run_callbacks_for("after_config_#{Bogo::Utility.snake(self.class.name.split('::').last)}")
     end
@@ -58,6 +59,27 @@ module Sfn
 
     protected
 
+    # Load API provider specific overrides to customize behavior
+    #
+    # @return [TrueClass, FalseClass]
+    def load_api_provider_extensions!
+      if(config.get(:credentials, :provider))
+        base_ext = Bogo::Utility.camel(config.get(:credentials, :provider))
+        targ_ext = self.class.name.split('::').last
+        if(ApiProvider.const_defined?(base_ext))
+          base_module = ApiProvider.const_get(base_ext)
+          ui.debug "Loading core provider extensions via `#{base_module}`"
+          extend base_module
+          if(base_module.const_defined?(targ_ext))
+            targ_module = base_module.const_get(targ_ext)
+            ui.debug "Loading targeted provider extensions via `#{targ_module}`"
+            extend targ_module
+          end
+          true
+        end
+      end
+    end
+
     # Start with current working directory and traverse to root
     # looking for a `.sfn` configuration file
     #

data/lib/sfn/command/create.rb

@@ -22,7 +22,6 @@ module Sfn
           file = config[:template]
         else
           file = load_template_file
-          nested_stacks_unpack = file.delete('sfn_nested_stack')
         end
 
         unless(config[:print_only])
@@ -34,66 +33,55 @@ module Sfn
           stack_info << " #{ui.color('Path:', :bold)} #{config[:file]}"
         end
 
-        unless(config[:print_only])
+        if(config[:print_only])
+          ui.puts format_json(parameter_scrub!(template_content(file)))
+          return
+        else
           ui.info "  -> #{stack_info}"
         end
 
-        if(nested_stacks_unpack)
-          unpack_nesting(name, file, :create)
-        else
-
-          if(config[:print_only] && !config[:apply_stacks])
-            ui.puts _format_json(
-              translate_template(
-                Sfn::Utils::StackParameterScrubber.scrub!(file)
-              )
-            )
-            return
-          end
-
-          stack = provider.connection.stacks.build(
-            config.fetch(:options, Smash.new).dup.merge(
-              :name => name,
-              :template => file
-            )
+        stack = provider.connection.stacks.build(
+          config.fetch(:options, Smash.new).dup.merge(
+            :name => name,
+            :template => template_content(file),
+            :parameters => Smash.new
           )
+        )
 
-          apply_stacks!(stack)
-          stack.template = Sfn::Utils::StackParameterScrubber.scrub!(scrub_template(stack.template))
+        apply_stacks!(stack)
+        populate_parameters!(file, :current_parameters => stack.parameters)
 
-          if(config[:print_only])
-            ui.puts _format_json(translate_template(stack.template))
-            return
-          end
-
-          populate_parameters!(stack.template)
-          stack.parameters = config_root_parameters
+        stack.parameters = config_root_parameters
 
-          stack.template = translate_template(stack.template)
+        if(config[:upload_root_template])
+          upload_result = store_template(name, file, Smash.new)
+          stack.template_url = upload_result[:url]
+        else
+          stack.template = parameter_scrub!(template_content(file, :scrub))
+        end
 
-          api_action!(:api_stack => stack) do
-            stack.save
-            if(config[:poll])
-              poll_stack(stack.name)
-              stack = provider.connection.stacks.get(name)
+        api_action!(:api_stack => stack) do
+          stack.save
+          if(config[:poll])
+            poll_stack(stack.name)
+            stack = provider.stack(name)
 
-              if(stack.reload.state == :create_complete)
-                ui.info "Stack create complete: #{ui.color('SUCCESS', :green)}"
-                namespace.const_get(:Describe).new({:outputs => true}, [name]).execute!
-              else
-                ui.fatal "Create of new stack #{ui.color(name, :bold)}: #{ui.color('FAILED', :red, :bold)}"
-                raise 'Stack did not reach a successful completion state.'
-              end
+            if(stack.reload.state == :create_complete)
+              ui.info "Stack create complete: #{ui.color('SUCCESS', :green)}"
+              namespace.const_get(:Describe).new({:outputs => true}, [name]).execute!
             else
-              ui.warn 'Stack state polling has been disabled.'
-              ui.info "Stack creation initialized for #{ui.color(name, :green)}"
+              ui.fatal "Create of new stack #{ui.color(name, :bold)}: #{ui.color('FAILED', :red, :bold)}"
+              raise 'Stack did not reach a successful completion state.'
             end
+          else
+            ui.warn 'Stack state polling has been disabled.'
+            ui.info "Stack creation initialized for #{ui.color(name, :green)}"
           end
-
         end
 
       end
 
     end
+
   end
 end

data/lib/sfn/command/describe.rb

@@ -73,7 +73,7 @@ module Sfn
       # @param stack [Miasma::Models::Orchestration::Stack]
       def outputs(stack)
         ui.info "Outputs for stack: #{ui.color(stack.name, :bold)}"
-        unless(stack.outputs.empty?)
+        unless(stack.outputs.nil? || stack.outputs.empty?)
           stack.outputs.each do |output|
             key, value = output.key, output.value
             key = snake(key).to_s.split('_').map(&:capitalize).join(' ')

data/lib/sfn/command/destroy.rb

@@ -40,7 +40,13 @@ module Sfn
         end
         if(config[:poll])
           if(stacks.size == 1)
-            poll_stack(stacks.first)
+            begin
+              poll_stack(stacks.first)
+            rescue Miasma::Error::ApiError::RequestError => error
+              unless(error.response.code == 404)
+                raise error
+              end
+            end
           else
             ui.error "Stack polling is not available when multiple stack deletion is requested!"
           end

data/lib/sfn/command/diff.rb

@@ -17,7 +17,7 @@ module Sfn
         name = name_args.first
 
         begin
-          stack = provider.connection.stacks.get(name)
+          stack = provider.stack(name)
         rescue Miasma::Error::ApiError::RequestError
           stack = nil
         end
@@ -25,9 +25,7 @@ module Sfn
         if(stack)
           config[:print_only] = true
           file = load_template_file
-          file.delete('sfn_nested_stack')
-          file = Sfn::Utils::StackParameterScrubber.scrub!(file)
-          file = translate_template(file)
+          file = parameter_scrub!(file.dump)
 
           ui.info "#{ui.color('SparkleFormation:', :bold)} #{ui.color('diff', :blue)} - #{name}"
           ui.puts
@@ -39,10 +37,11 @@ module Sfn
         end
       end
 
+      # @todo needs updates for better provider compat
       def diff_stack(stack, file, parent_names=[])
         stack_template = stack.template
         nested_stacks = Hash[
-          file['Resources'].find_all do |name, value|
+          file.fetch('Resources', file.fetch('resources', {})).find_all do |name, value|
             value.fetch('Properties', {})['Stack']
           end
         ]

data/lib/sfn/command/graph.rb

@@ -21,9 +21,7 @@ module Sfn
         config[:print_only] = true
         validate_graph_style!
         file = load_template_file
-        file.delete('sfn_nested_stack')
-        file = Sfn::Utils::StackParameterScrubber.scrub!(file)
-        file = translate_template(file)
+        file = parameter_scrub!(file.sparkle_dump)
         @outputs = Smash.new
         file = file.to_smash
         ui.info "Template resource graph generation - Style: #{ui.color(config[:graph_style], :bold)}"

data/lib/sfn/command/print.rb

@@ -10,14 +10,13 @@ module Sfn
       include Sfn::CommandModule::Template
       include Sfn::CommandModule::Stack
 
+      # Print the requested template
       def execute!
         config[:print_only] = true
         file = load_template_file
-        file.delete('sfn_nested_stack')
-        file = Sfn::Utils::StackParameterScrubber.scrub!(file)
-        file = translate_template(file)
 
-        json_content = _format_json(file)
+        json_content = format_json(parameter_scrub!(template_content(file)))
+
         if(config[:write_to_file])
           unless(File.directory?(File.dirname(config[:write_to_file])))
             run_action 'Creating parent directory' do