vagrant-berkshelf 1.2.0

data/lib/berkshelf/vagrant/action/install.rb

@@ -0,0 +1,71 @@
+module Berkshelf
+  module Vagrant
+    module Action
+      # @author Jamie Winsor <reset@riotgames.com>
+      class Install
+        include Berkshelf::Vagrant::EnvHelpers
+
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          if provision_disabled?(env)
+            env[:berkshelf].ui.info "Skipping Berkshelf with --no-provision"
+
+            return @app.call(env)
+          end
+
+          unless berkshelf_enabled?(env)
+            if File.exist?(env[:global_config].berkshelf.berksfile_path)
+              warn_disabled_but_berksfile_exists(env)
+            end
+
+            return @app.call(env)
+          end
+
+          env[:berkshelf].berksfile = Berkshelf::Berksfile.from_file(env[:global_config].berkshelf.berksfile_path)
+
+          if chef_solo?(env)
+            install(env)
+          end
+
+          @app.call(env)
+        rescue Berkshelf::BerkshelfError => e
+          raise Berkshelf::VagrantWrapperError.new(e)
+        end
+
+        private
+
+          def install(env)
+            check_vagrant_version(env)
+            env[:berkshelf].ui.info "Updating Vagrant's berkshelf: '#{env[:berkshelf].shelf}'"
+            opts = {
+              path: env[:berkshelf].shelf
+            }.merge(env[:global_config].berkshelf.to_hash).symbolize_keys!
+            env[:berkshelf].berksfile.install(opts)
+          end
+
+          def warn_disabled_but_berksfile_exists(env)
+            env[:berkshelf].ui.warn "Berkshelf plugin is disabled but a Berksfile was found at" +
+              " your configured path: #{env[:global_config].berkshelf.berksfile_path}"
+            env[:berkshelf].ui.warn "Enable the Berkshelf plugin by setting 'config.berkshelf.enabled = true'" +
+              " in your vagrant config"
+          end
+
+          def check_vagrant_version(env)
+            unless Solve::Constraint.new(">= 1.1").satisfies?(::Vagrant::VERSION)
+              raise Berkshelf::VagrantWrapperError.new(RuntimeError.new("vagrant-berkshelf requires Vagrant 1.1 or later."))
+            end
+
+            unless Solve::Constraint.new(::Berkshelf::Vagrant::TESTED_CONSTRAINT).satisfies?(::Vagrant::VERSION)
+              env[:berkshelf].ui.warn "This version of the Berkshelf plugin has not been fully tested on this version of Vagrant."
+              env[:berkshelf].ui.warn "You should check for a newer version of vagrant-berkshelf."
+              env[:berkshelf].ui.warn "If you encounter any errors with this version, please report them at https://github.com/RiotGames/vagrant-berkshelf/issues"
+              env[:berkshelf].ui.warn "You can also join the discussion in #berkshelf on Freenode."
+            end
+          end
+      end
+    end
+  end
+end

data/lib/berkshelf/vagrant/action/load_shelf.rb

@@ -0,0 +1,50 @@
+module Berkshelf
+  module Vagrant
+    module Action
+      # @author Jamie Winsor <reset@riotgames.com>
+      class LoadShelf
+        include Berkshelf::Vagrant::EnvHelpers
+
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          unless berkshelf_enabled?(env)
+            return @app.call(env)
+          end
+
+          shelf = load_shelf
+
+          if shelf.nil?
+            shelf = cache_shelf(Berkshelf::Vagrant.mkshelf)
+          end
+
+          env[:berkshelf].shelf = shelf
+
+          @app.call(env)
+        end
+
+        # @param [String] path
+        #
+        # @return [String]
+        def cache_shelf(path)
+          FileUtils.mkdir_p(File.dirname(path))
+
+          File.open(cache_file, 'w+') do |f|
+            f.write(path)
+          end
+
+          path
+        end
+
+        # @return [String, nil]
+        def load_shelf
+          return nil unless File.exist?(cache_file)
+
+          File.read(cache_file).chomp
+        end
+      end
+    end
+  end
+end

data/lib/berkshelf/vagrant/action/set_ui.rb

@@ -0,0 +1,17 @@
+module Berkshelf
+  module Vagrant
+    module Action
+      # @author Jamie Winsor <reset@riotgames.com>
+      class SetUI
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          Berkshelf.ui = env[:berkshelf].ui
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/berkshelf/vagrant/action/upload.rb

@@ -0,0 +1,50 @@
+module Berkshelf
+  module Vagrant
+    module Action
+      # @author Jamie Winsor <reset@riotgames.com>
+      class Upload
+        include Berkshelf::Vagrant::EnvHelpers
+
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          if provision_disabled?(env)
+            return @app.call(env)
+          end
+
+          unless berkshelf_enabled?(env)
+            return @app.call(env)
+          end
+
+          if chef_client?(env)
+            upload(env)
+          end
+
+          @app.call(env)
+        rescue Berkshelf::BerkshelfError => e
+          raise Berkshelf::VagrantWrapperError.new(e)
+        end
+
+        private
+
+          def upload(env)
+            provisioners(:chef_client, env).each do |provisioner|
+              env[:berkshelf].ui.info "Uploading cookbooks to '#{provisioner.config.chef_server_url}'"
+              env[:berkshelf].berksfile.upload(
+                server_url: provisioner.config.chef_server_url,
+                client_name: env[:berkshelf].config.chef.node_name,
+                client_key: env[:berkshelf].config.chef.client_key,
+                ssl: {
+                  verify: env[:berkshelf].config.ssl.verify
+                },
+                force: true,
+                freeze: false
+              )
+            end
+          end
+      end
+    end
+  end
+end

data/lib/berkshelf/vagrant/config.rb

@@ -0,0 +1,91 @@
+module Berkshelf
+  module Vagrant
+    # @author Jamie Winsor <reset@riotgames.com>
+    class Config < ::Vagrant.plugin("2", :config)
+      # @return [String]
+      #   path to the Berksfile to use with Vagrant
+      attr_reader :berksfile_path
+
+      # @return [Boolean]
+      #   disable of use Berks in Vagrant
+      attr_accessor :enabled
+
+      # @return [Array<Symbol>]
+      #   only cookbooks in these groups will be installed and copied to
+      #   Vagrant's shelf
+      attr_accessor :only
+
+      # @return [Array<Symbol>]
+      #   cookbooks in all other groups except for these will be installed
+      #   and copied to Vagrant's shelf
+      attr_accessor :except
+
+      # @return [String]
+      #   the Chef node name (client name) to use to authenticate with the remote
+      #   chef server to upload cookbooks when using the chef client provisioner
+      attr_accessor :node_name
+
+      # @return [String]
+      #   a filepath to a chef client key to use to authenticate with the remote
+      #   chef server to upload cookbooks when using the chef client provisioner
+      attr_accessor :client_key
+
+      def initialize
+        super
+
+        @berksfile_path = File.join(Dir.pwd, Berkshelf::DEFAULT_FILENAME)
+        @except         = Array.new
+        @only           = Array.new
+        @node_name      = Berkshelf::Config.instance.chef.node_name
+        @client_key     = Berkshelf::Config.instance.chef.client_key
+        @enabled        = File.exist?(@berksfile_path)
+      end
+
+      # @param [String] value
+      def berksfile_path=(value)
+        @berksfile_path = File.expand_path(value)
+      end
+
+      # @param [String] value
+      def client_key=(value)
+        @client_key = File.expand_path(value)
+      end
+
+      alias_method :to_hash, :instance_variables_hash
+
+      def validate(machine)
+        errors = Array.new
+
+        unless [TrueClass, FalseClass].include?(enabled.class)
+          errors << "A value for berkshelf.enabled can be true or false."
+        end
+
+        if enabled
+          if machine.config.berkshelf.berksfile_path.nil?
+            errors << "berkshelf.berksfile_path cannot be nil."
+          end
+
+          unless File.exist?(machine.config.berkshelf.berksfile_path)
+            errors << "No Berskfile was found at #{machine.config.berkshelf.berksfile_path}."
+          end
+
+          if !except.empty? && !only.empty?
+            errors << "A value for berkshelf.empty and berkshelf.only cannot both be defined."
+          end
+
+          if machine.env.config_global.vm.provisioners.any? { |prov| prov.name == :chef_client }
+            if machine.config.berkshelf.node_name.nil?
+              errors << "A configuration must be set for chef.node_name when using the chef_client provisioner. Run 'berks configure' or edit your configuration."
+            end
+
+            if machine.config.berkshelf.client_key.nil?
+              errors << "A configuration must be set for chef.client_key when using the chef_client provisioner. Run 'berks configure' or edit your configuration."
+            end
+          end
+        end
+
+        { "berkshelf configuration" => errors }
+      end
+    end
+  end
+end

data/lib/berkshelf/vagrant/env.rb

@@ -0,0 +1,26 @@
+module Berkshelf
+  module Vagrant
+    # @author Jamie Winsor <reset@riotgames.com>
+    #
+    # Environment data to build up and persist through the middleware chain
+    class Env
+      # @return [Vagrant::UI::Colored]
+      attr_accessor :ui
+      # @return [Berkshelf::Berksfile]
+      attr_accessor :berksfile
+      # @return [String]
+      attr_accessor :shelf
+      # @return [Berkshelf::Config]
+      attr_accessor :config
+
+      def initialize
+        if Gem::Version.new(::Vagrant::VERSION) >= Gem::Version.new("1.2")
+          @ui     = ::Vagrant::UI::Colored.new.scope('Berkshelf')
+        else
+          @ui     = ::Vagrant::UI::Colored.new('Berkshelf')
+        end
+        @config = Berkshelf::Config.instance
+      end
+    end
+  end
+end

data/lib/berkshelf/vagrant/env_helpers.rb

@@ -0,0 +1,64 @@
+module Berkshelf
+  module Vagrant
+    # @author Jamie Winsor <reset@riotgames.com>
+    #
+    # A module of common helper functions that can be mixed into Berkshelf::Vagrant actions
+    module EnvHelpers
+      # A file to persist vagrant-berkshelf specific information in between
+      # Vagrant runs.
+      #
+      # @return [String]
+      def cache_file
+        File.join('.vagrant', 'berkshelf')
+      end
+
+      # Filter all of the provisioners of the given vagrant environment with the given name
+      #
+      # @param [Symbol] name
+      #   name of provisioner to filter
+      # @param [Vagrant::Environment, Hash] env
+      #   environment to inspect
+      #
+      # @return [Array]
+      def provisioners(name, env)
+        env[:machine].config.vm.provisioners.select { |prov| prov.name == name }
+      end
+
+      # Determine if the given vagrant environment contains a chef_solo provisioner
+      #
+      # @param [Vagrant::Environment] env
+      #
+      # @return [Boolean]
+      def chef_solo?(env)
+        provisioners(:chef_solo, env).any?
+      end
+
+      # Determine if the given vagrant environment contains a chef_client provisioner
+      #
+      # @param [Vagrant::Environment] env
+      #
+      # @return [Boolean]
+      def chef_client?(env)
+        provisioners(:chef_client, env).any?
+      end
+
+      # Determine if the Berkshelf plugin should be run for the given environment
+      #
+      # @param [Vagrant::Environment] env
+      #
+      # @return [Boolean]
+      def berkshelf_enabled?(env)
+        env[:global_config].berkshelf.enabled
+      end
+
+      # Determine if --no-provision was specified
+      #
+      # @param [Vagrant::Environment] env
+      #
+      # @return [Boolean]
+      def provision_disabled?(env)
+        env.has_key?(:provision_enabled) && !env[:provision_enabled]
+      end
+    end
+  end
+end

data/lib/berkshelf/vagrant/errors.rb

@@ -0,0 +1,33 @@
+require 'vagrant/errors'
+
+module Berkshelf
+  # @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

data/lib/berkshelf/vagrant/plugin.rb

@@ -0,0 +1,42 @@
+module Berkshelf
+  module Vagrant
+    # @author Jamie Winsor <reset@riotgames.com>
+    TESTED_CONSTRAINT="<= 1.2.1"
+    class Plugin < ::Vagrant.plugin("2")
+      class << self
+        def provision(hook)
+          hook.after(::Vagrant::Action::Builtin::Provision, Berkshelf::Vagrant::Action.upload)
+          hook.after(::Vagrant::Action::Builtin::Provision, Berkshelf::Vagrant::Action.install)
+
+          if ::VagrantPlugins.const_defined?(:AWS)
+            hook.after(::VagrantPlugins::AWS::Action::TimedProvision, Berkshelf::Vagrant::Action.upload)
+            hook.after(::VagrantPlugins::AWS::Action::TimedProvision, Berkshelf::Vagrant::Action.install)
+          end
+
+          hook.before(::Vagrant::Action::Builtin::ConfigValidate, Berkshelf::Vagrant::Action.setup)
+        end
+      end
+
+      name "berkshelf"
+      description <<-DESC
+      Automatically make available cookbooks to virtual machines provisioned by Chef Solo
+      or Chef Client using Berkshelf.
+      DESC
+
+      action_hook(:berkshelf_provision, :machine_action_up, &method(:provision))
+      action_hook(:berkshelf_provision, :machine_action_reload, &method(:provision))
+      action_hook(:berkshelf_provision, :machine_action_provision, &method(:provision))
+
+      action_hook(:berkshelf_cleanup, :machine_action_destroy) do |hook|
+        # @todo this should be appended to the middleware stack instead of hooked in after the
+        #   Virtualbox specific destroy step but there is a bug in Vagrant (1.1.0) which
+        #   causes appended middleware to run multiple times.
+        hook.after(VagrantPlugins::ProviderVirtualBox::Action::DestroyUnusedNetworkInterfaces, Berkshelf::Vagrant::Action.clean)
+      end
+
+      config(:berkshelf) do
+        Berkshelf::Vagrant::Config
+      end
+    end
+  end
+end