kitchen-vagrant 0.6.0 → 0.7.0

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+## 0.7.0 / 2013-03-22
+
+### New features
+
+* Pull request [#7][]: [Breaking] Support Vagrant 1.1+ and remove vagrant gem dependency. ([@fnichol][])
+* Pull request [#8][]: Add dependency checks for Vagrant and berkshelf-vagrant plugin (if necessary). ([@fnichol][])
+
+
+## 0.6.0 / 2013-03-02
+
+The initial release.
+
+<!--- The following link definition list is generated by PimpMyChangelog --->
+[#7]: https://github.com/opscode/kitchen/issues/7
+[#8]: https://github.com/opscode/kitchen/issues/8
+[@fnichol]: https://github.com/fnichol

data/README.md

@@ -1,7 +1,7 @@
 # Kitchen::Vagrant
 
-[![Build Status](https://secure.travis-ci.org/jamie-ci/kitchen-vagrant.png)](https://travis-ci.org/jamie-ci/kitchen-vagrant)
-[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/jamie-ci/kitchen-vagrant)
+[![Build Status](https://travis-ci.org/opscode/kitchen-vagrant.png)](https://travis-ci.org/opscode/kitchen-vagrant)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/opscode/kitchen-vagrant)
 
 This gem provides `kitchen-vagrant`, a driver for `test-kitchen` to provision systems to test under Vagrant.
 

data/Rakefile

@@ -3,11 +3,7 @@ require 'cane/rake_task'
 require 'tailor/rake_task'
 
 desc "Run cane to check quality metrics"
-Cane::RakeTask.new do |cane|
-  cane.abc_exclude = %w(
-    Kitchen::Vagrant.define_vagrant_vm
-  )
-end
+Cane::RakeTask.new
 
 Tailor::RakeTask.new
 

data/kitchen-vagrant.gemspec

@@ -18,7 +18,6 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_dependency 'test-kitchen', '~> 1.0.0.alpha.0'
-  gem.add_dependency 'vagrant', '~> 1.0'
 
   gem.add_development_dependency 'cane'
   gem.add_development_dependency 'tailor'

data/lib/kitchen/driver/vagrant.rb

@@ -16,7 +16,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'fileutils'
+require 'rubygems/version'
+
 require 'kitchen'
+require 'kitchen/vagrant/vagrantfile_creator'
 
 module Kitchen
 
@@ -25,6 +29,9 @@ module Kitchen
     # Vagrant driver for Kitchen. It communicates to Vagrant via the CLI.
     #
     # @author Fletcher Nichol <fnichol@nichol.ca>
+    #
+    # @todo Vagrant installation check and version will be placed into any
+    #   dependency hook checks when feature is released
     class Vagrant < Kitchen::Driver::SSHBase
 
       default_config :customize, {:memory => '256'}
@@ -32,60 +39,113 @@ module Kitchen
       no_parallel_for :create, :destroy
 
       def create(state)
-        # @todo Vagrantfile setup will be placed in any dependency hook
-        #   checks when feature is released
-        vagrantfile = File.join(config[:kitchen_root], "Vagrantfile")
-        create_vagrantfile(vagrantfile) unless File.exists?(vagrantfile)
-
         state[:hostname] = instance.name
-        run "vagrant up #{state[:hostname]} --no-provision"
+        create_vagrantfile(state)
+        run "vagrant up --no-provision"
         info("Vagrant instance <#{state[:hostname]}> created.")
       end
 
       def converge(state)
+        create_vagrantfile(state)
         ssh_args = build_ssh_args(state)
         install_omnibus(ssh_args) if config[:require_chef_omnibus]
-        run "vagrant provision #{state[:hostname]}"
+        run "vagrant provision"
+      end
+
+      def setup(state)
+        create_vagrantfile(state)
+        super
+      end
+
+      def verify(state)
+        create_vagrantfile(state)
+        super
       end
 
       def destroy(state)
         return if state[:hostname].nil?
 
-        run "vagrant destroy #{state[:hostname]} -f"
+        create_vagrantfile(state)
+        run "vagrant destroy -f"
+        FileUtils.rm_rf(vagrant_root)
         info("Vagrant instance <#{state[:hostname]}> destroyed.")
         state.delete(:hostname)
       end
 
       def login_command(state)
-        %W{vagrant ssh #{state[:hostname]}}
+        create_vagrantfile(state)
+        LoginCommand.new(%W{vagrant ssh}, :chdir => vagrant_root)
+      end
+
+      def verify_dependencies
+        check_vagrant_version
+        check_berkshelf_plugin
       end
 
       protected
 
+      WEBSITE = "http://downloads.vagrantup.com/"
+      MIN_VER = "1.1.0"
+
       def ssh(ssh_args, cmd)
-        run %{vagrant ssh #{ssh_args.first} --command '#{cmd}'}
+        run %{vagrant ssh --command '#{cmd}'}
       end
 
-      def run(cmd)
+      def run(cmd, options = {})
         cmd = "echo #{cmd}" if config[:dry_run]
-        run_command(cmd)
+        run_command(cmd, { :cwd => vagrant_root }.merge(options))
+      end
+
+      def silently_run(cmd)
+        run_command(cmd,
+          :live_stream => nil, :quiet => logger.debug? ? false : true)
+      end
+
+      def vagrant_root
+        @vagrant_root ||= File.join(
+          config[:kitchen_root], %w{.kitchen kitchen-vagrant}, instance.name
+        )
+      end
+
+      def create_vagrantfile(state)
+        return if @vagrantfile_created
+
+        vagrantfile = File.join(vagrant_root, "Vagrantfile")
+        debug("Creating Vagrantfile for <#{state[:hostname]}> (#{vagrantfile})")
+        FileUtils.mkdir_p(vagrant_root)
+        File.open(vagrantfile, "wb") { |f| f.write(creator.render) }
+        @vagrantfile_created = true
       end
 
-      def create_vagrantfile(vagrantfile)
-        File.open(vagrantfile, "wb") { |f| f.write(vagrantfile_contents) }
+      def creator
+        Kitchen::Vagrant::VagrantfileCreator.new(instance, config)
+      end
+
+      def vagrant_version
+        version_string = silently_run("vagrant --version")
+        version_string = version_string.chomp.split(" ").last
+      rescue Errno::ENOENT
+        raise UserError, "Vagrant #{MIN_VER} or higher is not installed." +
+          " Please download a package from #{WEBSITE}."
+      end
+
+      def check_vagrant_version
+        version = vagrant_version
+        if Gem::Version.new(version) < Gem::Version.new(MIN_VER)
+          raise UserError, "Detected an old version of Vagrant (#{version})." +
+            " Please upgrade to version #{MIN_VER} or higher from #{WEBSITE}."
+        end
       end
 
-      def vagrantfile_contents
-        arr = []
-        arr << %{require 'kitchen/vagrant'}
+      def check_berkshelf_plugin
         if File.exists?(File.join(config[:kitchen_root], "Berksfile"))
-          arr << %{require 'berkshelf/vagrant'}
+          plugins = silently_run("vagrant plugin list").split("\n")
+          if ! plugins.find { |p| p =~ /^berkshelf-vagrant\b/ }
+            raise UserError, "Detected a Berksfile but the berksfile-vagrant" +
+              " plugin was not found in Vagrant. Please run:" +
+              " `vagrant plugin install berkshelf-vagrant' and retry."
+          end
         end
-        arr << %{}
-        arr << %{Vagrant::Config.run do |config|}
-        arr << %{  Kitchen::Vagrant.define_vms(config)}
-        arr << %{end\n}
-        arr.join("\n")
       end
     end
   end

data/lib/kitchen/driver/vagrant_version.rb

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

data/lib/kitchen/vagrant/vagrantfile_creator.rb

@@ -0,0 +1,110 @@
+# -*- 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)
+        network_block(arr)
+        provider_block(arr)
+        chef_block(arr)
+        berkshelf_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.hostname = "#{instance.name}.vagrantup.com"}
+      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 :virtualbox do |p|}
+          config[:customize].each do |key, value|
+            arr << %{    p.customize ["modifyvm", :id, "--#{key}", #{value}]}
+          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 instance.suite.roles_path
+          arr << %{    chef.roles_path = #{instance.suite.roles_path}}
+        end
+        arr << %{  end}
+      end
+
+      def berkshelf_block(arr)
+        if File.exists?(berksfile)
+          arr << %{  c.berkshelf.berksfile_path = "#{berksfile}"}
+        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
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-vagrant
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-02 00:00:00.000000000 Z
+date: 2013-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-kitchen
@@ -27,22 +27,6 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.0.0.alpha.0
-- !ruby/object:Gem::Dependency
-  name: vagrant
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: cane
   requirement: !ruby/object:Gem::Requirement
@@ -100,6 +84,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -107,7 +92,7 @@ files:
 - kitchen-vagrant.gemspec
 - lib/kitchen/driver/vagrant.rb
 - lib/kitchen/driver/vagrant_version.rb
-- lib/kitchen/vagrant.rb
+- lib/kitchen/vagrant/vagrantfile_creator.rb
 homepage: https://github.com/opscode/kitchen-vagrant/
 licenses: []
 post_install_message: 
@@ -122,7 +107,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -433240395816256093
+      hash: 2904040541379656438
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -131,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -433240395816256093
+      hash: 2904040541379656438
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24

data/lib/kitchen/vagrant.rb

@@ -1,101 +0,0 @@
-# -*- encoding: utf-8 -*-
-#
-# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
-#
-# Copyright (C) 2012, 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.
-
-require 'forwardable'
-require 'vagrant'
-
-require 'kitchen'
-
-module Kitchen
-
-  module Vagrant
-
-    # A Vagrant confiuration class which wraps a Kitchen::Config instance.
-    #
-    # @author Fletcher Nichol <fnichol@nichol.ca>
-    class Config < ::Vagrant::Config::Base
-      extend Forwardable
-
-      def_delegators :@config, :suites, :suites=, :platforms, :platforms=,
-        :instances, :yaml_file, :yaml_file=, :log_level, :log_level=,
-        :test_base_path, :test_base_path=, :yaml_data
-
-      def initialize
-        @config = Kitchen::Config.new
-        @config.yaml_file = ENV['KITCHEN_YAML'] if ENV['KITCHEN_YAML']
-      end
-
-      # Override default implementation to prevent serializing the config
-      # instance variable, which may contain circular references.
-      #
-      # @return [Hash] an empty Hash
-      def instance_variables_hash
-        {}
-      end
-    end
-
-    # Defines all Vagrant virtual machines, one for each instance.
-    #
-    # @param config [Vagrant::Config::Top] Vagrant top level config object
-    def self.define_vms(config)
-      config.kitchen.instances.each do |instance|
-        define_vagrant_vm(config, instance)
-      end
-    end
-
-    private
-
-    def self.define_vagrant_vm(config, instance)
-      driver = instance.driver
-
-      config.vm.define instance.name do |c|
-        c.vm.box = driver[:box]
-        c.vm.box_url = driver[:box_url] if driver[:box_url]
-        c.vm.host_name = "#{instance.name}.vagrantup.com"
-
-        Array(driver[:forward_port]).each do |ports|
-          if ports.length != 2
-            raise ArgumentError,
-              "Vagrant config.vm.forward_port only accepts two arguments"
-          end
-          c.vm.forward_port(*ports)
-        end
-
-        Array(driver[:network]).each do |network_options|
-          options = Array(network_options)
-          type = options.shift
-          c.vm.network(type.to_sym, *options)
-        end
-
-        driver[:customize].each do |key, value|
-          c.vm.customize ["modifyvm", :id, "--#{key}", value]
-        end
-
-        c.vm.provision :chef_solo do |chef|
-          chef.log_level = config.kitchen.log_level
-          chef.run_list = instance.run_list
-          chef.json = instance.attributes
-          chef.data_bags_path = instance.suite.data_bags_path
-          chef.roles_path = instance.suite.roles_path
-        end
-      end
-    end
-  end
-end
-
-Vagrant.config_keys.register(:kitchen) { Kitchen::Vagrant::Config }