test-kitchen 1.2.1 → 1.3.0

data/features/kitchen_init_command.feature

@@ -36,8 +36,14 @@ Feature: Add Test Kitchen support to an existing project
   Scenario: Running init that creates a Gemfile
     When I successfully run `kitchen init --create-gemfile`
     Then the file "Gemfile" should contain "https://rubygems.org"
-    And the file "Gemfile" should contain "gem 'test-kitchen'"
-    And the file "Gemfile" should contain "gem 'kitchen-vagrant'"
+    And the file "Gemfile" should contain:
+    """
+    gem "test-kitchen"
+    """
+    And the file "Gemfile" should contain:
+    """
+    gem "kitchen-vagrant"
+    """
     And the output should contain "You must run `bundle install'"
 
   Scenario: Running init with an existing Gemfile appends to the Gemfile
@@ -52,8 +58,8 @@ Feature: Add Test Kitchen support to an existing project
     """
     source "https://rubygems.org"
 
-    gem 'test-kitchen'
-    gem 'kitchen-vagrant'
+    gem "test-kitchen"
+    gem "kitchen-vagrant"
 
     """
     And the output should contain "You must run `bundle install'"
@@ -64,7 +70,7 @@ Feature: Add Test Kitchen support to an existing project
     """
     source "https://rubygems.org"
 
-    gem "test-kitchen"
+    gem 'test-kitchen'
 
     """
     When I successfully run `kitchen init`
@@ -72,8 +78,8 @@ Feature: Add Test Kitchen support to an existing project
     """
     source "https://rubygems.org"
 
-    gem "test-kitchen"
-    gem 'kitchen-vagrant'
+    gem 'test-kitchen'
+    gem "kitchen-vagrant"
 
     """
     And the output should contain "You must run `bundle install'"
@@ -84,8 +90,8 @@ Feature: Add Test Kitchen support to an existing project
     """
     source "https://rubygems.org"
 
-    gem "test-kitchen"
-    gem "kitchen-ec2"
+    gem 'test-kitchen'
+    gem 'kitchen-ec2'
 
     """
     When I successfully run `kitchen init --driver=kitchen-ec2`
@@ -93,8 +99,8 @@ Feature: Add Test Kitchen support to an existing project
     """
     source "https://rubygems.org"
 
-    gem "test-kitchen"
-    gem "kitchen-ec2"
+    gem 'test-kitchen'
+    gem 'kitchen-ec2'
 
     """
     And the output should not contain "You must run `bundle install'"
@@ -102,8 +108,14 @@ Feature: Add Test Kitchen support to an existing project
   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`
-    Then the file "Gemfile" should contain "gem 'kitchen-bluebox'"
-    And the file "Gemfile" should contain "gem 'kitchen-wakka'"
+    Then the file "Gemfile" should contain:
+    """
+    gem "kitchen-bluebox"
+    """
+    And the file "Gemfile" should contain:
+    """
+    gem "kitchen-wakka"
+    """
     And the output should contain "You must run `bundle install'"
 
   Scenario: Running init with multiple driver sets the plugin_driver to the
@@ -152,10 +164,10 @@ Feature: Add Test Kitchen support to an existing project
     Then the file "Rakefile" should contain:
     """
     begin
-      require 'kitchen/rake_tasks'
+      require "kitchen/rake_tasks"
       Kitchen::RakeTasks.new
     rescue LoadError
-      puts ">>>>> Kitchen gem not loaded, omitting tasks" unless ENV['CI']
+      puts ">>>>> Kitchen gem not loaded, omitting tasks" unless ENV["CI"]
     end
     """
 
@@ -171,10 +183,10 @@ Feature: Add Test Kitchen support to an existing project
     Then the file "Thorfile" should contain:
     """
     begin
-      require 'kitchen/thor_tasks'
+      require "kitchen/thor_tasks"
       Kitchen::ThorTasks.new
     rescue LoadError
-      puts ">>>>> Kitchen gem not loaded, omitting tasks" unless ENV['CI']
+      puts ">>>>> Kitchen gem not loaded, omitting tasks" unless ENV["CI"]
     end
     """
 

data/features/kitchen_list_command.feature

@@ -22,8 +22,8 @@ Feature: Listing Test Kitchen instances
   Scenario: Listing instances
     When I run `kitchen list`
     Then the exit status should be 0
-    And the output should contain "foobar-ubuntu-1304"
-    And the output should contain "foobar-centos-64"
+    And the output should match /^foobar-ubuntu-1304\s+Dummy\s+ChefSolo\s+\<Not Created\>$/
+    And the output should match /^foobar-centos-64\s+Dummy\s+ChefSolo\s+\<Not Created\>$/
 
   Scenario: Listing instances with the --bare option
     When I run `kitchen list --bare`

data/features/kitchen_login_command.feature

@@ -0,0 +1,56 @@
+Feature: Logging into a Kitchen instance
+  In order to iterate, explore, and debug
+  As a crafty developer
+  I want to run a command that will give me a terminal session
+
+  Background:
+    Given a file named ".kitchen.yml" with:
+    """
+    ---
+    driver:
+      name: dummy
+
+    provisioner:
+      name: dummy
+
+    platforms:
+      - name: flebian
+
+    suites:
+      - name: default
+      - name: full
+    """
+    And I successfully run `kitchen create default-flebian`
+
+  @spawn
+  Scenario: Logging in to an instance
+    When I run `kitchen login default-flebian`
+    Then the output should contain "Remote login is not supported in this driver."
+    And the exit status should not be 0
+
+  @spawn
+  Scenario: Attempting to log into a non-created instance
+    When I run `kitchen login full-flebian`
+    Then the output should contain:
+    """
+    Instance <full-flebian> has not yet been created
+    """
+    And the exit status should not be 0
+
+  @spawn
+  Scenario: Attempting to log into a non-existent instance
+    When I run `kitchen login nope`
+    Then the output should contain "No instances for regex `nope'"
+    And the exit status should not be 0
+
+  @spawn
+  Scenario: Attempting to log into an instance with an overly fuzzy match
+    When I run `kitchen login flebian`
+    Then the output should contain:
+    """
+    Argument `flebian' returned multiple results:
+      * default-flebian
+      * full-flebian
+    """
+    And the exit status should not be 0
+

data/features/kitchen_test_command.feature

@@ -0,0 +1,88 @@
+Feature: Running a full test instance test
+  In order to "fire-and-forget" or run help setup a CI job
+  As an operator or CI script
+  I want to run a command that will fully test one or more instances
+
+  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: Running a single instance
+    When I run `kitchen test client-beans`
+    Then the output should contain "Starting Kitchen"
+    Then the output should contain "Cleaning up any prior instances of <client-beans>"
+    Then the output should contain "Testing <client-beans>"
+    Then the output should contain "Finished testing <client-beans>"
+    Then the output should contain "Kitchen is finished."
+    And the exit status should be 0
+
+  @spawn
+  Scenario: Running a single instance never destroying an instance
+    When I successfully run `kitchen test client-beans --destroy=never`
+    And I successfully run `kitchen list client-beans`
+    Then the output should match /^client-beans\s+.+\s+Verified$/
+
+  @spawn
+  Scenario: Running a single instance always destroying an instance
+    Given a file named ".kitchen.local.yml" with:
+    """
+    ---
+    driver:
+      fail_converge: true
+    """
+    When I run `kitchen test client-beans --destroy=always`
+    Then the exit status should not be 0
+    When I successfully run `kitchen list client-beans`
+    Then the output should match /^client-beans\s+.+\s+\<Not Created\>$/
+
+  @spawn
+  Scenario: Running a single instance not destroying an instance on failure
+    Given a file named ".kitchen.local.yml" with:
+    """
+    ---
+    driver:
+      fail_converge: true
+    """
+    When I run `kitchen test client-beans --destroy=passing`
+    Then the exit status should not be 0
+    When I successfully run `kitchen list client-beans`
+    Then the output should match /^client-beans\s+.+\s+Created$/
+
+  @spawn
+  Scenario: Running a single instance destroying an instance on success
+    When I run `kitchen test client-beans --destroy=passing`
+    Then the exit status should be 0
+    When I successfully run `kitchen list client-beans`
+    Then the output should match /^client-beans\s+.+\s+\<Not Created\>$/
+
+  @spawn
+  Scenario: Running all instances
+    When I run `kitchen test`
+    Then the output should contain "Starting Kitchen"
+    Then the output should contain "Finished testing <client-cool>"
+    Then the output should contain "Finished testing <client-beans>"
+    Then the output should contain "Finished testing <server-cool>"
+    Then the output should contain "Finished testing <server-beans>"
+    Then the output should contain "Kitchen is finished."
+    And the exit status should be 0
+    When I successfully run `kitchen list`
+    Then the output should match /^client-cool\s+.+\s+\<Not Created\>$/
+    Then the output should match /^client-beans\s+.+\s+\<Not Created\>$/
+    Then the output should match /^server-cool\s+.+\s+\<Not Created\>$/
+    Then the output should match /^server-beans\s+.+\s+\<Not Created\>$/

data/features/step_definitions/gem_steps.rb

@@ -1,15 +1,17 @@
-require 'tmpdir'
-require 'pathname'
+# -*- encoding: utf-8 -*-
+
+require "tmpdir"
+require "pathname"
 
 Given(/^a sandboxed GEM_HOME directory named "(.*?)"$/) do |name|
-  backup_envvar('GEM_HOME')
-  backup_envvar('GEM_PATH')
+  backup_envvar("GEM_HOME")
+  backup_envvar("GEM_PATH")
 
   @aruba_timeout_seconds = 30
 
   gem_home = Pathname.new(Dir.mktmpdir(name))
-  ENV['GEM_HOME'] = gem_home.to_s
-  ENV['GEM_PATH'] = [gem_home.to_s, ENV['GEM_PATH']].join(':')
+  ENV["GEM_HOME"] = gem_home.to_s
+  ENV["GEM_PATH"] = [gem_home.to_s, ENV["GEM_PATH"]].join(":")
   @cleanup_dirs << gem_home
 end
 

data/features/step_definitions/git_steps.rb

@@ -1,3 +1,5 @@
-Given /I have a git repository/ do
-  create_dir('.git')
+# -*- encoding: utf-8 -*-
+
+Given(/I have a git repository/) do
+  create_dir(".git")
 end

data/features/step_definitions/output_steps.rb

@@ -0,0 +1,5 @@
+# -*- encoding: utf-8 -*-
+
+Then(/^the stdout should match \/([^\/]*)\/$/) do |expected|
+  assert_matching_output(expected, all_stdout)
+end

data/features/support/env.rb

@@ -1,12 +1,15 @@
+# -*- encoding: utf-8 -*-
+
 # Set up the environment for testing
-require 'aruba/cucumber'
-require 'aruba/in_process'
-require 'aruba/spawn_process'
-require 'kitchen'
-require 'kitchen/cli'
+require "aruba/cucumber"
+require "aruba/in_process"
+require "aruba/spawn_process"
+require "kitchen"
+require "kitchen/cli"
 
 class ArubaHelper
-  def initialize(argv, stdin=STDIN, stdout=STDOUT, stderr=STDERR, kernel=Kernel)
+
+  def initialize(argv, stdin = STDIN, stdout = STDOUT, stderr = STDERR, kernel = Kernel)
     @argv, @stdin, @stdout, @stderr, @kernel = argv, stdin, stdout, stderr, kernel
   end
 
@@ -28,7 +31,7 @@ Before do
   Aruba.process = Aruba::InProcess
 end
 
-Before('@spawn') do
+Before("@spawn") do
   Aruba.process = Aruba::SpawnProcess
 end
 
@@ -41,7 +44,7 @@ After do |s|
   # Restore environment variables to their original settings, if they have
   # been saved off
   ENV.keys.select { |key| key =~ /^_CUKE_/ }.each do |backup_key|
-    ENV[backup_key.sub(/^_CUKE_/, '')] = ENV.delete(backup_key)
+    ENV[backup_key.sub(/^_CUKE_/, "")] = ENV.delete(backup_key)
   end
 
   @cleanup_dirs.each { |dir| FileUtils.rm_rf(dir) }
@@ -58,7 +61,7 @@ end
 def unbundlerize
   keys = %w[BUNDLER_EDITOR BUNDLE_BIN_PATH BUNDLE_GEMFILE RUBYOPT]
 
-  keys.each { |key| backup_envvar(key) ; ENV.delete(key) }
+  keys.each { |key| backup_envvar(key); ENV.delete(key) }
   yield
   keys.each { |key| restore_envvar(key) }
 end

data/lib/kitchen.rb

@@ -2,7 +2,7 @@
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #
-# Copyright (C) 2012, Fletcher Nichol
+# Copyright (C) 2012, 2013, 2014 Fletcher Nichol
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -16,34 +16,35 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'pathname'
-require 'thread'
-
-require 'kitchen/errors'
-require 'kitchen/logger'
-require 'kitchen/logging'
-require 'kitchen/shell_out'
-require 'kitchen/util'
-
-require 'kitchen/provisioner'
-require 'kitchen/provisioner/base'
-require 'kitchen/busser'
-require 'kitchen/color'
-require 'kitchen/collection'
-require 'kitchen/config'
-require 'kitchen/data_munger'
-require 'kitchen/driver'
-require 'kitchen/driver/base'
-require 'kitchen/driver/proxy'
-require 'kitchen/driver/ssh_base'
-require 'kitchen/instance'
-require 'kitchen/loader/yaml'
-require 'kitchen/metadata_chopper'
-require 'kitchen/platform'
-require 'kitchen/state_file'
-require 'kitchen/ssh'
-require 'kitchen/suite'
-require 'kitchen/version'
+require "pathname"
+require "thread"
+
+require "kitchen/errors"
+require "kitchen/logger"
+require "kitchen/logging"
+require "kitchen/shell_out"
+require "kitchen/configurable"
+require "kitchen/util"
+
+require "kitchen/provisioner"
+require "kitchen/provisioner/base"
+require "kitchen/busser"
+require "kitchen/color"
+require "kitchen/collection"
+require "kitchen/config"
+require "kitchen/data_munger"
+require "kitchen/driver"
+require "kitchen/driver/base"
+require "kitchen/driver/ssh_base"
+require "kitchen/driver/proxy"
+require "kitchen/instance"
+require "kitchen/loader/yaml"
+require "kitchen/metadata_chopper"
+require "kitchen/platform"
+require "kitchen/state_file"
+require "kitchen/ssh"
+require "kitchen/suite"
+require "kitchen/version"
 
 # Test Kitchen base module.
 #
@@ -52,43 +53,64 @@ module Kitchen
 
   class << self
 
+    # @return [Logger] the common Kitchen logger
     attr_accessor :logger
-    attr_accessor :crashes
+
+    # @return [Mutex] a common mutex for global coordination
     attr_accessor :mutex
 
     # Returns the root path of the Kitchen gem source code.
     #
     # @return [Pathname] root path of gem
     def source_root
-      @source_root ||= Pathname.new(File.expand_path('../../', __FILE__))
-    end
-
-    def crashes?
-      ! crashes.empty?
+      @source_root ||= Pathname.new(File.expand_path("../../", __FILE__))
     end
 
+    # Returns a default logger which emits on standard output.
+    #
+    # @return [Logger] a logger
     def default_logger
-      Logger.new(:stdout => STDOUT, :level => env_log)
+      Logger.new(:stdout => $stdout, :level => env_log)
     end
 
+    # Returns a default file logger which emits on standard output and to a
+    # log file.
+    #
+    # @return [Logger] a logger
     def default_file_logger
       logfile = File.expand_path(File.join(".kitchen", "logs", "kitchen.log"))
-      Logger.new(:stdout => STDOUT, :logdev => logfile, :level => env_log)
+      Logger.new(:stdout => $stdout, :logdev => logfile, :level => env_log)
+    end
+
+    # Returns whether or not standard output is associated with a terminal
+    # device (tty).
+    #
+    # @return [true,false] is there a tty?
+    def tty?
+      $stdout.tty?
     end
 
     private
 
+    # Determine the default log level from an environment variable, if it is
+    # set.
+    #
+    # @return [Integer,nil] a log level or nil if not set
+    # @api private
     def env_log
-      level = ENV['KITCHEN_LOG'] && ENV['KITCHEN_LOG'].downcase.to_sym
+      level = ENV["KITCHEN_LOG"] && ENV["KITCHEN_LOG"].downcase.to_sym
       level = Util.to_logger_level(level) unless level.nil?
+      level
     end
   end
 
   # Default log level verbosity
   DEFAULT_LOG_LEVEL = :info
 
+  # Default base directory for integration tests, fixtures, etc.
   DEFAULT_TEST_DIR = "test/integration".freeze
 
+  # Default base directory for instance and common log files
   DEFAULT_LOG_DIR = ".kitchen/logs".freeze
 end