sfn 3.0.30 → 3.0.32

data/lib/sfn/command/import.rb

@@ -1,5 +1,5 @@
-require 'stringio'
-require 'sfn'
+require "stringio"
+require "sfn"
 
 module Sfn
   class Command
@@ -12,27 +12,27 @@ module Sfn
 
       # Run the import action
       def execute!
-        raise NotImplementedError.new 'Implementation updates required'
+        raise NotImplementedError.new "Implementation updates required"
         stack_name, json_file = name_args
-        ui.info "#{ui.color('Stack Import:', :bold)} #{stack_name}"
+        ui.info "#{ui.color("Stack Import:", :bold)} #{stack_name}"
         unless json_file
           entries = [].tap do |_entries|
-            _entries.push('s3') if config[:bucket]
-            _entries.push('fs') if config[:path]
+            _entries.push("s3") if config[:bucket]
+            _entries.push("fs") if config[:path]
           end
           if entries.size > 1
             valid = false
             until valid
-              answer = ui.ask_question('Import via file system (fs) or remote bucket (remote)?', :default => 'remote')
+              answer = ui.ask_question("Import via file system (fs) or remote bucket (remote)?", :default => "remote")
               valid = true if %w(remote fs).include?(answer)
               entries = [answer]
             end
           elsif entries.size < 1
-            ui.fatal 'No path or bucket set. Unable to perform dynamic lookup!'
+            ui.fatal "No path or bucket set. Unable to perform dynamic lookup!"
             exit 1
           end
           case entries.first
-          when 'remote'
+          when "remote"
             json_file = remote_discovery
           else
             json_file = local_discovery
@@ -49,9 +49,9 @@ module Sfn
               ),
               [stack_name]
             )
-            ui.info '  - Starting creation of import'
+            ui.info "  - Starting creation of import"
             creator.execute!
-            ui.info "#{ui.color('Stack Import', :bold)} (#{json_file}): #{ui.color('complete', :green)}"
+            ui.info "#{ui.color("Stack Import", :bold)} (#{json_file}): #{ui.color("complete", :green)}"
           rescue => e
             ui.fatal "Failed to import stack: #{e}"
             debug "#{e.class}: #{e}\n#{e.backtrace.join("\n")}"
@@ -84,8 +84,8 @@ module Sfn
         directory = storage.directories.get(config[:bucket])
         file = prompt_for_file(
           directory,
-          :directories_name => 'Collections',
-          :files_names => 'Exports',
+          :directories_name => "Collections",
+          :files_names => "Exports",
           :filter_prefix => bucket_prefix,
         )
         if file
@@ -98,15 +98,15 @@ module Sfn
       #
       # @return [IO] stack export IO
       def local_discovery
-        _, bucket = config[:path].split('/', 2)
+        _, bucket = config[:path].split("/", 2)
         storage = provider.service_for(:storage,
                                        :provider => :local,
-                                       :local_root => '/')
+                                       :local_root => "/")
         directory = storage.directories.get(bucket)
         prompt_for_file(
           directory,
-          :directories_name => 'Collections',
-          :files_names => 'Exports',
+          :directories_name => "Collections",
+          :files_names => "Exports",
         )
       end
     end

data/lib/sfn/command/init.rb

@@ -1,5 +1,5 @@
-require 'sfn'
-require 'fileutils'
+require "sfn"
+require "fileutils"
 
 module Sfn
   class Command
@@ -8,15 +8,15 @@ module Sfn
       include Sfn::CommandModule::Base
 
       INIT_DIRECTORIES = [
-        'sparkleformation/dynamics',
-        'sparkleformation/components',
-        'sparkleformation/registry',
+        "sparkleformation/dynamics",
+        "sparkleformation/components",
+        "sparkleformation/registry",
       ]
 
       # Run the init command to initialize new project
       def execute!
         unless name_args.size == 1
-          raise ArgumentError.new 'Please provide path argument only for project initialization'
+          raise ArgumentError.new "Please provide path argument only for project initialization"
         else
           path = name_args.first
         end
@@ -25,33 +25,33 @@ module Sfn
         end
         if File.directory?(path)
           ui.warn "Project directory already exists at given path. (`#{path}`)"
-          ui.confirm 'Overwrite existing files?'
+          ui.confirm "Overwrite existing files?"
         end
-        run_action 'Creating base project directories' do
+        run_action "Creating base project directories" do
           INIT_DIRECTORIES.each do |new_dir|
             FileUtils.mkdir_p(File.join(path, new_dir))
           end
           nil
         end
-        run_action 'Creating project bundle' do
-          File.open(File.join(path, 'Gemfile'), 'w') do |file|
+        run_action "Creating project bundle" do
+          File.open(File.join(path, "Gemfile"), "w") do |file|
             file.puts "source 'https://rubygems.org'\n\ngem 'sfn'"
           end
           nil
         end
-        ui.info 'Generating .sfn configuration file'
+        ui.info "Generating .sfn configuration file"
         Dir.chdir(path) do
           Conf.new({:generate => true}, []).execute!
         end
-        ui.info 'Installing project bundle'
+        ui.info "Installing project bundle"
         Dir.chdir(path) do
           if defined?(Bundler)
-            Bundler.clean_system('bundle install')
+            Bundler.clean_system("bundle install")
           else
-            system('bundle install')
+            system("bundle install")
           end
         end
-        ui.info 'Project initialization complete!'
+        ui.info "Project initialization complete!"
         ui.puts "  Project path -> #{File.expand_path(path)}"
       end
     end

data/lib/sfn/command/inspect.rb

@@ -1,4 +1,4 @@
-require 'sfn'
+require "sfn"
 
 module Sfn
   class Command
@@ -22,7 +22,7 @@ module Sfn
           end.compact
         end
         if outputs.empty?
-          ui.info '  Stack dump:'
+          ui.info "  Stack dump:"
           ui.puts MultiJson.dump(
             MultiJson.load(
               stack.reload.to_json
@@ -34,25 +34,25 @@ module Sfn
 
       def display_instance_failure(stack)
         instances = stack.resources.all.find_all do |resource|
-          resource.state.to_s.end_with?('failed')
+          resource.state.to_s.end_with?("failed")
         end.map do |resource|
           # If compute instance, simply expand
           if resource.within?(:compute, :servers)
             resource.instance
             # If a waitcondition, check for instance ID
-          elsif resource.type.to_s.downcase.end_with?('waitcondition')
-            if resource.status_reason.to_s.include?('uniqueId')
-              srv_id = resource.status_reason.split(' ').last.strip
+          elsif resource.type.to_s.downcase.end_with?("waitcondition")
+            if resource.status_reason.to_s.include?("uniqueId")
+              srv_id = resource.status_reason.split(" ").last.strip
               provider.connection.api_for(:compute).servers.get(srv_id)
             end
           end
         end.compact
         if instances.empty?
-          ui.error 'Failed to locate any failed instances'
+          ui.error "Failed to locate any failed instances"
         else
           log_path = config[:failure_log_path]
           if log_path.to_s.empty?
-            log_path = '/var/log/chef/client.log'
+            log_path = "/var/log/chef/client.log"
           end
           opts = ssh_key ? {:keys => [ssh_key]} : {}
           instances.each do |instance|
@@ -84,7 +84,7 @@ module Sfn
       #
       # @return [Array<String>] usernames for ssh connect attempt
       def ssh_attempt_users
-        [config[:ssh_user], config[:ssh_attempt_users], ENV['USER']].flatten.compact.uniq
+        [config[:ssh_user], config[:ssh_attempt_users], ENV["USER"]].flatten.compact.uniq
       end
 
       def ssh_key
@@ -93,14 +93,14 @@ module Sfn
 
       def display_attribute(stack)
         [config[:attribute]].flatten.compact.each do |stack_attribute|
-          attr = stack_attribute.split('.').inject(stack) do |memo, key|
+          attr = stack_attribute.split(".").inject(stack) do |memo, key|
             args = key.scan(/\(([^\)]*)\)/).flatten.first.to_s
             if args
-              args = args.split(',').map { |a| a.to_i.to_s == a ? a.to_i : a }
-              key = key.split('(').first
+              args = args.split(",").map { |a| a.to_i.to_s == a ? a.to_i : a }
+              key = key.split("(").first
             end
             if memo.public_methods.include?(key.to_sym)
-              if args.size == 1 && args.first.to_s.start_with?('&')
+              if args.size == 1 && args.first.to_s.start_with?("&")
                 memo.send(key, &args.first.slice(2, args.first.size).to_sym)
               else
                 memo.send(*[key, args].flatten.compact)
@@ -152,11 +152,11 @@ module Sfn
           end.compact
         ]
         unless asg_nodes.empty?
-          ui.info '  AutoScale Group Instances:'
+          ui.info "  AutoScale Group Instances:"
           ui.puts MultiJson.dump(asg_nodes, :pretty => true)
         end
         unless compute_nodes.empty?
-          ui.info '  Compute Instances:'
+          ui.info "  Compute Instances:"
           ui.puts MultiJson.dump(compute_nodes, :pretty => true)
         end
       end
@@ -179,7 +179,7 @@ module Sfn
           end
         ]
         unless load_balancers.empty?
-          ui.info '  Load Balancer Instances:'
+          ui.info "  Load Balancer Instances:"
           ui.puts MultiJson.dump(load_balancers, :pretty => true)
         end
       end

data/lib/sfn/command/lint.rb

@@ -1,4 +1,4 @@
-require 'sfn'
+require "sfn"
 
 module Sfn
   class Command
@@ -12,7 +12,7 @@ module Sfn
         print_only_original = config[:print_only]
         config[:print_only] = true
         file = load_template_file
-        ui.info "#{ui.color("Template Linting (#{provider.connection.provider}): ", :bold)} #{config[:file].sub(Dir.pwd, '').sub(%r{^/}, '')}"
+        ui.info "#{ui.color("Template Linting (#{provider.connection.provider}): ", :bold)} #{config[:file].sub(Dir.pwd, "").sub(%r{^/}, "")}"
         config[:print_only] = print_only_original
 
         raw_template = parameter_scrub!(template_content(file))
@@ -22,16 +22,16 @@ module Sfn
         else
           result = lint_template(raw_template)
           if result == true
-            ui.info ui.color('  -> VALID', :green, :bold)
+            ui.info ui.color("  -> VALID", :green, :bold)
           else
-            ui.info ui.color('  -> INVALID', :red, :bold)
+            ui.info ui.color("  -> INVALID", :red, :bold)
             result.each do |failure|
               ui.error "Result Set: #{ui.color(failure[:rule_set].name, :red, :bold)}"
               failure[:failures].each do |f_msg|
                 ui.fatal f_msg
               end
             end
-            raise 'Linting failure'
+            raise "Linting failure"
           end
         end
       end
@@ -54,7 +54,7 @@ module Sfn
       def rule_sets
         sets = [config[:lint_directory]].flatten.compact.map do |directory|
           if File.directory?(directory)
-            files = Dir.glob(File.join(directory, '**', '**', '*.rb'))
+            files = Dir.glob(File.join(directory, "**", "**", "*.rb"))
             files.map do |path|
               begin
                 Sfn::Lint.class_eval(

data/lib/sfn/command/list.rb

@@ -1,4 +1,4 @@
-require 'sfn'
+require "sfn"
 
 module Sfn
   class Command
@@ -15,7 +15,7 @@ module Sfn
               allowed_attributes.each do |attr|
                 width_val = stacks.map { |e| e[attr].to_s.length }.push(attr.length).max + 2
                 width_val = width_val > 70 ? 70 : width_val < 20 ? 20 : width_val
-                column attr.split('_').map(&:capitalize).join(' '), :width => width_val
+                column attr.split("_").map(&:capitalize).join(" "), :width => width_val
               end
             end
             get_stacks.each do |stack|

data/lib/sfn/command/plan.rb

@@ -0,0 +1,227 @@
+require "sfn"
+
+module Sfn
+  class Command
+    # Plan command
+    class Plan < Command
+      include Sfn::CommandModule::Base
+      include Sfn::CommandModule::Planning
+      include Sfn::CommandModule::Stack
+      include Sfn::CommandModule::Template
+
+      # Run the stack planning command
+      def execute!
+        name_required!
+        name = name_args.first
+
+        stack_info = "#{ui.color("Name:", :bold)} #{name}"
+        begin
+          stack = provider.stacks.get(name)
+        rescue Miasma::Error::ApiError::RequestError
+          stack = provider.stacks.build(name: name)
+        end
+
+        return display_plan_lists(stack) if config[:list]
+
+        if config[:plan_name]
+          # ensure custom attribute is dirty so we can modify
+          stack.custom = stack.custom.dup
+          stack.custom[:plan_name] = config[:plan_name]
+        end
+
+        use_existing = false
+
+        unless config[:print_only]
+          ui.info "#{ui.color("SparkleFormation:", :bold)} #{ui.color("plan", :green)}"
+          if stack && stack.plan
+            ui.warn "Found existing plan for this stack"
+            begin
+              ui.confirm "Destroy existing plan?"
+              ui.info "Destroying existing plan to generate new plan"
+              stack.plan.destroy
+            rescue Bogo::Ui::ConfirmationDeclined
+              ui.info "Loading existing stack plan for #{ui.color(stack.name, :bold)}..."
+              use_existing = true
+            end
+          end
+        end
+
+        unless use_existing
+          config[:compile_parameters] ||= Smash.new
+
+          if config[:file]
+            s_name = [name]
+
+            c_setter = lambda do |c_stack|
+              if c_stack.outputs
+                compile_params = c_stack.outputs.detect do |output|
+                  output.key == "CompileState"
+                end
+              end
+              if compile_params
+                compile_params = MultiJson.load(compile_params.value)
+                c_current = config[:compile_parameters].fetch(s_name.join("__"), Smash.new)
+                config[:compile_parameters][s_name.join("__")] = compile_params.merge(c_current)
+              end
+              c_stack.nested_stacks(false).each do |n_stack|
+                s_name.push(n_stack.data.fetch(:logical_id, n_stack.name))
+                c_setter.call(n_stack)
+                s_name.pop
+              end
+            end
+
+            if stack && stack.persisted?
+              c_setter.call(stack)
+            end
+
+            ui.debug "Compile parameters - #{config[:compile_parameters]}"
+            file = load_template_file(:stack => stack)
+            stack_info << " #{ui.color("Path:", :bold)} #{config[:file]}"
+          else
+            file = stack.template.dup
+          end
+
+          unless file
+            if config[:template]
+              file = config[:template]
+              stack_info << " #{ui.color("(template provided)", :green)}"
+            else
+              stack_info << " #{ui.color("(no template update)", :yellow)}"
+            end
+          end
+          unless config[:print_only]
+            ui.info "  -> #{stack_info}"
+          end
+          if file
+            if config[:print_only]
+              ui.puts format_json(parameter_scrub!(template_content(file)))
+              return
+            end
+
+            original_parameters = stack.parameters
+
+            apply_stacks!(stack)
+
+            populate_parameters!(file, :current_parameters => stack.root_parameters)
+
+            stack.parameters = config_root_parameters
+
+            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
+          else
+            apply_stacks!(stack)
+            original_parameters = stack.parameters
+            populate_parameters!(stack.template, :current_parameters => stack.root_parameters)
+            stack.parameters = config_root_parameters
+          end
+
+          # Set options defined within config into stack instance for update request
+
+          ui.info "  -> Generating plan information..."
+        else
+          ui.info "  -> Loading plan information..."
+        end
+
+        plan = stack.plan || stack.plan_generate
+
+        begin
+          display_plan_information(plan)
+        rescue Bogo::Ui::ConfirmationDeclined
+          stack.reload
+          if (stack.template.nil? || stack.template.empty?) && stack.state == :unknown
+            ui.auto_confirm = false
+            ui.warn "Stack appears to be empty and should be destroyed"
+            ui.confirm "Destroy stack?"
+            stack.destroy
+            poll_stack(stack.name)
+          else
+            ui.confirm "Destroy generated plan?"
+            plan.destroy
+          end
+          raise
+        end
+
+        if config[:merge_api_options]
+          config.fetch(:options, Smash.new).each_pair do |key, value|
+            if stack.respond_to?("#{key}=")
+              stack.send("#{key}=", value)
+            end
+          end
+        end
+
+        begin
+          api_action!(:api_stack => stack) do
+            stack.plan_execute
+            if config[:poll]
+              poll_stack(stack.name)
+              if stack.reload.state == :update_complete || stack.reload.state == :create_complete
+                ui.info "Stack plan apply complete: #{ui.color("SUCCESS", :green)}"
+                namespace.const_get(:Describe).new({:outputs => true}, [name]).execute!
+              else
+                ui.fatal "Update of 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 plan apply initialized for #{ui.color(name, :green)}"
+            end
+          end
+        rescue Miasma::Error::ApiError::RequestError => e
+          if e.message.downcase.include?("no updates")
+            ui.warn "No changes detected for stack (#{stack.name})"
+          else
+            raise
+          end
+        end
+      end
+
+      # Display plan list in table form
+      #
+      # @param [Miasma::Models::Orchestration::Stack]
+      def display_plan_lists(stack)
+        unless stack
+          raise "Failed to locate requested stack `#{name_args.first}`"
+        end
+        plans = stack.plans.all
+        if plans.empty?
+          ui.warn "No plans found for stack `#{stack.name}`"
+          return
+        end
+        ui.info "Plans for stack: #{ui.color(stack.name, :bold)}\n"
+        n_width = "Plan Name".length
+        i_width = "Plan ID".length
+        s_width = "Plan State".length
+        c_width = "Created".length
+        plan_info = plans.map do |plan|
+          plan_id = plan.id.to_s.split("/").last
+          n_width = plan.name.to_s.length if plan.name.to_s.length > n_width
+          i_width = plan_id.to_s.length if plan_id.length > i_width
+          s_width = plan.state.to_s.length if plan.state.to_s.length > s_width
+          c_width = plan.created_at.to_s.length if plan.created_at.to_s.length > c_width
+          [plan.name, plan_id, plan.state, plan.created_at]
+        end
+        table = ui.table(self) do
+          table(:border => false) do
+            row(:header => true) do
+              column "Plan Name", :width => n_width + 5
+              column "Plan ID", :width => i_width + 5
+              column "Plan State", :width => s_width + 5
+              column "Created", :width => c_width + 5
+            end
+            plan_info.sort_by(&:first).each do |plan|
+              row do
+                plan.each do |item|
+                  column item
+                end
+              end
+            end
+          end
+        end.display
+      end
+    end
+  end
+end