sfn 0.0.1 → 0.3.0

data/lib/sfn/config.rb

@@ -0,0 +1,106 @@
+require 'sfn'
+require 'bogo-config'
+
+module Sfn
+
+  # Top level configuration
+  class Config < Bogo::Config
+
+    # Only values allowed designating bool type
+    BOOLEAN_VALUES = [TrueClass, FalseClass]
+
+    autoload :Create, 'sfn/config/create'
+    autoload :Describe, 'sfn/config/describe'
+    autoload :Destroy, 'sfn/config/destroy'
+    autoload :Describe, 'sfn/config/describe'
+    autoload :Events, 'sfn/config/events'
+    autoload :Export, 'sfn/config/export'
+    autoload :Import, 'sfn/config/import'
+    autoload :Inspect, 'sfn/config/inspect'
+    autoload :List, 'sfn/config/list'
+    autoload :Promote, 'sfn/config/promote'
+    autoload :Update, 'sfn/config/update'
+    autoload :Validate, 'sfn/config/validate'
+
+    attribute(
+      :credentials, Smash,
+      :coerce => proc{|v|
+        v = Smash[v.split(',').map{|x| v.split('=')}] if v.is_a?(String)
+        v.to_smash
+      },
+      :description => 'Provider credentials'
+    )
+    attribute(
+      :ignore_parameters, String,
+      :multiple => true,
+      :description => 'Parameters to ignore during modifications'
+    )
+    attribute(
+      :interactive_parameters, [TrueClass, FalseClass],
+      :default => true,
+      :description => 'Prompt for template parameters'
+    )
+    attribute(
+      :poll, [TrueClass, FalseClass],
+      :default => true,
+      :description => 'Poll stack events on modification actions'
+    )
+    attribute(
+      :defaults, [TrueClass, FalseClass],
+      :description => 'Automatically accept default values'
+    )
+    attribute(
+      :yes, [TrueClass, FalseClass],
+      :description => 'Automatically accept any requests for confirmation'
+    )
+    attribute(
+      :config, String,
+      :description => 'Configuration file path'
+    )
+
+    attribute :create, Create, :coerce => proc{|v| Create.new(v)}
+    attribute :update, Update, :coerce => proc{|v| Update.new(v)}
+    attribute :destroy, Destroy, :coerce => proc{|v| Destroy.new(v)}
+    attribute :events, Events, :coerce => proc{|v| Events.new(v)}
+    attribute :export, Export, :coerce => proc{|v| Export.new(v)}
+    attribute :import, Import, :coerce => proc{|v| Import.new(v)}
+    attribute :inspect, Inspect, :coerce => proc{|v| Inpsect.new(v)}
+    attribute :describe, Describe, :coerce => proc{|v| Describe.new(v)}
+    attribute :list, List, :coerce => proc{|v| List.new(v)}
+    attribute :promote, Promote, :coerce => proc{|v| Promote.new(v)}
+    attribute :validate, Validate, :coerce => proc{|v| Validate.new(v)}
+
+    # Provide all options for config class (includes global configs)
+    #
+    # @param klass [Class]
+    # @return [Smash]
+    def self.options_for(klass)
+      shorts = ['h'] # always reserve `-h` for help
+      _options_for(self, shorts).merge(
+        _options_for(klass, shorts)
+      )
+    end
+
+    # Provide options for config class
+    #
+    # @param klass [Class]
+    # @param shorts [Array<String>]
+    # @return [Smash]
+    def self._options_for(klass, shorts)
+      Smash[
+        klass.attributes.sort_by(&:first).map do |name, info|
+          next unless info[:description]
+          short = name.chars.zip(name.chars.map(&:upcase)).flatten.detect do |c|
+            !shorts.include?(c)
+          end
+          shorts << short
+          info[:short] = short
+          info[:long] = name.tr('_', '-')
+          info[:boolean] = [info[:type]].compact.flatten.all?{|t| BOOLEAN_VALUES.include?(t)}
+          [name, info]
+        end.compact
+      ]
+    end
+
+  end
+end

data/lib/sfn/config/create.rb

@@ -0,0 +1,35 @@
+require 'sfn'
+
+module Sfn
+  class Config
+    # Create command configuration
+    class Create < Update
+
+      attribute(
+        :timeout, Integer,
+        :coerce => proc{|v| v.to_i},
+        :description => 'Seconds to wait for stack to complete'
+      )
+      attribute(
+        :rollback, [TrueClass, FalseClass],
+        :description => 'Rollback stack on failure'
+      )
+      attribute(
+        :capabilities, String,
+        :multiple => true,
+        :description => 'Capabilities to allow the stack'
+      )
+      attribute(
+        :options, String,
+        :multiple => true,
+        :description => 'Extra options to apply to the API call'
+      )
+      attribute(
+        :notifications, String,
+        :multiple => true,
+        :description => 'Notification endpoints for stack events'
+      )
+
+    end
+  end
+end

data/lib/sfn/config/describe.rb

@@ -0,0 +1,19 @@
+require 'sfn'
+
+module Sfn
+  class Config
+    class Describe < Bogo::Config
+
+      attribute(
+        :resources, [TrueClass, FalseClass],
+        :description => 'Display stack resource list'
+      )
+
+      attribute(
+        :outputs, [TrueClass, FalseClass],
+        :description => 'Display stack outputs'
+      )
+
+    end
+  end
+end

data/lib/sfn/config/destroy.rb

@@ -0,0 +1,9 @@
+require 'sfn'
+
+module Sfn
+  class Config
+    # Destroy command configuration
+    class Destroy < Bogo::Config
+    end
+  end
+end

data/lib/sfn/config/events.rb

@@ -0,0 +1,25 @@
+require 'sfn'
+
+module Sfn
+  class Config
+    # Events command configuration
+    class Events < Bogo::Config
+
+      attribute(
+        :attribute, String,
+        :multiple => true,
+        :description => 'Event attribute to display'
+      )
+      attribute(
+        :poll_delay, Integer,
+        :default => 20,
+        :description => 'Seconds to pause between each event poll'
+      )
+      attribute(
+        :all_attributes, [TrueClass, FalseClass],
+        :description => 'Display all event attributes'
+      )
+
+    end
+  end
+end

data/lib/sfn/config/export.rb

@@ -0,0 +1,29 @@
+require 'sfn'
+
+module Sfn
+  class Config
+
+    # Export command configuration
+    class Export < Bogo::Config
+
+      attribute(
+        :name, String,
+        :description => 'Export file base name'
+      )
+      attribute(
+        :path, String,
+        :description => 'Local path prefix for dump file'
+      )
+      attribute(
+        :bucket, String,
+        :description => 'Remote storage bucket'
+      )
+      attribute(
+        :bucket_prefix, String,
+        :description => 'Remote key prefix within bucket for dump file'
+      )
+
+    end
+
+  end
+end

data/lib/sfn/config/import.rb

@@ -0,0 +1,24 @@
+require 'sfn'
+
+module Sfn
+  class Config
+
+    # Import command configuration
+    class Import < Bogo::Config
+
+      attribute(
+        :path, String,
+        :description => 'Directory path JSON export files are located'
+      )
+      attribute(
+        :bucket, String,
+        :description => 'Remote storage bucket JSON export files are located'
+      )
+      attribute(
+        :bucket_prefix, String,
+        :description => 'Remote key prefix within bucket for dump file'
+      )
+
+    end
+  end
+end

data/lib/sfn/config/inspect.rb

@@ -0,0 +1,37 @@
+require 'sfn'
+
+module Sfn
+  class Config
+    # Inspect command configuration
+    class Inspect < Bogo::Config
+
+      attribute(
+        :attribute, String,
+        :multiple => true,
+        :description => 'Dot delimited attribute to view'
+      )
+      attribute(
+        :nodes, [TrueClass, FalseClass],
+        :description => 'Locate all instances and display addresses'
+      )
+      attribute(
+        :instance_failure, String,
+        :description => 'Display log file error from failed not if possible',
+      )
+      attribute(
+        :failure_log_path, String,
+        :description => 'Path to remote log file for display on failure',
+        :default => '/var/log/chef/client.log'
+      )
+      attribute(
+        :identity_file, String,
+        :description => 'SSH identity file for authentication'
+      )
+      attribute(
+        :ssh_user, String,
+        :description => 'SSH username for inspection connect'
+      )
+
+    end
+  end
+end

data/lib/sfn/config/list.rb

@@ -0,0 +1,25 @@
+require 'sfn'
+
+module Sfn
+  class Config
+    # List command configuration
+    class List < Bogo::Config
+
+      attribute(
+        :attribute, String,
+        :multiple => true,
+        :description => 'Attribute of stack to print'
+      )
+      attribute(
+        :all_attributes, [TrueClass, FalseClass],
+        :description => 'Print all available attributes'
+      )
+      attribute(
+        :status, String,
+        :multiple => true,
+        :description => 'Match stacks with given status. Use "none" to disable.'
+      )
+
+    end
+  end
+end

data/lib/sfn/config/promote.rb

@@ -0,0 +1,23 @@
+require 'sfn'
+
+module Sfn
+  class Config
+    # Promote command configuration
+    class Promote < Bogo::Config
+
+      attribute(
+        :accounts, String,
+        :description => 'JSON accounts file path'
+      )
+      attribute(
+        :bucket, String,
+        :description => 'Bucket name containing the exports'
+      )
+      attribute(
+        :bucket_prefix, String,
+        :description => 'Key prefix within remote bucket'
+      )
+
+    end
+  end
+end

data/lib/sfn/config/update.rb

@@ -0,0 +1,20 @@
+require 'sfn'
+
+module Sfn
+  class Config
+    # Update command configuration
+    class Update < Validate
+
+      attribute(
+        :print_only, [TrueClass, FalseClass],
+        :description => 'Print the resulting stack template'
+      )
+      attribute(
+        :apply_stack, String,
+        :multiple => true,
+        :description => 'Apply outputs from stack to input parameters'
+      )
+
+    end
+  end
+end

data/lib/sfn/config/validate.rb

@@ -0,0 +1,49 @@
+require 'sfn'
+
+module Sfn
+  class Config
+    # Validate command configuration
+    class Validate < Bogo::Config
+
+      attribute(
+        :processing, [TrueClass, FalseClass],
+        :description => 'Call the unicorns and explode the glitter bombs'
+      )
+      attribute(
+        :file, String,
+        :description => 'Path to template file'
+      )
+      attribute(
+        :file_path_prompt, [TrueClass, FalseClass],
+        :default => true,
+        :description => 'Enable interactive prompt for template path discovery'
+      )
+      attribute(
+        :base_directory, String,
+        :description => 'Path to root of of templates directory'
+      )
+      attribute(
+        :no_base_directory, [TrueClass, FalseClass],
+        :description => 'Unset any value used for the template root directory path'
+      )
+      attribute(
+        :translate, String,
+        :description => 'Translate generated template to given prodiver'
+      )
+      attribute(
+        :translate_chunk, Integer,
+        :description => 'Chunk length for serialization'
+      )
+      attribute(
+        :apply_nesting, [TrueClass, FalseClass],
+        :default => true,
+        :description => 'Apply stack nesting'
+      )
+      attribute(
+        :nesting_bucket, String,
+        :description => 'Bucket to use for storing nested stack templates'
+      )
+
+    end
+  end
+end

data/lib/sfn/monkey_patch.rb

@@ -0,0 +1,8 @@
+require 'sfn'
+
+module Sfn
+  # Container for monkey patches
+  module MonkeyPatch
+    autoload :Stack, 'sfn/monkey_patch/stack'
+  end
+end

data/lib/sfn/monkey_patch/stack.rb

@@ -0,0 +1,200 @@
+require 'base64'
+require 'sfn'
+
+module Sfn
+  module MonkeyPatch
+
+    # Expand stack model functionality
+    module Stack
+
+      include Bogo::AnimalStrings
+
+      ## Status helpers
+
+      # Check for state suffix
+      #
+      # @param args [String, Symbol] state suffix to check for (multiple allowed)
+      # @return [TrueClass, FalseClass] true if any matches found in argument list
+      def status_ends_with?(*args)
+        stat = status.to_s.downcase
+        !!args.map(&:to_s).map(&:downcase).detect do |suffix|
+          stat.end_with?(suffix)
+        end
+      end
+
+      # Check for state prefix
+      #
+      # @param args [String, Symbol] state prefix to check for (multiple allowed)
+      # @return [TrueClass, FalseClass] true if any matches found in argument list
+      def status_starts_with?(*args)
+        stat = status.to_s.downcase
+        !!args.map(&:to_s).map(&:downcase).detect do |prefix|
+          stat.start_with?(prefix)
+        end
+      end
+
+      # Check for state inclusion
+      #
+      # @param args [String, Symbol] state string to check for (multiple allowed)
+      # @return [TrueClass, FalseClass] true if any matches found in argument list
+      def status_includes?(*args)
+        stat = status.to_s.downcase
+        !!args.map(&:to_s).map(&:downcase).detect do |string|
+          stat.include?(string)
+        end
+      end
+
+      # @return [TrueClass, FalseClass] stack is in progress
+      def in_progress?
+        status_ends_with?(:in_progress)
+      end
+
+      # @return [TrueClass, FalseClass] stack is in complete state
+      def complete?
+        status_ends_with?(:complete, :failed)
+      end
+
+      # @return [TrueClass, FalseClass] stack is failed state
+      def failed?
+        status_ends_with?(:failed) ||
+          (status_includes?(:rollback) && status_ends_with?(:complete))
+      end
+
+      # @return [TrueClass, FalseClass] stack is in success state
+      def success?
+        !failed? && complete?
+      end
+
+      # @return [TrueClass, FalseClass] stack is creating
+      def creating?
+        in_progress? && status_starts_with?(:create)
+      end
+
+      # @return [TrueClass, FalseClass] stack is deleting
+      def deleting?
+        in_progress? && status_starts_with?(:delete)
+      end
+
+      # @return [TrueClass, FalseClass] stack is updating
+      def updating?
+        in_progress? && status_starts_with?(:update)
+      end
+
+      # @return [TrueClass, FalseClass] stack is rolling back
+      def rollbacking?
+        in_progress? && status_starts_with?(:rollback)
+      end
+
+      # @return [String] action currently being performed
+      def performing
+        if(in_progress?)
+          status.to_s.downcase.split('_').first.to_sym
+        end
+      end
+
+      ### Color coders
+
+      # @return [TrueClass, FalseClass] stack is in red state
+      def red?
+        failed? || deleting?
+      end
+
+      # @return [TrueClass, FalseClass] stack is in green state
+      def green?
+        success?
+      end
+
+      # @return [TrueClass, FalseClass] stack is in yellow state
+      def yellow?
+        !red? && !green?
+      end
+
+      # Provides color of stack state. Red is an error state, yellow
+      # is a warning state and green is a success state
+      #
+      # @return [Symbol] color of state (:red, :yellow, :green)
+      def color_state
+        red? ? :red : green? ? :green : :yellow
+      end
+
+      # Provides text of stack state. Danger is an error state, warning
+      # is a warning state and success is a success state
+      #
+      # @return [Symbol] color of state (:danger, :warning, :success)
+      def text_state
+        red? ? :danger : green? ? :success : :warning
+      end
+
+      # @return [String] URL safe encoded stack id
+      def encoded_id
+        Base64.urlsafe_encode64(id)
+      end
+
+      # Whole number representation of current completion
+      #
+      # @param min [Integer] lowest allowed return value (defaults 5)
+      # @return [Integer] percent complete (0..100)
+      def percent_complete(min = 5)
+        if(in_progress?)
+          total_resources = load_template.fetch('Resources', []).size
+          total_complete = resources.all.find_all do |resource|
+            resource.resource_status.downcase.end_with?('complete')
+          end.size
+          result = ((total_complete.to_f / total_resources) * 100).to_i
+          result > min.to_i ? result : min
+        else
+          100
+        end
+      end
+
+      # Apply stack outputs to current stack parameters
+      #
+      # @param remote_stack [Miasma::Orchestration::Stack]
+      # @return [self]
+      # @note setting `DisableApply` within parameter hash will
+      #   prevent parameters being overridden
+      def apply_stack(remote_stack, ignore_params=nil)
+        default_key = 'Default'
+        stack_parameters = template['Parameters']
+        valid_parameters = Smash[
+          stack_parameters.map do |key, val|
+            unless(val['DisableApply'])
+              [snake(key), key]
+            end
+          end.compact
+        ]
+        unless(ignore_params)
+          if(defined?(Chef::Config))
+            ignore_params = Chef::Config[:knife].to_smash.get(:cloudformation, :ignore_parameters)
+          end
+        end
+        if(ignore_params)
+          valid_parameters = Hash[
+            valid_parameters.map do |snake_param, camel_param|
+              unless(ignore_params.include?(camel_param))
+                [snake_param, camel_param]
+              end
+            end.compact
+          ]
+        end
+        if(persisted?)
+          remote_stack.outputs.each do |output|
+            if(param_key = valid_parameters[snake(output.key)])
+              parameters.merge!(param_key => output.value)
+            end
+          end
+        else
+          remote_stack.outputs.each do |output|
+            if(param_key = valid_parameters[snake(output.key)])
+              stack_parameters[param_key][default_key] = output.value
+            end
+          end
+        end
+      end
+
+    end
+  end
+end
+
+# Infect miasma
+Miasma::Models::Orchestration::Stack.send(:include, Sfn::MonkeyPatch::Stack)