kitchen-vagrant 0.11.3 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 95096907c062649c205dec6e25089de1b544988e
-  data.tar.gz: 1b52d8650103cdfcb557cd79f512fe7cfd64e6a7
+  metadata.gz: be1f6aa281e6d30bac21b1d0d2ea90d8aceeb97d
+  data.tar.gz: 164abbd12a39dda7d94d80473e3e0b5f525ff3d3
 SHA512:
-  metadata.gz: 1408b696426a143ec795efe291b5a7a84c32fca64290f5370b653df73d6cb06336e64b79d5c7e407d262eb8627433f8c7d2c3cb1ecb3b85968e0f78e9fe39c7d
-  data.tar.gz: b32721e1b39d49c2ba1f62eebf132f9fc885e338bd60a4a56c5301c66d7f03bb18ed6ce399f2e40f64455adb11fc5dd48541bf5be1bc83b1862ebd9e5e9798ed
+  metadata.gz: 6d54365a1ed0862fecbbb34f4a3185cf6ef98dff6f6a92525767fc0dc87b53c33c523eda2e9a40b4e9c225b00a12df849c6b0db3da4e9d9f6adf32603471b3f8
+  data.tar.gz: 38001ca6c09018623d6209f480258f36983dd6203b2e7eecbcaded4eb4a1867813b46fd6a44e70a70f506b7eb50a0d706cbcaa0b4f93cac40dca059796d2916d

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+## 0.12.0 / 2013-11-29
+
+### Breaking changes
+
+* Remove `use_vagrant_provision` configuration option.
+
+### New features
+
+* Major refactor of Vagrantfile generation, to use an ERB template. For more details please consult the `vagrantfile_erb` section of the README. (@fnicho)
+* Add `pre_create_command` option to run optional setup such as Bindler. (@fnichol)
+
+### Improvments
+
+* Pull request #56: Enabled passing options to the synced folders. (@antonio-osorio)
+* Pull request #55: Fix README badges. (@arangamani)
+
+
 ## 0.11.3 / 2013-11-09
 
 ### Bug fixes

data/README.md

@@ -1,13 +1,13 @@
 # <a name="title"></a> Kitchen::Vagrant
 
-[![Build Status](https://travis-ci.org/opscode/kitchen-vagrant.png)](https://travis-ci.org/opscode/kitchen-vagrant)
-[![Code Climate](https://codeclimate.com/github/opscode/kitchen-vagrant.png)](https://codeclimate.com/github/opscode/kitchen-vagrant)
+[![Build Status](https://travis-ci.org/test-kitchen/kitchen-vagrant.png)](https://travis-ci.org/test-kitchen/kitchen-vagrant)
+[![Code Climate](https://codeclimate.com/github/test-kitchen/kitchen-vagrant.png)](https://codeclimate.com/github/test-kitchen/kitchen-vagrant)
 
 A Test Kitchen Driver for Vagrant.
 
 This driver works by generating a single Vagrantfile for each instance in a
 sandboxed directory. Since the Vagrantfile is written out on disk, Vagrant
-needs absolutely no knowledge of Test Kitchen. So no Vagrant plugin gem is
+needs absolutely no knowledge of Test Kitchen. So no Vagrant plugins are
 required.
 
 ## <a name="requirements"></a> Requirements
@@ -51,7 +51,8 @@ Please read the [Driver usage][driver_usage] page for more details.
 ## <a name="default-config"></a> Default Configuration
 
 This driver can predict the Vagrant box name and download URL for a select
-number of platforms that have been published by Opscode, such as:
+number of platforms (VirtualBox provider only) that have been published by
+Opscode, such as:
 
 ```ruby
 ---
@@ -93,7 +94,9 @@ platforms:
 details, please read the Vagrant [machine settings][vagrant_machine_settings]
 page.
 
-There is **no** default value set.
+The default will be computed from the platform name of the instance. For
+example, a platform called "fuzzypants-9.000" will produce a default `box`
+value of `"opscode-fuzzypants-9.000"`.
 
 ### <a name="config-box-url"></a> box\_url
 
@@ -101,7 +104,7 @@ The URL that the configured box can be found at. If the box is not installed on
 the system, it will be retrieved from this URL when the virtual machine is
 started.
 
-There is **no** default value set.
+The default will be computed from the platform name of the instance.
 
 ### <a name="config-provider"></a> provider
 
@@ -179,15 +182,25 @@ end
 Please read the Vagrant [networking basic usage][vagrant_networking] page for
 more details.
 
-There is **no** default value set.
+The default is an empty Array, `[]`.
 
-### <a name="config-use-vagrant-provision"></a> use_vagrant_provision
+### <a name="config-pre-create-command"></a> pre\_create\_command
 
-Determines whether or not this driver will use a `vagrant provision` shell out
-in the **converge** action. If this value is falsey (`nil`, `false`) the
-behavior from `Kitchen::Driver::SSHBase` will be used, bypassing the Vagrant
-Chef solo provisioner. If this value is truthy, a `vagrant provision` will
-be used.
+An optional hoook to run a command immediately prior to the
+`vagrant up --no-provisioner` command being executed.
+
+There is an optional token, `{{vagrant_root}}` that can be used in the
+`pre_create_command` string which will be expanded by the driver to be the full
+path to the sandboxed Vagrant root directory containing the Vagrantfile. This
+command will be executed from the directory containing the .kitchen.yml file,
+or the `kitchen_root`.
+
+For example, if your project requires
+[Bindler](https://github.com/fgrehm/bindler), this command could be:
+
+```
+pre_create_command: cp .vagrant_plugins.json {{vagrant_root}}/ && vagrant plugin bundle
+```
 
 The default is unset, or `nil`.
 
@@ -200,7 +213,8 @@ The default is an empty Array, or `[]`. The example:
 
 ```ruby
 driver_config:
-  synced_folders: [["/Users/mray/ws/cookbooks/pxe_dust/.kitchen/kitchen-vagrant/opt/chef", "/opt/chef"]]
+  synced_folders: [["/Users/mray/ws/cookbooks/pxe_dust/.kitchen/kitchen-vagrant/opt/chef", "/opt/chef"],
+                   ["/host_path", "/vm_path", "create: true, disabled: false"]]
 ```
 
 will generate a Vagrantfile configuration similar to:
@@ -210,25 +224,10 @@ Vagrant.configure("2") do |config|
   # ...
 
   c.vm.synced_folder "/Users/mray/ws/cookbooks/pxe_dust/.kitchen/kitchen-vagrant/opt/chef", "/opt/chef"
+  c.vm.synced_folder "/host_path", "/vm_path", create: true, disabled: false
 end
 ```
 
-### <a name="config-require-chef-omnibus"></a> require\_chef\_omnibus
-
-Determines whether or not a Chef [Omnibus package][chef_omnibus_dl] will be
-installed. There are several different behaviors available:
-
-* `true` - the latest release will be installed. Subsequent converges
-  will skip re-installing if chef is present.
-* `latest` - the latest release will be installed. Subsequent converges
-  will always re-install even if chef is present.
-* `<VERSION_STRING>` (ex: `10.24.0`) - the desired version string will
-  be passed the the install.sh script. Subsequent converges will skip if
-  the installed version and the desired version match.
-* `false` or `nil` - no chef is installed.
-
-The default value is unset, or `nil`.
-
 ### <a name="config-username"></a> username
 
 This is the username used for SSH authentication if you
@@ -237,6 +236,21 @@ would like to connect with a different account than Vagrant default user.
 If this value is nil, then Vagrant parameter `config.ssh.default.username`
 will be used (which is usually set to 'vagrant').
 
+### <a name="config-vagrantfile-erb"></a> vagrantfile\_erb
+
+An alternamte Vagrantfile ERB template that will be rendered for use by this
+driver. The binding context for the ERB processing is that of the Driver
+object, which means that methods like `config[:kitchen_root]`, `instance.name`,
+and `instance.provisioner[:run_list]` can be used to compose a custom
+Vagrantfile if necessary.
+
+**Warning:** Be cautious when going down this road as your setup may cease to
+be portable or applicable to other Test Kitchen Drivers such as Ec2 or Docker.
+Using the alternative Vagrantfile template strategy may be a dangerous
+road--be aware.
+
+The default is to use a template which ships with this gem.
+
 ### <a name="config-ssh-key"></a> ssh\_key
 
 This is the path to the private key file used for SSH authentication if you
@@ -278,7 +292,6 @@ Apache 2.0 (see [LICENSE][license])
 [license]:          https://github.com/opscode/kitchen-vagrant/blob/master/LICENSE
 [repo]:             https://github.com/opscode/kitchen-vagrant
 [driver_usage]:     http://docs.kitchen-ci.org/drivers/usage
-[chef_omnibus_dl]:  http://www.opscode.com/chef/install/
 
 [vagrant_dl]:               http://downloads.vagrantup.com/
 [vagrant_machine_settings]: http://docs.vagrantup.com/v2/vagrantfile/machine_settings.html

data/kitchen-vagrant.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency 'test-kitchen', '~> 1.0.0.beta'
+  gem.add_dependency 'test-kitchen', '~> 1.0.0.rc'
 
   gem.add_development_dependency 'cane'
   gem.add_development_dependency 'tailor'

data/lib/kitchen/driver/vagrant.rb

@@ -20,7 +20,6 @@ require 'fileutils'
 require 'rubygems/version'
 
 require 'kitchen'
-require 'kitchen/vagrant/vagrantfile_creator'
 
 module Kitchen
 
@@ -35,10 +34,20 @@ module Kitchen
     class Vagrant < Kitchen::Driver::SSHBase
 
       default_config :customize, { :memory => '256' }
-      default_config :synced_folders, {}
+      default_config :network, []
+      default_config :synced_folders, []
+      default_config :pre_create_command, nil
+
+      default_config :vagrantfile_erb,
+        File.join(File.dirname(__FILE__), "../../../templates/Vagrantfile.erb")
+
+      default_config :provider,
+        ENV.fetch('VAGRANT_DEFAULT_PROVIDER', "virtualbox")
+
       default_config :box do |driver|
         "opscode-#{driver.instance.platform.name}"
       end
+
       default_config :box_url do |driver|
         "https://opscode-vm-bento.s3.amazonaws.com/vagrant/" \
           "opscode_#{driver.instance.platform.name}_provisionerless.box"
@@ -50,8 +59,9 @@ module Kitchen
 
       def create(state)
         create_vagrantfile
+        run_pre_create_command
         cmd = "vagrant up --no-provision"
-        cmd += " --provider=#{@config[:provider]}" if @config[:provider]
+        cmd += " --provider=#{config[:provider]}" if config[:provider]
         run cmd
         set_ssh_state(state)
         info("Vagrant instance #{instance.to_str} created.")
@@ -87,6 +97,11 @@ module Kitchen
         check_vagrant_version
       end
 
+      def instance=(instance)
+        @instance = instance
+        resolve_config!
+      end
+
       protected
 
       WEBSITE = "http://downloads.vagrantup.com/"
@@ -102,6 +117,12 @@ module Kitchen
           :live_stream => nil, :quiet => logger.debug? ? false : true)
       end
 
+      def run_pre_create_command
+        if config[:pre_create_command]
+          run(config[:pre_create_command], :cwd => config[:kitchen_root])
+        end
+      end
+
       def vagrant_root
         @vagrant_root ||= File.join(
           config[:kitchen_root], %w{.kitchen kitchen-vagrant}, instance.name
@@ -114,12 +135,21 @@ module Kitchen
         vagrantfile = File.join(vagrant_root, "Vagrantfile")
         debug("Creating Vagrantfile for #{instance.to_str} (#{vagrantfile})")
         FileUtils.mkdir_p(vagrant_root)
-        File.open(vagrantfile, "wb") { |f| f.write(creator.render) }
+        File.open(vagrantfile, "wb") { |f| f.write(render_template) }
+        debug_vagrantfile(vagrantfile)
         @vagrantfile_created = true
       end
 
-      def creator
-        Kitchen::Vagrant::VagrantfileCreator.new(instance, config)
+      def render_template
+        if File.exists?(template)
+          ERB.new(IO.read(template)).result(binding).gsub(%r{^\s*$\n}, '')
+        else
+          raise ActionFailed, "Could not find Vagrantfile template #{template}"
+        end
+      end
+
+      def template
+        File.expand_path(config[:vagrantfile_erb], config[:kitchen_root])
       end
 
       def set_ssh_state(state)
@@ -140,6 +170,25 @@ module Kitchen
         Hash[lines]
       end
 
+      def debug_vagrantfile(vagrantfile)
+        if logger.debug?
+          debug("------------")
+          IO.read(vagrantfile).each_line { |l| debug("#{l.chomp}") }
+          debug("------------")
+        end
+      end
+
+      def resolve_config!
+        unless config[:vagrantfile_erb].nil?
+          config[:vagrantfile_erb] =
+            File.expand_path(config[:vagrantfile_erb], config[:kitchen_root])
+        end
+        unless config[:pre_create_command].nil?
+          config[:pre_create_command] =
+            config[:pre_create_command].gsub("{{vagrant_root}}", vagrant_root)
+        end
+      end
+
       def vagrant_version
         version_string = silently_run("vagrant --version")
         version_string = version_string.chomp.split(" ").last

data/lib/kitchen/driver/vagrant_version.rb

@@ -21,6 +21,6 @@ module Kitchen
   module Driver
 
     # Version string for Vagrant Kitchen driver
-    VAGRANT_VERSION = "0.11.3"
+    VAGRANT_VERSION = "0.12.0"
   end
 end

data/templates/Vagrantfile.erb

@@ -0,0 +1,48 @@
+Vagrant.configure("2") do |c|
+  c.vm.box = "<%= config[:box] %>"
+  c.vm.box_url = "<%= config[:box_url] %>"
+  c.vm.hostname = "<%= instance.name %>.vagrantup.com"
+
+<% if config[:guest] %>
+  c.vm.guest = <%= config[:guest] %>
+<% end %>
+<% if config[:username] %>
+  c.ssh.username = "<%= config[:username] %>"
+<% end %>
+<% if config[:ssh_key] %>
+  c.ssh.private_key_path = "<%= config[:ssh_key] %>"
+<% end %>
+
+<% Array(config[:network]).each do |opts| %>
+  c.vm.network(:<%= opts[0] %>, <%= opts[1..-1].join(", ") %>)
+<% end %>
+
+  c.vm.synced_folder ".", "/vagrant", disabled: true
+<% config[:synced_folders].each do |source, destination, options|
+     l_source = source.gsub("%{instance_name}", instance.name)
+     l_destination = destination.gsub("%{instance_name}", instance.name)
+     opt = (options.nil? ? '' : ", #{options}")
+%>
+  c.vm.synced_folder "<%= l_source %>", "<%= l_destination %>"<%= opt %>
+<% end %>
+
+  c.vm.provider :<%= config[:provider] %> do |p|
+<% config[:customize].each do |key, value| %>
+  <% case config[:provider]
+     when "virtualbox" %>
+    p.customize ["modifyvm", :id, "--<%= key %>", "<%= value %>"]
+  <% when "rackspace" %>
+    p.<%= key %> = "<%= value%>"
+  <% when /^vmware_/ %>
+    <% if key == :memory %>
+      <% unless config[:customize].include?(:memsize) %>
+    p.vmx["memsize"] = "<%= value %>"
+      <% end %>
+    <% else %>
+    p.vmx["<%= key %>"] = "<%= value %>"
+    <% end %>
+  <% end %>
+<% end %>
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-vagrant
 version: !ruby/object:Gem::Version
-  version: 0.11.3
+  version: 0.12.0
 platform: ruby
 authors:
 - Fletcher Nichol
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-09 00:00:00.000000000 Z
+date: 2013-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-kitchen
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.0.beta
+        version: 1.0.0.rc
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.0.beta
+        version: 1.0.0.rc
 - !ruby/object:Gem::Dependency
   name: cane
   requirement: !ruby/object:Gem::Requirement
@@ -83,7 +83,7 @@ files:
 - kitchen-vagrant.gemspec
 - lib/kitchen/driver/vagrant.rb
 - lib/kitchen/driver/vagrant_version.rb
-- lib/kitchen/vagrant/vagrantfile_creator.rb
+- templates/Vagrantfile.erb
 homepage: https://github.com/opscode/kitchen-vagrant/
 licenses:
 - Apache 2.0

data/lib/kitchen/vagrant/vagrantfile_creator.rb

@@ -1,173 +0,0 @@
-# -*- encoding: utf-8 -*-
-#
-# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
-#
-# Copyright (C) 2013, Fletcher Nichol
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#    http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-module Kitchen
-
-  module Vagrant
-
-    # Class to render Vagrantfiles to be used by the Kitchen Vagrant driver.
-    #
-    # @author Fletcher Nichol <fnichol@nichol.ca>
-    class VagrantfileCreator
-
-      def initialize(instance, config)
-        @instance = instance
-        @config = config
-      end
-
-      def render
-        arr = []
-        arr << %{Vagrant.configure("2") do |c|}
-        common_block(arr)
-        guest_block(arr)
-        network_block(arr)
-        provider_block(arr)
-        chef_block(arr) if config[:use_vagrant_provision]
-        synced_folders_block(arr)
-        arr << %{end}
-        arr.join("\n")
-      end
-
-      private
-
-      attr_reader :instance, :config
-
-      def common_block(arr)
-        arr << %{  c.vm.box = "#{config[:box]}"}
-        arr << %{  c.vm.box_url = "#{config[:box_url]}"} if config[:box_url]
-        arr << %{  c.vm.synced_folder ".", "/vagrant", disabled: true}
-        if config[:ssh_key]
-          arr << %{  c.ssh.private_key_path = "#{config[:ssh_key]}"}
-        end
-        arr << %{  c.vm.hostname = "#{instance.name}.vagrantup.com"}
-        arr << %{  c.ssh.username = "#{config[:username]}"} if config[:username]
-      end
-
-      def guest_block(arr)
-        if config[:guest]
-          arr << %{  c.vm.guest = #{config[:guest]}}
-        end
-      end
-
-      def network_block(arr)
-        Array(config[:network]).each do |network_options|
-          options = Array(network_options.dup)
-          type = options.shift
-          arr << %{  c.vm.network(:#{type}, #{options.join(", ")})}
-        end
-      end
-
-      def provider_block(arr)
-        arr << %{  c.vm.provider :#{provider} do |p|}
-        case provider
-        when 'virtualbox'
-          virtualbox_customize(arr)
-        when 'vmware_fusion', 'vmware_workstation'
-          vmware_customize(arr)
-        when 'rackspace'
-          rackspace_customize(arr)
-        end
-        arr << %{  end}
-      end
-
-      def chef_block(arr)
-        arr << %{  c.vm.provision :chef_solo do |chef|}
-        arr << %{    chef.log_level = #{vagrant_logger_level}}
-        arr << %{    chef.run_list = #{instance.run_list.inspect}}
-        arr << %{    chef.json = #{instance.attributes.to_s}}
-        if instance.suite.data_bags_path
-          arr << %{    chef.data_bags_path = "#{instance.suite.data_bags_path}"}
-        end
-        if key_path
-          arr << %{    chef.encrypted_data_bag_secret_key_path = "#{key_path}"}
-        end
-        if instance.suite.roles_path
-          arr << %{    chef.roles_path = "#{instance.suite.roles_path}"}
-        end
-        arr << %{  end}
-      end
-
-      def synced_folders_block(arr)
-        config[:synced_folders].each do |source, destination|
-          arr << %{  c.vm.synced_folder "#{source}", "#{destination}" }
-        end
-      end
-
-      def vagrant_logger_level
-        if instance.logger.debug?
-          ":debug"
-        elsif instance.logger.info?
-          ":info"
-        elsif instance.logger.error?
-          ":error"
-        elsif instance.logger.fatal?
-          ":fatal"
-        else
-          ":info"
-        end
-      end
-
-      def berksfile
-        File.join(config[:kitchen_root], "Berksfile")
-      end
-
-      def provider
-        config[:provider] || ENV['VAGRANT_DEFAULT_PROVIDER'] || 'virtualbox'
-      end
-
-      def virtualbox_customize(arr)
-        config[:customize].each do |key, value|
-          arr << %{    p.customize ["modifyvm", :id, "--#{key}", "#{value}"]}
-        end
-      end
-
-      def vmware_customize(arr)
-        config[:customize].each do |key, value|
-          if key == :memory
-            # XXX: This is kind of a hack to address the fact that
-            # "memory" is a default attribute in our Vagrant driver.
-            #
-            # The VMware VMX format expects to see "memsize" instead of
-            # just "memory" like Virtualbox would. So if "memsize" has
-            # been specified we simply ignore the "memory" option.
-            unless config[:customize].include?(:memsize)
-              arr << %{    p.vmx["memsize"] = "#{value}"}
-            end
-          else
-            arr << %{    p.vmx["#{key}"] = "#{value}"}
-          end
-        end
-      end
-
-      def rackspace_customize(arr)
-        config[:customize].each do |key, value|
-          arr << %{    p.#{key} = "#{value}"}
-        end
-      end
-
-      def key_path
-        return nil if instance.suite.encrypted_data_bag_secret_key_path.nil?
-
-        File.join(
-          config[:kitchen_root],
-          instance.suite.encrypted_data_bag_secret_key_path
-        )
-      end
-    end
-  end
-end