knife-cloudformation 0.1.14 → 0.1.16

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## v0.1.16
+* Fix exit code on stack destroy
+* Update stack loading for single stack requests
+* Add import and export functionality
+
 ## v0.1.14
 * Extract template building tools
 * Add support for custom CF locations and prompting

data/knife-cloudformation.gemspec

@@ -11,6 +11,7 @@ Gem::Specification.new do |s|
   s.require_path = 'lib'
   s.add_dependency 'chef'
   s.add_dependency 'fog', '~> 1.17'
+  s.add_dependency 'unf'
   s.add_dependency 'net-sftp'
   s.add_dependency 'sparkle_formation', '~> 0.1.2'
   s.add_dependency 'redis-objects'

data/lib/chef/knife/cloudformation_create.rb

@@ -1,6 +1,6 @@
 require 'sparkle_formation'
 require 'pathname'
-require 'chef/knife/cloudformation_base'
+require 'knife-cloudformation/cloudformation_base'
 
 class Chef
   class Knife
@@ -126,13 +126,17 @@ class Chef
           exit 1
         end
 
-        set_paths_and_discover_file!
-        unless(File.exists?(Chef::Config[:knife][:cloudformation][:file].to_s))
-          ui.fatal "Invalid formation file path provided: #{Chef::Config[:knife][:cloudformation][:file]}"
-          exit 1
+        unless(Chef::Config[:knife][:cloudformation][:template])
+          set_paths_and_discover_file!
+          unless(File.exists?(Chef::Config[:knife][:cloudformation][:file].to_s))
+            ui.fatal "Invalid formation file path provided: #{Chef::Config[:knife][:cloudformation][:file]}"
+            exit 1
+          end
         end
 
-        if(Chef::Config[:knife][:cloudformation][:processing])
+        if(Chef::Config[:knife][:cloudformation][:template])
+          file = Chef::Config[:knife][:cloudformation][:template]
+        elsif(Chef::Config[:knife][:cloudformation][:processing])
           file = SparkleFormation.compile(Chef::Config[:knife][:cloudformation][:file])
         else
           file = _from_json(File.read(Chef::Config[:knife][:cloudformation][:file]))
@@ -143,7 +147,14 @@ class Chef
           exit 1
         end
         ui.info "#{ui.color('Cloud Formation: ', :bold)} #{ui.color(action_type, :green)}"
-        ui.info "  -> #{ui.color('Name:', :bold)} #{name} #{ui.color('Path:', :bold)} #{Chef::Config[:knife][:cloudformation][:file]} #{ui.color('(not pre-processed)', :yellow) if Chef::Config[:knife][:cloudformation][:disable_processing]}"
+        stack_info = "#{ui.color('Name:', :bold)} #{name}"
+        if(Chef::Config[:knife][:cloudformation][:path])
+          stack_info << " #{ui.color('Path:', :bold)} #{Chef::Config[:knife][:cloudformation][:file]}"
+          if(Chef::Config[:knife][:cloudformation][:disable_processing])
+            stack_info << " #{ui.color('(not pre-processed)', :yellow)}"
+          end
+        end
+        ui.info "  -> #{stack_info}"
         populate_parameters!(file)
         stack_def = KnifeCloudformation::AwsCommons::Stack.build_stack_definition(file, Chef::Config[:knife][:cloudformation][:options])
         aws.create_stack(name, stack_def)
@@ -175,6 +186,7 @@ class Chef
           if(stack['Parameters'])
             Chef::Config[:knife][:cloudformation][:options][:parameters] ||= Mash.new
             stack['Parameters'].each do |k,v|
+              next if Chef::Config[:knife][:cloudformation][:options][:parameters][k]
               valid = false
               until(valid)
                 default = Chef::Config[:knife][:cloudformation][:options][:parameters][k] || v['Default']

data/lib/chef/knife/cloudformation_describe.rb

@@ -1,4 +1,4 @@
-require 'chef/knife/cloudformation_base'
+require 'knife-cloudformation/cloudformation_base'
 
 class Chef
   class Knife

data/lib/chef/knife/cloudformation_destroy.rb

@@ -1,4 +1,4 @@
-require 'chef/knife/cloudformation_base'
+require 'knife-cloudformation/cloudformation_base'
 
 class Chef
   class Knife
@@ -30,7 +30,7 @@ class Chef
             stacks.each do |stack_name|
               poll_stack(stack_name)
             end
-          rescue Fog::AWS::CloudFormation::NotFound
+          rescue SystemExit, Fog::AWS::CloudFormation::NotFound
             # ignore this error since this is the end result we want!
           end
           ui.info "  -> Destroyed Cloud Formation#{plural}: #{ui.color(stacks.join(', '), :bold, :red)}"

data/lib/chef/knife/cloudformation_events.rb

@@ -1,4 +1,4 @@
-require 'chef/knife/cloudformation_base'
+require 'knife-cloudformation/cloudformation_base'
 
 class Chef
   class Knife

data/lib/chef/knife/cloudformation_export.rb

@@ -0,0 +1,79 @@
+require 'knife-cloudformation/cloudformation_base'
+require 'knife-cloudformation/export'
+
+class Chef
+  class Knife
+    class CloudformationExport < Knife
+
+      include KnifeCloudformation::KnifeBase
+
+      banner 'knife cloudformation export NAME'
+
+      # TODO: Add option for s3 exports
+
+      option(:path,
+        :long => '--export-path PATH',
+        :description => 'Path to write export JSON file',
+        :proc => lambda{|v| Chef::Config[:knife][:cloudformation][:export_path] = v }
+      )
+
+      option(:ignore_parameters,
+        :short => '-P NAME',
+        :long => '--exclude-parameter NAME',
+        :description => 'Exclude parameter from export (can be used multiple times)',
+        :proc => lambda{|v|
+          Chef::Config[:knife][:cloudformation][:ignore_parameters] ||= []
+          Chef::Config[:knife][:cloudformation][:ignore_parameters].push(v).uniq!
+        }
+      )
+
+      option(:chef_environment_parameter,
+        :long => '--chef-environment-parameter NAME',
+        :description => 'Parameter used within stack to specify Chef environment',
+        :proc => lambda{|v|
+          Chef::Config[:knife][:cloudformation][:chef_environment_parameter] = v
+        }
+      )
+
+      option(:chef_popsicle,
+        :long => '--[no-]freeze-run-list',
+        :boolean => true,
+        :default => true,
+        :description => 'Freezes first run files',
+        :proc => lambda{|v| Chef::Config[:knife][:cloudformation][:chef_popsicle] = v }
+      )
+
+      def run
+        if(Chef::Config[:knife][:cloudformation][:export_path])
+          file_path = File.join(
+            Chef::Config[:knife][:cloudformation][:export_path], "#{name_args.first}-#{Time.now.to_i}.json"
+          )
+        end
+        ui.info "#{ui.color('Stack Export:', :bold)} #{name_args.first}"
+        if(file_path)
+          ui.info "  - Writing to: #{file_path}"
+        else
+          ui.info "  - Printing to console"
+        end
+        ui.confirm 'Perform export'
+        ex_opts = {}
+        [:chef_popsicle, :chef_environment_parameter, :ignore_parameters].each do |key|
+          unless(Chef::Config[:knife][:cloudformation][key].nil?)
+            ex_opts[key] = Chef::Config[:knife][:cloudformation][key]
+          end
+        end
+        exporter = KnifeCloudformation::Export.new(name_args.first, ex_opts.merge(:aws_commons => aws))
+        result = exporter.export
+        if(file_path)
+          File.open(file_path, 'w') do |file|
+            file.puts _format_json(result)
+          end
+        else
+          ui.info _format_json(result)
+        end
+        ui.info "#{ui.color('Stack export', :bold)} (#{name_args.first}): #{ui.color('complete', :green)}"
+      end
+
+    end
+  end
+end

data/lib/chef/knife/cloudformation_import.rb

@@ -0,0 +1,35 @@
+require 'knife-cloudformation/cloudformation_base'
+
+class Chef
+  class Knife
+    class CloudformationImport < Knife
+
+      include KnifeCloudformation::KnifeBase
+
+      banner 'knife cloudformation import NEW_STACK_NAME JSON_EXPORT_FILE'
+
+      def run
+        stack_name, json_file = name_args
+        ui.info "#{ui.color('Stack Import', :bold)} (#{json_file})"
+        if(File.exists?(json_file))
+          stack = _from_json(File.read(json_file))
+          creator = Chef::Knife::CloudformationCreate.new
+          creator.name_args = [stack_name]
+          Chef::Config[:knife][:cloudformation][:template] = stack['template_body']
+          Chef::Config[:knife][:cloudformation][:options] = Mash.new
+          Chef::Config[:knife][:cloudformation][:options][:parameters] = Mash.new
+          stack['parameters'].each do |k,v|
+            Chef::Config[:knife][:cloudformation][:options][:parameters][k] = v
+          end
+          ui.info '  - Starting creation of import'
+          creator.run
+          ui.info "#{ui.color('Stack Import', :bold)} (#{json_file}): #{ui.color('complete', :green)}"
+        else
+          ui.error "Failed to locate JSON export file (#{json_file})"
+          exit 1
+        end
+      end
+
+    end
+  end
+end

data/lib/chef/knife/cloudformation_inspect.rb

@@ -1,4 +1,4 @@
-require 'chef/knife/cloudformation_base'
+require 'knife-cloudformation/cloudformation_base'
 require 'knife-cloudformation/utils'
 
 class Chef

data/lib/chef/knife/cloudformation_list.rb

@@ -1,4 +1,4 @@
-require 'chef/knife/cloudformation_base'
+require 'knife-cloudformation/cloudformation_base'
 
 class Chef
   class Knife

data/lib/chef/knife/cloudformation_update.rb

@@ -1,4 +1,4 @@
-require 'chef/knife/cloudformation_create'
+require 'knife-cloudformation/cloudformation_base'
 
 class Chef
   class Knife

data/lib/knife-cloudformation/aws_commons/stack.rb

@@ -229,7 +229,7 @@ module KnifeCloudformation
       def timeout_in_minutes
         @memo[:raw_stack].value['TimeoutInMinutes']
       end
-      alias_method :timeout_in_minutes, :timeout
+      alias_method :timeout, :timeout_in_minutes
 
       def stack_id
         @memo[:raw_stack].value['StackId']

data/lib/knife-cloudformation/aws_commons.rb

@@ -90,6 +90,7 @@ module KnifeCloudformation
         end
         if(@memo[:stacks].update_allowed? || args[:force_refresh])
           @memo[:stacks_lock].lock do
+            @_stacks_cached = true
             @memo[:stacks].value = aws(:cloud_formation).describe_stacks.body['Stacks']
           end
         end
@@ -118,8 +119,10 @@ module KnifeCloudformation
         [name, name.start_with?('arn:') ? name : id_from_stack_name(name)]
       end.map do |name, s_id|
         unless(@local[:stacks][s_id])
-          seed = stacks.detect do |stk|
-            stk['StackId'] == s_id
+          if(@_stacks_cached)
+            seed = stacks.detect do |stk|
+              stk['StackId'] == s_id
+            end
           end
           @local[:stacks][s_id] = Stack.new(name, self, seed)
         end

data/lib/knife-cloudformation/export.rb

@@ -0,0 +1,173 @@
+require 'knife-cloudformation/aws_commons'
+require 'chef'
+
+module KnifeCloudformation
+  class Export
+
+    DEFAULT_OPTIONS = {
+      :chef_popsicle => true,
+      :ignored_parameters => ['Environment', 'StackCreator'],
+      :chef_environment_parameter => 'Environment'
+    }
+
+    attr_reader :stack, :stack_name, :stack_id, :options, :aws_commons
+
+    def initialize(stack_name, options={})
+      @stack_name = stack_name
+      @options = DEFAULT_OPTIONS.merge(options)
+      if(aws_commons?)
+        @aws_commons = options[:aws_commons]
+      else
+        raise ArgumentError.new('Expecting `AwsCommons` instance but none provided!')
+      end
+      load_stack
+    end
+
+    def export
+      exported = stack.to_hash
+      if(chef_popsicle?)
+        freeze_runlists(exported)
+      end
+      remove_ignored_parameters(exported)
+      exported
+    end
+
+    def method_missing(*args)
+      m = args.first.to_s
+      if(m.end_with?('?') && options.has_key?(k = m.sub('?', '').to_sym))
+        !!options[k]
+      else
+        super
+      end
+    end
+
+    protected
+
+    def remove_ignored_parameters(export)
+      options[:ignored_parameters].each do |param|
+        export[:parameters].delete(param)
+      end
+    end
+
+    def chef_environment_name
+      if(chef_environment_parameter?)
+        name = stack[:parameters][options[:chef_environment_parameter]]
+      end
+      name || '_default'
+    end
+
+    def environment
+      unless(@env)
+        @env = Chef::Environment.load('imdev')
+      end
+      @env
+    end
+
+    def load_stack
+      @stack = AwsCommons::Stack.new(stack_name, aws_commons)
+      @stack_id = @stack.stack_id
+      @stack
+    end
+
+    def allowed_cookbook_version(cookbook)
+      restriction = environment.cookbook_versions[cookbook]
+      requirement = Gem::Requirement.new(restriction)
+      Chef::CookbookVersion.available_versions(cookbook).detect do |v|
+        requirement.satisfied_by?(Gem::Version.new(v))
+      end
+    end
+
+    def extract_runlist_item(item)
+      rl_item = item.is_a?(Chef::RunList::RunListItem) ? item : Chef::RunList::RunListItem.new(item)
+      static_content = Mash.new(:run_list => [])
+      if(rl_item.recipe?)
+        cookbook, recipe = rl_item.name.split('::')
+        peg_version = allowed_cookbook_version(cookbook)
+        static_content[:run_list] << "recipe[#{[cookbook, recipe || 'default'].join('::')}@#{peg_version}]"
+      elsif(rl_item.role?)
+        role = Chef::Role.load(rl_item.name)
+        role.run_list.each do |item|
+          static_content = Chef::Mixin::DeepMerge.merge(static_content, extract_runlist_item(item))
+        end
+        static_content = Chef::Mixin::DeepMerge.merge(
+          static_content, Chef::Mixin::DeepMerge.merge(role.default_attributes, role.override_attributes)
+        )
+      else
+        # dunno what this is
+      end
+      static_content
+    end
+
+    def unpack_and_freeze_runlist(first_run)
+      extracted_runlists = first_run['run_list'].map do |item|
+        extract_runlist_item(cf_replace(item))
+      end
+      first_run.delete('run_list')
+      first_run.replace(
+        extracted_runlists.inject(first_run) do |memo, first_run_item|
+          Chef::Mixin::DeepMerge.merge(memo, first_run_item)
+        end
+      )
+    end
+
+    def freeze_runlists(exported)
+      first_runs = locate_runlists(exported)
+      first_runs.each do |first_run|
+        unpack_and_freeze_runlist(first_run)
+      end
+    end
+
+    def locate_runlists(thing)
+      result = []
+      case thing
+      when Hash
+        if(thing['content'] && thing['content']['run_list'])
+          result << thing['content']
+        else
+          thing.each do |k,v|
+            result += locate_runlists(v)
+          end
+        end
+      when Array
+        thing.each do |v|
+          result += locate_runlists(v)
+        end
+      end
+      result
+    end
+
+    def cf_replace(hsh)
+      if(hsh.is_a?(Hash))
+        case hsh.keys.first
+        when 'Fn::Join'
+          cf_join(*hsh.values.first)
+        when 'Ref'
+          cf_ref(hsh.values.first)
+        else
+          hsh
+        end
+      else
+        hsh
+      end
+    end
+
+    def cf_ref(ref_name)
+      if(stack.parameters.has_key?(ref_name))
+        stack.parameters[ref_name]
+      else
+        raise KeyError.new("No parameter found with given reference name (#{ref_name}). " <<
+          "Only parameter based references supported!")
+      end
+    end
+
+    def cf_join(delim, args)
+      args.map do |arg|
+        if(arg.is_a?(Hash))
+          cf_replace(arg)
+        else
+          arg.to_s
+        end
+      end.join(delim)
+    end
+  end
+end

data/lib/knife-cloudformation/version.rb

@@ -2,5 +2,5 @@ module KnifeCloudformation
   class Version < Gem::Version
   end
 
-  VERSION = Version.new('0.1.14')
+  VERSION = Version.new('0.1.16')
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: knife-cloudformation
 version: !ruby/object:Gem::Version
-  version: 0.1.14
+  version: 0.1.16
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-31 00:00:00.000000000 Z
+date: 2013-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef
@@ -43,6 +43,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: unf
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: net-sftp
   requirement: !ruby/object:Gem::Requirement
@@ -114,15 +130,18 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/chef/knife/cloudformation_events.rb
-- lib/chef/knife/cloudformation_base.rb
 - lib/chef/knife/cloudformation_destroy.rb
 - lib/chef/knife/cloudformation_describe.rb
+- lib/chef/knife/cloudformation_export.rb
 - lib/chef/knife/cloudformation_list.rb
 - lib/chef/knife/cloudformation_create.rb
 - lib/chef/knife/cloudformation_update.rb
 - lib/chef/knife/cloudformation_inspect.rb
+- lib/chef/knife/cloudformation_import.rb
 - lib/knife-cloudformation.rb
+- lib/knife-cloudformation/cloudformation_base.rb
 - lib/knife-cloudformation/version.rb
+- lib/knife-cloudformation/export.rb
 - lib/knife-cloudformation/aws_commons.rb
 - lib/knife-cloudformation/cache.rb
 - lib/knife-cloudformation/utils.rb