test-kitchen 1.2.1 → 1.3.0

data/Gemfile

@@ -1,10 +1,14 @@
-source 'https://rubygems.org'
+# -*- encoding: utf-8 -*-
+source "https://rubygems.org"
 gemspec
 
 group :guard do
-  gem 'rb-inotify', :require => false
-  gem 'rb-fsevent', :require => false
-  gem 'rb-fchange', :require => false
-  gem 'guard-minitest'
-  gem 'guard-cucumber', '~> 1.4'
+  gem "guard-minitest"
+  gem "guard-cucumber", "~> 1.4"
+  gem "guard-rubocop"
+  gem "guard-yard"
+end
+
+group :test do
+  gem "codeclimate-test-reporter", :require => nil
 end

data/Guardfile

@@ -1,13 +1,42 @@
-guard 'minitest' do
-  watch(%r|^spec/(.*)_spec\.rb|)
-  watch(%r|^lib/(.*)([^/]+)\.rb|)     { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
-  watch(%r|^spec/spec_helper\.rb|)    { "spec" }
+# -*- encoding: utf-8 -*-
+ignore %r{^\.gem/}
+
+def rubocop_opts
+  { :all_on_start => false, :keep_failed => false, :cli => "-r finstyle" }
+end
+
+def cucumber_opts
+  cucumber_cli = "--no-profile --color --format progress --strict"
+  cucumber_cli += " --tags ~@spawn" if RUBY_PLATFORM =~ /mswin|mingw|windows/
+
+  { :all_on_start => false, :cli => cucumber_cli }
+end
+
+def yard_opts
+  { :port => "8808" }
 end
 
-cucumber_cli = '--no-profile --color --format progress --strict'
-cucumber_cli += ' --tags ~@spawn' if RUBY_PLATFORM =~ /mswin|mingw|windows/
-guard 'cucumber', cli: cucumber_cli do
+group :red_green_refactor, :halt_on_fail => true do
+  guard :minitest do
+    watch(%r{^spec/(.*)_spec\.rb})
+    watch(%r{^lib/(.*)([^/]+)\.rb})     { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+    watch(%r{^spec/spec_helper\.rb})    { "spec" }
+  end
+
+  guard :rubocop, rubocop_opts do
+    watch(%r{.+\.rb$})
+    watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+  end
+end
+
+guard :cucumber, cucumber_opts do
   watch(%r{^features/.+\.feature$})
-  watch(%r{^features/support/.+$})          { 'features' }
-  watch(%r{^features/step_definitions/(.+)_steps\.rb$}) { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'features' }
+  watch(%r{^features/support/.+$}) { "features" }
+  watch(%r{^features/step_definitions/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "features"
+  end
+end
+
+guard :yard, yard_opts do
+  watch(%r{lib/.+\.rb})
 end

data/README.md

@@ -3,7 +3,9 @@
 [![Gem Version](https://badge.fury.io/rb/test-kitchen.png)](http://badge.fury.io/rb/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)
+[![Test Coverage](https://codeclimate.com/github/test-kitchen/test-kitchen/coverage.png)](https://codeclimate.com/github/test-kitchen/test-kitchen)
 [![Dependency Status](https://gemnasium.com/test-kitchen/test-kitchen.png)](https://gemnasium.com/test-kitchen/test-kitchen)
+[![Inline docs](http://inch-ci.org/github/test-kitchen/test-kitchen.png?branch=master)](http://inch-ci.org/github/test-kitchen/test-kitchen)
 
 |             |                                               |
 |-------------|-----------------------------------------------|
@@ -41,7 +43,7 @@ $ kitchen init
 ```
 
 A `.kitchen.yml` will be created in your project base directory. This file
-describes your testing confiuration; what you want to test and on which target
+describes your testing configuration; what you want to test and on which target
 platforms. Each of these suite and platform combinations are called instances.
 By default your instances will be converged with Chef Solo and run in Vagrant
 virtual machines.
@@ -71,6 +73,8 @@ run through all the instances in serial by running:
 $ kitchen test
 ```
 
+## Usage
+
 There is help included with the `kitchen help` subcommand which will list all
 subcommands and their usage:
 
@@ -78,6 +82,12 @@ subcommands and their usage:
 $ kitchen help test
 ```
 
+More verbose logging (for both test-kitchen and the chef-solo/chef-zero provisioners) can be specified when running test-kitchen form the command line using:
+
+```
+$ kitchen test -l debug
+```
+
 ## Documentation
 
 Documentation is being added on the Test Kitchen [website][website]. Please

data/Rakefile

@@ -1,16 +1,18 @@
-require 'bundler/gem_tasks'
-require 'rake/testtask'
-require 'cucumber'
-require 'cucumber/rake/task'
+# -*- encoding: utf-8 -*-
 
+require "bundler/gem_tasks"
+
+require "rake/testtask"
 Rake::TestTask.new(:unit) do |t|
   t.libs.push "lib"
-  t.test_files = FileList['spec/**/*_spec.rb']
+  t.test_files = FileList["spec/**/*_spec.rb"]
   t.verbose = true
 end
 
+require "cucumber"
+require "cucumber/rake/task"
 Cucumber::Rake::Task.new(:features) do |t|
-  t.cucumber_opts = ['features', '-x', '--format progress']
+  t.cucumber_opts = ["features", "-x", "--format progress"]
 end
 
 desc "Run all test suites"
@@ -24,45 +26,27 @@ task :stats do
   sh "countloc -r spec features"
 end
 
-unless RUBY_ENGINE == 'jruby'
-  require 'cane/rake_task'
-  require 'tailor/rake_task'
+require "finstyle"
+require "rubocop/rake_task"
+RuboCop::RakeTask.new(:style) do |task|
+  task.options << "--display-cop-names"
+end
 
+if RUBY_ENGINE != "jruby"
+  require "cane/rake_task"
   desc "Run cane to check quality metrics"
   Cane::RakeTask.new do |cane|
-    cane.canefile = './.cane'
-  end
-
-  Tailor::RakeTask.new do |task|
-    task.file_set('bin/*', 'binaries')
-    task.file_set('lib/**/*.rb', 'code') do |style|
-      # TODO: Tailor is confused thinking `module Kitchen` is a class. Until
-      # the classes are split in seperate files, let's punt on this
-      style.max_code_lines_in_class 1550, level: :warn
-      # NOTE: Kitchen::InitGenerator.default_yaml is over the default 30 lines
-      # and produces a warning. Since most of it is increasing readability of
-      # the data structure, allowing it here to prevent it from growing
-      style.max_code_lines_in_method 34
-      style.max_line_length 80, level: :warn
-      style.max_line_length 160, level: :error
-    end
-    task.file_set('spec/**/*.rb', 'tests') do |style|
-      # 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
+    cane.canefile = "./.cane"
   end
 
   desc "Run all quality tasks"
-  task :quality => [:cane, :stats]
+  task :quality => [:cane, :style, :stats]
 else
   desc "Run all quality tasks"
-  task :quality => [:stats]
+  task :quality => [:style, :stats]
 end
 
+require "yard"
+YARD::Rake::YardocTask.new
+
 task :default => [:test, :quality]

data/bin/kitchen

@@ -5,9 +5,9 @@
 # https://twitter.com/mitchellh/status/283014103189053442
 Signal.trap("INT") { exit 1 }
 
-$:.unshift File.join(File.dirname(__FILE__), %w{.. lib})
-require 'rubygems'
-require 'kitchen/cli'
-require 'kitchen/errors'
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), %w[.. lib])
+require "rubygems"
+require "kitchen/cli"
+require "kitchen/errors"
 
 Kitchen.with_friendly_errors { Kitchen::CLI.start }

data/features/kitchen_action_commands.feature

@@ -0,0 +1,161 @@
+Feature: Running instance actions
+  In order to trigger discrete instance lifecyle actions
+  As an operator
+  I want to run a action commands
+
+  Background:
+    Given a file named ".kitchen.yml" with:
+    """
+    ---
+    driver:
+      name: dummy
+
+    provisioner:
+      name: dummy
+
+    platforms:
+      - name: cool
+      - name: beans
+
+    suites:
+      - name: client
+      - name: server
+    """
+
+  @spawn
+  Scenario: Creating a single instance
+    When I successfully run `kitchen list client-beans`
+    Then the stdout should match /^client-beans\s+.+\s+\<Not Created\>\Z/
+    When I run `kitchen create client-beans`
+    Then the output should contain "Finished creating <client-beans>"
+    And the exit status should be 0
+    When I successfully run `kitchen list client-beans`
+    Then the stdout should match /^client-beans\s+.+\s+Created\Z/
+
+  @spawn
+  Scenario: Creating a single instance that fails
+    Given a file named ".kitchen.local.yml" with:
+    """
+    ---
+    driver:
+      fail_create: true
+    """
+    When I successfully run `kitchen list client-beans`
+    Then the stdout should match /^client-beans\s+.+\s+\<Not Created\>\Z/
+    When I run `kitchen create client-beans`
+    Then the output should contain "Create failed on instance <client-beans>"
+    And the exit status should not be 0
+    When I successfully run `kitchen list client-beans`
+    Then the stdout should match /^client-beans\s+.+\s+\<Not Created\>\Z/
+
+  @spawn
+  Scenario: Converging a single instance
+    When I successfully run `kitchen create client-beans`
+    And I successfully run `kitchen list client-beans`
+    Then the stdout should match /^client-beans\s+.+\s+Created\Z/
+    When I run `kitchen converge client-beans`
+    Then the output should contain "Finished converging <client-beans>"
+    And the exit status should be 0
+    When I successfully run `kitchen list client-beans`
+    Then the stdout should match /^client-beans\s+.+\s+Converged\Z/
+
+  @spawn
+  Scenario: Converging a single instance that fails
+    Given a file named ".kitchen.local.yml" with:
+    """
+    ---
+    driver:
+      fail_converge: true
+    """
+    When I successfully run `kitchen create client-beans`
+    And I successfully run `kitchen list client-beans`
+    Then the stdout should match /^client-beans\s+.+\s+Created\Z/
+    When I run `kitchen converge client-beans`
+    Then the output should contain "Converge failed on instance <client-beans>"
+    And the exit status should not be 0
+    When I successfully run `kitchen list client-beans`
+    Then the stdout should match /^client-beans\s+.+\s+Created\Z/
+
+  @spawn
+  Scenario: Setting up a single instance
+    When I successfully run `kitchen converge client-beans`
+    And I successfully run `kitchen list client-beans`
+    Then the stdout should match /^client-beans\s+.+\s+Converged\Z/
+    When I run `kitchen setup client-beans`
+    Then the output should contain "Finished setting up <client-beans>"
+    And the exit status should be 0
+    When I successfully run `kitchen list client-beans`
+    Then the stdout should match /^client-beans\s+.+\s+Set Up\Z/
+
+  @spawn
+  Scenario: Setting up a single instance that fails
+    Given a file named ".kitchen.local.yml" with:
+    """
+    ---
+    driver:
+      fail_setup: true
+    """
+    When I successfully run `kitchen converge client-beans`
+    And I successfully run `kitchen list client-beans`
+    Then the stdout should match /^client-beans\s+.+\s+Converged\Z/
+    When I run `kitchen setup client-beans`
+    Then the output should contain "Setup failed on instance <client-beans>"
+    And the exit status should not be 0
+    When I successfully run `kitchen list client-beans`
+    Then the stdout should match /^client-beans\s+.+\s+Converged\Z/
+
+  @spawn
+  Scenario: Verifying a single instance
+    When I successfully run `kitchen setup client-beans`
+    And I successfully run `kitchen list client-beans`
+    Then the stdout should match /^client-beans\s+.+\s+Set Up\Z/
+    When I run `kitchen verify client-beans`
+    Then the output should contain "Finished verifying <client-beans>"
+    And the exit status should be 0
+    When I successfully run `kitchen list client-beans`
+    Then the stdout should match /^client-beans\s+.+\s+Verified\Z/
+
+  @spawn
+  Scenario: Verifying a single instance that fails
+    Given a file named ".kitchen.local.yml" with:
+    """
+    ---
+    driver:
+      fail_verify: true
+    """
+    When I successfully run `kitchen setup client-beans`
+    And I successfully run `kitchen list client-beans`
+    Then the stdout should match /^client-beans\s+.+\s+Set Up\Z/
+    When I run `kitchen verify client-beans`
+    Then the output should contain "Verify failed on instance <client-beans>"
+    And the exit status should not be 0
+    When I successfully run `kitchen list client-beans`
+    Then the stdout should match /^client-beans\s+.+\s+Set Up\Z/
+
+  @spawn
+  Scenario: Destroying a single instance
+    When I successfully run `kitchen create client-beans`
+    And I successfully run `kitchen list client-beans`
+    Then the stdout should match /^client-beans\s+.+\s+Created\Z/
+    When I run `kitchen destroy client-beans`
+    Then the output should contain "Finished destroying <client-beans>"
+    And the exit status should be 0
+    When I successfully run `kitchen list client-beans`
+    Then the stdout should match /^client-beans\s+.+\s+\<Not Created\>\Z/
+
+  @spawn
+  Scenario: Destroying a single instance that fails
+    Given a file named ".kitchen.local.yml" with:
+    """
+    ---
+    driver:
+      fail_destroy: true
+    """
+    When I successfully run `kitchen create client-beans`
+    And I successfully run `kitchen list client-beans`
+    Then the stdout should match /^client-beans\s+.+\s+Created\Z/
+    When I run `kitchen destroy client-beans`
+    Then the output should contain "Destroy failed on instance <client-beans>"
+    And the exit status should not be 0
+    When I successfully run `kitchen list client-beans`
+    Then the stdout should match /^client-beans\s+.+\s+Created\Z/

data/features/kitchen_console_command.feature

@@ -0,0 +1,34 @@
+Feature: Running a console command
+  In order to interactively explore Kitchen's internals and wiring
+  As an opterator
+  I want to run a command to launch an interactive console session
+
+  Background:
+    Given a file named ".kitchen.yml" with:
+    """
+    ---
+    driver:
+      name: dummy
+
+    provisioner:
+      name: dummy
+
+    platforms:
+      - name: flebian
+
+    suites:
+      - name: default
+      - name: full
+    """
+
+  @spawn
+  Scenario: Launching a session
+    When I run `kitchen console` interactively
+    And I type "instances.map { |i| i.name }"
+    And I type "exit"
+    Then the output should contain "kc(Kitchen::Config)> "
+    Then the output should contain:
+    """
+    ["default-flebian", "full-flebian"]
+    """
+    And the exit status should be 0

data/features/kitchen_diagnose_command.feature

@@ -0,0 +1,64 @@
+Feature: Running a diagnosis command
+  In order to understand how Kitchen is wired together
+  As an operator and configuration sleuth
+  I want to run a command to get configuration information
+
+  Background:
+    Given a file named ".kitchen.yml" with:
+    """
+    ---
+    driver:
+      name: dummy
+
+    provisioner:
+      name: dummy
+
+    platforms:
+      - name: cool
+      - name: beans
+
+    suites:
+      - name: client
+      - name: server
+    """
+
+  @spawn
+  Scenario: Showing all instances
+    When I run `kitchen diagnose`
+    Then the output should contain "kitchen_version: "
+    Then the output should contain "  client-cool:"
+    Then the output should contain "  client-beans:"
+    Then the output should contain "  server-cool:"
+    Then the output should contain "  server-beans:"
+    And the exit status should be 0
+
+  @spawn
+  Scenario: Showing all instances with loader configuration
+    When I run `kitchen diagnose --loader`
+    Then the output should contain:
+    """
+    loader:
+      process_erb: true
+      process_local: true
+      process_global: true
+    """
+    And the exit status should be 0
+
+  @spawn
+  Scenario: Coping with loading failure
+    Given a file named ".kitchen.local.yml" with:
+    """
+    I'm a little teapot
+    """
+    When I run `kitchen diagnose --all`
+    Then the output should contain:
+    """
+        raw_data:
+          error:
+    """
+    And the output should contain:
+    """
+    instances:
+      error:
+    """
+    And the exit status should be 0