vagrant-butcher 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca0c243f1bc78d523af45de51eda02479461c5eb
-  data.tar.gz: 7fd4a44a11cb8a079b163ad38485f6828535ddcb
+  metadata.gz: ca1d827124b21623cd41daacdb1a72e4dcd7cda6
+  data.tar.gz: d9799e2328a5f3d723fe906570d2fbc474dfa9a6
 SHA512:
-  metadata.gz: 4bbba48df2d30503688bc49232c54e12c79815165f47e0af1566c1e1cf12fa96e792b03e2f6b51ebcd403f53d584f5132fae0980a3c68b2f6dcc39c72fc4e819
-  data.tar.gz: 92fc213d56dc3eaefad1d826ca50a82c23828936b34bec2cf425e713e3a6b2a9400d3fe5ccb627ae248aa7243e7d9f5df85a8cb256169c40bfdb5e181c82de09
+  metadata.gz: 956282406a98f53cbf15022e0eec08419abaa0079f1fb5f379af90ce8d206c7a94d37f65f679cc61bc94719e4e56260d7f39dcfcfa7233eccdf4de9f68291a63
+  data.tar.gz: f02c1defd5d1763ff3c8703e3947bec9d6618739df4ee27a1df601940677e9ca48dd2ebb78475454bf963e5c59105efb3149609ea6d7d8f952e1309e75794b74

data/.gitignore

@@ -18,3 +18,4 @@ tmp
 .idea/
 .vagrant/
 .vagrant-butcher/
+*.sublime-*

data/lib/vagrant-butcher.rb

@@ -11,7 +11,7 @@ module Vagrant
     autoload :Action,     'vagrant-butcher/action'
     autoload :Config,     'vagrant-butcher/config'
     autoload :Env,        'vagrant-butcher/env'
-    autoload :EnvHelpers, 'vagrant-butcher/env_helpers'
+    autoload :Helpers,    'vagrant-butcher/helpers'
   end
 end
 

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

@@ -2,50 +2,23 @@ module Vagrant
   module Butcher
     module Action
       class Cleanup
-        include ::Vagrant::Butcher::EnvHelpers
+        include ::Vagrant::Butcher::Helpers::Action
+        include ::Vagrant::Butcher::Helpers::Connection
 
         def initialize(app, env)
           @app = app
-          @delete_all_success = true
-        end
-
-        def delete_resource(resource, env)
-          begin
-            @conn.send(resource.to_sym).delete(victim(env))
-            env[:butcher].ui.success "Chef #{resource} '#{victim(env)}' successfully butchered from the server..."
-          rescue Exception => e
-            env[:butcher].ui.warn "Could not butcher #{resource} #{victim(env)}: #{e.message}"
-            @delete_all_success = false
-          end
-        end
-
-        def cleanup_cache_dir(env)
-          if @delete_all_success
-            File.delete(host_key_path(env))
-            begin
-              Dir.delete(cache_dir(env))
-            rescue
-              # The dir wasn't empty.
-            end
-          else
-            env[:butcher].ui.warn "Client and/or node not butchered from the Chef Server. Client key was left at #{host_key_path(env)}"
-          end
         end
 
         def call(env)
-          setup_connection(env)
-
-          if butcher_config(env).enabled
-            if chef_client?(env)
-              %w(node client).each { |resource| delete_resource(resource, env) }
-              cleanup_cache_dir(env)
-            end
+          if butcher_config(machine(env)).enabled
+            cleanup(env)
           else
-            env[:butcher].ui.warn "Vagrant::Butcher disabled, not cleaning up Chef server!"
+            ui(env).warn "Vagrant::Butcher disabled, not cleaning up Chef server!"
           end
 
           @app.call(env)
         end
+
       end
     end
   end

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

@@ -2,45 +2,21 @@ module Vagrant
   module Butcher
     module Action
       class CopyGuestKey
-        include ::Vagrant::Butcher::EnvHelpers
+        include ::Vagrant::Butcher::Helpers::Action
+        include ::Vagrant::Butcher::Helpers::KeyFiles
 
         def initialize(app, env)
           @app = app
         end
 
-        def create_cache_dir(env)
-          unless File.exists?(cache_dir(env))
-            env[:butcher].ui.info "Creating #{cache_dir(env)}"
-            Dir.mkdir(cache_dir(env))
-          end
-        end
-
-        def copy_key_from_guest(env)
-          create_cache_dir(env)
-
-          begin
-            env[:machine].communicate.execute "cp #{guest_key_path(env)} #{guest_cache_key_path(env)}", :sudo => true
-            env[:butcher].ui.info "Copied #{guest_key_path(env)} to #{guest_cache_key_path(env)}"
-          rescue Exception => e
-            env[:butcher].ui.error "Failed to copy #{guest_key_path(env)} to #{guest_cache_key_path(env)}"
-            env[:butcher].ui.error e
-            return false
-          end
-
-          return true
-        end
-
         def call(env)
           begin
             @app.call(env)
           ensure
-            if chef_client?(env)
-              unless guest_cache_dir(env) && copy_key_from_guest(env)
-                env[:butcher].ui.error "Failed to copy Chef client key from the guest."
-              end
-            end
+            copy_guest_key(env) if chef_client?(env)
           end
         end
+
       end
     end
   end

data/lib/vagrant-butcher/errors.rb

@@ -2,37 +2,12 @@ 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
+    module Errors
+      class KeyCopyFailure < ::Vagrant::Errors::VagrantError
       end
 
-      def to_s
-        "#{original.class}: #{original.to_s}"
+      class NoSyncedFolder < ::Vagrant::Errors::VagrantError
       end
-
-      private
-
-        def method_missing(fun, *args, &block)
-          original.send(fun, *args, &block)
-        end
     end
   end
 end

data/lib/vagrant-butcher/helpers.rb

@@ -0,0 +1,10 @@
+module Vagrant
+  module Butcher
+    module Helpers
+      autoload :Config,     'vagrant-butcher/helpers/config'
+      autoload :Action,     'vagrant-butcher/helpers/action'
+      autoload :KeyFiles,   'vagrant-butcher/helpers/key_files'
+      autoload :Connection, 'vagrant-butcher/helpers/connection'
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module Vagrant
+  module Butcher
+    module Helpers
+      module Action
+        include Config
+
+        def ui(env)
+          @ui ||= env[:butcher].ui
+        end
+
+        def machine(env)
+          @machine ||= env[:machine]
+        end
+
+      end
+    end
+  end
+end

data/lib/vagrant-butcher/helpers/config.rb

@@ -0,0 +1,35 @@
+module Vagrant
+  module Butcher
+    module Helpers
+      module Config
+
+        def vm_config(env)
+          @vm_config ||= machine(env).config.vm
+        end
+
+        def butcher_config(env)
+          @butcher_config ||= machine(env).config.butcher
+        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 client_name(env)
+          @client_name ||= butcher_config(env).client_name || victim(env)
+        end
+
+        def victim(env)
+          @victim ||= chef_provisioner(env).node_name || vm_config(env).hostname || vm_config(env).box
+        end
+
+      end
+    end
+  end
+end

data/lib/vagrant-butcher/helpers/connection.rb

@@ -0,0 +1,57 @@
+require 'ridley'
+
+# Silence celluloid warnings and errors: https://github.com/RiotGames/ridley/issues/220
+::Ridley::Logging.logger.level = Logger.const_get 'FATAL'
+
+module Vagrant
+  module Butcher
+    module Helpers
+      module Connection
+        include ::Vagrant::Butcher::Helpers::KeyFiles
+
+        def setup_connection(env)
+          unless @conn
+            begin
+              @conn = ::Ridley.new(
+                server_url: chef_provisioner(env).chef_server_url,
+                client_name: client_name(env),
+                client_key: client_key(env),
+                ssl: {
+                  verify: butcher_config(env).verify_ssl
+                },
+                retries: butcher_config(env).retries,
+                retry_interval: butcher_config(env).retry_interval,
+                proxy: butcher_config(env).proxy
+              )
+            rescue Ridley::Errors::ClientKeyFileNotFoundOrInvalid
+              ui(env).error "Chef client key not found at #{client_key(env)}"
+            rescue Exception => e
+              ui(env).error "Could not connect to Chef Server: #{e}"
+            end
+          end
+          @conn
+        end
+
+        def delete_resource(resource, env)
+          begin
+            @conn.send(resource.to_sym).delete(victim(env))
+            ui(env).success "Chef #{resource} '#{victim(env)}' successfully butchered from the server..."
+          rescue Exception => e
+            ui(env).warn "Could not butcher #{resource} #{victim(env)}: #{e.message}"
+            @failed_deletions ||= []
+            @failed_deletions << resource
+          end
+        end
+
+        def cleanup(env)
+          setup_connection(env)
+          if chef_client?(env)
+            %w(node client).each { |resource| delete_resource(resource, env) }
+            cleanup_cache_dir(env)
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/vagrant-butcher/helpers/key_files.rb

@@ -0,0 +1,101 @@
+module Vagrant
+  module Butcher
+    module Helpers
+      module KeyFiles
+
+        def cache_dir(env)
+          @cache_dir ||= butcher_config(env).cache_dir
+        end
+
+        def cache_dir_mapping(env)
+          unless @cache_dir_mapping
+            # Grab all enabled synced_folders
+            synced_folders = vm_config(env).synced_folders.values.find_all { |f| !f[:disabled] }
+
+            # Expand the hostpath of each folder
+            synced_folders.each { |f| f[:hostpath] = File.expand_path(f[:hostpath]) }
+
+            # Select the folder wherein the cache_dir is contained
+            cache_dir_mappings = synced_folders.select { |f| cache_dir(env) =~ /^#{f[:hostpath]}/ }
+            @cache_dir_mapping = cache_dir_mappings.first if cache_dir_mappings.any?
+          end
+          @cache_dir_mapping
+        end
+
+        def guest_cache_dir(env)
+          unless @guest_cache_dir
+            if cache_dir_mapping(env)
+              # Return the path to the cache dir inside the VM
+              @guest_cache_dir = cache_dir(env).gsub(cache_dir_mapping(env)[:hostpath], cache_dir_mapping(env)[:guestpath])
+              ui(env).info "Guest cache dir at #{@guest_cache_dir}"
+            else
+              ui(env).error "We couldn't find a synced folder to access the cache dir on the guest."
+              ui(env).error "Did you disable the /vagrant folder or set a butcher.cache_path that isn't shared with the guest?"
+              raise ::Vagrant::Butcher::Errors::NoSyncedFolder
+            end
+          end
+          @guest_cache_dir
+        end
+
+        def guest_key_path(env)
+          @guest_key_path ||= butcher_config(env).guest_key_path
+        end
+
+        def guest_key_filename(env)
+          @guest_key ||= "#{env[:machine].name}-client.pem"
+        end
+
+        def guest_cache_key_path(env)
+          @guest_cache_key_path ||= "#{guest_cache_dir(env)}/#{guest_key_filename(env)}"
+        end
+
+        def client_key(env)
+          @client_key ||= butcher_config(env).client_key || "#{cache_dir(env)}/#{guest_key_filename(env)}"
+        end
+
+        def create_cache_dir(env)
+          unless File.exists?(cache_dir(env))
+            ui(env).info "Creating #{cache_dir(env)}"
+            Dir.mkdir(cache_dir(env))
+          end
+        end
+
+        def copy_key_file(env)
+          create_cache_dir(env)
+
+          begin
+            machine(env).communicate.execute "mkdir -p #{guest_cache_key_path(env)} ; cp #{guest_key_path(env)} #{guest_cache_key_path(env)}", :sudo => true
+            ui(env).info "Copied #{guest_key_path(env)} to #{guest_cache_key_path(env)}"
+          rescue Exception => e
+            ui(env).error "Failed to copy #{guest_key_path(env)} to #{guest_cache_key_path(env)}"
+            ui(env).error e
+            raise ::Vagrant::Butcher::Errors::KeyCopyFailure
+          end
+        end
+
+        def cleanup_cache_dir(env)
+          unless @failed_deletions
+            File.delete(client_key(env))
+            begin
+              Dir.delete(cache_dir(env))
+            rescue Errno::ENOTEMPTY
+              # The dir wasn't empty.
+            end
+          else
+            ui(env).warn "#{@failed_deletions} not butchered from the Chef Server. Client key was left at #{client_key(env)}"
+          end
+        end
+
+        def copy_guest_key(env)
+          begin
+            guest_cache_dir(env)
+            copy_key_file(env)
+          rescue ::Vagrant::Errors::VagrantError => e
+            ui(env).error "Failed to copy Chef client key from the guest: #{e.class}"
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/vagrant-butcher/version.rb

@@ -1,5 +1,5 @@
 module Vagrant
   module Butcher
-    VERSION = "2.0.0"
+    VERSION = "2.1.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-butcher
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Cassiano Leal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-05 00:00:00.000000000 Z
+date: 2013-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ridley
@@ -86,8 +86,12 @@ files:
 - lib/vagrant-butcher/action/copy_guest_key.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/helpers.rb
+- lib/vagrant-butcher/helpers/action.rb
+- lib/vagrant-butcher/helpers/config.rb
+- lib/vagrant-butcher/helpers/connection.rb
+- lib/vagrant-butcher/helpers/key_files.rb
 - lib/vagrant-butcher/plugin.rb
 - lib/vagrant-butcher/version.rb
 - spec/spec_helper.rb

data/lib/vagrant-butcher/env_helpers.rb

@@ -1,113 +0,0 @@
-require 'ridley'
-
-# Silence celluloid warnings and errors: https://github.com/RiotGames/ridley/issues/220
-::Ridley::Logging.logger.level = Logger.const_get 'FATAL'
-
-module Vagrant
-  module Butcher
-    module EnvHelpers
-      def vm_config(env)
-        @vm_config ||= env[:machine].config.vm
-      end
-
-      def setup_connection(env)
-        unless @conn
-          begin
-            @conn = ::Ridley.new(
-              server_url: chef_provisioner(env).chef_server_url,
-              client_name: client_name(env),
-              client_key: client_key(env),
-              ssl: {
-                verify: butcher_config(env).verify_ssl
-              },
-              retries: butcher_config(env).retries,
-              retry_interval: butcher_config(env).retry_interval,
-              proxy: butcher_config(env).proxy
-            )
-          rescue Ridley::Errors::ClientKeyFileNotFoundOrInvalid
-            env[:butcher].ui.error "Chef client key not found at #{host_key_path(env)}"
-          rescue Exception => e
-            env[:butcher].ui.error "Could not connect to Chef Server: #{e}"
-          end
-        end
-        @conn
-      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 butcher_config(env)
-        @butcher_config ||= env[:machine].config.butcher
-      end
-
-      def cache_dir(env)
-        @cache_dir ||= butcher_config(env).cache_dir
-      end
-
-      def cache_dir_mapping(env)
-        unless @cache_dir_mapping
-          # Grab all enabled synced_folders
-          synced_folders = vm_config(env).synced_folders.values.find_all { |f| !f[:disabled] }
-
-          # Expand the hostpath of each folder
-          synced_folders.each { |f| f[:hostpath] = File.expand_path(f[:hostpath]) }
-
-          # Select the folder wherein the cache_dir is contained
-          cache_dir_mappings = synced_folders.select { |f| cache_dir(env) =~ /^#{f[:hostpath]}/ }
-          @cache_dir_mapping = cache_dir_mappings.first if cache_dir_mappings.any?
-        end
-        @cache_dir_mapping
-      end
-
-      def guest_cache_dir(env)
-        unless @guest_cache_dir
-          if cache_dir_mapping(env)
-            # Return the path to the cache dir inside the VM
-            @guest_cache_dir = cache_dir(env).gsub(cache_dir_mapping(env)[:hostpath], cache_dir_mapping(env)[:guestpath])
-            env[:butcher].ui.info "Guest cache dir at #{@guest_cache_dir}"
-          else
-            @guest_cache_dir = false
-            env[:butcher].ui.error "We couldn't find a synced folder to access the cache dir on the guest."
-            env[:butcher].ui.error "Did you disable the /vagrant folder or set a butcher.cache_path that isn't shared with the guest?"
-          end
-        end
-        @guest_cache_dir
-      end
-
-      def guest_key_path(env)
-        @guest_key_path ||= butcher_config(env).guest_key_path
-      end
-
-      def guest_key_filename(env)
-        @guest_key ||= "#{env[:machine].name}-client.pem"
-      end
-
-      def host_key_path(env)
-        @host_key_path ||= "#{cache_dir(env)}/#{guest_key_filename(env)}"
-      end
-
-      def guest_cache_key_path(env)
-        @guest_cache_key_path ||= "#{guest_cache_dir(env)}/#{guest_key_filename(env)}"
-      end
-
-      def client_key(env)
-        @client_key ||= butcher_config(env).client_key || host_key_path(env)
-      end
-
-      def client_name(env)
-        @client_name ||= butcher_config(env).client_name || victim(env)
-      end
-
-      def victim(env)
-        @victim ||= chef_provisioner(env).node_name || vm_config(env).hostname || vm_config(env).box
-      end
-    end
-  end
-end