vagrant-butcher 0.0.3 → 1.0.0

data/.gitignore

@@ -16,3 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 .idea/
+.vagrant/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+script: bundle exec rspec spec/

data/Gemfile

@@ -2,3 +2,10 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in vagrant-butcher.gemspec
 gemspec
+
+group :development do
+  # We depend on Vagrant for development, but we don't add it as a
+  # gem dependency because we expect to be installed within the
+  # Vagrant environment itself using `vagrant plugin`.
+  gem "vagrant", :git => "git://github.com/mitchellh/vagrant.git"
+end

data/README.md

@@ -1,45 +1,61 @@
 [![Gem Version](https://badge.fury.io/rb/vagrant-butcher.png)](http://badge.fury.io/rb/vagrant-butcher)
+[![Build Status](https://travis-ci.org/cassianoleal/vagrant-butcher.png)](https://travis-ci.org/cassianoleal/vagrant-butcher)
+[![Code Climate](https://codeclimate.com/github/cassianoleal/vagrant-butcher.png)](https://codeclimate.com/github/cassianoleal/vagrant-butcher)
 
 # Vagrant::Butcher
 
-If you're using Vagrant with the Chef-Client provisioner, e.g. for creating cookbooks, it creates a client and a node on the Chef server. Once you destroy the VM, both the client and node will be kept on the server, which may cause problems if you fire up the same VM again.
+If you're using Vagrant with the Chef-Client provisioner it creates a client and a node on the Chef server when the VM spins up.
 
-This gem attempts to correct that.
+This plugin will automatically get rid of that cruft for you when you destroy the VM.
 
-## Installation
+## Changelog
 
-Installation will depend on whether you're using bundler or not.
+### 1.0.0
 
-### If you're using Bundler
+* 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)_
 
-Add this line to your cookbook's Gemfile:
+### 0.0.3
 
-    gem 'vagrant-butcher'
+* 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)_.
 
-And then execute:
+## <a id="install"></a>Installation
 
-    $ bundle
+Starting with version 1.0.0, installation is made via Vagrant plugins only:
 
-### If you're not using bundler
+    $ vagrant plugin install vagrant-butcher
 
-You have to install this plugin via Vagrant:
-
-    $ vagrant gem install 'vagrant-butcher'
-
-Explanation for that is found on the [Vagrant Plugins Documentation](http://vagrantup.com/v1/docs/extending/types.html)
-
-## Usage
+## <a id='usage'></a>Usage
 
 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 overrdidden by setting:
+By default, the gem looks for the Chef server settings on `$HOME/.chef/knife.rb`. This can be overridden by setting:
 
-    Vagrant::Config.run do |config|
-      config.vm.provision :chef_solo do |chef|
-        chef.knife_config = '/path/to/knife.rb'
+    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._
+
+This is the output of the plugin when it runs successfully:
+
+    $ vagrant destroy -f
+    [Butcher] knife.rb location set to '/path/to/knife.rb'
+    [Butcher] Chef node 'node_name' successfully butchered from the server...
+    [Butcher] Chef client 'node_name' successfully butchered from the server...
+    [default] Forcing shutdown of VM...
+    [default] Destroying VM and associated drives...
+
+## <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.
+
 ## Contributing
 
 1. Fork it

data/lib/vagrant-butcher.rb

@@ -1,4 +1,14 @@
-require "vagrant/provisioners/chef"
-require "vagrant-butcher/version"
-require "vagrant-butcher/cleanup"
-require "chef"
+require 'vagrant'
+require 'vagrant-butcher/version'
+require 'vagrant-butcher/errors'
+
+module Vagrant
+  module Butcher
+    autoload :Action,     'vagrant-butcher/action'
+    autoload :Config,     'vagrant-butcher/config'
+    autoload :Env,        'vagrant-butcher/env'
+    autoload :EnvHelpers, 'vagrant-butcher/env_helpers'
+  end
+end
+
+require 'vagrant-butcher/plugin'

data/lib/vagrant-butcher/action.rb

@@ -0,0 +1,20 @@
+module Vagrant
+  module Butcher
+    module Action
+      autoload :Cleanup, 'vagrant-butcher/action/cleanup'
+      
+      def self.cleanup
+        ::Vagrant::Action::Builder.new.tap do |b|
+          b.use setup
+          b.use Vagrant::Butcher::Action::Cleanup
+        end
+      end
+
+      def self.setup
+        @setup ||= ::Vagrant::Action::Builder.new.tap do |b|
+          b.use ::Vagrant::Action::Builtin::EnvSet, butcher: Vagrant::Butcher::Env.new
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+require 'chef/config'
+require 'chef/rest'
+require 'chef/api_client'
+
+module Vagrant
+  module Butcher
+    module Action
+      class Cleanup
+        include ::Vagrant::Butcher::EnvHelpers
+
+        def initialize(app, env)
+          @app = app
+          @env = env
+        end
+
+        def victim
+          @victim ||= chef_provisioner(@env).node_name || vm_config(@env).hostname || vm_config(@env).box
+        end
+
+        def delete_resource(resource)
+          begin
+            chef_api(@env).delete_rest("#{resource}s/#{victim}")
+            @env[:butcher].ui.success "Chef #{resource} '#{victim}' successfully butchered from the server..."
+          rescue Exception => e
+            @env[:butcher].ui.warn "Could not remove #{resource} #{victim}: #{e.message}"
+          end
+        end
+
+        def call(env)
+          if chef_client?(env)
+            begin
+              ::Chef::Config.from_file knife_config_file(env)
+            rescue Errno::ENOENT => e
+              raise ::Vagrant::Butcher::VagrantWrapperError.new(e)
+            end
+
+            %w(node client).each { |resource| delete_resource(resource) }
+          end
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-butcher/config.rb

@@ -0,0 +1,27 @@
+module Vagrant
+  module Butcher
+    class Config < ::Vagrant.plugin('2', :config)
+      attr_accessor :knife_config_file
+      
+      def initialize
+        super
+        @knife_config_file = UNSET_VALUE
+      end
+      
+      def knife_config_file=(value)
+        @knife_config_file = File.expand_path(value)
+      end
+      
+      def validate(machine)
+        errors = []
+        errors << "Knife configuration not found at #{@knife_config_file}." if !File.exists?(@knife_config_file)
+        
+        { "butcher configuration" => errors }
+      end
+      
+      def finalize!
+        @knife_config_file = File.expand_path "#{ENV['HOME']}/.chef/knife.rb" if @knife_config_file == UNSET_VALUE
+      end
+    end
+  end
+end

data/lib/vagrant-butcher/env.rb

@@ -0,0 +1,11 @@
+module Vagrant
+  module Butcher
+    class Env
+      attr_accessor :ui
+      
+      def initialize
+        @ui = ::Vagrant::UI::Colored.new('Butcher')
+      end
+    end
+  end
+end

data/lib/vagrant-butcher/env_helpers.rb

@@ -0,0 +1,31 @@
+module Vagrant
+  module Butcher
+    module EnvHelpers
+      def vm_config(env)
+        @vm_config ||= env[:machine].config.vm
+      end
+
+      def chef_api(env)
+        ::Chef::REST.new(chef_provisioner(env).chef_server_url)
+      end
+
+      def chef_provisioner(env)
+        @chef_provisioner ||= vm_config(env).provisioners.find do |p|
+          p.config.is_a? VagrantPlugins::Chef::Config::ChefClient
+        end.config
+      end
+
+      def chef_client?(env)
+        vm_config(env).provisioners.select { |p| p.name == :chef_client }.any?
+      end
+
+      def knife_config_file(env)
+        # Make sure that the default is set
+        env[:machine].config.butcher.finalize!
+
+        env[:butcher].ui.info "knife.rb location set to '#{env[:machine].config.butcher.knife_config_file}'"
+        env[:machine].config.butcher.knife_config_file
+      end
+    end
+  end
+end

data/lib/vagrant-butcher/errors.rb

@@ -0,0 +1,38 @@
+require 'vagrant/errors'
+
+module Vagrant
+  module Butcher
+    # This is a copy/adaptation of the VagrantWrapperError class of berkshelf-vagrant
+    # The original can be found on https://github.com/RiotGames/berkshelf-vagrant
+    
+    # @author Jamie Winsor <reset@riotgames.com>
+    #
+    # A wrapper for a BerkshelfError for Vagrant. All Berkshelf exceptions should be
+    # wrapped in this proxy object so they are properly handled when Vagrant encounters
+    # an exception.
+    #
+    # @example wrapping an error encountered within the Vagrant plugin
+    #   rescue BerkshelfError => e
+    #     VagrantWrapperError.new(e)
+    #   end
+    class VagrantWrapperError < ::Vagrant::Errors::VagrantError
+      # @param [BerkshelfError]
+      attr_reader :original
+
+      # @param [BerkshelfError] original
+      def initialize(original)
+        @original = original
+      end
+
+      def to_s
+        "#{original.class}: #{original.to_s}"
+      end
+
+      private
+
+        def method_missing(fun, *args, &block)
+          original.send(fun, *args, &block)
+        end
+    end
+  end
+end

data/lib/vagrant-butcher/plugin.rb

@@ -0,0 +1,18 @@
+module Vagrant
+  module Butcher
+    class Plugin < Vagrant.plugin('2')
+      name "vagrant-butcher"
+      description <<-DESC
+      Delete node and client from the Chef server when destroying the VM.
+      DESC
+      
+      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
+    end
+  end
+end

data/lib/vagrant-butcher/version.rb

@@ -1,5 +1,5 @@
 module Vagrant
   module Butcher
-    VERSION = "0.0.3"
+    VERSION = "1.0.0"
   end
 end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'vagrant-butcher'

data/spec/unit/vagrant_butcher/config_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper.rb'
+
+describe Vagrant::Butcher::Config do
+  subject { described_class.new }
+  
+  it "has the option to set knife.rb path" do
+    subject.should respond_to(:knife_config_file)
+  end
+  
+  it "sets knife.rb default path" do
+    subject.finalize!.should eql(File.expand_path("#{ENV['HOME']}/.chef/knife.rb"))
+  end
+  
+  describe "#validate" do
+    let(:env)     { double('env') }
+    let(:config)  { double('config', butcher: subject) }
+    let(:machine) { double('machine', config: config, env: env) }
+    let(:result)  { subject.validate(machine) }
+    
+    context "when validations pass" do
+      before(:each) do
+        File.should_receive(:exists?).with(subject.knife_config_file).and_return(true)
+      end
+
+      it "contains an empty Array for the 'butcher configuration' key" do
+        result["butcher configuration"].should be_a(Array)
+        result["butcher configuration"].should be_empty
+      end
+    end
+    
+    context "when validations fail" do
+      before(:each) do
+        File.should_receive(:exists?).with(subject.knife_config_file).and_return(false)
+      end
+
+      it "contains an empty Array for the 'butcher configuration' key" do
+        result["butcher configuration"].should be_a(Array)
+        result["butcher configuration"].should_not be_empty
+      end
+    end
+  end
+end

data/spec/unit/vagrant_butcher_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper.rb'
+
+describe Vagrant::Butcher::Plugin do
+end

data/vagrant-butcher.gemspec

@@ -17,6 +17,9 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
   
-  gem.add_dependency "vagrant", "~> 1.0"
-  gem.add_dependency "chef"
+  gem.add_dependency "chef", ">= 11.2.0"
+  
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "pry-debugger"
+  gem.add_development_dependency "bundler", "~> 1.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-butcher
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,33 +9,33 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-21 00:00:00.000000000 Z
+date: 2013-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: vagrant
+  name: chef
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 11.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 11.2.0
 - !ruby/object:Gem::Dependency
-  name: chef
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -43,6 +43,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
 description: Delete Chef client and node when destroying Vagrant VM
 email:
 - cassianoleal@gmail.com
@@ -51,14 +83,23 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/vagrant-butcher.rb
-- lib/vagrant-butcher/cleanup.rb
+- lib/vagrant-butcher/action.rb
+- lib/vagrant-butcher/action/cleanup.rb
+- lib/vagrant-butcher/config.rb
+- lib/vagrant-butcher/env.rb
+- lib/vagrant-butcher/env_helpers.rb
+- lib/vagrant-butcher/errors.rb
+- lib/vagrant-butcher/plugin.rb
 - lib/vagrant-butcher/version.rb
-- lib/vagrant_init.rb
+- spec/spec_helper.rb
+- spec/unit/vagrant_butcher/config_spec.rb
+- spec/unit/vagrant_butcher_spec.rb
 - vagrant-butcher.gemspec
 homepage: https://github.com/cassianoleal/vagrant-butcher
 licenses: []
@@ -86,4 +127,7 @@ specification_version: 3
 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.
-test_files: []
+test_files:
+- spec/spec_helper.rb
+- spec/unit/vagrant_butcher/config_spec.rb
+- spec/unit/vagrant_butcher_spec.rb

data/lib/vagrant-butcher/cleanup.rb

@@ -1,39 +0,0 @@
-module Vagrant
-  module Provisioners
-    class ChefClient < Chef
-      class Config < Chef::Config
-        attr_accessor :knife_config
-        def knife_config; @knife_config || "#{ENV['HOME']}/.chef/knife.rb"; end
-      end
-
-      def cleanup_chef_server(node_name)
-        chef_api = ::Chef::REST.new(::Chef::Config[:chef_server_url])
-        %w(node client).each do |resource|
-          env[:ui].info "Removing Chef #{resource} \"#{node_name}\"..."
-          begin
-            chef_api.delete_rest("#{resource}s/#{node_name}")
-          rescue Exception => e
-            env[:ui].warn "Could not remove #{resource} #{node_name}: #{e.message}"
-          end
-        end
-      end
-
-      def cleanup
-        ::Chef::Config.from_file(config.knife_config)
-        conf = env[:vm].config.vm
-
-        # If a node_name is given to the chef-client provisioner, use it
-        chef_provisioner = conf.provisioners.find { |p| p.provisioner.name == "Vagrant::Provisioners::ChefClient" }
-        victim = chef_provisioner.config.node_name
-
-        # If no node_name, fall back to host_name or box
-        if not victim then
-          env[:ui].info "No chef.node_name set, falling back to vm.host_name or vm.box."
-          victim ||= conf.host_name || conf.box
-        end
-
-        cleanup_chef_server(victim)
-      end
-    end
-  end
-end

data/lib/vagrant_init.rb

@@ -1,3 +0,0 @@
-# This file is automatically loaded by Vagrant. We use this to kick-start
-# our plugin.
-require 'vagrant-butcher'