test-kitchen 0.7.0 → 1.0.0.alpha.0

data/spec/kitchen/loader/yaml_spec.rb

@@ -0,0 +1,243 @@
+# -*- 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.
+
+require_relative '../../spec_helper'
+
+require 'kitchen/errors'
+require 'kitchen/util'
+require 'kitchen/loader/yaml'
+
+class Yamled
+  attr_accessor :foo
+end
+
+describe Kitchen::Loader::YAML do
+
+  let(:loader) { Kitchen::Loader::YAML.new("/tmp/.kitchen.yml") }
+
+  before do
+    FakeFS.activate!
+    FileUtils.mkdir_p("/tmp")
+  end
+
+  after do
+    FakeFS.deactivate!
+    FakeFS::FileSystem.clear
+  end
+
+  describe ".initialize" do
+
+    it "sets config_file based on Dir.pwd by default" do
+      loader = Kitchen::Loader::YAML.new
+
+      loader.config_file.must_equal File.expand_path(
+        File.join(Dir.pwd, '.kitchen.yml'))
+    end
+
+    it "sets config_file from parameter, if given" do
+      loader = Kitchen::Loader::YAML.new('/tmp/crazyfunkytown.file')
+
+      loader.config_file.must_equal '/tmp/crazyfunkytown.file'
+    end
+  end
+
+  describe "#read" do
+
+    it "returns a hash of kitchen.yml with symbolized keys" do
+      stub_yaml!({
+        'foo' => 'bar'
+      })
+
+      loader.read.must_equal({ :foo => 'bar' })
+    end
+
+    it "deep merges in kitchen.local.yml configuration with kitchen.yml" do
+      stub_yaml!(".kitchen.yml", {
+        'common' => { 'xx' => 1 },
+        'a' => 'b'
+      })
+      stub_yaml!(".kitchen.local.yml", {
+        'common' => { 'yy' => 2 },
+        'c' => 'd'
+      })
+
+      loader.read.must_equal({
+        :a => 'b',
+        :c => 'd',
+        :common => { :xx => 1, :yy => 2 }
+      })
+    end
+
+    it "merges kitchen.local.yml over configuration in kitchen.yml" do
+      stub_yaml!(".kitchen.yml", {
+        'common' => { 'thekey' => 'nope' }
+      })
+      stub_yaml!(".kitchen.local.yml", {
+        'common' => { 'thekey' => 'yep' }
+      })
+
+      loader.read.must_equal({ :common => { :thekey => 'yep' } })
+    end
+
+    it "handles a kitchen.local.yml with no yaml elements" do
+      stub_yaml!(".kitchen.yml", {
+        'a' => 'b'
+      })
+      stub_yaml!(".kitchen.local.yml", Hash.new)
+
+      loader.read.must_equal({ :a => 'b' })
+    end
+
+    it "handles a kitchen.yml with no yaml elements" do
+      stub_yaml!(".kitchen.yml", Hash.new)
+      stub_yaml!(".kitchen.local.yml", {
+        'a' => 'b'
+      })
+
+      loader.read.must_equal({ :a => 'b' })
+    end
+
+    it "raises an UserError if the config_file does not exist" do
+      proc { loader.read }.must_raise Kitchen::UserError
+    end
+
+    it "arbitrary objects aren't deserialized in kitchen.yml" do
+      FileUtils.mkdir_p "/tmp"
+      File.open("/tmp/.kitchen.yml", "wb") do |f|
+        f.write <<-YAML.gsub(/^ {10}/, '')
+          --- !ruby/object:Yamled
+          foo: bar
+        YAML
+      end
+
+      loader.read.class.wont_equal Yamled
+      loader.read.class.must_equal Hash
+      loader.read.must_equal({ :foo => 'bar' })
+    end
+
+    it "arbitrary objects aren't deserialized in kitchen.local.yml" do
+      FileUtils.mkdir_p "/tmp"
+      File.open("/tmp/.kitchen.local.yml", "wb") do |f|
+        f.write <<-YAML.gsub(/^ {10}/, '')
+          --- !ruby/object:Yamled
+          wakka: boop
+        YAML
+      end
+      stub_yaml!(".kitchen.yml", Hash.new)
+
+      loader.read.class.wont_equal Yamled
+      loader.read.class.must_equal Hash
+      loader.read.must_equal({ :wakka => 'boop' })
+    end
+
+    it "raises a UserError if kitchen.yml cannot be parsed" do
+      FileUtils.mkdir_p "/tmp"
+      File.open("/tmp/.kitchen.yml", "wb") { |f| f.write '&*%^*' }
+
+      proc { loader.read }.must_raise Kitchen::UserError
+    end
+
+    it "raises a UserError if kitchen.local.yml cannot be parsed" do
+      FileUtils.mkdir_p "/tmp"
+      File.open("/tmp/.kitchen.local.yml", "wb") { |f| f.write '&*%^*' }
+      stub_yaml!(".kitchen.yml", Hash.new)
+
+      proc { loader.read }.must_raise Kitchen::UserError
+    end
+
+    it "evaluates kitchen.yml through erb before loading by default" do
+      FileUtils.mkdir_p "/tmp"
+      File.open("/tmp/.kitchen.yml", "wb") do |f|
+        f.write <<-'YAML'.gsub(/^ {10}/, '')
+          ---
+          name: <%= "AHH".downcase + "choo" %>
+        YAML
+      end
+
+      loader.read.must_equal({ :name => "ahhchoo" })
+    end
+
+    it "evaluates kitchen.local.yml through erb before loading by default" do
+      FileUtils.mkdir_p "/tmp"
+      File.open("/tmp/.kitchen.local.yml", "wb") do |f|
+        f.write <<-'YAML'.gsub(/^ {10}/, '')
+          ---
+          <% %w{noodle mushroom}.each do |kind| %>
+            <%= kind %>: soup
+          <% end %>
+        YAML
+      end
+      stub_yaml!(".kitchen.yml", { 'spinach' => 'salad' })
+
+      loader.read.must_equal({
+        :spinach => 'salad',
+        :noodle => 'soup',
+        :mushroom => 'soup'
+      })
+    end
+
+    it "skips evaluating kitchen.yml through erb if disabled" do
+      loader = Kitchen::Loader::YAML.new(
+        '/tmp/.kitchen.yml', :process_erb => false)
+      FileUtils.mkdir_p "/tmp"
+      File.open("/tmp/.kitchen.yml", "wb") do |f|
+        f.write <<-'YAML'.gsub(/^ {10}/, '')
+          ---
+          name: <%= "AHH".downcase %>
+        YAML
+      end
+
+      loader.read.must_equal({ :name => '<%= "AHH".downcase %>' })
+    end
+
+    it "skips evaluating kitchen.local.yml through erb if disabled" do
+      loader = Kitchen::Loader::YAML.new(
+        '/tmp/.kitchen.yml', :process_erb => false)
+      FileUtils.mkdir_p "/tmp"
+      File.open("/tmp/.kitchen.local.yml", "wb") do |f|
+        f.write <<-'YAML'.gsub(/^ {10}/, '')
+          ---
+          name: <%= "AHH".downcase %>
+        YAML
+      end
+      stub_yaml!(".kitchen.yml", Hash.new)
+
+      loader.read.must_equal({ :name => '<%= "AHH".downcase %>' })
+    end
+
+    it "skips kitchen.local.yml if disabled" do
+      loader = Kitchen::Loader::YAML.new(
+        '/tmp/.kitchen.yml', :process_local => false)
+      stub_yaml!(".kitchen.yml", {
+        'a' => 'b'
+      })
+      stub_yaml!(".kitchen.local.yml", {
+        'superawesomesauceadditions' => 'enabled, yo'
+      })
+
+      loader.read.must_equal({ :a => 'b' })
+    end
+  end
+
+  private
+
+  def stub_yaml!(name = ".kitchen.yml", hash)
+    FileUtils.mkdir_p "/tmp"
+    File.open("/tmp/#{name}", "wb") { |f| f.write(hash.to_yaml) }
+  end
+end

data/spec/kitchen/platform_spec.rb

@@ -0,0 +1,48 @@
+# -*- 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_relative '../spec_helper'
+
+require 'kitchen/errors'
+require 'kitchen/platform'
+
+describe Kitchen::Platform do
+
+  let(:opts) do ; { :name => 'plata' } ; end
+  let(:platform) { Kitchen::Platform.new(opts) }
+
+  it "raises an ArgumentError if name is missing" do
+    opts.delete(:name)
+    proc { Kitchen::Platform.new(opts) }.must_raise Kitchen::ClientError
+  end
+
+  it "returns an empty Array given no run_list" do
+    platform.run_list.must_equal []
+  end
+
+  it "returns an empty Hash given no attributes" do
+    platform.attributes.must_equal Hash.new
+  end
+
+  it "returns attributes from constructor" do
+    opts.merge!({ :run_list => ['a', 'b'], :attributes => { :c => 'd' } })
+    platform.name.must_equal 'plata'
+    platform.run_list.must_equal ['a', 'b']
+    platform.attributes.must_equal({ :c => 'd' })
+  end
+end

data/spec/kitchen/state_file_spec.rb

@@ -0,0 +1,122 @@
+# -*- 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.
+
+require_relative '../spec_helper'
+
+require 'kitchen/errors'
+require 'kitchen/state_file'
+require 'kitchen/util'
+
+class YamledState
+  attr_accessor :yoinks
+end
+
+describe Kitchen::StateFile do
+
+  let(:state_file)  { Kitchen::StateFile.new('/tmp', 'oftheunion')}
+  let(:file_name)   { '/tmp/.kitchen/oftheunion.yml' }
+
+  before do
+    FakeFS.activate!
+    FileUtils.mkdir_p("/tmp")
+  end
+
+  after do
+    FakeFS.deactivate!
+    FakeFS::FileSystem.clear
+  end
+
+  describe "#read" do
+
+    it "returns an empty hash if the file does not exist" do
+      state_file.read.must_equal(Hash.new)
+    end
+
+    it "returns a Hash with symbolized keys from the state file" do
+      stub_state_file!
+
+      state_file.read.must_equal({
+        :cloud_id => 42,
+        :flavor => 'extra_crispy'
+      })
+    end
+
+    it "arbitrary objects aren't deserialized from state file" do
+      stub_state_file! <<-'YAML'.gsub(/^ {8}/, '')
+        --- !ruby/object:YamledState
+        yoinks: zoinks
+      YAML
+
+      state_file.read.class.wont_equal YamledState
+      state_file.read.class.must_equal Hash
+      state_file.read.must_equal({ :yoinks => 'zoinks' })
+    end
+
+    it "raises a StateFileLoadError if the state file cannot be parsed" do
+      stub_state_file!('&*%^*')
+
+      proc { state_file.read }.must_raise Kitchen::StateFileLoadError
+    end
+  end
+
+  describe "#write" do
+
+    it "creates the directory path to the state file" do
+      File.directory?('/tmp/.kitchen').must_equal false
+      state_file.write({})
+      File.directory?('/tmp/.kitchen').must_equal true
+    end
+
+    it "writes a state file with stringified keys" do
+      state_file.write({ :thekey => 'thyself' })
+
+      IO.read(file_name).split("\n").must_include 'thekey: thyself'
+    end
+  end
+
+  describe "#destroy" do
+
+    it "executes if no file exists" do
+      File.exists?(file_name).must_equal false
+      state_file.destroy
+      File.exists?(file_name).must_equal false
+    end
+
+    it "deletes the state file" do
+      stub_state_file!
+      state_file.destroy
+
+      File.exists?(file_name).must_equal false
+    end
+  end
+
+  private
+
+  def stub_state_file!(yaml_string = nil)
+    if yaml_string.nil?
+      yaml_string = <<-'YAML'.gsub(/^ {8}/, '')
+        ---
+        cloud_id: 42
+        flavor: extra_crispy
+      YAML
+    end
+
+    FileUtils.mkdir_p(File.dirname(file_name))
+    File.open(file_name, 'wb') { |f| f.write(yaml_string) }
+  end
+end

data/spec/kitchen/suite_spec.rb

@@ -0,0 +1,64 @@
+# -*- 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_relative '../spec_helper'
+
+require 'kitchen/errors'
+require 'kitchen/suite'
+
+describe Kitchen::Suite do
+
+  let(:opts) do ; { :name => 'suitezy', :run_list => ['doowah'] } ; end
+  let(:suite) { Kitchen::Suite.new(opts) }
+
+  it "raises an ArgumentError if name is missing" do
+    opts.delete(:name)
+    proc { Kitchen::Suite.new(opts) }.must_raise Kitchen::ClientError
+  end
+
+  it "raises an ArgumentError if run_list is missing" do
+    opts.delete(:run_list)
+    proc { Kitchen::Suite.new(opts) }.must_raise Kitchen::ClientError
+  end
+
+  it "returns an empty Hash given no attributes" do
+    suite.attributes.must_equal Hash.new
+  end
+
+  it "returns an empty Array given no excludes" do
+    suite.excludes.must_equal Array.new
+  end
+
+  it "returns nil given no data_bags_path" do
+    suite.data_bags_path.must_be_nil
+  end
+
+  it "returns nil given no roles_path" do
+    suite.roles_path.must_be_nil
+  end
+
+  it "returns attributes from constructor" do
+    opts.merge!({ :attributes => { :a => 'b' }, :data_bags_path => 'crazy',
+      :roles_path => 'town' })
+    suite.name.must_equal 'suitezy'
+    suite.run_list.must_equal ['doowah']
+    suite.attributes.must_equal({ :a => 'b' })
+    suite.data_bags_path.must_equal 'crazy'
+    suite.roles_path.must_equal 'town'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,47 @@
+# -*- 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 'simplecov'
+SimpleCov.adapters.define 'gem' do
+  command_name 'Specs'
+
+  add_filter '.gem/'
+  add_filter '/spec/'
+  add_filter '/lib/vendor/'
+
+  add_group 'Libraries', '/lib/'
+end
+SimpleCov.start 'gem'
+
+require 'fakefs/safe'
+require 'minitest/autorun'
+require 'mocha/setup'
+
+# enable yaml symbol parsing if code is executing under guard
+if ENV['GUARD_NOTIFY']
+  require 'safe_yaml'
+  YAML.enable_symbol_parsing!
+  SafeYAML::OPTIONS[:suppress_warnings] = true
+end
+
+# Nasty hack to redefine IO.read in terms of File#read for fakefs
+class IO
+  def self.read(*args)
+    File.open(args[0], "rb") { |f| f.read(args[1]) }
+  end
+end

data/templates/plugin/driver.rb.erb

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+#
+<%= license %>
+
+require 'kitchen'
+
+module Kitchen
+
+  module Driver
+
+    # <%= klass_name %> driver for Kitchen.
+    #
+    # @author <%= author %> <<%= email %>>
+    class <%= klass_name %> < Kitchen::Driver::SSHBase
+
+      def create(state)
+      end
+
+      def destroy(state)
+      end
+    end
+  end
+end

data/templates/plugin/license_apachev2.erb

@@ -0,0 +1,15 @@
+Author:: <%= author %> (<<%= email %>>)
+
+Copyright (C) <%= year %>, <%= author %>
+
+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.

data/templates/plugin/license_gplv2.erb

@@ -0,0 +1,18 @@
+Author:: <%= author %> (<<%= email %>>)
+
+Copyright (C) <%= year %>  <%= author %>
+
+This program is free software; you can redistribute it and/or
+modify it under the terms of the GNU General Public License
+as published by the Free Software Foundation; either version 2
+of the License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor,
+Boston, MA  02110-1301, USA.

data/templates/plugin/license_gplv3.erb

@@ -0,0 +1,16 @@
+Author:: <%= author %> (<<%= email %>>)
+
+Copyright (C) <%= year %>  <%= author %>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/templates/plugin/license_mit.erb

@@ -0,0 +1,22 @@
+Author:: <%= author %> (<<%= email %>>)
+
+Copyright (c) <%= year %>, <%= author %>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/templates/plugin/license_reserved.erb

@@ -0,0 +1,5 @@
+Author:: <%= author %> (<<%= email %>>)
+
+Copyright (C) <%= year %>, <%= author %>
+
+All rights reserved - Do Not Redistribute

data/templates/plugin/version.rb.erb

@@ -0,0 +1,12 @@
+# -*- encoding: utf-8 -*-
+#
+<%= license %>
+
+module Kitchen
+
+  module Driver
+
+    # Version string for <%= klass_name %> Kitchen driver
+    <%= constant %>_VERSION = "0.1.0"
+  end
+end

data/test-kitchen.gemspec

@@ -0,0 +1,44 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kitchen/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "test-kitchen"
+  gem.version       = Kitchen::VERSION
+  gem.license       = 'Apache 2.0'
+  gem.authors       = ["Fletcher Nichol"]
+  gem.email         = ["fnichol@nichol.ca"]
+  gem.description   = %q{A Chef convergence integration test harness}
+  gem.summary       = gem.description
+  gem.homepage      = "https://github.com/opscode/test-kitchen"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = %w(kitchen)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.required_ruby_version = ">= 1.9.1"
+
+  gem.add_dependency 'celluloid'
+  gem.add_dependency 'thor'
+  gem.add_dependency 'pry'
+  gem.add_dependency 'net-ssh'
+  gem.add_dependency 'net-scp'
+  gem.add_dependency 'mixlib-shellout'
+  gem.add_dependency 'safe_yaml'
+
+  gem.add_development_dependency 'minitest'
+  gem.add_development_dependency 'mocha'
+  gem.add_development_dependency 'fakefs'
+  gem.add_development_dependency 'guard-minitest'
+  gem.add_development_dependency 'aruba', '~> 0.5'
+  gem.add_development_dependency 'guard-cucumber'
+
+  gem.add_development_dependency 'yard'
+  gem.add_development_dependency 'maruku'
+  gem.add_development_dependency 'cane'
+  gem.add_development_dependency 'tailor'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'countloc'
+end