test-kitchen 1.0.0.beta.4 → 1.0.0.rc.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c66b46e1a915624ed333e89ef6e7c829db84cfd1
-  data.tar.gz: 839dca4f7400f2dc66d4e5540684913cf586510e
+  metadata.gz: 531f23b775d0e1852010f3405773b4a36e938126
+  data.tar.gz: 7d447f5dca58df770141b9184606632bc4ae4a61
 SHA512:
-  metadata.gz: 87dfa48955478b2a69137244a9bef11763662af13ceae16218499ee95da0b6971cbeedd441486d1d88d74665562b09b81077e89113788b0e293c4ce09c9ece01
-  data.tar.gz: e60dbac3c1567c35eca1d819210d3298d564ce33cab87da49ff5a2a1a45d4bc0130c713a71cebdcf651db09b19a2b74088d20da9032c9864e809753a71c03464
+  metadata.gz: 39879c2db849837769c3375cae413a18521fd28978456336703c005c4aef3913dd1e20e83d55485ae9e8e9cd5dd0b7d2f7f1fa3f5d9c5aa51aab5e8995c482fb
+  data.tar.gz: fb4e14f632ae4fecb40cb34c83df2cdad2bcb784bd41168cae3fbe2ffad8e043399444ac721b44c907dafddcd9f55c3ae834f4b9e3d208c1e4c911999f284a36

data/CHANGELOG.md

@@ -1,4 +1,53 @@
-## 1.0.0.beta.4 / 2013-01-11
+## 1.0.0.rc.1 / 2013-11-28
+
+### Changes
+
+* Busser now installs into /tmp/busser by default on instances. (@fnichol)
+* Test Kitchen now works out of /tmp/kitchen for all providers by default. (@fnichol)
+* Remove Chef Omnibus `GEM_PATH` inclusion in Busser `GEM_PATH`. This fully isolates Busser and its runner plugins to a `GEM_HOME` and `GEM_PATH` in `<busser_root_path>/gems`. (@fnichol)
+* Add --provisioner to `kitchen init` to override default, chef\_solo. (@fnichol)
+
+### Bug fixes
+
+* Issue #240, issue #242, pull request #258: Fix Busser and Chef Zero sandboxing so that each tool is completely isolated from the Omnibus packages gems and each other. (@fnichol, @schisamo)
+
+### New features
+
+* Beef up Provisioners so that they resemble Drivers with user, default, inherited, and computed configuration..
+* Use `chef-client -z` (local mode) with ChefZero Provisioner for Chef versions >= 11.8.0. Support older versions of Chef with a best-effort fallback shim to use chef-zero. (@fnichol)
+* `kitchen list --debug` mode greatly improved showing rendered configuration for each Instance's Driver, Provisioner, and Busser configuration. (@fnichol)
+* Pull request #249: Add a data\_path which will be sync'd to the instance in the same manner as roles and data bags. (@oferrigni)
+* Test Kitchen no longer requires a cookbook to run; kitchen init anywhere! (@fnichol)
+* All settings in solo.rb (for ChefSolo) and client.rb (for ChefZero) can be modified or added with a `solo_rb:` or `client_rb:` block inside a `provisioner:` block. (@fnichol)
+* Add :ruby_bindr in a busser config block to set Busser's alternative remote path to Ruby. (@fnichol)
+* Busser install root can be configured and is relocatable, defaults to /tmp/busser. (@fnichol)
+* Test Kitchen root can be configured and is relocatable, defaults to /tmp/kitchen. (@fnichol)
+* Support installing a specific version of Busser. (@fnichol)
+
+### Improvements
+
+* Greatly simplify default .kitchen.yml. (@fnichol, @sethvargo)
+* Massive internal refactoring data manipulation logic. Data code now lives in Kitchen::DataMunger and was properly TDD'ed from the ground up with a full test suite. (@fnichol)
+* `require_chef_ommnibus` will default to `true` for all Chef provisioners and so can be omitted from .kitchen.yml files in most cases. (@fnichol)
+* Pull request #262: Use a configurable glob pattern to select Chef cookbook files. (@fnichol)
+* Pull request #141: Do not create a gitignore if there is no git repo. (@sethvargo)
+* Improve `kitchen init` smarts for detecting gems already in Gemfile. (@fnichol)
+* Expand all Chef-related local paths in Provisioner::ChefBase. (@fnichol)
+* Issue #227: Handle absolute paths. (@sethvargo)
+* Cope with nil values for run\_list and attributes entries in .kitchen.yml. (@fnichol)
+* Allow for nil values for `provisioner:`, `driver:`, & `busser:`. (@fnichol)
+* Pull request #253: Fix TravisCI badges. (@arangamani)
+* Pull request #254: Update references to test-kitchen org. (@josephholsten)
+* Pull request #256: Changed 'passed' to 'passing' in the Destroy options documentation. (@scarolan)
+* Pull request #259: Fix inconsistent date in CHANGELOG. (@ryansouza)
+* Extract Berkshelf & Librarian-Chef resolver code to classes. (@fnichol)
+* Full spec coverage for Suite. (@fnichol)
+* Full spec coverage for Platform. (@fnichol)
+* Full spec coverage for Instance. (@fnichol)
+* Full spec coverage for Kitchen::Provisioner.for\_plugin (@fnichol)
+
+
+## 1.0.0.beta.4 / 2013-11-01
 
 ### Bug fixes
 

data/Gemfile

@@ -5,6 +5,6 @@ group :guard do
   gem 'rb-inotify', :require => false
   gem 'rb-fsevent', :require => false
   gem 'rb-fchange', :require => false
-  gem 'guard-minitest', '~> 1.3'
+  gem 'guard-minitest'
   gem 'guard-cucumber', '~> 1.4'
 end

data/README.md

@@ -1,7 +1,7 @@
 # Test Kitchen
 
-[![Build Status](https://secure.travis-ci.org/opscode/test-kitchen.png?branch=master)](https://travis-ci.org/opscode/test-kitchen)
-[![Code Climate](https://codeclimate.com/github/opscode/test-kitchen.png)](https://codeclimate.com/github/opscode/test-kitchen)
+[![Build Status](https://secure.travis-ci.org/test-kitchen/test-kitchen.png?branch=master)](https://travis-ci.org/test-kitchen/test-kitchen)
+[![Code Climate](https://codeclimate.com/github/test-kitchen/test-kitchen.png)](https://codeclimate.com/github/test-kitchen/test-kitchen)
 
 A convergence integration test harness for configuration management systems.
 
@@ -23,7 +23,7 @@ $ kitchen init
       create  .kitchen.yml
 ```
 In this guide, we
-will be using the [kitchen vagrant driver](https://github.com/opscode/kitchen-vagrant),
+will be using the [kitchen vagrant driver](https://github.com/test-kitchen/kitchen-vagrant),
 so install that:
 
 ```text
@@ -40,14 +40,25 @@ your tests in parallel. Trust us, it's faster!
 
 ### Helpful Switches
 
- - `--destroy=always|passed|never`
-   - `passed` (default): destroy the machine after a successful test
+ - `--destroy=always|passing|never`
+   - `passing` (default): destroy the machine after a successful test
      run (which implies passing tests.)
    - `never`: Never clean up builds, even if they pass or fail.
    - `always`: Regardless of the success or failure of the build,
      destroy the machine.
  - `--log-level=debug|info|warn|error|fatal` - Set the log-level of
-     the entire stack, including the chef-solo run. 
+     the entire stack, including the chef-solo run.
+
+You can also specify these switches in the `settings` has in your YAML:
+
+```yaml
+settings:
+  parallel: true
+  destroy: never
+```
+
+Options specified via the CLI still take precedence over options specified
+in the config.
 
 ## The Kitchen YAML format
 
@@ -121,4 +132,4 @@ via freenode/IRC (#chef-hacking),
 Twitter ([@fnichol](https://twitter.com/fnichol)),
 or Email ([fnichol@nichol.ca](mailto:fnichol@nichol.ca)).
 
-For everyone else, watch [this space](https://github.com/opscode/test-kitchen).
+For everyone else, watch [this space](https://github.com/test-kitchen/test-kitchen).

data/Rakefile

@@ -35,6 +35,7 @@ unless RUBY_ENGINE == 'jruby'
       Kitchen::RakeTasks#define
       Kitchen::ThorTasks#define
       Kitchen::CLI#pry_prompts
+      Kitchen::CLI#debug_instance
       Kitchen::Instance#synchronize_or_call
       Kitchen::Driver::SSHBase#converge
     )
@@ -64,10 +65,16 @@ unless RUBY_ENGINE == 'jruby'
       # allow vertical alignment of `let(:foo) { block }` blocks
       style.spaces_before_lbrace 1, level: :off
     end
+    task.file_set('spec/kitchen/data_munger_spec.rb', 'tests') do |style|
+      # allow data formatting in DataMunger
+      style.indentation_spaces 2, level: :off
+      # allow far larger spec file to cover all data input cases as possible
+      style.max_code_lines_in_class 600, level: :off
+    end
   end
 
   desc "Run all quality tasks"
-  task :quality => [:cane, :tailor, :stats]
+  task :quality => [:cane, :stats]
 else
   desc "Run all quality tasks"
   task :quality => [:stats]

data/features/kitchen_init_command.feature

@@ -14,13 +14,14 @@ Feature: Add Test Kitchen support to an existing project
 
   Scenario: Running init with default values
     Given a sandboxed GEM_HOME directory named "kitchen-init"
+    And I have a git repository
     When I run `kitchen init`
     Then the exit status should be 0
     And a directory named ".kitchen" should exist
     And a directory named "test/integration/default" should exist
     And the file ".gitignore" should contain ".kitchen/"
     And the file ".gitignore" should contain ".kitchen.local.yml"
-    And the file ".kitchen.yml" should contain "driver_plugin: vagrant"
+    And the file ".kitchen.yml" should contain "driver: vagrant"
     And a file named "Gemfile" should not exist
     And a file named "Rakefile" should not exist
     And a file named "Thorfile" should not exist
@@ -34,12 +35,64 @@ Feature: Add Test Kitchen support to an existing project
     And the output should contain "You must run `bundle install'"
 
   Scenario: Running init with an existing Gemfile appends to the Gemfile
-    Given an empty file named "Gemfile"
+    Given a file named "Gemfile" with:
+    """
+    source "https://rubygems.org"
+
+
+    """
     When I successfully run `kitchen init`
-    And the file "Gemfile" should contain "gem 'test-kitchen'"
-    And the file "Gemfile" should contain "gem 'kitchen-vagrant'"
+    Then the file "Gemfile" should contain exactly:
+    """
+    source "https://rubygems.org"
+
+    gem 'test-kitchen'
+    gem 'kitchen-vagrant'
+
+    """
+    And the output should contain "You must run `bundle install'"
+
+  Scenario: Running init with a Gemfile containing test-kitchen does not
+    re-append
+    Given a file named "Gemfile" with:
+    """
+    source "https://rubygems.org"
+
+    gem "test-kitchen"
+
+    """
+    When I successfully run `kitchen init`
+    Then the file "Gemfile" should contain exactly:
+    """
+    source "https://rubygems.org"
+
+    gem "test-kitchen"
+    gem 'kitchen-vagrant'
+
+    """
     And the output should contain "You must run `bundle install'"
 
+  Scenario: Running init with a Gemfile containing the driver gem does not
+    re-append
+    Given a file named "Gemfile" with:
+    """
+    source "https://rubygems.org"
+
+    gem "test-kitchen"
+    gem "kitchen-ec2"
+
+    """
+    When I successfully run `kitchen init --driver=kitchen-ec2`
+    Then the file "Gemfile" should contain exactly:
+    """
+    source "https://rubygems.org"
+
+    gem "test-kitchen"
+    gem "kitchen-ec2"
+
+    """
+    And the output should not contain "You must run `bundle install'"
+
   Scenario: Running init with multiple drivers appends to the Gemfile
     Given an empty file named "Gemfile"
     When I successfully run `kitchen init --driver=kitchen-bluebox kitchen-wakka`
@@ -51,13 +104,24 @@ Feature: Add Test Kitchen support to an existing project
     first driver given
     Given an empty file named "Gemfile"
     When I successfully run `kitchen init --driver=kitchen-bluebox kitchen-wakka`
-    Then the file ".kitchen.yml" should contain "driver_plugin: bluebox"
+    Then the file ".kitchen.yml" should contain "driver: bluebox"
 
   Scenario: Running init with no drivers sets the plugin_driver to the
     dummy driver
     Given an empty file named "Gemfile"
     When I successfully run `kitchen init --no-driver`
-    Then the file ".kitchen.yml" should contain "driver_plugin: dummy"
+    Then the file ".kitchen.yml" should contain "driver: dummy"
+
+  Scenario: Running init without a provisioner sets the default provisioner
+    to chef_solo in .kitchen.yml
+    Given an empty file named "Gemfile"
+    When I successfully run `kitchen init --no-driver`
+    Then the file ".kitchen.yml" should contain "provisioner: chef_solo"
+
+  Scenario: Running init with a provisioner sets the provisioner in .kitchen.yml
+    Given an empty file named "Gemfile"
+    When I successfully run `kitchen init --no-driver --provisioner=chef_zero`
+    Then the file ".kitchen.yml" should contain "provisioner: chef_zero"
 
   Scenario: Running with a Rakefile file appends Kitchen tasks
     Given an empty file named "Gemfile"
@@ -73,6 +137,11 @@ Feature: Add Test Kitchen support to an existing project
     end
     """
 
+  Scenario: Running without git doesn't make a .gitignore
+    When I successfully run `kitchen init`
+    Then the exit status should be 0
+    And a file named ".gitignore" should not exist
+
   Scenario: Running with a Thorfile file appends Kitchen tasks
     Given an empty file named "Gemfile"
     Given an empty file named "Thorfile"
@@ -87,7 +156,7 @@ Feature: Add Test Kitchen support to an existing project
     end
     """
 
-  Scenario: Running init with a the name attribute metadata.rb sets a run list
+  Scenario: Running init with a name in metadata.rb sets a run list
     Given an empty file named "Gemfile"
     Given a file named "metadata.rb" with:
     """
@@ -100,10 +169,20 @@ Feature: Add Test Kitchen support to an existing project
     support "centos"
     """
     When I successfully run `kitchen init`
-    Then the file ".kitchen.yml" should contain:
+    Then the file ".kitchen.yml" should contain exactly:
     """
+    ---
+    driver: vagrant
+    provisioner: chef_solo
+
+    platforms:
+      - name: ubuntu-12.04
+      - name: centos-6.4
+
     suites:
-    - name: default
-      run_list: ["recipe[ntp]"]
-      attributes: {}
+      - name: default
+        run_list:
+          - recipe[ntp::default]
+        attributes:
+
     """

data/features/step_definitions/git_steps.rb

@@ -0,0 +1,3 @@
+Given /I have a git repository/ do
+  create_dir('.git')
+end

data/lib/kitchen/busser.rb

@@ -2,7 +2,7 @@
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #
-# Copyright (C) 2012, Fletcher Nichol
+# Copyright (C) 2012, 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.
@@ -33,16 +33,47 @@ module Kitchen
     # @param [String] suite_name name of suite on which to operate
     #   (**Required**)
     # @param [Hash] opts optional configuration
-    # @option opts [TrueClass, FalseClass] :use_sudo whether or not to invoke
+    # @option opts [String] :kitchen_root local path to the root of the project
+    # @option opts [String] :instance_ruby_bindir path to the directory
+    #   containing the Ruby binary on the remote instance
+    # @option opts [TrueClass, FalseClass] :sudo whether or not to invoke
     #   sudo before commands requiring root access (default: `true`)
     def initialize(suite_name, opts = {})
       validate_options(suite_name)
 
-      @ruby_binpath = opts.fetch(:ruby_binpath, DEFAULT_RUBY_BINPATH)
-      @busser_root = opts.fetch(:busser_root, DEFAULT_BUSSER_ROOT)
-      @test_root = opts.fetch(:test_root, DEFAULT_TEST_ROOT)
+      kitchen_root = opts.fetch(:kitchen_root) { Dir.pwd }
+      test_base_path = opts.fetch(:test_base_path, Kitchen::DEFAULT_TEST_DIR)
+
+      @test_base_path = File.expand_path(test_base_path, kitchen_root)
       @suite_name = suite_name
       @use_sudo = opts.fetch(:sudo, true)
+      @ruby_bindir = opts.fetch(:instance_ruby_bindir, DEFAULT_RUBY_BINDIR)
+      @root_path = opts.fetch(:root_path, DEFAULT_ROOT_PATH)
+      @version_string = opts.fetch(:version, "busser")
+      @busser_bin = File.join(@root_path, "bin/busser")
+    end
+
+    # Returns the name of this busser, suitable for display in a CLI.
+    #
+    # @return [String] name of this busser
+    def name
+      suite_name
+    end
+
+    # Returns an array of configuration keys.
+    #
+    # @return [Array] array of configuration keys
+    def config_keys
+      [:test_base_path, :ruby_bindir, :root_path, :version_string,
+        :busser_bin, :use_sudo, :suite_name]
+    end
+
+    # Provides hash-like access to configuration keys.
+    #
+    # @param attr [Object] configuration key
+    # @return [Object] value at configuration key
+    def [](attr)
+      config_keys.include?(attr) ? self.send(attr) : nil
     end
 
     # Returns a command string which installs Busser, and installs all
@@ -60,11 +91,12 @@ module Kitchen
         # use Bourne (/bin/sh) as Bash does not exist on all Unix flavors
         <<-INSTALL_CMD.gsub(/^ {10}/, '')
           sh -c '
-          #{sandbox_env(true)}
-          if ! #{sudo}#{gem_bin} list busser -i >/dev/null; then
-            echo "-----> Installing busser and plugins"
-            #{sudo}#{gem_bin} install busser --no-rdoc --no-ri
+          #{busser_setup_env}
+          if ! #{sudo}#{ruby_bindir}/gem list busser -i >/dev/null; then
+            #{sudo}#{ruby_bindir}/gem install #{gem_install_args}
           fi
+          gem_bindir=`#{ruby_bindir}/ruby -rrubygems -e "puts Gem.bindir"`
+          #{sudo}${gem_bindir}/busser setup
           #{sudo}#{busser_bin} plugin install #{plugins.join(' ')}'
         INSTALL_CMD
       end
@@ -85,9 +117,8 @@ module Kitchen
         # use Bourne (/bin/sh) as Bash does not exist on all Unix flavors
         <<-INSTALL_CMD.gsub(/^ {10}/, '')
           sh -c '
-          #{sandbox_env(true)}
           #{sudo}#{busser_bin} suite cleanup
-          #{local_suite_files.map { |f| stream_file(f, remote_file(f, @suite_name)) }.join}
+          #{local_suite_files.map { |f| stream_file(f, remote_file(f, suite_name)) }.join}
           #{helper_files.map { |f| stream_file(f, remote_file(f, "helpers")) }.join}'
         INSTALL_CMD
       end
@@ -101,18 +132,21 @@ module Kitchen
     # @return [String] a command string to run the test suites, or nil if no
     #   work needs to be performed
     def run_cmd
-      @run_cmd ||= local_suite_files.empty? ? nil : "#{sandbox_env} #{sudo}#{busser_bin} test"
+      @run_cmd ||= local_suite_files.empty? ? nil : "#{sudo}#{busser_bin} test"
     end
 
     private
 
-    DEFAULT_RUBY_BINPATH = "/opt/chef/embedded/bin".freeze
-    DEFAULT_BUSSER_ROOT = "/tmp/kitchen-busser".freeze
-    DEFAULT_TEST_ROOT = File.join(Dir.pwd, "test/integration").freeze
+    DEFAULT_RUBY_BINDIR = "/opt/chef/embedded/bin".freeze
+    DEFAULT_ROOT_PATH = "/tmp/busser".freeze
 
-    attr_reader :ruby_binpath
-    attr_reader :busser_root
-    attr_reader :test_root
+    attr_reader :test_base_path
+    attr_reader :ruby_bindir
+    attr_reader :root_path
+    attr_reader :version_string
+    attr_reader :busser_bin
+    attr_reader :use_sudo
+    attr_reader :suite_name
 
     def validate_options(suite_name)
       if suite_name.nil?
@@ -126,24 +160,24 @@ module Kitchen
     end
 
     def plugins
-      Dir.glob(File.join(test_root, @suite_name, "*")).select { |d|
-        File.directory?(d) && File.basename(d) != "data_bags"
+      Dir.glob(File.join(test_base_path, suite_name, "*")).reject { |d|
+        ! File.directory?(d) || non_suite_dirs.include?(File.basename(d))
       }.map { |d| "busser-#{File.basename(d)}" }.sort.uniq
     end
 
     def local_suite_files
-      Dir.glob(File.join(test_root, @suite_name, "*/**/*")).reject do |f|
-        f["data_bags"] || File.directory?(f)
+      Dir.glob(File.join(test_base_path, suite_name, "*/**/*")).reject do |f|
+        f[/(data|data_bags|environments|nodes|roles)/] || File.directory?(f)
       end
     end
 
     def helper_files
-      Dir.glob(File.join(test_root, "helpers", "*/**/*"))
+      Dir.glob(File.join(test_base_path, "helpers", "*/**/*"))
     end
 
     def remote_file(file, dir)
-      local_prefix = File.join(test_root, dir)
-      "$(#{sandbox_env} #{sudo}#{busser_bin} suite path)/".concat(file.sub(%r{^#{local_prefix}/}, ''))
+      local_prefix = File.join(test_base_path, dir)
+      "$(#{sudo}#{busser_bin} suite path)/".concat(file.sub(%r{^#{local_prefix}/}, ''))
     end
 
     def stream_file(local_path, remote_path)
@@ -167,35 +201,35 @@ module Kitchen
     end
 
     def sudo
-      @use_sudo ? "sudo -E " : ""
+      use_sudo ? "sudo -E " : ""
     end
 
-    def ruby_bin
-      @ruby_bin ||= File.join(ruby_binpath, 'ruby')
+    def busser_gem
+      "busser"
     end
 
-    def gem_bin
-      @gem_bin ||= File.join(ruby_binpath, 'gem')
+    def non_suite_dirs
+      %w{data data_bags environments nodes roles}
     end
 
-    def busser_bin
-      @busser_bin ||= "#{ruby_bin} #{File.join(busser_root, "gems", "bin", "busser")}"
+    def busser_setup_env
+      [
+        %{BUSSER_ROOT="#{root_path}"},
+        %{GEM_HOME="#{root_path}/gems"},
+        %{GEM_PATH="#{root_path}/gems"},
+        %{GEM_CACHE="#{root_path}/gems/cache"},
+        %{; export BUSSER_ROOT GEM_HOME GEM_PATH GEM_CACHE;}
+      ].join(" ")
     end
 
-    def sandbox_env(export=false)
-      env = [
-        "BUSSER_ROOT=#{busser_root}",
-        "GEM_HOME=#{busser_root}/gems",
-        "GEM_PATH=$GEM_HOME",
-        "GEM_CACHE=$GEM_HOME/cache",
-        "PATH=$PATH:$GEM_HOME/bin"
-      ]
-
-      if export
-        env << "; export BUSSER_ROOT GEM_HOME GEM_PATH GEM_CACHE PATH;"
-      end
+    def gem_install_args
+      gem, version = version_string.split("@")
+      gem, version = "busser", gem if gem =~ /^\d+\.\d+\.\d+/
 
-      env.join(" ")
+      args = gem
+      args += " --version #{version}" if version
+      args += " --no-rdoc --no-ri"
+      args
     end
   end
 end