test-kitchen 0.7.0 → 1.0.0.alpha.0

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rvmrc
+.rbenv-version
+.ruby-version

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - jruby-19mode
+  - ruby-head
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-19mode

data/.yardopts

@@ -0,0 +1,3 @@
+--readme README.md
+--markup markdown
+--markup-provider maruku

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'rb-inotify', :require => false
+  gem 'rb-fsevent', :require => false
+  gem 'rb-fchange', :require => false
+end
+
+group :test do
+  gem 'rake', '~> 0.9'
+end

data/Guardfile

@@ -0,0 +1,11 @@
+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 'cucumber' 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' }
+end

data/LICENSE

@@ -0,0 +1,15 @@
+Author:: Fletcher Nichol (<fnichol@nichol.ca>)
+
+Copyright 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.

data/README.md

@@ -0,0 +1,131 @@
+# Test Kitchen
+
+[![Build Status](https://secure.travis-ci.org/opscode/test-kitchen.png?branch=1.0)](https://travis-ci.org/opscode/test-kitchen)
+[![Code Climate](https://codeclimate.com/github/opscode/test-kitchen.png)](https://codeclimate.com/github/opscode/test-kitchen)
+
+A convergence integration test harness for configuration management systems.
+
+# Getting started
+
+
+Project Setup
+-------------
+
+In your `Gemfile`, add `test-kitchen` as a
+dependency:
+
+```ruby
+gem 'test-kitchen', git: 'git://github.com/opscode/test-kitchen.git', branch: '1.0'
+```
+
+and run the `bundle` command to install:
+
+    $ bundle install
+
+This will expose the `test-kitchen` CLI. Run `bundle exec kitchen init` to get started:
+
+    $ kitchen init
+
+You will be prompted with a series of questions. In this guide, we
+will be using the [kitchen vagrant driver](https://github.com/opscode/kitchen-vagrant).
+
+```text
+$ bundle exec kitchen init
+      create  .kitchen.yml
+      append  Rakefile
+      create  test/integration/default
+      append  .gitignore
+      append  .gitignore
+      Add a Driver plugin to your Gemfile?
+      (y/n)> y
+      Enter gem name, `list', or `skip'>
+      kitchen-vagrant
+      append  Gemfile
+      You must run `bundle install' to fetch any new gems.
+```
+
+Run the `bundle` command again to install the new vagrant driver:
+
+    $ bundle install
+
+Open up the `.kitchen.yml` file created in the root of your
+repository.
+
+Now, it is time to get testing. Use the `--parallel` option to run
+your tests in parallel. Trust us, it's faster!
+
+    $ bundle exec kitchen test
+
+## The Kitchen YAML format
+
+Test-Kitchen reads its configuration from the .kitchen.yml
+configuration file at the root of your cookbook. It closely resembles
+the format of .travis.yml which is intentional.
+
+There are 4 stanzas in .kitchen.yml, driver_plugin, driver_config,
+platforms, and suites. driver_plugin, platforms, and suites are
+currently required. driver_config can optionally be used to set values
+for all platforms defined.
+
+The driver_plugin stanza is only one line long and defines which
+driver is used by test-kitchen.
+
+The platforms stanza defines individual virtual machines. Additional
+driver_config, node attributes, and run_list can be defined in this stanza
+
+The suites stanza defines sets of tests that you intend to be run on
+each platform. A run_list and node attributes can be defined for each
+suite. The run_list and node attributes will be merged with that of
+each platform. In case of the conflict, the attributes defined on the
+suite will triumph.
+
+```yaml
+
+---
+driver_plugin: vagrant
+
+platforms:
+- name: ubuntu-12.04
+  driver_config:
+    box: opscode-ubuntu-12.04
+    box_url: https://opscode-vm.s3.amazonaws.com/vagrant/boxes/opscode-ubuntu-12.04.box
+
+- name: centos-6.3
+  driver_config:
+    box: opscode-centos-6.3
+    box_url: https://opscode-vm.s3.amazonaws.com/vagrant/boxes/opscode-centos-6.3.box
+  run_list:
+  - recipe[yum::epel]
+
+suites:
+- name: stock_system_and_user
+  run_list:
+  - recipe[user::data_bag]
+  - recipe[rvm::system]
+  - recipe[rvm::user]
+  attributes:
+    users:
+    - wigglebottom
+    rvm:
+      user_installs:
+      - user: wigglebottom
+        default_ruby: 1.8.7
+```
+
+## Overriding .kitchen.yaml with .kitchen.<driver>.local.yml
+
+TODO
+
+## A Note
+
+This project is currently in rapid development which means frequent releases,
+potential for massive refactorings (that could be API breaking), and minimal
+to no documentation. This will change as the project transitions to be used in
+production environments.
+
+Despite the warnings above, if you are still interested, please get in touch
+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).

data/Rakefile

@@ -0,0 +1,69 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = FileList['spec/**/*_spec.rb']
+  t.verbose = true
+end
+
+task :default => [:test]
+
+unless RUBY_ENGINE == 'jruby'
+  require 'cane/rake_task'
+  require 'tailor/rake_task'
+  require 'cucumber'
+  require 'cucumber/rake/task'
+
+  desc "Run cane to check quality metrics"
+  Cane::RakeTask.new do |cane|
+    cane.abc_exclude = %w(
+      Kitchen::RakeTasks#define
+      Kitchen::ThorTasks#define
+      Kitchen::CLI#pry_prompts
+      Kitchen::Instance#synchronize_or_call
+    )
+    cane.style_exclude = %w(
+      lib/vendor/hash_recursive_merge.rb
+    )
+    cane.doc_exclude = %w(
+      lib/vendor/hash_recursive_merge.rb
+    )
+    cane.style_measure = 160
+  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
+  end
+
+  Cucumber::Rake::Task.new(:features) do |t|
+    t.cucumber_opts = ['features', '-x', '--format progress']
+  end
+
+  Rake::Task[:default].enhance [:cane, :features, :tailor]
+end
+
+desc "Display LOC stats"
+task :stats do
+  puts "\n## Production Code Stats"
+  sh "countloc -r lib/kitchen lib/kitchen.rb"
+  puts "\n## Test Code Stats"
+  sh "countloc -r spec features"
+end
+
+Rake::Task[:default].enhance [:stats]

data/bin/kitchen

@@ -1,7 +1,12 @@
 #!/usr/bin/env ruby
+# -*- encoding: utf-8 -*-
 
-$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), "..", "lib")))
-#require 'bundler/setup'
-require 'test-kitchen'
+# Trap interrupts to quit cleanly. See
+# https://twitter.com/mitchellh/status/283014103189053442
+Signal.trap("INT") { exit 1 }
 
-TestKitchen::CLI::Kitchen.new.run
+$:.unshift File.join(File.dirname(__FILE__), %w{.. lib})
+require 'rubygems'
+require 'kitchen/cli'
+
+Kitchen::CLI.start

data/features/cli.feature

@@ -0,0 +1,17 @@
+Feature: Ensure that the Command Line Interface works as designed
+  In order to test code via CLI
+  As an Operator
+  I want to run the CLI with different arguments
+
+Scenario: Running the help command exits cleanly
+  When I successfully run `kitchen help`
+  Then the exit status should be 0
+  And the output should contain "kitchen console"
+  And a file named ".kitchen/logs/kitchen.log" should exist
+
+Scenario: Show the version number
+  When I successfully run `kitchen version`
+  Then the exit status should be 0
+  
+
+

data/features/cli_init.feature

@@ -0,0 +1,156 @@
+Feature: Ensure that the Command Line Interface init creates the correct files
+  In order to initialize an un-Kitchenified cookbook
+  As an Operator
+  I want to initialize a cookbook
+
+
+@ok
+Scenario: Basic init with no extras succeeds
+  When I run `kitchen init` interactively
+  And I type "n"
+  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/
+  .kitchen.local.yml
+  """
+  And the file ".kitchen.yml" should contain:
+  """
+  ---
+  driver_plugin: vagrant
+  platforms:
+  - name: ubuntu-12.04
+    driver_config:
+      box: opscode-ubuntu-12.04
+      box_url: https://opscode-vm.s3.amazonaws.com/vagrant/boxes/opscode-ubuntu-12.04.box
+    run_list:
+    - recipe[apt]
+  - name: ubuntu-10.04
+    driver_config:
+      box: opscode-ubuntu-10.04
+      box_url: https://opscode-vm.s3.amazonaws.com/vagrant/boxes/opscode-ubuntu-10.04.box
+    run_list:
+    - recipe[apt]
+  - name: centos-6.3
+    driver_config:
+      box: opscode-centos-6.3
+      box_url: https://opscode-vm.s3.amazonaws.com/vagrant/boxes/opscode-centos-6.3.box
+    run_list:
+    - recipe[yum::epel]
+  - name: centos-5.8
+    driver_config:
+      box: opscode-centos-5.8
+      box_url: https://opscode-vm.s3.amazonaws.com/vagrant/boxes/opscode-centos-5.8.box
+    run_list:
+    - recipe[yum::epel]
+  suites:
+  - name: default
+    run_list: []
+    attributes: {}
+  """
+  And a file named "Gemfile" should not exist
+  And a file named "Rakefile" should not exist
+  And a file named "Thorfile" should not exist
+
+
+
+@ok
+Scenario: Running with a Rakefile file appends Kitchen tasks
+  Given an empty file named "Rakefile"
+  When I run `kitchen init` interactively
+  And I type "n"
+  Then the exit status should be 0
+  And the file "Rakefile" should contain exactly:
+  """
+  
+  begin
+    require 'kitchen/rake_tasks'
+    Kitchen::RakeTasks.new
+  rescue LoadError
+    puts ">>>>> Kitchen gem not loaded, omitting tasks" unless ENV['CI']
+  end
+
+  """
+
+
+@ok
+Scenario: Running with a Thorfile file appends Kitchen tasks
+  Given an empty file named "Thorfile"
+  When I run `kitchen init` interactively
+  And I type "n"
+  Then the exit status should be 0
+  And the file "Thorfile" should contain exactly:
+  """
+  
+  begin
+    require 'kitchen/thor_tasks'
+    Kitchen::ThorTasks.new
+  rescue LoadError
+    puts ">>>>> Kitchen gem not loaded, omitting tasks" unless ENV['CI']
+  end
+
+  """
+
+
+@ok
+Scenario: Listing the drivers provides correct output, does not write Gemfile
+  When I run `kitchen init` interactively
+  And I type "y"
+  And I type "list"
+  And I type "skip"
+  Then the exit status should be 0
+  And a file named ".kitchen.yml" should exist
+  And a directory named ".kitchen" should exist
+  And a file named "Gemfile" should not exist
+
+
+@ok
+Scenario: Running the init command without a Gemfile provides warning and fails
+  When I run `kitchen init` interactively
+  And I type "y"
+  And I type "kitchen-vagrant"
+  And the output should contain "You do not have an existing Gemfile"
+  Then the exit status should be 1
+
+
+@ok
+Scenario: Running the init command succeeds
+  Given an empty file named "Gemfile"
+  When I run `kitchen init` interactively
+  And I type "y"
+  And I type "kitchen-vagrant"
+  Then the exit status should be 0
+  And the output should contain "You must run `bundle install' to fetch any new gems."
+  And a file named ".kitchen.yml" should exist
+  And a file named ".gitignore" should exist
+  And the file "Gemfile" should contain "gem 'kitchen-vagrant', :group => :integration"
+
+
+@ok
+Scenario: Running init with a correct metadata.rb works
+  Given a file named "metadata.rb" with:
+  """
+  name              "ntp"
+  license           "Apache 2.0"
+  description       "Installs and configures ntp as a client or server"
+  version           "0.1.0"
+  recipe "ntp", "Installs and configures ntp either as a server or client"
+
+  %w{ ubuntu debian redhat centos fedora scientific amazon oracle freebsd }.each do |os|
+    supports os
+  end
+  """
+  When I run `kitchen init` interactively
+  And I type "n"
+  Then the exit status should be 0
+  And the file ".kitchen.yml" should contain:
+  """
+  suites:
+  - name: default
+    run_list:
+    - recipe[ntp]
+    attributes: {}
+  """
+

data/features/support/env.rb

@@ -0,0 +1,14 @@
+# Set up the environment for testing
+require 'aruba/cucumber'
+require 'kitchen'
+
+Before do
+  @aruba_timeout_seconds = 5
+end
+
+After do |s| 
+  # Tell Cucumber to quit after this scenario is done - if it failed.
+  # This is useful to inspect the 'tmp/aruba' directory before any other
+  # steps are executed and clear it out.
+  Cucumber.wants_to_quit = true if s.failed?
+end

data/lib/kitchen/busser.rb

@@ -0,0 +1,166 @@
+# -*- 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 'base64'
+require 'digest'
+require 'net/https'
+
+module Kitchen
+
+  # Command string generator to interface with Kitchen Busser (kb). The
+  # commands that are generated are safe to pass to an SSH command or as an
+  # unix command argument (escaped in single quotes).
+  #
+  # @author Fletcher Nichol <fnichol@nichol.ca>
+  class Busser
+
+    # Constructs a new busser command generator, given a suite name.
+    #
+    # @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
+    #   sudo before commands requiring root access (default: `true`)
+    def initialize(suite_name, opts = { :use_sudo => true })
+      validate_options(suite_name)
+
+      @suite_name = suite_name
+      @use_sudo = opts[:use_sudo]
+    end
+
+    # Returns a command string which installs the Kitchen Busser (kb), installs
+    # all required kb plugins for the suite.
+    #
+    # If no work needs to be performed, for example if there are no tests for
+    # the given suite, then `nil` will be returned.
+    #
+    # @return [String] a command string to setup the test suite, or nil if no
+    #   work needs to be performed
+    def setup_cmd
+      @setup_cmd ||= if local_suite_files.empty?
+        nil
+      else
+        <<-INSTALL_CMD.gsub(/^ {10}/, '')
+          #{sudo}#{ruby_bin} -e "$(cat <<"EOF"
+          #{install_script}
+          EOF
+          )"
+          #{sudo}#{kb_bin} install #{plugins.join(' ')}
+        INSTALL_CMD
+      end
+    end
+
+    # Returns a command string which transfers all suite test files to the
+    # instance.
+    #
+    # If no work needs to be performed, for example if there are no tests for
+    # the given suite, then `nil` will be returned.
+    #
+    # @return [String] a command string to transfer all suite test files, or
+    #   nil if no work needs to be performed.
+    def sync_cmd
+      @sync_cmd ||= if local_suite_files.empty?
+        nil
+      else
+        <<-INSTALL_CMD.gsub(/^ {10}/, '')
+          #{sudo}#{kb_bin} cleanup-suites
+          #{local_suite_files.map { |f| stream_file(f, remote_file(f)) }.join}
+        INSTALL_CMD
+      end
+    end
+
+    # Returns a command string which runs all kb suite tests for the suite.
+    #
+    # If no work needs to be performed, for example if there are no tests for
+    # the given suite, then `nil` will be returned.
+    #
+    # @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 : "#{sudo}#{kb_bin} test"
+    end
+
+    private
+
+    INSTALL_URL = "https://raw.github.com/opscode/kb/go".freeze
+    DEFAULT_RUBY_BINPATH = "/opt/chef/embedded/bin".freeze
+    DEFAULT_KB_ROOT = "/opt/kb".freeze
+    DEFAULT_TEST_ROOT = File.join(Dir.pwd, "test/integration").freeze
+
+    def validate_options(suite_name)
+      raise ClientError, "Busser#new requires a suite_name" if suite_name.nil?
+    end
+
+    def install_script
+      @install_script ||= begin
+        uri = URI.parse(INSTALL_URL)
+        http = Net::HTTP.new(uri.host, 443)
+        http.use_ssl = true
+        response = http.request(Net::HTTP::Get.new(uri.path))
+        response.body
+      end
+    end
+
+    def plugins
+      Dir.glob(File.join(test_root, @suite_name, "*")).select { |d|
+        File.directory?(d) && File.basename(d) != "data_bags"
+      }.map { |d| 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)
+      end
+    end
+
+    def remote_file(file)
+      local_prefix = File.join(test_root, @suite_name)
+      "$(#{kb_bin} suitepath)/".concat(file.sub(%r{^#{local_prefix}/}, ''))
+    end
+
+    def stream_file(local_path, remote_path)
+      local_file = IO.read(local_path)
+      md5 = Digest::MD5.hexdigest(local_file)
+      perms = sprintf("%o", File.stat(local_path).mode)[3, 3]
+      kb_stream_file = "#{kb_bin} stream-file #{remote_path} #{md5} #{perms}"
+
+      <<-STREAMFILE.gsub(/^ {8}/, '')
+        echo "Uploading #{remote_path} (mode=#{perms})"
+        cat <<"__EOFSTREAM__" | #{sudo}#{kb_stream_file}
+        #{Base64.encode64(local_file)}
+        __EOFSTREAM__
+      STREAMFILE
+    end
+
+    def sudo
+      @use_sudo ? "sudo " : ""
+    end
+
+    def ruby_bin
+      File.join(DEFAULT_RUBY_BINPATH, "ruby")
+    end
+
+    def kb_bin
+      File.join(DEFAULT_KB_ROOT, "bin/kb")
+    end
+
+    def test_root
+      DEFAULT_TEST_ROOT
+    end
+  end
+end