test-kitchen 1.4.2 → 1.5.0.rc.1

data/lib/kitchen/verifier/shell.rb

@@ -0,0 +1,101 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: SAWANOBORI Yukihiko (<sawanoboriyu@higanworks.com>)
+#
+# Copyright (C) 2015, HiganWorks LLC
+#
+# 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/verifier/base"
+
+module Kitchen
+
+  module Verifier
+
+    # Shell verifier for Kitchen. This verifier just execute shell command from local.
+    #
+    # @author SAWANOBORI Yukihiko (<sawanoboriyu@higanworks.com>)
+    class Shell < Kitchen::Verifier::Base
+      require "mixlib/shellout"
+
+      kitchen_verifier_api_version 1
+
+      plugin_version Kitchen::VERSION
+
+      default_config :sleep, 0
+      default_config :command, "true"
+      default_config :shellout_opts, {}
+      default_config :live_stream, $stdout
+      default_config :remote_exec, false
+
+      # (see Base#call)
+      def call(state)
+        info("[#{name}] Verify on instance=#{instance} with state=#{state}")
+        sleep_if_set
+        merge_state_to_env(state)
+        if config[:remote_exec]
+          instance.transport.connection(state) do |conn|
+            conn.execute(config[:command])
+          end
+        else
+          shellout
+        end
+        debug("[#{name}] Verify completed.")
+      end
+
+      # for legacy drivers.
+      def run_command
+        if config[:remote_exec]
+          config[:command]
+        else
+          shellout
+          nil
+        end
+      end
+
+      private
+
+      # Sleep for a period of time, if a value is set in the config.
+      #
+      # @api private
+      def sleep_if_set
+        config[:sleep].to_i.times do
+          info(".")
+          sleep 1
+        end
+      end
+
+      def shellout
+        cmd = Mixlib::ShellOut.new(config[:command], config[:shellout_opts])
+        cmd.live_stream = config[:live_stream]
+        cmd.run_command
+        begin
+          cmd.error!
+        rescue Mixlib::ShellOut::ShellCommandFailed
+          raise ActionFailed, "Action #verify failed for #{instance.to_str}."
+        end
+      end
+
+      def merge_state_to_env(state)
+        env_state = { :environment => {} }
+        env_state[:environment]["KITCHEN_INSTANCE"] = instance.name
+        env_state[:environment]["KITCHEN_PLATFORM"] = instance.platform.name
+        env_state[:environment]["KITCHEN_SUITE"] = instance.suite.name
+        state.each_pair do |key, value|
+          env_state[:environment]["KITCHEN_" + key.to_s.upcase] = value
+        end
+        config[:shellout_opts].merge!(env_state)
+      end
+    end
+  end
+end

data/lib/kitchen/version.rb

@@ -18,5 +18,5 @@
 
 module Kitchen
 
-  VERSION = "1.4.2"
+  VERSION = "1.5.0.rc.1"
 end

data/spec/kitchen/configurable_spec.rb

@@ -727,6 +727,19 @@ describe Kitchen::Configurable do
 
     let(:cmd) { subject.send(:wrap_shell_code, "mkdir foo") }
 
+    before do
+      @original_env = ENV.to_hash
+      ENV.replace("http_proxy"  => nil, "HTTP_PROXY"  => nil,
+                  "https_proxy" => nil, "HTTPS_PROXY" => nil,
+                  "ftp_proxy"   => nil, "FTP_PROXY"   => nil,
+                  "no_proxy"    => nil, "NO_PROXY"    => nil)
+    end
+
+    after do
+      ENV.clear
+      ENV.replace(@original_env)
+    end
+
     describe "for bourne shells" do
 
       before { platform.stubs(:shell_type).returns("bourne") }
@@ -764,16 +777,121 @@ describe Kitchen::Configurable do
         CODE
       end
 
-      it "exports all http proxy variables when both are set" do
+      it "exports ftp_proxy & FTP_PROXY when :ftp_proxy is set" do
+        config[:ftp_proxy] = "ftp://proxy"
+
+        cmd.must_equal(outdent!(<<-CODE.chomp))
+          sh -c '
+          ftp_proxy="ftp://proxy"; export ftp_proxy
+          FTP_PROXY="ftp://proxy"; export FTP_PROXY
+          mkdir foo
+          '
+        CODE
+      end
+
+      it "exports all http proxy variables when all are set" do
         config[:http_proxy] = "http://proxy"
         config[:https_proxy] = "https://proxy"
+        config[:ftp_proxy] = "ftp://proxy"
+
+        cmd.must_equal(outdent!(<<-CODE.chomp))
+          sh -c '
+          http_proxy="http://proxy"; export http_proxy
+          HTTP_PROXY="http://proxy"; export HTTP_PROXY
+          https_proxy="https://proxy"; export https_proxy
+          HTTPS_PROXY="https://proxy"; export HTTPS_PROXY
+          ftp_proxy="ftp://proxy"; export ftp_proxy
+          FTP_PROXY="ftp://proxy"; export FTP_PROXY
+          mkdir foo
+          '
+        CODE
+      end
+
+      it "exports http_proxy & HTTP_PROXY from workstation when :http_proxy isn't set" do
+        ENV["http_proxy"] = "http://proxy"
+        ENV["HTTP_PROXY"] = "http://proxy"
+
+        cmd.must_equal(outdent!(<<-CODE.chomp))
+          sh -c '
+          http_proxy="http://proxy"; export http_proxy
+          HTTP_PROXY="http://proxy"; export HTTP_PROXY
+          mkdir foo
+          '
+        CODE
+      end
+
+      it "exports https_proxy & HTTPS_PROXY from workstation when :https_proxy isn't set" do
+        ENV["https_proxy"] = "https://proxy"
+        ENV["HTTPS_PROXY"] = "https://proxy"
+
+        cmd.must_equal(outdent!(<<-CODE.chomp))
+          sh -c '
+          https_proxy="https://proxy"; export https_proxy
+          HTTPS_PROXY="https://proxy"; export HTTPS_PROXY
+          mkdir foo
+          '
+        CODE
+      end
+
+      it "exports ftp_proxy & FTP_PROXY from workstation when :ftp_proxy isn't set" do
+        ENV["ftp_proxy"] = "ftp://proxy"
+        ENV["FTP_PROXY"] = "ftp://proxy"
+
+        cmd.must_equal(outdent!(<<-CODE.chomp))
+          sh -c '
+          ftp_proxy="ftp://proxy"; export ftp_proxy
+          FTP_PROXY="ftp://proxy"; export FTP_PROXY
+          mkdir foo
+          '
+        CODE
+      end
+
+      it "exports no_proxy & NO_PROXY from workstation when http_proxy is set from workstation" do
+        ENV["http_proxy"] = "http://proxy"
+        ENV["HTTP_PROXY"] = "http://proxy"
+        ENV["no_proxy"]   = "http://no"
+        ENV["NO_PROXY"]   = "http://no"
 
         cmd.must_equal(outdent!(<<-CODE.chomp))
           sh -c '
           http_proxy="http://proxy"; export http_proxy
           HTTP_PROXY="http://proxy"; export HTTP_PROXY
+          no_proxy="http://no"; export no_proxy
+          NO_PROXY="http://no"; export NO_PROXY
+          mkdir foo
+          '
+        CODE
+      end
+
+      it "exports no_proxy & NO_PROXY from workstation when https_proxy is set from workstation" do
+        ENV["https_proxy"] = "https://proxy"
+        ENV["HTTPS_PROXY"] = "https://proxy"
+        ENV["no_proxy"]   = "http://no"
+        ENV["NO_PROXY"]   = "http://no"
+
+        cmd.must_equal(outdent!(<<-CODE.chomp))
+          sh -c '
           https_proxy="https://proxy"; export https_proxy
           HTTPS_PROXY="https://proxy"; export HTTPS_PROXY
+          no_proxy="http://no"; export no_proxy
+          NO_PROXY="http://no"; export NO_PROXY
+          mkdir foo
+          '
+        CODE
+      end
+
+      it "exports no_proxy & NO_PROXY from workstation when ftp_proxy is set from workstation" do
+        ENV["ftp_proxy"]  = "ftp://proxy"
+        ENV["FTP_PROXY"]  = "ftp://proxy"
+        ENV["no_proxy"]   = "http://no"
+        ENV["NO_PROXY"]   = "http://no"
+
+        cmd.must_equal(outdent!(<<-CODE.chomp))
+          sh -c '
+          ftp_proxy="ftp://proxy"; export ftp_proxy
+          FTP_PROXY="ftp://proxy"; export FTP_PROXY
+          no_proxy="http://no"; export no_proxy
+          NO_PROXY="http://no"; export NO_PROXY
           mkdir foo
           '
         CODE
@@ -808,15 +926,106 @@ describe Kitchen::Configurable do
         CODE
       end
 
-      it "exports all http proxy variables when both are set" do
+      it "exports ftp_proxy & FTP_PROXY when :ftp_proxy is set" do
+        config[:ftp_proxy] = "ftp://proxy"
+
+        cmd.must_equal(outdent!(<<-CODE.chomp))
+          $env:ftp_proxy = "ftp://proxy"
+          $env:FTP_PROXY = "ftp://proxy"
+          mkdir foo
+        CODE
+      end
+
+      it "exports all http proxy variables when all are set" do
         config[:http_proxy] = "http://proxy"
         config[:https_proxy] = "https://proxy"
+        config[:ftp_proxy] = "ftp://proxy"
+
+        cmd.must_equal(outdent!(<<-CODE.chomp))
+          $env:http_proxy = "http://proxy"
+          $env:HTTP_PROXY = "http://proxy"
+          $env:https_proxy = "https://proxy"
+          $env:HTTPS_PROXY = "https://proxy"
+          $env:ftp_proxy = "ftp://proxy"
+          $env:FTP_PROXY = "ftp://proxy"
+          mkdir foo
+        CODE
+      end
+
+      it "exports http_proxy & HTTP_PROXY from workstation when :http_proxy isn't set" do
+        ENV["http_proxy"] = "http://proxy"
+        ENV["HTTP_PROXY"] = "http://proxy"
+
+        cmd.must_equal(outdent!(<<-CODE.chomp))
+          $env:http_proxy = "http://proxy"
+          $env:HTTP_PROXY = "http://proxy"
+          mkdir foo
+        CODE
+      end
+
+      it "exports https_proxy & HTTPS_PROXY from workstation when :https_proxy isn't set" do
+        ENV["https_proxy"] = "https://proxy"
+        ENV["HTTPS_PROXY"] = "https://proxy"
+
+        cmd.must_equal(outdent!(<<-CODE.chomp))
+          $env:https_proxy = "https://proxy"
+          $env:HTTPS_PROXY = "https://proxy"
+          mkdir foo
+        CODE
+      end
+
+      it "exports ftp_proxy & FTP_PROXY from workstation when :ftp_proxy isn't set" do
+        ENV["ftp_proxy"] = "ftp://proxy"
+        ENV["FTP_PROXY"] = "ftp://proxy"
+
+        cmd.must_equal(outdent!(<<-CODE.chomp))
+          $env:ftp_proxy = "ftp://proxy"
+          $env:FTP_PROXY = "ftp://proxy"
+          mkdir foo
+        CODE
+      end
+
+      it "exports no_proxy & NO_PROXY from workstation when http_proxy is set from workstation" do
+        ENV["http_proxy"] = "http://proxy"
+        ENV["HTTP_PROXY"] = "http://proxy"
+        ENV["no_proxy"]   = "http://no"
+        ENV["NO_PROXY"]   = "http://no"
 
         cmd.must_equal(outdent!(<<-CODE.chomp))
           $env:http_proxy = "http://proxy"
           $env:HTTP_PROXY = "http://proxy"
+          $env:no_proxy = "http://no"
+          $env:NO_PROXY = "http://no"
+          mkdir foo
+        CODE
+      end
+
+      it "exports no_proxy & NO_PROXY from workstation when https_proxy is set from workstation" do
+        ENV["https_proxy"] = "https://proxy"
+        ENV["HTTPS_PROXY"] = "https://proxy"
+        ENV["no_proxy"]   = "http://no"
+        ENV["NO_PROXY"]   = "http://no"
+
+        cmd.must_equal(outdent!(<<-CODE.chomp))
           $env:https_proxy = "https://proxy"
           $env:HTTPS_PROXY = "https://proxy"
+          $env:no_proxy = "http://no"
+          $env:NO_PROXY = "http://no"
+          mkdir foo
+        CODE
+      end
+
+      it "exports no_proxy & NO_PROXY from workstation when ftp_proxy is set from workstation" do
+        ENV["ftp_proxy"] = "ftp://proxy"
+        ENV["FTP_PROXY"] = "ftp://proxy"
+        ENV["no_proxy"]   = "http://no"
+        ENV["NO_PROXY"]   = "http://no"
+
+        cmd.must_equal(outdent!(<<-CODE.chomp))
+          $env:ftp_proxy = "ftp://proxy"
+          $env:FTP_PROXY = "ftp://proxy"
+          $env:no_proxy = "http://no"
+          $env:NO_PROXY = "http://no"
           mkdir foo
         CODE
       end

data/spec/kitchen/driver/ssh_base_spec.rb

@@ -288,11 +288,18 @@ describe Kitchen::Driver::SSHBase do
       provisioner.stubs(:[]).with(:root_path).returns("/rooty")
       FakeFS.activate!
       FileUtils.mkdir_p("/tmp")
+      @original_env = ENV.to_hash
+      ENV.replace("http_proxy"  => nil, "HTTP_PROXY"  => nil,
+                  "https_proxy" => nil, "HTTPS_PROXY" => nil,
+                  "ftp_proxy"   => nil, "FTP_PROXY"   => nil,
+                  "no_proxy"    => nil, "NO_PROXY"    => nil)
     end
 
     after do
       FakeFS.deactivate!
       FakeFS::FileSystem.clear
+      ENV.clear
+      ENV.replace(@original_env)
     end
 
     constructs_an_ssh_connection
@@ -333,6 +340,33 @@ describe Kitchen::Driver::SSHBase do
       cmd
     end
 
+    it "invokes the #install_command with ENV[\"http_proxy\"] set" do
+      ENV["http_proxy"] = "http://proxy"
+      transport.stubs(:connection).yields(connection)
+      if running_tests_on_windows?
+        connection.expects(:execute).
+          with("env http_proxy=http://proxy HTTP_PROXY=http://proxy install")
+      else
+        connection.expects(:execute).with("env http_proxy=http://proxy install")
+      end
+      cmd
+    end
+
+    it "invokes the #install_command with ENV[\"http_proxy\"] and ENV[\"no_proxy\"] set" do
+      ENV["http_proxy"] = "http://proxy"
+      ENV["no_proxy"]   = "http://no"
+      transport.stubs(:connection).yields(connection)
+      if running_tests_on_windows?
+        connection.expects(:execute).
+          with("env http_proxy=http://proxy HTTP_PROXY=http://proxy " \
+            "no_proxy=http://no NO_PROXY=http://no install")
+      else
+        connection.expects(:execute).with("env http_proxy=http://proxy " \
+          "no_proxy=http://no install")
+      end
+      cmd
+    end
+
     it "invokes the #install_command with :https_proxy set in config" do
       config[:https_proxy] = "https://proxy"
       transport.stubs(:connection).yields(connection)
@@ -341,12 +375,75 @@ describe Kitchen::Driver::SSHBase do
       cmd
     end
 
-    it "invokes the #install_command with :http_proxy & :https_proxy set" do
+    it "invokes the #install_command with ENV[\"https_proxy\"] set" do
+      ENV["https_proxy"] = "https://proxy"
+      transport.stubs(:connection).yields(connection)
+      if running_tests_on_windows?
+        connection.expects(:execute).
+          with("env https_proxy=https://proxy HTTPS_PROXY=https://proxy install")
+      else
+        connection.expects(:execute).with("env https_proxy=https://proxy install")
+      end
+      cmd
+    end
+
+    it "invokes the #install_command with ENV[\"https_proxy\"] and ENV[\"no_proxy\"] set" do
+      ENV["https_proxy"] = "https://proxy"
+      ENV["no_proxy"]    = "https://no"
+      transport.stubs(:connection).yields(connection)
+      if running_tests_on_windows?
+        connection.expects(:execute).
+          with("env https_proxy=https://proxy HTTPS_PROXY=https://proxy " \
+          "no_proxy=https://no NO_PROXY=https://no install")
+      else
+        connection.expects(:execute).with("env https_proxy=https://proxy " \
+          "no_proxy=https://no install")
+      end
+      cmd
+    end
+
+    it "invokes the #install_command with :ftp_proxy set in config" do
+      config[:ftp_proxy] = "ftp://proxy"
+      transport.stubs(:connection).yields(connection)
+      connection.expects(:execute).with("env ftp_proxy=ftp://proxy install")
+
+      cmd
+    end
+
+    it "invokes the #install_command with ENV[\"ftp_proxy\"] set" do
+      ENV["ftp_proxy"] = "ftp://proxy"
+      transport.stubs(:connection).yields(connection)
+      if running_tests_on_windows?
+        connection.expects(:execute).
+          with("env ftp_proxy=ftp://proxy FTP_PROXY=ftp://proxy install")
+      else
+        connection.expects(:execute).with("env ftp_proxy=ftp://proxy install")
+      end
+      cmd
+    end
+
+    it "invokes the #install_command with ENV[\"ftp_proxy\"] and ENV[\"no_proxy\"] set" do
+      ENV["ftp_proxy"]  = "ftp://proxy"
+      ENV["no_proxy"]   = "http://no"
+      transport.stubs(:connection).yields(connection)
+      if running_tests_on_windows?
+        connection.expects(:execute).
+          with("env ftp_proxy=ftp://proxy FTP_PROXY=http://proxy " \
+            "no_proxy=http://no NO_PROXY=http://no install")
+      else
+        connection.expects(:execute).with("env ftp_proxy=ftp://proxy " \
+          "no_proxy=http://no install")
+      end
+      cmd
+    end
+
+    it "invokes the #install_command with :http_proxy & :https_proxy & :ftp_proxy set" do
       config[:http_proxy] = "http://proxy"
       config[:https_proxy] = "https://proxy"
+      config[:ftp_proxy] = "ftp://proxy"
       transport.stubs(:connection).yields(connection)
       connection.expects(:execute).with(
-        "env http_proxy=http://proxy https_proxy=https://proxy install")
+        "env http_proxy=http://proxy https_proxy=https://proxy ftp_proxy=ftp://proxy install")
 
       cmd
     end
@@ -428,12 +525,21 @@ describe Kitchen::Driver::SSHBase do
       cmd
     end
 
-    it "invokes the Verifier#install_command with :http_proxy & :https_proxy set" do
+    it "invokes the Verifier#install_command with :ftp_proxy set in config" do
+      config[:ftp_proxy] = "ftp://proxy"
+      transport.stubs(:connection).yields(connection)
+      connection.expects(:execute).with("env ftp_proxy=ftp://proxy install")
+
+      cmd
+    end
+
+    it "invokes the Verifier#install_command with :http_proxy & :https_proxy & :ftp_proxy set" do
       config[:http_proxy] = "http://proxy"
       config[:https_proxy] = "https://proxy"
+      config[:ftp_proxy] = "ftp://proxy"
       transport.stubs(:connection).yields(connection)
       connection.expects(:execute).with(
-        "env http_proxy=http://proxy https_proxy=https://proxy install")
+        "env http_proxy=http://proxy https_proxy=https://proxy ftp_proxy=ftp://proxy install")
 
       cmd
     end
@@ -505,11 +611,19 @@ describe Kitchen::Driver::SSHBase do
         cmd
       end
 
-      it "invokes Verifier##{phase}_command with :http_proxy & :https_proxy set" do
+      it "invokes Verifier##{phase}_command with :ftp_proxy set in config" do
+        config[:ftp_proxy] = "ftp://proxy"
+        connection.expects(:execute).with("env ftp_proxy=ftp://proxy #{phase}")
+
+        cmd
+      end
+
+      it "invokes Verifier##{phase}_command with :http_proxy & :https_proxy & :ftp_proxy set" do
         config[:http_proxy] = "http://proxy"
         config[:https_proxy] = "https://proxy"
+        config[:ftp_proxy] = "ftp://proxy"
         connection.expects(:execute).with(
-          "env http_proxy=http://proxy https_proxy=https://proxy #{phase}")
+          "env http_proxy=http://proxy https_proxy=https://proxy ftp_proxy=ftp://proxy #{phase}")
 
         cmd
       end
@@ -919,12 +1033,21 @@ describe Kitchen::Driver::SSHBase do
         cmd
       end
 
-      it "invokes the #install_command with :http_proxy & :https_proxy set" do
+      it "invokes the #install_command with :ftp_proxy set in config" do
+        config[:ftp_proxy] = "ftp://proxy"
+        Kitchen::SSH.stubs(:new).returns(connection)
+        connection.expects(:exec).with("env ftp_proxy=ftp://proxy huh")
+
+        cmd
+      end
+
+      it "invokes the #install_command with :http_proxy & :https_proxy & :ftp_proxy set" do
         config[:http_proxy] = "http://proxy"
         config[:https_proxy] = "https://proxy"
+        config[:ftp_proxy] = "ftp://proxy"
         Kitchen::SSH.stubs(:new).returns(connection)
         connection.expects(:exec).with(
-          "env http_proxy=http://proxy https_proxy=https://proxy huh")
+          "env http_proxy=http://proxy https_proxy=https://proxy ftp_proxy=ftp://proxy huh")
 
         cmd
       end