berkshelf-vagrant 1.0.6 → 1.1.0

data/README.md

@@ -16,9 +16,16 @@ Install the Berkshelf Vagrant plugin
 
 ## Usage
 
-The Berkshelf Vagrant plugin automatically hooks into the Vagrant provisioning middleware; theres no need to perform any additional steps after installation.
+Once the Berkshelf Vagrant plugin is installed it can be enabled in your Vagrantfile
 
-Just ensure that you have a Berksfile in the directory with your Vagrantfile and when you run `vagrant up`, `vagrant provision`, or `vagrant destroy` the Berkshelf integration will automatically kick in!
+
+    Vagrant.configure("2") do |config|
+      ...
+      config.berkshelf.enabled = true
+      ...
+    end
+
+The plugin will look in your current working directory for your `Berksfile` by default. Just ensure that your Berksfile exists and when you run `vagrant up`, `vagrant provision`, or `vagrant destroy` the Berkshelf integration will automatically kick in!
 
 # Authors
 - Jamie Winsor (<reset@riotgames.com>)

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

@@ -10,9 +10,13 @@ module Berkshelf
         end
 
         def call(env)
-          if chef_solo?(env) && env[:berkshelf].shelf
+          unless berkshelf_enabled?(env)
+            return @app.call(env)
+          end
+
+          if chef_solo?(env) && shelf = env[:berkshelf].shelf
             provisioners(:chef_solo, env).each do |provisioner|
-              provisioner.config.cookbooks_path = provisioner.config.send(:prepare_folders_config, env[:berkshelf].shelf)
+              provisioner.config.cookbooks_path = provisioner.config.send(:prepare_folders_config, shelf)
             end
           end
 

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

@@ -10,6 +10,14 @@ module Berkshelf
         end
 
         def call(env)
+          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)
@@ -30,6 +38,13 @@ module Berkshelf
             }.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
       end
     end
   end

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

@@ -10,6 +10,10 @@ module Berkshelf
         end
 
         def call(env)
+          unless berkshelf_enabled?(env)
+            return @app.call(env)
+          end
+
           shelf = load_shelf
 
           if shelf.nil?

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

@@ -10,6 +10,10 @@ module Berkshelf
         end
 
         def call(env)
+          unless berkshelf_enabled?(env)
+            return @app.call(env)
+          end
+
           if chef_client?(env)
             upload(env)
           end

data/lib/berkshelf/vagrant/config.rb

@@ -8,6 +8,10 @@ module Berkshelf
       #   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
@@ -36,6 +40,7 @@ module Berkshelf
         @only           = Array.new
         @node_name      = Berkshelf::Config.instance.chef.node_name
         @client_key     = Berkshelf::Config.instance.chef.client_key
+        @enabled        = false
       end
 
       # @param [String] value
@@ -53,25 +58,31 @@ module Berkshelf
       def validate(machine)
         errors = Array.new
 
-        if machine.config.berkshelf.berksfile_path.nil?
-          errors << "berkshelf.berksfile_path cannot be nil."
+        unless [TrueClass, FalseClass].include?(enabled.class)
+          errors << "A value for berkshelf.enabled can be true or false."
         end
 
-        unless File.exist?(machine.config.berkshelf.berksfile_path)
-          errors << "No Berskfile was found at #{machine.config.berkshelf.berksfile_path}."
-        end
+        if enabled
+          if machine.config.berkshelf.berksfile_path.nil?
+            errors << "berkshelf.berksfile_path cannot be nil."
+          end
 
-        if !except.empty? && !only.empty?
-          errors << "A value for berkshelf.empty and berkshelf.only cannot both be defined."
-        end
+          unless File.exist?(machine.config.berkshelf.berksfile_path)
+            errors << "No Berskfile was found at #{machine.config.berkshelf.berksfile_path}."
+          end
 
-        if chef_client?(machine.env)
-          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."
+          if !except.empty? && !only.empty?
+            errors << "A value for berkshelf.empty and berkshelf.only cannot both be defined."
           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."
+          if chef_client?(machine.env)
+            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
 

data/lib/berkshelf/vagrant/env_helpers.rb

@@ -22,7 +22,7 @@ module Berkshelf
       # @return [Array]
       def provisioners(name, env)
         config_global = env.respond_to?(:config_global) ? env.config_global : env[:global_config]
-        
+
         config_global.vm.provisioners.select { |prov| prov.name == name }
       end
 
@@ -43,6 +43,15 @@ module Berkshelf
       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
     end
   end
 end

data/lib/berkshelf/vagrant/version.rb

@@ -1,5 +1,5 @@
 module Berkshelf
   module Vagrant
-    VERSION = "1.0.6"
+    VERSION = "1.1.0"
   end
 end

data/spec/unit/berkshelf/vagrant/config_spec.rb

@@ -2,13 +2,16 @@ require 'spec_helper'
 
 describe Berkshelf::Vagrant::Config do
   let(:unset_value) { described_class::UNSET_VALUE }
-
-  subject { described_class.new }
+  let(:config) { described_class.new }
 
   it "sets a path to a Berksfile in the current working directory for berksfile_path" do
     subject.berksfile_path.should eql(File.join(Dir.pwd, "Berksfile"))
   end
 
+  it "set the value of disabled to a false" do
+    config.enabled.should be false
+  end
+
   it "sets the value of only to an empty array" do
     subject.only.should be_a(Array)
     subject.only.should be_empty
@@ -32,26 +35,46 @@ describe Berkshelf::Vagrant::Config do
     let(:config) { double('config', berkshelf: subject) }
     let(:machine) { double('machine', config: config, env: env) }
 
-    before(:each) do
+    before do
       subject.finalize!
-      subject.should_receive(:chef_client?).with(env).and_return(true)
     end
 
-    let(:result) { subject.validate(machine) }
+    context "when the plugin is enabled" do
+      before(:each) do
+        subject.stub(enabled: true)
+        subject.should_receive(:chef_client?).with(env).and_return(true)
+      end
+
+      let(:result) { subject.validate(machine) }
 
-    it "returns a Hash with a 'berkshelf configuration' key" do
-      result.should be_a(Hash)
-      result.should have_key("berkshelf configuration")
+      it "returns a Hash with a 'berkshelf configuration' key" do
+        result.should be_a(Hash)
+        result.should have_key("berkshelf configuration")
+      end
+
+      context "when all validations pass" do
+        before(:each) do
+          File.should_receive(:exist?).with(subject.berksfile_path).and_return(true)
+        end
+
+        it "contains an empty Array for the 'berkshelf configuration' key" do
+          result["berkshelf configuration"].should be_a(Array)
+          result["berkshelf configuration"].should be_empty
+        end
+      end
     end
 
-    context "when all validations pass" do
-      before(:each) do
-        File.should_receive(:exist?).with(subject.berksfile_path).and_return(true)
+    context "when the plugin is disabled" do
+      let(:machine) { double('machine') }
+
+      before do
+        subject.stub(enabled: false)
       end
 
-      it "contains an empty Array for the 'berkshelf configuration' key" do
-        result["berkshelf configuration"].should be_a(Array)
-        result["berkshelf configuration"].should be_empty
+      it "does not perform any validations" do
+        machine.should_not_receive(:config)
+
+        subject.validate(machine)
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: berkshelf-vagrant
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-21 00:00:00.000000000 Z
+date: 2013-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: berkshelf
@@ -240,10 +240,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1000128588332199351
+      hash: -2045934776218572655
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A Vagrant plugin to add Berkshelf integration to the Chef provisioners