├── .gitignore
├── .travis.yml
├── Gemfile
├── Gemfile.lock
├── LICENSE.txt
├── README.md
├── Rakefile
├── Vagrantfile
├── lib
    ├── vagrant-butcher.rb
    └── vagrant-butcher
    │   ├── action.rb
    │   ├── action
    │       ├── cleanup.rb
    │       └── copy_guest_key.rb
    │   ├── config.rb
    │   ├── errors.rb
    │   ├── helpers.rb
    │   ├── helpers
    │       ├── action.rb
    │       ├── config.rb
    │       ├── connection.rb
    │       ├── guest.rb
    │       └── key_files.rb
    │   ├── plugin.rb
    │   └── version.rb
├── spec
    ├── spec_helper.rb
    └── unit
    │   ├── vagrant_butcher
    │       └── config_spec.rb
    │   └── vagrant_butcher_spec.rb
└── vagrant-butcher.gemspec


/.gitignore:
--------------------------------------------------------------------------------
 1 | *.gem
 2 | *.rbc
 3 | .bundle
 4 | .config
 5 | .yardoc
 6 | InstalledFiles
 7 | _yardoc
 8 | coverage
 9 | doc/
10 | lib/bundler/man
11 | pkg
12 | rdoc
13 | spec/reports
14 | test/tmp
15 | test/version_tmp
16 | tmp
17 | .idea/
18 | .vagrant/
19 | .vagrant-butcher/
20 | *.sublime-*
21 | 


--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | language: ruby
2 | rvm:
3 |   - 2.5.3
4 | script: bundle exec rspec spec/
5 | 


--------------------------------------------------------------------------------
/Gemfile:
--------------------------------------------------------------------------------
 1 | source 'https://rubygems.org'
 2 | 
 3 | group :development do
 4 |   # We depend on Vagrant for development, but we don't add it as a
 5 |   # gem dependency because we expect to be installed within the
 6 |   # Vagrant environment itself using `vagrant plugin`.
 7 |   gem "vagrant", :git => 'https://github.com/mitchellh/vagrant.git'
 8 | end
 9 | 
10 | group :plugins do
11 |   gemspec
12 | end
13 | 


--------------------------------------------------------------------------------
/Gemfile.lock:
--------------------------------------------------------------------------------
  1 | GIT
  2 |   remote: https://github.com/mitchellh/vagrant.git
  3 |   revision: 4ce8d84f7e6709e4478612a9f0810dc686076ee0
  4 |   specs:
  5 |     vagrant (2.2.6.dev)
  6 |       bcrypt_pbkdf (~> 1.0.0)
  7 |       childprocess (~> 0.6.0)
  8 |       ed25519 (~> 1.2.4)
  9 |       erubis (~> 2.7.0)
 10 |       hashicorp-checkpoint (~> 0.1.5)
 11 |       i18n (~> 1.1.1)
 12 |       listen (~> 3.1.5)
 13 |       log4r (~> 1.1.9, < 1.1.11)
 14 |       net-scp (~> 1.2.0)
 15 |       net-sftp (~> 2.1)
 16 |       net-ssh (~> 5.1.0)
 17 |       rb-kqueue (~> 0.2.0)
 18 |       rest-client (>= 1.6.0, < 3.0)
 19 |       ruby_dep (<= 1.3.1)
 20 |       rubyzip (~> 1.2.2)
 21 |       vagrant_cloud (~> 2.0.2)
 22 |       wdm (~> 0.1.0)
 23 |       winrm (~> 2.1)
 24 |       winrm-elevated (~> 1.1)
 25 |       winrm-fs (~> 1.0)
 26 | 
 27 | PATH
 28 |   remote: .
 29 |   specs:
 30 |     vagrant-butcher (2.3.2.pre)
 31 |       ridley (~> 5.1)
 32 | 
 33 | GEM
 34 |   remote: https://rubygems.org/
 35 |   specs:
 36 |     addressable (2.6.0)
 37 |       public_suffix (>= 2.0.2, < 4.0)
 38 |     bcrypt_pbkdf (1.0.1)
 39 |     buff-config (2.0.0)
 40 |       buff-extensions (~> 2.0)
 41 |       varia_model (~> 0.6)
 42 |     buff-extensions (2.0.0)
 43 |     buff-ignore (1.2.0)
 44 |     buff-ruby_engine (1.0.0)
 45 |     buff-shell_out (1.1.0)
 46 |       buff-ruby_engine (~> 1.0)
 47 |     builder (3.2.3)
 48 |     byebug (11.0.1)
 49 |     celluloid (0.16.0)
 50 |       timers (~> 4.0.0)
 51 |     celluloid-io (0.16.2)
 52 |       celluloid (>= 0.16.0)
 53 |       nio4r (>= 1.1.0)
 54 |     chef-config (15.1.36)
 55 |       addressable
 56 |       fuzzyurl
 57 |       mixlib-config (>= 2.2.12, < 4.0)
 58 |       mixlib-shellout (>= 2.0, < 4.0)
 59 |       tomlrb (~> 1.2)
 60 |     childprocess (0.6.3)
 61 |       ffi (~> 1.0, >= 1.0.11)
 62 |     coderay (1.1.2)
 63 |     concurrent-ruby (1.1.5)
 64 |     date (2.0.0)
 65 |     did_you_mean (1.2.0)
 66 |     diff-lcs (1.3)
 67 |     domain_name (0.5.20180417)
 68 |       unf (>= 0.0.5, < 1.0.0)
 69 |     ed25519 (1.2.4)
 70 |     erubis (2.7.0)
 71 |     faraday (0.15.4)
 72 |       multipart-post (>= 1.2, < 3)
 73 |     ffi (1.11.1)
 74 |     fileutils (1.2.0)
 75 |     fuzzyurl (0.9.0)
 76 |     gssapi (1.3.0)
 77 |       ffi (>= 1.0.1)
 78 |     gyoku (1.3.1)
 79 |       builder (>= 2.1.2)
 80 |     hashicorp-checkpoint (0.1.5)
 81 |     hashie (3.6.0)
 82 |     hitimes (1.3.1)
 83 |     http-cookie (1.0.3)
 84 |       domain_name (~> 0.5)
 85 |     httpclient (2.8.3)
 86 |     i18n (1.1.1)
 87 |       concurrent-ruby (~> 1.0)
 88 |     json (2.3.1)
 89 |     listen (3.1.5)
 90 |       rb-fsevent (~> 0.9, >= 0.9.4)
 91 |       rb-inotify (~> 0.9, >= 0.9.7)
 92 |       ruby_dep (~> 1.2)
 93 |     little-plugger (1.1.4)
 94 |     log4r (1.1.10)
 95 |     logging (2.2.2)
 96 |       little-plugger (~> 1.1)
 97 |       multi_json (~> 1.10)
 98 |     method_source (0.9.2)
 99 |     mime-types (3.2.2)
100 |       mime-types-data (~> 3.2015)
101 |     mime-types-data (3.2019.0331)
102 |     mixlib-authentication (3.0.1)
103 |     mixlib-config (3.0.1)
104 |       tomlrb
105 |     mixlib-shellout (3.0.4)
106 |     multi_json (1.13.1)
107 |     multipart-post (2.1.1)
108 |     net-scp (1.2.1)
109 |       net-ssh (>= 2.6.5)
110 |     net-sftp (2.1.2)
111 |       net-ssh (>= 2.6.5)
112 |     net-ssh (5.1.0)
113 |     netrc (0.11.0)
114 |     nio4r (2.3.1)
115 |     nori (2.6.0)
116 |     pry (0.12.2)
117 |       coderay (~> 1.1.0)
118 |       method_source (~> 0.9.0)
119 |     pry-byebug (3.7.0)
120 |       byebug (~> 11.0)
121 |       pry (~> 0.10)
122 |     public_suffix (3.1.1)
123 |     rb-fsevent (0.10.3)
124 |     rb-inotify (0.10.0)
125 |       ffi (~> 1.0)
126 |     rb-kqueue (0.2.5)
127 |       ffi (>= 0.5.0)
128 |     rest-client (2.0.2)
129 |       http-cookie (>= 1.0.2, < 2.0)
130 |       mime-types (>= 1.16, < 4.0)
131 |       netrc (~> 0.8)
132 |     retryable (2.0.4)
133 |     ridley (5.1.1)
134 |       addressable
135 |       buff-config (~> 2.0)
136 |       buff-extensions (~> 2.0)
137 |       buff-ignore (~> 1.2)
138 |       buff-shell_out (~> 1.0)
139 |       celluloid (~> 0.16.0)
140 |       celluloid-io (~> 0.16.1)
141 |       chef-config (>= 12.5.0)
142 |       erubis
143 |       faraday (~> 0.9)
144 |       hashie (>= 2.0.2, < 4.0.0)
145 |       httpclient (~> 2.7)
146 |       json (>= 1.7.7)
147 |       mixlib-authentication (>= 1.3.0)
148 |       retryable (~> 2.0)
149 |       semverse (~> 2.0)
150 |       varia_model (~> 0.6)
151 |     rspec (3.8.0)
152 |       rspec-core (~> 3.8.0)
153 |       rspec-expectations (~> 3.8.0)
154 |       rspec-mocks (~> 3.8.0)
155 |     rspec-core (3.8.2)
156 |       rspec-support (~> 3.8.0)
157 |     rspec-expectations (3.8.4)
158 |       diff-lcs (>= 1.2.0, < 2.0)
159 |       rspec-support (~> 3.8.0)
160 |     rspec-mocks (3.8.1)
161 |       diff-lcs (>= 1.2.0, < 2.0)
162 |       rspec-support (~> 3.8.0)
163 |     rspec-support (3.8.2)
164 |     ruby_dep (1.3.1)
165 |     rubyntlm (0.6.2)
166 |     rubyzip (1.2.3)
167 |     semverse (2.0.0)
168 |     timers (4.0.4)
169 |       hitimes
170 |     tomlrb (1.2.8)
171 |     unf (0.1.4)
172 |       unf_ext
173 |     unf_ext (0.0.7.6)
174 |     vagrant_cloud (2.0.2)
175 |       rest-client (~> 2.0.2)
176 |     varia_model (0.6.0)
177 |       buff-extensions (~> 2.0)
178 |       hashie (>= 2.0.2, < 4.0.0)
179 |     wdm (0.1.1)
180 |     winrm (2.3.2)
181 |       builder (>= 2.1.2)
182 |       erubis (~> 2.7)
183 |       gssapi (~> 1.2)
184 |       gyoku (~> 1.0)
185 |       httpclient (~> 2.2, >= 2.2.0.2)
186 |       logging (>= 1.6.1, < 3.0)
187 |       nori (~> 2.0)
188 |       rubyntlm (~> 0.6.0, >= 0.6.1)
189 |     winrm-elevated (1.1.1)
190 |       winrm (~> 2.0)
191 |       winrm-fs (~> 1.0)
192 |     winrm-fs (1.3.2)
193 |       erubis (~> 2.7)
194 |       logging (>= 1.6.1, < 3.0)
195 |       rubyzip (~> 1.1)
196 |       winrm (~> 2.0)
197 | 
198 | PLATFORMS
199 |   ruby
200 | 
201 | DEPENDENCIES
202 |   date
203 |   did_you_mean (= 1.2.0)
204 |   fileutils
205 |   pry-byebug
206 |   rspec
207 |   vagrant!
208 |   vagrant-butcher!
209 | 
210 | BUNDLED WITH
211 |    1.16.4
212 | 


--------------------------------------------------------------------------------
/LICENSE.txt:
--------------------------------------------------------------------------------
 1 | Copyright (c) 2012 Cassiano Leal
 2 | 
 3 | MIT License
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining
 6 | a copy of this software and associated documentation files (the
 7 | "Software"), to deal in the Software without restriction, including
 8 | without limitation the rights to use, copy, modify, merge, publish,
 9 | distribute, sublicense, and/or sell copies of the Software, and to
10 | permit persons to whom the Software is furnished to do so, subject to
11 | the following conditions:
12 | 
13 | The above copyright notice and this permission notice shall be
14 | included in all copies or substantial portions of the Software.
15 | 
16 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17 | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18 | MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19 | NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20 | LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21 | OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22 | WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | [![Gem Version](https://badge.fury.io/rb/vagrant-butcher.png)](http://badge.fury.io/rb/vagrant-butcher)
  2 | [![Build Status](https://travis-ci.org/cassianoleal/vagrant-butcher.png)](https://travis-ci.org/cassianoleal/vagrant-butcher)
  3 | [![Code Climate](https://codeclimate.com/github/cassianoleal/vagrant-butcher.png)](https://codeclimate.com/github/cassianoleal/vagrant-butcher)
  4 | 
  5 | # Vagrant::Butcher
  6 | 
  7 | 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.
  8 | 
  9 | This plugin will automatically get rid of that cruft for you when you destroy the VM.
 10 | 
 11 | ## <a id="install"></a>Installation
 12 | 
 13 | Install this plugin using the Vagrant command line:
 14 | 
 15 |     $ vagrant plugin install vagrant-butcher
 16 | 
 17 | ## <a id='usage'></a>Usage
 18 | 
 19 | The plugin is loaded automatically once installed.
 20 | 
 21 | ## <a id='configuration'></a>Configuration
 22 | 
 23 | For most cases, the plugin shouldn't need any configuration. However, there are a few options that can be set. The options are all set in the `Vagrantfile` in the format:
 24 | 
 25 | ```ruby
 26 | Vagrant.configure("2") do |config|
 27 |   ...
 28 |   config.butcher.<option> = <value>
 29 |   ...
 30 | end
 31 | ```
 32 | 
 33 | | Option           | Default Value            | Purpose                                                                |
 34 | | ---------------- | ------------------------ | ---------------------------------------------------------------------- |
 35 | | `enabled`        | `true`                   | Defines whether `node` and `client` should be deleted                  |
 36 | | `guest_key_path` | `'/etc/chef/client.pem'` | Location of the client key in the guest VM                             |
 37 | | `verify_ssl`     | `true`                   | If set to false, does not verify Chef's host key                       |
 38 | | `proxy`          | `nil`                    | Inform the URL of a proxy server between your host and the Chef Server |
 39 | | `client_name`    | Guest's node name        | Inform a client name to override the plugin's default behaviour        |
 40 | | `client_key`     | Guest's client key       | Point to a local `.pem` key file that matches the `client_name`        |
 41 | 
 42 | ## <a id='caveats'></a>Caveats
 43 | 
 44 | * 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.
 45 | * The default `.` -> `/vagrant` shared folder should be mounted.
 46 | * `verify_ssl` is enabled by default. You might want to disable that if, for example, you run your own Chef server with a self-signed cert. Check [here](#configuration) to see how.
 47 | 
 48 | ## Changelog
 49 | 
 50 | ### 2.3.0
 51 | 
 52 | * Fix logger spam caused by Hashie used in Ridley (see [issue](https://github.com/intridea/hashie/issues/394))
 53 | 
 54 | ### 2.2.0
 55 | 
 56 | * Removed compatibility with Vagrant < 1.5
 57 | * Fixes an issue with recent Vagrant versions where the butcher sequence would never run
 58 | * Sets default `guest_key_path` depending on OS
 59 | * Tested and confirmed working on Windows and Linux
 60 | 
 61 | ### 2.0.0
 62 | 
 63 | * No more option to point to `knife.rb`. Data is retrieved from the `Vagrantfile`'s `chef_client` provisioner
 64 | * `chef` is no longer a requirement (no more `json` conflicts)
 65 | * [Configuration](#configuration) items were added to point to custom client name and key
 66 | * It's possible to disable the plugin by setting the `enabled` flag to `false` in the Vagrantfile.
 67 | 
 68 | See [Configuration](#configuration) for all possible customisations.
 69 | 
 70 | ### 1.1.0
 71 | 
 72 | * :auto was added as an optional value for knife_config_file
 73 | 
 74 | ### 1.0.1
 75 | 
 76 | * Support for Vagrant 1.2
 77 | 
 78 | ### 1.0.0
 79 | 
 80 | * 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.
 81 | * [Configuration](#usage) change.
 82 | * [Installation](#install) via `vagrant plugin` only.
 83 | * Provider-independent. _[Read more](#caveats)_
 84 | 
 85 | ### 0.0.3
 86 | 
 87 | * 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)_.
 88 | 
 89 | # Authors
 90 | 
 91 | * Cassiano Leal (<cassianoleal@gmail.com>)
 92 | * Daniel Searles ([https://github.com/squaresurf]())
 93 | 
 94 | ## Contributing
 95 | 
 96 | 1. Fork it
 97 | 2. Create your feature branch (`git checkout -b my-new-feature`)
 98 | 3. Commit your changes (`git commit -am 'Add some feature'`)
 99 | 4. Push to the branch (`git push origin my-new-feature`)
100 | 5. Create new Pull Request
101 | 


--------------------------------------------------------------------------------
/Rakefile:
--------------------------------------------------------------------------------
1 | require "bundler/gem_tasks"
2 | 


--------------------------------------------------------------------------------
/Vagrantfile:
--------------------------------------------------------------------------------
 1 | # -*- mode: ruby -*-
 2 | # vi: set ft=ruby :
 3 | 
 4 | # Vagrantfile API/syntax version. Don't touch unless you know what you're doing!
 5 | VAGRANTFILE_API_VERSION = "2"
 6 | 
 7 | orgname = ENV['CHEF_ORGNAME']
 8 | 
 9 | Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
10 |   config.vm.box = "chef/ubuntu-14.04"
11 |   # config.vm.network :private_network, ip: "192.168.33.10"
12 |   # config.vm.network :public_network
13 | 
14 |   config.butcher.verify_ssl = true
15 | 
16 |   config.vm.provision :chef_client do |chef|
17 |     chef.node_name = 'vagrant_butcher_test_vm'
18 |     chef.chef_server_url = "https://api.opscode.com/organizations/#{orgname}"
19 |     chef.validation_key_path = "~/.chef/#{orgname}-validator.pem"
20 |     chef.validation_client_name = "#{orgname}-validator"
21 |     # chef.run_list = [ 'recipe[dummy::fail]' ]
22 |   end
23 | end
24 | 


--------------------------------------------------------------------------------
/lib/vagrant-butcher.rb:
--------------------------------------------------------------------------------
 1 | begin
 2 |   require "vagrant"
 3 | rescue LoadError
 4 |   raise "This plugin must run within Vagrant."
 5 | end
 6 | require 'vagrant-butcher/version'
 7 | require 'vagrant-butcher/errors'
 8 | 
 9 | # Work around logger spam from hashie
10 | # https://github.com/intridea/hashie/issues/394
11 | begin
12 |   require "hashie"
13 |   require "hashie/logger"
14 |   # We cannot `disable_warnings` in a subclass because
15 |   # Hashie::Mash is used directly in the Ridley dependency:
16 |   # https://github.com/berkshelf/ridley/search?q=Hashie&unscoped_q=Hashie
17 |   # Therefore, we completely silence the Hashie logger as done in Berkshelf:
18 |   # https://github.com/berkshelf/berkshelf/pull/1668/files#diff-3eca4e8b32b88ae6a1f14498e3ef7b25R5
19 |   Hashie.logger = Logger.new(nil)
20 | rescue LoadError
21 |   # intentionally left blank
22 | end
23 | 
24 | module Vagrant
25 |   module Butcher
26 |     autoload :Action,     'vagrant-butcher/action'
27 |     autoload :Config,     'vagrant-butcher/config'
28 |     autoload :Helpers,    'vagrant-butcher/helpers'
29 |   end
30 | end
31 | 
32 | require 'vagrant-butcher/plugin'
33 | 


--------------------------------------------------------------------------------
/lib/vagrant-butcher/action.rb:
--------------------------------------------------------------------------------
 1 | module Vagrant
 2 |   module Butcher
 3 |     module Action
 4 |       autoload :Cleanup, 'vagrant-butcher/action/cleanup'
 5 |       autoload :CopyGuestKey, 'vagrant-butcher/action/copy_guest_key'
 6 | 
 7 |       def self.cleanup
 8 |         ::Vagrant::Action::Builder.new.tap do |b|
 9 |           b.use Vagrant::Butcher::Action::Cleanup
10 |         end
11 |       end
12 | 
13 |       def self.copy_guest_key
14 |         ::Vagrant::Action::Builder.new.tap do |b|
15 |           b.use Vagrant::Butcher::Action::CopyGuestKey
16 |         end
17 |       end
18 |     end
19 |   end
20 | end
21 | 


--------------------------------------------------------------------------------
/lib/vagrant-butcher/action/cleanup.rb:
--------------------------------------------------------------------------------
 1 | module Vagrant
 2 |   module Butcher
 3 |     module Action
 4 |       class Cleanup
 5 |         include ::Vagrant::Butcher::Helpers::Action
 6 |         include ::Vagrant::Butcher::Helpers::Connection
 7 | 
 8 |         def initialize(app, env)
 9 |           @app = app
10 |         end
11 | 
12 |         def call(env)
13 |           if butcher_config(machine(env)).enabled
14 |             cleanup(env)
15 |           else
16 |             env[:ui].warn "Vagrant::Butcher disabled, not cleaning up Chef server!"
17 |           end
18 | 
19 |           @app.call(env)
20 |         end
21 | 
22 |       end
23 |     end
24 |   end
25 | end
26 | 


--------------------------------------------------------------------------------
/lib/vagrant-butcher/action/copy_guest_key.rb:
--------------------------------------------------------------------------------
 1 | module Vagrant
 2 |   module Butcher
 3 |     module Action
 4 |       class CopyGuestKey
 5 |         include ::Vagrant::Butcher::Helpers::Action
 6 |         include ::Vagrant::Butcher::Helpers::KeyFiles
 7 | 
 8 |         def initialize(app, env)
 9 |           @app = app
10 |         end
11 | 
12 |         def call(env)
13 |           begin
14 |             @app.call(env)
15 |           ensure
16 |             copy_guest_key(env) if chef_client?(env)
17 |           end
18 |         end
19 | 
20 |       end
21 |     end
22 |   end
23 | end
24 | 


--------------------------------------------------------------------------------
/lib/vagrant-butcher/config.rb:
--------------------------------------------------------------------------------
 1 | module Vagrant
 2 |   module Butcher
 3 |     class Config < ::Vagrant.plugin('2', :config)
 4 |       include Helpers::Guest
 5 | 
 6 |       attr_accessor :enabled
 7 |       attr_accessor :guest_key_path
 8 |       attr_reader   :cache_dir
 9 |       attr_accessor :verify_ssl
10 |       attr_accessor :retries
11 |       attr_accessor :retry_interval
12 |       attr_accessor :proxy
13 |       attr_accessor :client_name
14 |       attr_accessor :client_key
15 | 
16 |       def initialize
17 |         super
18 |         @enabled = UNSET_VALUE
19 |         @guest_key_path = UNSET_VALUE
20 |         @cache_dir = ".vagrant/butcher"
21 |         @verify_ssl = UNSET_VALUE
22 |         @retries = UNSET_VALUE
23 |         @retry_interval = UNSET_VALUE
24 |         @proxy = UNSET_VALUE
25 |         @client_name = UNSET_VALUE
26 |         @client_key = UNSET_VALUE
27 |       end
28 | 
29 |       def finalize!
30 |         @enabled = true if @enabled == UNSET_VALUE
31 |         @guest_key_path = :DEFAULT if @guest_key_path == UNSET_VALUE
32 |         @verify_ssl = true if @verify_ssl == UNSET_VALUE
33 |         @retries = 0 if @retries == UNSET_VALUE
34 |         @retry_interval = 0 if @retry_interval == UNSET_VALUE
35 |         @proxy = nil if @proxy == UNSET_VALUE
36 |         @client_name = nil if @client_name == UNSET_VALUE
37 |         @client_key = nil if @client_key == UNSET_VALUE
38 |       end
39 |     end
40 |   end
41 | end
42 | 


--------------------------------------------------------------------------------
/lib/vagrant-butcher/errors.rb:
--------------------------------------------------------------------------------
 1 | require 'vagrant/errors'
 2 | 
 3 | module Vagrant
 4 |   module Butcher
 5 |     module Errors
 6 |       class KeyCopyFailure < ::Vagrant::Errors::VagrantError
 7 |       end
 8 | 
 9 |       class NoSyncedFolder < ::Vagrant::Errors::VagrantError
10 |       end
11 |     end
12 |   end
13 | end
14 | 


--------------------------------------------------------------------------------
/lib/vagrant-butcher/helpers.rb:
--------------------------------------------------------------------------------
 1 | module Vagrant
 2 |   module Butcher
 3 |     module Helpers
 4 |       autoload :Config,     'vagrant-butcher/helpers/config'
 5 |       autoload :Action,     'vagrant-butcher/helpers/action'
 6 |       autoload :KeyFiles,   'vagrant-butcher/helpers/key_files'
 7 |       autoload :Connection, 'vagrant-butcher/helpers/connection'
 8 |       autoload :Guest,      'vagrant-butcher/helpers/guest'
 9 |     end
10 |   end
11 | end
12 | 


--------------------------------------------------------------------------------
/lib/vagrant-butcher/helpers/action.rb:
--------------------------------------------------------------------------------
 1 | module Vagrant
 2 |   module Butcher
 3 |     module Helpers
 4 |       module Action
 5 |         include Config
 6 | 
 7 |         def machine(env)
 8 |           @machine ||= env[:machine]
 9 |         end
10 | 
11 |         def root_path(env)
12 |           @root_path ||= env[:root_path]
13 |         end
14 | 
15 |       end
16 |     end
17 |   end
18 | end
19 | 


--------------------------------------------------------------------------------
/lib/vagrant-butcher/helpers/config.rb:
--------------------------------------------------------------------------------
 1 | module Vagrant
 2 |   module Butcher
 3 |     module Helpers
 4 |       module Config
 5 | 
 6 |         def vm_config(env)
 7 |           @vm_config ||= machine(env).config.vm
 8 |         end
 9 | 
10 |         def butcher_config(env)
11 |           @butcher_config ||= machine(env).config.butcher
12 |         end
13 | 
14 |         def chef_provisioner(env)
15 |           @chef_provisioner ||= vm_config(env).provisioners.find do |p|
16 |             p.config.is_a? VagrantPlugins::Chef::Config::ChefClient
17 |           end.config
18 |         end
19 | 
20 |         def chef_client?(env)
21 |           vm_config(env).provisioners.select do |p|
22 |             # At some point, Vagrant changed from name to type.
23 |             p.name == :chef_client || \
24 |             p.type == :chef_client
25 |           end.any?
26 |         end
27 | 
28 |         def client_name(env)
29 |           @client_name ||= butcher_config(env).client_name || victim(env)
30 |         end
31 | 
32 |         def victim(env)
33 |           @victim ||= chef_provisioner(env).node_name || vm_config(env).hostname || vm_config(env).box
34 |         end
35 | 
36 |       end
37 |     end
38 |   end
39 | end
40 | 


--------------------------------------------------------------------------------
/lib/vagrant-butcher/helpers/connection.rb:
--------------------------------------------------------------------------------
 1 | require 'ridley'
 2 | 
 3 | # Silence celluloid warnings and errors: https://github.com/RiotGames/ridley/issues/220
 4 | ::Ridley::Logging.logger.level = Logger.const_get 'FATAL'
 5 | 
 6 | module Vagrant
 7 |   module Butcher
 8 |     module Helpers
 9 |       module Connection
10 |         include ::Vagrant::Butcher::Helpers::KeyFiles
11 | 
12 |         def setup_connection(env)
13 |           begin
14 |             @conn = ::Ridley.new(
15 |               server_url: chef_provisioner(env).chef_server_url,
16 |               client_name: client_name(env),
17 |               client_key: client_key_path(env),
18 |               ssl: {
19 |                 verify: butcher_config(env).verify_ssl
20 |               },
21 |               retries: butcher_config(env).retries,
22 |               retry_interval: butcher_config(env).retry_interval,
23 |               proxy: butcher_config(env).proxy
24 |             )
25 |           rescue Ridley::Errors::ClientKeyFileNotFoundOrInvalid
26 |             env[:ui].error "Chef client key not found at #{client_key_path(env)}"
27 |           rescue Exception => e
28 |             env[:ui].error "Could not connect to Chef Server: #{e}"
29 |           end
30 |         end
31 | 
32 |         def delete_resource(resource, env)
33 |           begin
34 |             @conn.send(resource.to_sym).delete(victim(env))
35 |             env[:ui].success "Chef #{resource} '#{victim(env)}' successfully butchered from the server..."
36 |           rescue Exception => e
37 |             env[:ui].warn "Could not butcher #{resource} #{victim(env)}: #{e.message}"
38 |             @failed_deletions ||= []
39 |             @failed_deletions << resource
40 |           end
41 |         end
42 | 
43 |         def cleanup(env)
44 |           if chef_client?(env)
45 |             setup_connection(env)
46 |             %w(node client).each { |resource| delete_resource(resource, env) }
47 |             cleanup_cache_dir(env)
48 |           end
49 |         end
50 | 
51 |       end
52 |     end
53 |   end
54 | end
55 | 


--------------------------------------------------------------------------------
/lib/vagrant-butcher/helpers/guest.rb:
--------------------------------------------------------------------------------
 1 | module Vagrant
 2 |   module Butcher
 3 |     module Helpers
 4 |       module Guest
 5 | 
 6 |         def windows?(env)
 7 |           machine(env).guest.capability_host_chain.last.first == :windows
 8 |         end
 9 | 
10 |         def get_guest_key_path(env)
11 |           return butcher_config(env).guest_key_path unless butcher_config(env).guest_key_path == :DEFAULT
12 |           return 'c:\etc\chef\client.pem' if windows?(env)
13 |           return '/etc/chef/client.pem'
14 |         end
15 | 
16 |       end
17 |     end
18 |   end
19 | end
20 | 


--------------------------------------------------------------------------------
/lib/vagrant-butcher/helpers/key_files.rb:
--------------------------------------------------------------------------------
 1 | require 'fileutils'
 2 | 
 3 | module Vagrant
 4 |   module Butcher
 5 |     module Helpers
 6 |       module KeyFiles
 7 |         include ::Vagrant::Butcher::Helpers::Guest
 8 | 
 9 |         def cache_dir(env)
10 |           @cache_dir ||= File.expand_path(File.join(root_path(env), butcher_config(env).cache_dir))
11 |         end
12 | 
13 |         def guest_key_path(env)
14 |           @guest_key_path ||= get_guest_key_path(env)
15 |         end
16 | 
17 |         def key_filename(env)
18 |           @key_filename ||= "#{env[:machine].name}-client.pem"
19 |         end
20 | 
21 |         def client_key_path(env)
22 |           @client_key_path ||= butcher_config(env).client_key || "#{cache_dir(env)}/#{key_filename(env)}"
23 |         end
24 | 
25 |         def create_cache_dir(env)
26 |           unless File.exists?(cache_dir(env))
27 |             env[:ui].info "Creating #{cache_dir(env)} ..."
28 |             FileUtils.mkdir_p(cache_dir(env))
29 |           end
30 |         end
31 | 
32 |         def grab_key_from_guest(env)
33 |           create_cache_dir(env)
34 |           unless windows?(env)
35 |             machine(env).communicate.execute "chmod 0644 #{guest_key_path(env)}", :sudo => true
36 |           end
37 |           machine(env).communicate.download(guest_key_path(env), "#{cache_dir(env)}/#{key_filename(env)}")
38 |           env[:ui].info "Saved client key to #{cache_dir(env)}/#{key_filename(env)}"
39 |         end
40 | 
41 |         def cleanup_cache_dir(env)
42 |           unless @failed_deletions
43 |             key_file = "#{cache_dir(env)}/#{key_filename(env)}"
44 |             File.delete(key_file) if File.exists?(key_file)
45 |             Dir.delete(cache_dir(env)) if (Dir.entries(cache_dir(env)) - %w{ . .. }).empty?
46 |           else
47 |             env[:ui].warn "#{@failed_deletions} not butchered from the Chef Server. Client key was left at #{client_key_path(env)}"
48 |           end
49 |         end
50 | 
51 |         def copy_guest_key(env)
52 |           begin
53 |             grab_key_from_guest(env)
54 |           rescue ::Vagrant::Errors::VagrantError => e
55 |             env[:ui].error "Failed to create #{cache_dir(env)}/#{key_filename(env)}: #{e.class} - #{e}"
56 |           end
57 |         end
58 | 
59 |       end
60 |     end
61 |   end
62 | end
63 | 


--------------------------------------------------------------------------------
/lib/vagrant-butcher/plugin.rb:
--------------------------------------------------------------------------------
 1 | module Vagrant
 2 |   module Butcher
 3 |     class Plugin < Vagrant.plugin('2')
 4 |       name "vagrant-butcher"
 5 |       description <<-DESC
 6 |       Delete node and client from the Chef server when destroying the VM.
 7 |       DESC
 8 | 
 9 |       class << self
10 |         def provision(hook)
11 |           # This should be at the end so that it can copy the chef client pem.
12 |           hook.before(::Vagrant::Action::Builtin::Provision, Vagrant::Butcher::Action.copy_guest_key)
13 |         end
14 |       end
15 | 
16 |       action_hook(:vagrant_butcher_copy_guest_key, :machine_action_up, &method(:provision))
17 |       action_hook(:vagrant_butcher_copy_guest_key, :machine_action_reload, &method(:provision))
18 |       action_hook(:vagrant_butcher_copy_guest_key, :machine_action_provision, &method(:provision))
19 | 
20 |       action_hook(:vagrant_butcher_cleanup, :machine_action_destroy) do |hook|
21 |         hook.before(::Vagrant::Action::Builtin::ProvisionerCleanup, Vagrant::Butcher::Action.cleanup)
22 |       end
23 | 
24 |       config("butcher") do
25 |         Config
26 |       end
27 |     end
28 |   end
29 | end
30 | 


--------------------------------------------------------------------------------
/lib/vagrant-butcher/version.rb:
--------------------------------------------------------------------------------
1 | module Vagrant
2 |   module Butcher
3 |     VERSION = "2.3.2.pre"
4 |   end
5 | end
6 | 


--------------------------------------------------------------------------------
/spec/spec_helper.rb:
--------------------------------------------------------------------------------
1 | require 'rubygems'
2 | require 'bundler/setup'
3 | require 'vagrant-butcher'
4 | 


--------------------------------------------------------------------------------
/spec/unit/vagrant_butcher/config_spec.rb:
--------------------------------------------------------------------------------
 1 | require 'spec_helper.rb'
 2 | 
 3 | describe Vagrant::Butcher::Config do
 4 |   subject { described_class.new }
 5 | 
 6 |   it "permits the user to (en|dis)able the plugin" do
 7 |     expect(subject).to respond_to(:enabled=)
 8 |   end
 9 | 
10 |   it "has the option to set guest chef client pem path" do
11 |     expect(subject).to respond_to(:guest_key_path=)
12 |   end
13 | 
14 |   it "has the option to verify SSL certs" do
15 |     expect(subject).to respond_to(:verify_ssl=)
16 |   end
17 | 
18 |   it "allows the user to configure a proxy" do
19 |     expect(subject).to respond_to(:proxy=)
20 |   end
21 | 
22 |   it "has an option to set a custom client_name" do
23 |     expect(subject).to respond_to(:client_name=)
24 |   end
25 | 
26 |   it "has an option to point to a local client key" do
27 |     expect(subject).to respond_to(:client_key=)
28 |   end
29 | 
30 |   it "does not have the option to set knife.rb path" do
31 |     expect(subject).to_not respond_to(:knife_config_file=)
32 |   end
33 | 
34 |   it "does not have the option to set cache dir path" do
35 |     expect(subject).to_not respond_to(:cache_dir=)
36 |   end
37 | 
38 |   it "sets guest chef client pem default path" do
39 |     subject.finalize!
40 |     expect(subject.guest_key_path).to eql(:DEFAULT)
41 |   end
42 | 
43 |   it "sets cache dir path" do
44 |     subject.finalize!
45 |     expect(subject.cache_dir).to eql(".vagrant/butcher")
46 |   end
47 | end
48 | 


--------------------------------------------------------------------------------
/spec/unit/vagrant_butcher_spec.rb:
--------------------------------------------------------------------------------
1 | require 'spec_helper.rb'
2 | 
3 | describe Vagrant::Butcher::Plugin do
4 | end
5 | 


--------------------------------------------------------------------------------
/vagrant-butcher.gemspec:
--------------------------------------------------------------------------------
 1 | # -*- encoding: utf-8 -*-
 2 | lib = File.expand_path('../lib', __FILE__)
 3 | $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 4 | require 'vagrant-butcher/version'
 5 | 
 6 | Gem::Specification.new do |gem|
 7 |   gem.name          = "vagrant-butcher"
 8 |   gem.version       = Vagrant::Butcher::VERSION
 9 |   gem.authors       = ["Cassiano Leal"]
10 |   gem.email         = ["cassianoleal@gmail.com"]
11 |   gem.description   = %q{Delete Chef client and node when destroying Vagrant VM}
12 |   gem.summary       = %q{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.}
13 |   gem.homepage      = "https://github.com/cassianoleal/vagrant-butcher"
14 |   gem.license       = 'MIT'
15 | 
16 |   gem.files         = `git ls-files`.split($/)
17 |   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
18 |   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
19 |   gem.require_paths = ["lib"]
20 | 
21 |   gem.add_dependency "ridley", "~> 5.1"
22 | 
23 |   gem.add_development_dependency "rspec"
24 |   gem.add_development_dependency "pry-byebug"
25 |   gem.add_development_dependency "did_you_mean", "= 1.2.0"
26 |   gem.add_development_dependency "fileutils"
27 |   gem.add_development_dependency "date"
28 | end
29 | 


--------------------------------------------------------------------------------