test-kitchen 1.0.0.alpha.7 → 1.0.0.beta.1

data/lib/kitchen/provisioner/chef_solo.rb

@@ -0,0 +1,69 @@
+# -*- 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 'kitchen/provisioner/chef_base'
+
+module Kitchen
+
+  module Provisioner
+
+    # Chef Solo provisioner.
+    #
+    # @author Fletcher Nichol <fnichol@nichol.ca>
+    class ChefSolo < ChefBase
+
+      def create_sandbox
+        create_chef_sandbox { prepare_solo_rb }
+      end
+
+      def run_command
+        [
+          sudo('chef-solo'),
+          "--config #{home_path}/solo.rb",
+          "--json-attributes #{home_path}/dna.json",
+          "--log_level #{config[:log_level]}"
+        ].join(" ")
+      end
+
+      def home_path
+        "/tmp/kitchen-chef-solo".freeze
+      end
+
+      private
+
+      def prepare_solo_rb
+        solo = []
+        solo << %{node_name "#{instance.name}"}
+        solo << %{file_cache_path "#{home_path}/cache"}
+        solo << %{cookbook_path "#{home_path}/cookbooks"}
+        solo << %{role_path "#{home_path}/roles"}
+        if instance.suite.data_bags_path
+          solo << %{data_bag_path "#{home_path}/data_bags"}
+        end
+        if instance.suite.encrypted_data_bag_secret_key_path
+          secret = "#{home_path}/encrypted_data_bag_secret"
+          solo << %{encrypted_data_bag_secret "#{secret}"}
+        end
+
+        File.open(File.join(tmpdir, "solo.rb"), "wb") do |file|
+          file.write(solo.join("\n"))
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/provisioner/chef_zero.rb

@@ -0,0 +1,92 @@
+# -*- 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 'kitchen/provisioner/chef_base'
+
+module Kitchen
+
+  module Provisioner
+
+    # Chef Zero provisioner.
+    #
+    # @author Fletcher Nichol <fnichol@nichol.ca>
+    class ChefZero < ChefBase
+
+      def create_sandbox
+        create_chef_sandbox do
+          prepare_chef_client_zero_rb
+          prepare_client_rb
+        end
+      end
+
+      def prepare_command
+        ruby_bin = "/opt/chef/embedded/bin"
+
+        <<-PREPARE.gsub(/^ {10}/, '')
+          bash -c '
+          if [ ! -f "#{ruby_bin}/chef-zero" ] ; then
+            echo "-----> Installing chef-zero and knife-essentials gems"
+            #{sudo("#{ruby_bin}/gem")} install \
+              chef-zero knife-essentials --no-ri --no-rdoc
+          fi'
+        PREPARE
+      end
+
+      def run_command
+        [
+          sudo('/opt/chef/embedded/bin/ruby'),
+          "#{home_path}/chef-client-zero.rb",
+          "--config #{home_path}/client.rb",
+          "--json-attributes #{home_path}/dna.json",
+          "--log_level #{config[:log_level]}"
+        ].join(" ")
+      end
+
+      def home_path
+        "/tmp/kitchen-chef-zero".freeze
+      end
+
+      private
+
+      def prepare_chef_client_zero_rb
+        source = File.join(File.dirname(__FILE__),
+          %w{.. .. .. support chef-client-zero.rb})
+        FileUtils.cp(source, File.join(tmpdir, "chef-client-zero.rb"))
+      end
+
+      def prepare_client_rb
+        client = []
+        client << %{node_name "#{instance.name}"}
+        client << %{file_cache_path "#{home_path}/cache"}
+        client << %{cookbook_path "#{home_path}/cookbooks"}
+        client << %{node_path "#{home_path}/nodes"}
+        client << %{client_path "#{home_path}/clients"}
+        client << %{role_path "#{home_path}/roles"}
+        client << %{data_bag_path "#{home_path}/data_bags"}
+        if instance.suite.encrypted_data_bag_secret_key_path
+          secret = "#{home_path}/encrypted_data_bag_secret"
+          client << %{encrypted_data_bag_secret "#{secret}"}
+        end
+
+        File.open(File.join(tmpdir, "client.rb"), "wb") do |file|
+          file.write(client.join("\n"))
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/ssh.rb

@@ -0,0 +1,160 @@
+# -*- 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 'logger'
+require 'net/ssh'
+require 'net/scp'
+require 'socket'
+
+require 'kitchen/errors'
+require 'kitchen/login_command'
+
+module Kitchen
+
+  # Wrapped exception for any internally raised SSH-related errors.
+  #
+  # @author Fletcher Nichol <fnichol@nichol.ca>
+  class SSHFailed < TransientFailure ; end
+
+  # Class to help establish SSH connections, issue remote commands, and
+  # transfer files between a local system and remote node.
+  #
+  # @author Fletcher Nichol <fnichol@nichol.ca>
+  class SSH
+
+    def initialize(hostname, username, options = {})
+      @hostname = hostname
+      @username = username
+      @options = options.dup
+      @logger = @options.delete(:logger) || ::Logger.new(STDOUT)
+
+      if block_given?
+        yield self
+        shutdown
+      end
+    end
+
+    def exec(cmd)
+      logger.debug("[SSH] #{self} (#{cmd})")
+      exit_code = exec_with_exit(cmd)
+
+      if exit_code != 0
+        raise SSHFailed, "SSH exited (#{exit_code}) for command: [#{cmd}]"
+      end
+    end
+
+    def upload!(local, remote, options = {}, &progress)
+      if progress.nil?
+        progress = lambda { |ch, name, sent, total|
+          if sent == total
+            logger.info("Uploaded #{name} (#{total} bytes)")
+          end
+        }
+      end
+
+      session.scp.upload!(local, remote, options, &progress)
+    end
+
+    def upload_path!(local, remote, options = {}, &progress)
+      options = { :recursive => true }.merge(options)
+
+      upload!(local, remote, options, &progress)
+    end
+
+    def shutdown
+      return if @session.nil?
+
+      logger.debug("[SSH] closing connection to #{self}")
+      session.shutdown!
+    ensure
+      @session = nil
+    end
+
+    def wait
+      logger.log("Waiting for #{hostname}:#{port}...") until test_ssh
+    end
+
+    def login_command
+      args  = %W{ -o UserKnownHostsFile=/dev/null }
+      args += %W{ -o StrictHostKeyChecking=no }
+      args += %W{ -o LogLevel=#{logger.debug? ? "VERBOSE" : "ERROR"} }
+      Array(options[:keys]).each { |ssh_key| args += %W{ -i #{ssh_key}} }
+      args += %W{ -p #{port}}
+      args += %W{ #{username}@#{hostname}}
+
+      LoginCommand.new(["ssh", *args])
+    end
+
+    private
+
+    attr_reader :hostname, :username, :options, :logger
+
+    def session
+      @session ||= begin
+        logger.debug("[SSH] opening connection to #{self}")
+        Net::SSH.start(hostname, username, options)
+      end
+    end
+
+    def to_s
+      "#{username}@#{hostname}:#{port}<#{options.inspect}>"
+    end
+
+    def port
+      options.fetch(:port, 22)
+    end
+
+    def exec_with_exit(cmd)
+      exit_code = nil
+      session.open_channel do |channel|
+
+        channel.request_pty
+
+        channel.exec(cmd) do |ch, success|
+
+          channel.on_data do |ch, data|
+            logger << data
+          end
+
+          channel.on_extended_data do |ch, type, data|
+            logger << data
+          end
+
+          channel.on_request("exit-status") do |ch, data|
+            exit_code = data.read_long
+          end
+        end
+      end
+      session.loop
+      exit_code
+    end
+
+    def test_ssh
+      socket = TCPSocket.new(hostname, port)
+      IO.select([socket], nil, nil, 5)
+    rescue SocketError, Errno::ECONNREFUSED,
+      Errno::EHOSTUNREACH, Errno::ENETUNREACH, IOError
+      sleep 2
+      false
+    rescue Errno::EPERM, Errno::ETIMEDOUT
+      false
+    ensure
+      socket && socket.close
+    end
+  end
+end

data/lib/kitchen/suite.rb

@@ -27,55 +27,75 @@ module Kitchen
     # @return [String] logical name of this suite
     attr_reader :name
 
-    # @return [Array] Array of Chef run_list items
-    attr_reader :run_list
-
-    # @return [Hash] Hash of Chef node attributes
-    attr_reader :attributes
-
     # @return [Array] Array of names of excluded platforms
     attr_reader :excludes
 
-    # @return [String] local path to the suite's data bags, or nil if one does
-    #   not exist
-    attr_reader :data_bags_path
-
-    # @return [String] local path to the suite's encrypted data bag secret
-    #   key path, or nil if one does not exist
-    attr_reader :encrypted_data_bag_secret_key_path
-
-    # @return [String] local path to the suite's roles, or nil if one does
-    #   not exist
-    attr_reader :roles_path
-
     # Constructs a new suite.
     #
     # @param [Hash] options configuration for a new suite
     # @option options [String] :name logical name of this suit (**Required**)
-    # @option options [String] :run_list Array of Chef run_list items
-    #   (**Required**)
-    # @option options [Hash] :attributes Hash of Chef node attributes
     # @option options [String] :excludes Array of names of excluded platforms
-    # @option options [String] :data_bags_path path to data bags
-    # @option options [String] :roles_path path to roles
-    # @option options [String] :encrypted_data_bag_secret_key_path path to
-    #   secret key file
     def initialize(options = {})
+      options = options.dup
       validate_options(options)
 
-      @name = options[:name]
-      @run_list = options[:run_list]
-      @attributes = options[:attributes] || Hash.new
-      @excludes = options[:excludes]     || Array.new
-      @data_bags_path = options[:data_bags_path]
-      @roles_path = options[:roles_path]
-      @encrypted_data_bag_secret_key_path = options[:encrypted_data_bag_secret_key_path]
+      @name = options.delete(:name)
+      @excludes = Array(options[:excludes])
+      @data = options
+    end
+
+    # Extra suite methods used for accessing Chef data such as a run list,
+    # node attributes, etc.
+    module Cheflike
+
+      # @return [Array] Array of Chef run_list items
+      def run_list
+        Array(data[:run_list])
+      end
+
+      # @return [Hash] Hash of Chef node attributes
+      def attributes
+        data[:attributes] || Hash.new
+      end
+
+      # @return [String] local path to the suite's data bags, or nil if one
+      #   does not exist
+      def data_bags_path
+        data[:data_bags_path]
+      end
+
+      # @return [String] local path to the suite's encrypted data bag secret
+      #   key path, or nil if one does not exist
+      def encrypted_data_bag_secret_key_path
+        data[:encrypted_data_bag_secret_key_path]
+      end
+
+      # @return [String] local path to the suite's roles, or nil if one does
+      #   not exist
+      def roles_path
+        data[:roles_path]
+      end
+
+      # @return [String] local path to the suite's nodes, or nil if one does
+      #   not exist
+      def nodes_path
+        data[:nodes_path]
+      end
+    end
+
+    # Extra suite methods used for accessing Puppet data such as a manifest.
+    module Puppetlike
+
+      def manifest
+      end
     end
 
     private
 
+    attr_reader :data
+
     def validate_options(opts)
-      [:name, :run_list].each do |k|
+      [:name].each do |k|
         raise ClientError, "Suite#new requires option :#{k}" if opts[k].nil?
       end
     end

data/lib/kitchen/version.rb

@@ -18,5 +18,5 @@
 
 module Kitchen
 
-  VERSION = "1.0.0.alpha.7"
+  VERSION = "1.0.0.beta.1"
 end

data/spec/kitchen/config_spec.rb

@@ -93,43 +93,75 @@ describe Kitchen::Config do
       config.suites.must_equal []
     end
 
+    def cheflike_suite(suite)
+      suite.extend(Kitchen::Suite::Cheflike)
+    end
+
     it "returns a suite with nil for data_bags_path by default" do
       stub_data!({ :suites => [{ :name => 'one', :run_list => [] }] })
-      config.suites.first.data_bags_path.must_be_nil
+      cheflike_suite(config.suites.first).data_bags_path.must_be_nil
     end
 
-    it "retuns a suite with a common data_bags_path set" do
+    it "returns a suite with a common data_bags_path set" do
       stub_data!({ :suites => [{ :name => 'one', :run_list => [] }] })
       config.test_base_path = "/tmp/base"
       FileUtils.mkdir_p "/tmp/base/data_bags"
 
-      config.suites.first.data_bags_path.must_equal "/tmp/base/data_bags"
+      cheflike_suite(config.suites.first).data_bags_path.
+        must_equal "/tmp/base/data_bags"
     end
 
-    it "retuns a suite with a suite-specific data_bags_path set" do
+    it "returns a suite with a suite-specific data_bags_path set" do
       stub_data!({ :suites => [{ :name => 'cool', :run_list => [] }] })
       config.test_base_path = "/tmp/base"
       FileUtils.mkdir_p "/tmp/base/cool/data_bags"
-      config.suites.first.data_bags_path.must_equal "/tmp/base/cool/data_bags"
+
+      cheflike_suite(config.suites.first).data_bags_path.
+        must_equal "/tmp/base/cool/data_bags"
+    end
+
+    it "returns a suite with a custom data_bags_path set" do
+      stub_data!({ :suites => [{ :name => 'one', :run_list => [],
+        :data_bags_path => 'shared/data_bags' }] })
+      config.kitchen_root = "/tmp/base"
+      FileUtils.mkdir_p "/tmp/base/shared/data_bags"
+
+      cheflike_suite(config.suites.first).data_bags_path.
+        must_equal "/tmp/base/shared/data_bags"
     end
 
     it "returns a suite with nil for roles_path by default" do
       stub_data!({ :suites => [{ :name => 'one', :run_list => [] }] })
-      config.suites.first.roles_path.must_be_nil
+
+      cheflike_suite(config.suites.first).roles_path.must_be_nil
     end
 
     it "returns a suite with a common roles_path set" do
       stub_data!({ :suites => [{ :name => 'one', :run_list => [] }] })
       config.test_base_path = "/tmp/base"
       FileUtils.mkdir_p "/tmp/base/roles"
-      config.suites.first.roles_path.must_equal "/tmp/base/roles"
+
+      cheflike_suite(config.suites.first).roles_path.
+        must_equal "/tmp/base/roles"
     end
 
     it "returns a suite with a suite-specific roles_path set" do
       stub_data!({ :suites => [{ :name => 'mysuite', :run_list => [] }] })
       config.test_base_path = "/tmp/base"
       FileUtils.mkdir_p "/tmp/base/mysuite/roles"
-      config.suites.first.roles_path.must_equal "/tmp/base/mysuite/roles"
+
+      cheflike_suite(config.suites.first).roles_path.
+        must_equal "/tmp/base/mysuite/roles"
+    end
+
+    it "returns a suite with a custom roles_path set" do
+      stub_data!({ :suites => [{ :name => 'one', :run_list => [],
+        :roles_path => 'shared/roles' }] })
+      config.kitchen_root = "/tmp/base"
+      FileUtils.mkdir_p "/tmp/base/shared/roles"
+
+      cheflike_suite(config.suites.first).roles_path.
+        must_equal "/tmp/base/shared/roles"
     end
   end