vagrant-butcher 1.0.1 → 1.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Nzg1MWJkZjQ2ZGY4MGRlY2I2NmQyZDJlZmVlM2VmNmYyYTY0ZmE5NQ==
+  data.tar.gz: !binary |-
+    Nzc3OTE1ZWQyMmVlYzZiZTQxNmYzNzU4YTM3MGMyODk2YmYyMzM2OQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    YWViMWQ3YTM5NjE1MDBhYzhiMmJmNGNlMDg5ZWIzYzFmMmY4NDlmNmY2Nzdm
+    YWVmNzA0ODM0ZjA2NDYwMDlkNWZlMDBjYmZjMWI2OGEyODMxMGRkOWE5NWM1
+    ZGFkZTU5ZGEyOTVlNWYzYTlhM2M4M2NkNzgxZGU4ZTJmMTU5MTE=
+  data.tar.gz: !binary |-
+    YjE1Njk5MjZhMmFiMmY1ZWI2MDQ2MzlkMDBkZDRhNDU1OWIxYmJjYzhmNzMy
+    ZGY4YTcwZmViMjJiZWU2MmZiYzIyNjlmYjI2ZTBhMmEyZGZkMjQzMWEwM2Yz
+    NzE3NTNkMDkyMTMxYjllNmYzMTg5NDY3MjYyNzZhNWIxYzAzY2E=

data/README.md

@@ -8,19 +8,6 @@ If you're using Vagrant with the Chef-Client provisioner it creates a client and
 
 This plugin will automatically get rid of that cruft for you when you destroy the VM.
 
-## Changelog
-
-### 1.0.0
-
-* Support for Vagrant 1.x (it's been tested on 1.4, but should work on previous minor releases) -- if you're using a pre-1.0 Vagrant release, stick to vagrant-butcher 0.0.3.
-* [Configuration](#usage) change.
-* [Installation](#install) via `vagrant plugin` only.
-* Provider-independent. _[Read more](#caveats)_
-
-### 0.0.3
-
-* Uses chef.node_name if set. Otherwise, fall back to vm.host_name (as before), or vm.box. -- _Kudos to [pikesley](https://github.com/pikesley)_.
-
 ## <a id="install"></a>Installation
 
 Starting with version 1.0.0, installation is made via Vagrant plugins only:
@@ -33,12 +20,14 @@ The plugin is loaded automatically once installed.
 
 By default, the gem looks for the Chef server settings on `$HOME/.chef/knife.rb`. This can be overridden by setting:
 
-    Vagrant.configure("2") do |config|
-      config.butcher.knife_config_file = '/path/to/knife.rb'
-      config.vm.provision :chef_client do |chef|
-        # Chef Client provisioner configuration
-      end
-    end
+```ruby
+Vagrant.configure("2") do |config|
+  config.butcher.knife_config_file = '/path/to/knife.rb'
+  config.vm.provision :chef_client do |chef|
+    # Chef Client provisioner configuration
+  end
+end
+```
 
 _Note that beginning with 1.0, the configuration is done outside of the `chef_client` provisioner._
 
@@ -51,11 +40,40 @@ This is the output of the plugin when it runs successfully:
     [default] Forcing shutdown of VM...
     [default] Destroying VM and associated drives...
 
+### <a id='auto_knife'></a>Auto Knife
+
+Starting with version 1.1.0 you can set the knife_config_file to `:auto` if you'd like it to automatically create a knife.rb for that instance from the chef provisioner values.
+
+This option has the following two limitations:
+- It doesn't work with windows guests.
+- The default `.` -> `/vagrant` shared folder should be mounted.
+
 ## <a id='caveats'></a>Caveats
 
 * Version 1.0 has only been tested with Vagrant 1.1+. If you're using an older version, it's probably best to stick to 0.0.3
 * So far this has only been tested and confirmed to run with the VirtualBox and Rackspace provisioners. It should work with others, but if you run into issues please file a bug.
 
+## Changelog
+
+### 1.1.0
+
+* :auto was added as an optional value for knife_config_file
+
+### 1.0.1
+
+* Support for Vagrant 1.2
+
+### 1.0.0
+
+* Support for Vagrant 1.x (it's been tested on 1.1.4, but should work on previous minor releases) -- if you're using a pre-1.0 Vagrant release, stick to vagrant-butcher 0.0.3.
+* [Configuration](#usage) change.
+* [Installation](#install) via `vagrant plugin` only.
+* Provider-independent. _[Read more](#caveats)_
+
+### 0.0.3
+
+* Uses chef.node_name if set. Otherwise, fall back to vm.host_name (as before), or vm.box. -- _Kudos to [pikesley](https://github.com/pikesley)_.
+
 ## Contributing
 
 1. Fork it

data/lib/vagrant-butcher/action.rb

@@ -2,6 +2,7 @@ module Vagrant
   module Butcher
     module Action
       autoload :Cleanup, 'vagrant-butcher/action/cleanup'
+      autoload :AutoKnife, 'vagrant-butcher/action/auto_knife'
       
       def self.cleanup
         ::Vagrant::Action::Builder.new.tap do |b|
@@ -10,6 +11,13 @@ module Vagrant
         end
       end
 
+      def self.auto_knife
+        ::Vagrant::Action::Builder.new.tap do |b|
+          b.use setup
+          b.use Vagrant::Butcher::Action::AutoKnife
+        end
+      end
+
       def self.setup
         @setup ||= ::Vagrant::Action::Builder.new.tap do |b|
           b.use ::Vagrant::Action::Builtin::EnvSet, butcher: Vagrant::Butcher::Env.new

data/lib/vagrant-butcher/action/auto_knife.rb

@@ -0,0 +1,66 @@
+require 'chef/config'
+require 'chef/rest'
+require 'chef/api_client'
+
+module Vagrant
+  module Butcher
+    module Action
+      class AutoKnife
+        include ::Vagrant::Butcher::EnvHelpers
+
+        def initialize(app, env)
+          @app = app
+        end
+
+        def victim(env)
+          @victim ||= chef_provisioner(env).node_name || vm_config(env).hostname || vm_config(env).box
+        end
+
+        def auto_create_knife(env)
+          folders = vm_config(env).synced_folders
+          if !folders.has_key?("/vagrant") || folders["/vagrant"][:disabled] == TRUE
+            env[:butcher].ui.warn "/vagrant folder not set to be mounted."
+          end
+
+          unless File.exists?(cache_dir(env))
+            env[:butcher].ui.info "Creating #{cache_dir(env)}"
+            Dir.mkdir(cache_dir(env))
+          end
+
+          begin
+            env[:machine].communicate.execute "cp #{guest_key_path(env)} #{auto_knife_guest_key_path(env)}", :sudo => true
+          rescue Exception => e
+            env[:butcher].ui.error "Failed to copy  #{guest_key_path(env)} to #{auto_knife_key_path(env)}"
+            env[:butcher].ui.error e
+            return false
+          end
+
+          env[:butcher].ui.info "Copied #{guest_key_path(env)} to #{auto_knife_key_path(env)}"
+
+          env[:butcher].ui.info "Creating #{auto_knife_config_file(env)}"
+
+          knife_rb = <<-END.gsub(/^ */, '')
+            log_level                :info
+            log_location             STDOUT
+            client_key               '#{auto_knife_key_path(env)}'
+            node_name                '#{victim(env)}'
+          END
+
+          File.new(auto_knife_config_file(env), 'w+').write(knife_rb)
+
+          return true
+        end
+
+        def call(env)
+          if chef_client?(env) && auto_knife?(env) && !File.exists?(auto_knife_config_file(env))
+            unless auto_create_knife(env)
+              env[:butcher].ui.error "Failed to auto create knife.rb."
+            end
+          end
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-butcher/action/cleanup.rb

@@ -10,10 +10,7 @@ module Vagrant
 
         def initialize(app, env)
           @app = app
-        end
-
-        def victim(env)
-          @victim ||= chef_provisioner(env).node_name || vm_config(env).hostname || vm_config(env).box
+          @delete_all_success = true
         end
 
         def delete_resource(resource, env)
@@ -22,11 +19,25 @@ module Vagrant
             env[:butcher].ui.success "Chef #{resource} '#{victim(env)}' successfully butchered from the server..."
           rescue Exception => e
             env[:butcher].ui.warn "Could not remove #{resource} #{victim(env)}: #{e.message}"
+            @delete_all_success = false
+          end
+        end
+
+        def delete_auto_knife(env)
+          env[:butcher].ui.info 'hwsee'
+          if @delete_all_success
+            File.delete(auto_knife_config_file(env))
+            File.delete(auto_knife_key_path(env))
+            begin
+              Dir.delete(cache_dir(env))
+            rescue
+              # The dir wasn't empty.
+            end
           end
         end
 
         def call(env)
-          if chef_client?(env)
+          if chef_client?(env) && knife_config_file(env)
             begin
               ::Chef::Config.from_file knife_config_file(env)
             rescue Errno::ENOENT => e
@@ -34,6 +45,10 @@ module Vagrant
             end
 
             %w(node client).each { |resource| delete_resource(resource, env) }
+
+            if auto_knife?(env)
+              delete_auto_knife(env)
+            end
           end
 
           @app.call(env)

data/lib/vagrant-butcher/config.rb

@@ -1,25 +1,45 @@
 module Vagrant
   module Butcher
     class Config < ::Vagrant.plugin('2', :config)
+      attr_accessor :guest_key_path
+      attr_accessor :cache_dir
+      attr_accessor :guest_cache_dir
       attr_accessor :knife_config_file
       
       def initialize
         super
+        @guest_key_path = UNSET_VALUE
+        @cache_dir = UNSET_VALUE
+        @guest_cache_dir = UNSET_VALUE
         @knife_config_file = UNSET_VALUE
       end
-      
+
+      def cache_dir=(value)
+        @cache_dir = File.expand_path(value)
+      end
+
       def knife_config_file=(value)
-        @knife_config_file = File.expand_path(value)
+        unless value == :auto
+          value = File.expand_path(value)
+        end
+
+        @knife_config_file = value
       end
       
       def validate(machine)
         errors = []
-        errors << "Knife configuration not found at #{@knife_config_file}." if !File.exists?(@knife_config_file)
+
+        if @knife_config_file != :auto && !File.exists?(@knife_config_file)
+          errors << "Knife configuration not found at #{@knife_config_file}."
+        end
         
         { "butcher configuration" => errors }
       end
       
       def finalize!
+        @guest_key_path = '/etc/chef/client.pem' if @guest_key_path == UNSET_VALUE
+        @cache_dir = File.expand_path ".vagrant-butcher" if @cache_dir == UNSET_VALUE
+        @guest_cache_dir = "/vagrant/" + File.basename(@cache_dir) if @guest_cache_dir == UNSET_VALUE
         @knife_config_file = File.expand_path "#{ENV['HOME']}/.chef/knife.rb" if @knife_config_file == UNSET_VALUE
       end
     end

data/lib/vagrant-butcher/env_helpers.rb

@@ -19,12 +19,92 @@ module Vagrant
         vm_config(env).provisioners.select { |p| p.name == :chef_client }.any?
       end
 
+      def auto_knife?(env)
+        butcher_config(env).knife_config_file == :auto
+      end
+
+      def butcher_config(env)
+        @butcher_config ||= env[:machine].config.butcher
+      end
+
+      def cache_dir(env)
+        unless @cache_dir
+          env[:butcher].ui.info "cache dir is set to '#{butcher_config(env).cache_dir}'"
+        end
+
+        @cache_dir ||= butcher_config(env).cache_dir
+      end
+
+      def guest_cache_dir(env)
+        unless @guest_cache_dir
+          @guest_cache_dir = butcher_config(env).guest_cache_dir
+          env[:butcher].ui.info "guest cache dir is set to '#{@guest_cache_dir}'"
+        end
+
+        @guest_cache_dir
+      end
+
+      def guest_key_path(env)
+        unless @guest_key_path
+          @guest_key_path = butcher_config(env).guest_key_path
+          env[:butcher].ui.info "guest key path is set to '#{@guest_key_path}'"
+        end
+
+        @guest_key_path
+      end
+
+      def auto_knife_config_file(env)
+        @auto_knife_config_file ||= "#{cache_dir(env)}/#{env[:machine].name}-knife.rb"
+      end
+
       def knife_config_file(env)
-        # Make sure that the default is set
-        env[:machine].config.butcher.finalize!
+        unless @knife_config_file
+          if auto_knife?(env)
+            file = "#{cache_dir(env)}/#{env[:machine].name}-knife.rb"
+            unless File.exists?(file)
+              file = false
+            end
+          else
+            file = butcher_config(env).knife_config_file
+          end
+
+          env[:butcher].ui.info "knife.rb location set to '#{file}'"
+
+          @knife_config_file = file
+        end
+
+        @knife_config_file
+      end
+
+      def auto_knife_key(env)
+        unless @auto_knife_key
+          @auto_knife_key = "#{env[:machine].name}-client.pem"
+          env[:butcher].ui.info "auto client key name is #{@auto_knife_key}"
+        end
+
+        @auto_knife_key
+      end
+
+      def auto_knife_key_path(env)
+        unless @auto_knife_key_path
+          @auto_knife_key_path = "#{cache_dir(env)}/#{auto_knife_key(env)}"
+          env[:butcher].ui.info "auto client key path is #{@auto_knife_key_path}"
+        end
+
+        @auto_knife_key_path
+      end
+
+      def auto_knife_guest_key_path(env)
+        unless @auto_knife_guest_key_path
+          @auto_knife_guest_key_path = "#{guest_cache_dir(env)}/#{auto_knife_key(env)}"
+          env[:butcher].ui.info "auto client guest key path is #{@auto_knife_guest_key_path}"
+        end
+
+        @auto_knife_guest_key_path
+      end
 
-        env[:butcher].ui.info "knife.rb location set to '#{env[:machine].config.butcher.knife_config_file}'"
-        env[:machine].config.butcher.knife_config_file
+      def victim(env)
+        @victim ||= chef_provisioner(env).node_name || vm_config(env).hostname || vm_config(env).box
       end
     end
   end

data/lib/vagrant-butcher/plugin.rb

@@ -5,11 +5,22 @@ module Vagrant
       description <<-DESC
       Delete node and client from the Chef server when destroying the VM.
       DESC
-      
+
+      class << self
+        def provision(hook)
+          # This should be at the end so that it can copy the chef client pem.
+          hook.append(::Vagrant::Butcher::Action.auto_knife)
+        end
+      end
+
+      action_hook(:vagrant_butcher_auto_knife, :machine_action_up, &method(:provision))
+      action_hook(:vagrant_butcher_auto_knife, :machine_action_reload, &method(:provision))
+      action_hook(:vagrant_butcher_auto_knife, :machine_action_provision, &method(:provision))
+
       action_hook(:vagrant_butcher_cleanup, :machine_action_destroy) do |hook|
         hook.after(::Vagrant::Action::Builtin::ConfigValidate, Vagrant::Butcher::Action.cleanup)
       end
-      
+
       config("butcher") do
         Config
       end

data/lib/vagrant-butcher/version.rb

@@ -1,5 +1,5 @@
 module Vagrant
   module Butcher
-    VERSION = "1.0.1"
+    VERSION = "1.1.0"
   end
 end

data/spec/unit/vagrant_butcher/config_spec.rb

@@ -7,10 +7,37 @@ describe Vagrant::Butcher::Config do
     subject.should respond_to(:knife_config_file)
   end
   
+  it "has the option to set guest chef client pem path" do
+    subject.should respond_to(:guest_key_path)
+  end
+  
+  it "has the option to set cache dir path" do
+    subject.should respond_to(:cache_dir)
+  end
+  
+  it "has the option to set guest cache dir path" do
+    subject.should respond_to(:guest_cache_dir)
+  end
+  
   it "sets knife.rb default path" do
     subject.finalize!.should eql(File.expand_path("#{ENV['HOME']}/.chef/knife.rb"))
   end
   
+  it "sets guest chef client pem default path" do
+    subject.finalize!
+    subject.guest_key_path.should eql('/etc/chef/client.pem')
+  end
+  
+  it "sets cache dir default path" do
+    subject.finalize!
+    subject.cache_dir.should eql(File.expand_path(".vagrant-butcher"))
+  end
+  
+  it "sets guest cache dir default path" do
+    subject.finalize!
+    subject.guest_cache_dir.should eql("/vagrant/" + File.basename(subject.cache_dir))
+  end
+  
   describe "#validate" do
     let(:env)     { double('env') }
     let(:config)  { double('config', butcher: subject) }

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-butcher
 version: !ruby/object:Gem::Version
-  version: 1.0.1
-  prerelease: 
+  version: 1.1.0
 platform: ruby
 authors:
 - Cassiano Leal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-16 00:00:00.000000000 Z
+date: 2013-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: pry-debugger
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -62,7 +55,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -90,6 +81,7 @@ files:
 - Rakefile
 - lib/vagrant-butcher.rb
 - lib/vagrant-butcher/action.rb
+- lib/vagrant-butcher/action/auto_knife.rb
 - lib/vagrant-butcher/action/cleanup.rb
 - lib/vagrant-butcher/config.rb
 - lib/vagrant-butcher/env.rb
@@ -104,27 +96,26 @@ files:
 - vagrant-butcher.gemspec
 homepage: https://github.com/cassianoleal/vagrant-butcher
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.6
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: When a Vagrant VM that was spun up using Chef-Client is destroyed, it leaves
   behind a client and a node on the Chef server. What butcher does is to clean up
   those during the destroy operation.