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

data/lib/kitchen/driver.rb

@@ -20,6 +20,10 @@ require 'thor/util'
 
 module Kitchen
 
+  # A driver is responsible for carrying out the lifecycle activities of an
+  # instance, such as creating, converging, and destroying an instance.
+  #
+  # @author Fletcher Nichol <fnichol@nichol.ca>
   module Driver
 
     # Returns an instance of a driver given a plugin type string.

data/lib/kitchen/driver/base.rb

@@ -22,23 +22,7 @@ module Kitchen
 
   module Driver
 
-    # Value object to track a shell command that will be passed to Kernel.exec
-    # for execution.
-    #
-    # @author Fletcher Nichol <fnichol@nichol.ca>
-    class LoginCommand
-
-      attr_reader :cmd_array, :options
-
-      def initialize(cmd_array, options = {})
-        @cmd_array = cmd_array
-        @options = options
-      end
-    end
-
-    # Base class for a driver. A driver is responsible for carrying out the
-    # lifecycle activities of an instance, such as creating, converging, and
-    # destroying an instance.
+    # Base class for a driver.
     #
     # @author Fletcher Nichol <fnichol@nichol.ca>
     class Base
@@ -46,22 +30,32 @@ module Kitchen
       include ShellOut
       include Logging
 
-      attr_writer :instance
+      attr_accessor :instance
 
       class << self
         attr_reader :serial_actions
       end
 
       def initialize(config = {})
-        @config = config
+        @config = LazyDriverHash.new(config, self)
         self.class.defaults.each do |attr, value|
           @config[attr] = value unless @config[attr]
         end
+      end
+
+      def validate_config!
         Array(self.class.validations).each do |tuple|
-          tuple.last.call(tuple.first, config[tuple.first])
+          tuple.last.call(tuple.first, config[tuple.first], self)
         end
       end
 
+      # Returns the name of this driver, suitable for display in a CLI.
+      #
+      # @return [String] name of this driver
+      def name
+        self.class.name.split('::').last
+      end
+
       # Provides hash-like access to configuration keys.
       #
       # @param attr [Object] configuration key
@@ -121,7 +115,7 @@ module Kitchen
 
       protected
 
-      attr_reader :config, :instance
+      attr_reader :config
 
       ACTION_METHODS = %w{create converge setup verify destroy}.
         map(&:to_sym).freeze
@@ -180,8 +174,8 @@ module Kitchen
         end
       end
 
-      def self.default_config(attr, value)
-        defaults[attr] = value
+      def self.default_config(attr, value = nil, &block)
+        defaults[attr] = block_given? ? block : value
       end
 
       def self.validations
@@ -192,9 +186,10 @@ module Kitchen
         @validations = [] if @validations.nil?
         if ! block_given?
           klass = self
-          block = lambda do |attr, value|
+          block = lambda do |attr, value, driver|
             if value.nil? || value.to_s.empty?
-              raise UserError, "#{klass}#config[:#{attr}] cannot be blank"
+              attribute = "#{klass}#{driver.instance.to_str}#config[:#{attr}]"
+              raise UserError, "#{attribute} cannot be blank"
             end
           end
         end
@@ -211,6 +206,28 @@ module Kitchen
         @serial_actions ||= []
         @serial_actions += methods
       end
+
+      # A modifed Hash object that may contain procs as a value which must be
+      # executed in the context of a Driver object.
+      #
+      # @author Fletcher Nichol <fnichol@nichol.ca>
+      class LazyDriverHash < SimpleDelegator
+
+        def initialize(obj, driver)
+          @driver = driver
+          super(obj)
+        end
+
+        def [](key)
+          proc_or_val = __getobj__[key]
+
+          if proc_or_val.respond_to?(:call)
+            proc_or_val.call(@driver)
+          else
+            proc_or_val
+          end
+        end
+      end
     end
   end
 end

data/lib/kitchen/driver/ssh_base.rb

@@ -16,9 +16,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'net/ssh'
-require 'socket'
-
 module Kitchen
 
   module Driver
@@ -39,28 +36,29 @@ module Kitchen
       end
 
       def converge(state)
-        ssh_args = build_ssh_args(state)
-
-        install_omnibus(ssh_args) if config[:require_chef_omnibus]
-        prepare_chef_home(ssh_args)
-        upload_chef_data(ssh_args)
-        run_chef_solo(ssh_args)
+        provisioner = new_provisioner
+
+        Kitchen::SSH.new(*build_ssh_args(state)) do |conn|
+          run_remote(provisioner.install_command, conn)
+          run_remote(provisioner.init_command, conn)
+          transfer_path(provisioner.create_sandbox, provisioner.home_path, conn)
+          run_remote(provisioner.prepare_command, conn)
+          run_remote(provisioner.run_command, conn)
+        end
+      ensure
+        provisioner && provisioner.cleanup_sandbox
       end
 
       def setup(state)
-        ssh_args = build_ssh_args(state)
-
-        if busser_setup_cmd
-          ssh(ssh_args, busser_setup_cmd)
+        Kitchen::SSH.new(*build_ssh_args(state)) do |conn|
+          run_remote(busser_setup_cmd, conn)
         end
       end
 
       def verify(state)
-        ssh_args = build_ssh_args(state)
-
-        if busser_run_cmd
-          ssh(ssh_args, busser_sync_cmd)
-          ssh(ssh_args, busser_run_cmd)
+        Kitchen::SSH.new(*build_ssh_args(state)) do |conn|
+          run_remote(busser_sync_cmd, conn)
+          run_remote(busser_run_cmd, conn)
         end
       end
 
@@ -69,20 +67,23 @@ module Kitchen
       end
 
       def login_command(state)
-        combined = config.merge(state)
-
-        args  = %W{ -o UserKnownHostsFile=/dev/null }
-        args += %W{ -o StrictHostKeyChecking=no }
-        args += %W{ -o LogLevel=#{logger.debug? ? "VERBOSE" : "ERROR"} }
-        args += %W{ -i #{combined[:ssh_key]}} if combined[:ssh_key]
-        args += %W{ -p #{combined[:port]}} if combined[:port]
-        args += %W{ #{combined[:username]}@#{combined[:hostname]}}
+        SSH.new(*build_ssh_args(state)).login_command
+      end
 
-        Driver::LoginCommand.new(["ssh", *args])
+      def ssh(ssh_args, command)
+        Kitchen::SSH.new(*ssh_args) do |conn|
+          run_remote(command, conn)
+        end
       end
 
       protected
 
+      def new_provisioner
+        combined = config.dup
+        combined[:log_level] = Util.from_logger_level(logger.level)
+        Provisioner.for_plugin(combined[:provisioner], instance, combined)
+      end
+
       def build_ssh_args(state)
         combined = config.merge(state)
 
@@ -92,132 +93,37 @@ module Kitchen
         opts[:password] = combined[:password] if combined[:password]
         opts[:port] = combined[:port] if combined[:port]
         opts[:keys] = Array(combined[:ssh_key]) if combined[:ssh_key]
+        opts[:logger] = logger
 
         [combined[:hostname], combined[:username], opts]
       end
 
-      def chef_home
-        "/tmp/kitchen-chef-solo".freeze
-      end
-
-      def install_omnibus(ssh_args)
-        url = "https://www.opscode.com/chef/install.sh"
-        flag = config[:require_chef_omnibus]
-        version = if flag.is_a?(String) && flag != "latest"
-          "-s -- -v #{flag.downcase}"
-        else
-          ""
-        end
-
-        ssh(ssh_args, <<-INSTALL.gsub(/^ {10}/, ''))
-          should_update_chef() {
-            case "#{flag}" in
-              true|$(chef-solo -v | cut -d " " -f 2)) return 1 ;;
-              latest|*) return 0 ;;
-            esac
-          }
-
-          if [ ! -d "/opt/chef" ] || should_update_chef ; then
-            echo "-----> Installing Chef Omnibus (#{flag})"
-            if command -v wget >/dev/null ; then
-              wget #{url} -O - | #{cmd('bash')} #{version}
-            elif command -v curl >/dev/null ; then
-              curl -sSL #{url} | #{cmd('bash')} #{version}
-            else
-              echo ">>>>>> Neither wget nor curl found on this instance."
-              exit 1
-            fi
-          fi
-        INSTALL
-      end
-
-      def prepare_chef_home(ssh_args)
-        ssh(ssh_args, "#{cmd('rm')} -rf #{chef_home} && mkdir -p #{chef_home}/cache")
-      end
-
-      def upload_chef_data(ssh_args)
-        Kitchen::ChefDataUploader.new(
-          instance, ssh_args, config[:kitchen_root], chef_home
-        ).upload
-      end
-
-      def run_chef_solo(ssh_args)
-        ssh(ssh_args, <<-RUN_SOLO)
-          #{cmd('chef-solo')} -c #{chef_home}/solo.rb -j #{chef_home}/dna.json \
-            --log_level #{Util.from_logger_level(logger.level)}
-        RUN_SOLO
-      end
-
-      def ssh(ssh_args, cmd)
+      def env_cmd(cmd)
         env = "env"
-        if config[:http_proxy]
-          env << " http_proxy=#{config[:http_proxy]}"
-        end
-        if config[:https_proxy]
-          env << " https_proxy=#{config[:https_proxy]}"
-        end
-        if env != "env"
-          cmd = "#{env} #{cmd}"
-        end
-
-        debug("[SSH] #{ssh_args[1]}@#{ssh_args[0]} (#{cmd})")
-        Net::SSH.start(*ssh_args) do |ssh|
-          exit_code = ssh_exec_with_exit!(ssh, cmd)
+        env << " http_proxy=#{config[:http_proxy]}"   if config[:http_proxy]
+        env << " https_proxy=#{config[:https_proxy]}" if config[:https_proxy]
 
-          if exit_code != 0
-            shorter_cmd = cmd.squeeze(" ").strip
-            raise ActionFailed,
-              "SSH exited (#{exit_code}) for command: [#{shorter_cmd}]"
-          end
-        end
-      rescue Net::SSH::Exception => ex
-        raise ActionFailed, ex.message
+        env == "env" ? cmd : "#{env} #{cmd}"
       end
 
-      def ssh_exec_with_exit!(ssh, cmd)
-        exit_code = nil
-        ssh.open_channel do |channel|
+      def run_remote(command, connection)
+        return if command.nil?
 
-          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
-        ssh.loop
-        exit_code
+        connection.exec(env_cmd(command))
+      rescue SSHFailed, Net::SSH::Exception => ex
+        raise ActionFailed, ex.message
       end
 
-      def wait_for_sshd(hostname)
-        logger << "." until test_ssh(hostname)
-      end
+      def transfer_path(local, remote, connection)
+        return if local.nil?
 
-      def test_ssh(hostname)
-        socket = TCPSocket.new(hostname, config[: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
+        connection.upload_path!(local, remote)
+      rescue SSHFailed, Net::SSH::Exception => ex
+        raise ActionFailed, ex.message
       end
 
-      def cmd(script)
-        config[:sudo] ? "sudo -E #{script}" : script
+      def wait_for_sshd(*ssh_args)
+        SSH.new(*ssh_args).wait
       end
     end
   end

data/lib/kitchen/errors.rb

@@ -18,6 +18,9 @@
 
 module Kitchen
 
+  # All Kitchen errors and exceptions.
+  #
+  # @author Fletcher Nichol <fnichol@nichol.ca>
   module Error
 
     def self.formatted_trace(exception)

data/lib/kitchen/generator/init.rb

@@ -47,33 +47,12 @@ module Kitchen
         self.class.source_root(Kitchen.source_root.join("templates", "init"))
 
         create_kitchen_yaml
-
-        rakedoc = <<-RAKE.gsub(/^ {10}/, '')
-
-          begin
-            require 'kitchen/rake_tasks'
-            Kitchen::RakeTasks.new
-          rescue LoadError
-            puts ">>>>> Kitchen gem not loaded, omitting tasks" unless ENV['CI']
-          end
-        RAKE
-        append_to_file("Rakefile", rakedoc) if init_rakefile?
-
-        thordoc = <<-THOR.gsub(/^ {10}/, '')
-
-          begin
-            require 'kitchen/thor_tasks'
-            Kitchen::ThorTasks.new
-          rescue LoadError
-            puts ">>>>> Kitchen gem not loaded, omitting tasks" unless ENV['CI']
-          end
-        THOR
-        append_to_file("Thorfile", thordoc) if init_thorfile?
-
+        prepare_rakefile if init_rakefile?
+        prepare_thorfile if init_thorfile?
         empty_directory "test/integration/default" if init_test_dir?
         append_to_gitignore(".kitchen/")
         append_to_gitignore(".kitchen.local.yml")
-        prepare_gemfile if File.exists?("Gemfile") || options[:create_gemfile]
+        prepare_gemfile if init_gemfile?
         add_drivers
 
         if @display_bundle_msg
@@ -98,13 +77,18 @@ module Kitchen
         })
       end
 
+      def init_gemfile?
+        File.exists?(File.join(destination_root, "Gemfile")) ||
+          options[:create_gemfile]
+      end
+
       def init_rakefile?
-        File.exists?("Rakefile") &&
+        File.exists?(File.join(destination_root, "Rakefile")) &&
           not_in_file?("Rakefile", %r{require 'kitchen/rake_tasks'})
       end
 
       def init_thorfile?
-        File.exists?("Thorfile") &&
+        File.exists?(File.join(destination_root, "Thorfile")) &&
           not_in_file?("Thorfile", %r{require 'kitchen/thor_tasks'})
       end
 
@@ -112,10 +96,36 @@ module Kitchen
         Dir.glob("test/integration/*").select { |d| File.directory?(d) }.empty?
       end
 
+      def prepare_rakefile
+        rakedoc = <<-RAKE.gsub(/^ {10}/, '')
+
+          begin
+            require 'kitchen/rake_tasks'
+            Kitchen::RakeTasks.new
+          rescue LoadError
+            puts ">>>>> Kitchen gem not loaded, omitting tasks" unless ENV['CI']
+          end
+        RAKE
+        append_to_file(File.join(destination_root, "Rakefile"), rakedoc)
+      end
+
+      def prepare_thorfile
+        thordoc = <<-THOR.gsub(/^ {10}/, '')
+
+          begin
+            require 'kitchen/thor_tasks'
+            Kitchen::ThorTasks.new
+          rescue LoadError
+            puts ">>>>> Kitchen gem not loaded, omitting tasks" unless ENV['CI']
+          end
+        THOR
+        append_to_file(File.join(destination_root, "Thorfile"), thordoc)
+      end
+
       def append_to_gitignore(line)
-        create_file(".gitignore") unless File.exists?(".gitignore")
+        create_file(".gitignore") unless File.exists?(File.join(destination_root, ".gitignore"))
 
-        if IO.readlines(".gitignore").grep(%r{^#{line}}).empty?
+        if IO.readlines(File.join(destination_root, ".gitignore")).grep(%r{^#{line}}).empty?
           append_to_file(".gitignore", "#{line}\n")
         end
       end
@@ -126,7 +136,7 @@ module Kitchen
       end
 
       def create_gemfile_if_missing
-        unless File.exists?("Gemfile")
+        unless File.exists?(File.join(destination_root, "Gemfile"))
           create_file("Gemfile", %{source 'https://rubygems.org'\n\n})
         end
       end
@@ -144,7 +154,7 @@ module Kitchen
         display_warning = false
 
         Array(options[:driver]).each do |driver_gem|
-          if File.exists?("Gemfile") || options[:create_gemfile]
+          if File.exists?(File.join(destination_root, "Gemfile")) || options[:create_gemfile]
             add_driver_to_gemfile(driver_gem)
           else
             install_gem(driver_gem)
@@ -167,7 +177,7 @@ module Kitchen
       end
 
       def not_in_file?(filename, regexp)
-        IO.readlines(filename).grep(regexp).empty?
+        IO.readlines(File.join(destination_root, filename)).grep(regexp).empty?
       end
 
       def unbundlerize