test-kitchen 1.4.0.beta.2 → 1.4.0.rc.1

data/lib/kitchen/transport/winrm/logging.rb

@@ -1,50 +0,0 @@
-# -*- encoding: utf-8 -*-
-#
-# Author:: Fletcher (<fnichol@nichol.ca>)
-#
-# Copyright (C) 2015, 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.
-
-module Kitchen
-
-  module Transport
-
-    class Winrm < Kitchen::Transport::Base
-
-      # Mixin to use an optionally provided logger for logging.
-      #
-      # @author Fletcher Nichol <fnichol@nichol.ca>
-      module Logging
-
-        # Logs a message on the logger at the debug level, if a logger is
-        # present.
-        #
-        # @param msg [String] a message to log
-        # @yield evaluates and uses return value as message to log. If msg
-        #   parameter is set, it will take precedence over the block.
-        def debug(msg = nil, &block)
-          return if logger.nil? || !logger.debug?
-          logger.debug("[#{log_subject}] " << (msg || block.call))
-        end
-
-        # The subject for log messages.
-        #
-        # @return [String] log subject
-        def log_subject
-          @log_subject ||= self.class.to_s.split("::").last
-        end
-      end
-    end
-  end
-end

data/lib/kitchen/transport/winrm/template.rb

@@ -1,74 +0,0 @@
-# -*- encoding: utf-8 -*-
-#
-# Author:: Fletcher (<fnichol@nichol.ca>)
-#
-# Copyright (C) 2015, 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 "erb"
-require "ostruct"
-
-module Kitchen
-
-  module Transport
-
-    class Winrm < Kitchen::Transport::Base
-
-      # Wraps an ERb template which can be called multiple times with
-      # different binding contexts.
-      #
-      # @author Fletcher Nichol <fnichol@nichol.ca>
-      # @api private
-      class Template
-
-        # Initializes an ERb template using a file as the template source.
-        #
-        # @param file [String] path to an ERb template file
-        def initialize(file)
-          @erb = ERB.new(IO.read(file))
-        end
-
-        # Renders the template using a hash as context.
-        #
-        # @param vars [Hash] a hash used for context
-        # @return [String] the rendered template
-        def render(vars)
-          @erb.result(Context.for(vars))
-        end
-        alias_method :%, :render
-
-        # Internal class which wraps a binding context for rendering
-        # an ERb template.
-        #
-        # @author Fletcher Nichol <fnichol@nichol.ca>
-        # @api private
-        class Context < OpenStruct
-
-          # Creates a new binding context for a hash of data.
-          #
-          # @param vars [Hash] a hash used for context
-          # @return [Binding] a binding context for the given hash
-          def self.for(vars)
-            new(vars).my_binding
-          end
-
-          # @return [Binding] a binding context
-          def my_binding
-            binding
-          end
-        end
-      end
-    end
-  end
-end

data/lib/kitchen/transport/winrm/tmp_zip.rb

@@ -1,187 +0,0 @@
-# -*- encoding: utf-8 -*-
-#
-# Author:: Fletcher (<fnichol@nichol.ca>)
-#
-# Copyright (C) 2015, 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 "delegate"
-require "pathname"
-require "tempfile"
-require "zip"
-
-require "kitchen/transport/winrm/logging"
-
-module Kitchen
-
-  module Transport
-
-    class Winrm < Kitchen::Transport::Base
-
-      # A temporary Zip file for a given directory.
-      #
-      # @author Fletcher Nichol <fnichol@nichol.ca>
-      class TmpZip
-
-        include Logging
-
-        # Contructs a new Zip file for the given directory.
-        #
-        # There are 2 ways to interpret the directory path:
-        #
-        # * If the directory has no path separator terminator, then the
-        #   directory basename will be used as the base directory in the
-        #   resulting zip file.
-        # * If the directory has a path separator terminator (such as `/` or
-        #   `\\`), then the entries under the directory will be added to the
-        #   resulting zip file.
-        #
-        # The following emaples assume a directory tree structure of:
-        #
-        #     src
-        #     |-- alpha.txt
-        #     |-- beta.txt
-        #     \-- sub
-        #         \-- charlie.txt
-        #
-        # @example Including the base directory in the zip file
-        #
-        #   TmpZip.new("/path/to/src")
-        #   # produces a zip file with entries:
-        #   # - src/alpha.txt
-        #   # - src/beta.txt
-        #   # - src/sub/charlie.txt
-        #
-        # @example Excluding the base directory in the zip file
-        #
-        #   TmpZip.new("/path/to/src/")
-        #   # produces a zip file with entries:
-        #   # - alpha.txt
-        #   # - beta.txt
-        #   # - sub/charlie.txt
-        #
-        # @param dir [String,Pathname,#to_s] path to the directory
-        # @param logger [#debug,#debug?] an optional logger/ui object that
-        #   responds to `#debug` and `#debug?` (default `nil`)
-        def initialize(dir, logger = nil)
-          @logger = logger
-          @dir = Pathname.new(dir)
-          @method = ::Zip::Entry::DEFLATED
-          @compression = Zlib::BEST_COMPRESSION
-          @zip_io = Tempfile.open(["tmpzip-", ".zip"], :binmode => true)
-          write_zip
-          @zip_io.close
-        end
-
-        # @return [Pathname] path to zip file
-        def path
-          Pathname.new(zip_io.path) if zip_io.path
-        end
-
-        # Unlinks (deletes) the zip file from the filesystem.
-        def unlink
-          zip_io.unlink
-        end
-
-        private
-
-        # @return [Integer] the compression used for Zip entries. Possible
-        #   values are `Zlib::BEST_COMPRESSION`, `Zlib::DEFAULT_COMPRESSION`,
-        #   and `Zlib::NO_COMPRESSION`.
-        # @api private
-        attr_reader :compression
-
-        # @return [Pathname] the directory used to create the Zip file
-        # @api private
-        attr_reader :dir
-
-        # @return [#debug] the logger
-        # @api private
-        attr_reader :logger
-
-        # @return [Integer] compression method used for Zip entries. Possible
-        #   values are `Zip::Entry::DEFLATED` and `Zip::Entry::STORED`.
-        # @api private
-        attr_reader :method
-
-        # @return [IO] the Zip file IO
-        # @api private
-        attr_reader :zip_io
-
-        # @return [Pathname] the path segement to be stripped off Zip entries
-        # @api private
-        def dir_strip
-          @dir_strip ||= if dir.to_s.end_with?("/", "\\")
-            Pathname.new(dir.to_s.chop)
-          else
-            dir.dirname
-          end
-        end
-
-        # @return [Array<Pathname] all recursive files under the base
-        #   directory, excluding directories
-        # @api private
-        def entries
-          Pathname.glob(dir.join("**/*")).delete_if(&:directory?).sort
-        end
-
-        # (see Logging.log_subject)
-        # @api private
-        def log_subject
-          @log_subject ||= [self.class.to_s.split("::").last, path].join("::")
-        end
-
-        # Adds all file entries to the Zip output stream.
-        #
-        # @param zos [Zip::OutputStream] zip output stream
-        # @api private
-        def produce_zip_entries(zos)
-          entries.each do |entry|
-            entry_path = entry.sub("#{dir_strip}/", "")
-            debug { "+++ Adding #{entry_path}" }
-            zos.put_next_entry(entry_path, nil, nil, method, compression)
-            entry.open("rb") { |src| IO.copy_stream(src, zos) }
-          end
-          debug { "=== All files added." }
-        end
-
-        # Writes out a temporary Zip file.
-        #
-        # @api private
-        def write_zip
-          debug { "Populating files" }
-          Zip::OutputStream.write_buffer(NoDupIO.new(zip_io)) do |zos|
-            produce_zip_entries(zos)
-          end
-        end
-
-        # Simple delegate wrapper to prevent `#dup` calls being made on IO
-        # objects. This is used to bypass an issue in the `Zip::Outputstream`
-        # constructor where an incoming IO is duplicated, leading to races
-        # on flushing the final stream to disk.
-        #
-        # @author Fletcher Nichol <fnichol@nichol.ca>
-        # @api private
-        class NoDupIO < SimpleDelegator
-
-          # @return [self] returns self and does *not* return a duplicate
-          #   object
-          def dup
-            self
-          end
-        end
-      end
-    end
-  end
-end

data/spec/kitchen/transport/winrm/command_executor_spec.rb

@@ -1,400 +0,0 @@
-# -*- encoding: utf-8 -*-
-#
-# Author:: Fletcher (<fnichol@nichol.ca>)
-#
-# Copyright (C) 2015, 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_relative "../../../spec_helper"
-
-require "kitchen"
-require "kitchen/transport/winrm/command_executor"
-
-require "base64"
-require "securerandom"
-require "winrm"
-
-describe Kitchen::Transport::Winrm::CommandExecutor do
-
-  let(:logged_output)   { StringIO.new }
-  let(:logger)          { Logger.new(logged_output) }
-  let(:shell_id)        { "shell-123" }
-
-  let(:executor) do
-    Kitchen::Transport::Winrm::CommandExecutor.new(service, logger)
-  end
-
-  let(:service) do
-    s = mock("winrm_service")
-    s.responds_like_instance_of(WinRM::WinRMWebService)
-    s
-  end
-
-  let(:version_output) do
-    o = WinRM::Output.new
-    o[:exitcode] = 0
-    o[:data].concat([{ :stdout => "6.3.9600.0\r\n" }])
-    o
-  end
-
-  before do
-    service.stubs(:open_shell).returns(shell_id)
-
-    stub_powershell_script(shell_id,
-      "[environment]::OSVersion.Version.tostring()", version_output)
-  end
-
-  describe "#close" do
-
-    it "calls service#close_shell" do
-      executor.open
-      service.expects(:close_shell).with(shell_id)
-
-      executor.close
-    end
-
-    it "only calls service#close_shell once for multiple calls" do
-      executor.open
-      service.expects(:close_shell).with(shell_id).once
-
-      executor.close
-      executor.close
-      executor.close
-    end
-  end
-
-  describe "#open" do
-
-    it "calls service#open_shell" do
-      service.expects(:open_shell).returns(shell_id)
-
-      executor.open
-    end
-
-    it "returns a shell id as a string" do
-      executor.open.must_equal shell_id
-    end
-
-    describe "for modern windows distributions" do
-
-      let(:version_output) do
-        o = WinRM::Output.new
-        o[:exitcode] = 0
-        o[:data].concat([{ :stdout => "6.3.9600.0\r\n" }])
-        o
-      end
-
-      it "sets #max_commands to 1500 - 2" do
-        executor.max_commands.must_equal nil
-        executor.open
-
-        executor.max_commands.must_equal(1500 - 2)
-      end
-    end
-
-    describe "for older/legacy windows distributions" do
-
-      let(:version_output) do
-        o = WinRM::Output.new
-        o[:exitcode] = 0
-        o[:data].concat([{ :stdout => "6.1.8500.0\r\n" }])
-        o
-      end
-
-      it "sets #max_commands to 15 - 2" do
-        executor.max_commands.must_equal nil
-        executor.open
-
-        executor.max_commands.must_equal(15 - 2)
-      end
-    end
-  end
-
-  describe "#run_cmd" do
-
-    describe "when #open has not been previously called" do
-
-      it "raises a WinRMError error" do
-        err = proc { executor.run_cmd("nope") }.must_raise WinRM::WinRMError
-        err.message.must_equal "#{executor.class}#open must be called " \
-          "before any run methods are invoked"
-      end
-    end
-
-    describe "when #open has been previously called" do
-
-      let(:command_id) { "command-123" }
-
-      let(:echo_output) do
-        o = WinRM::Output.new
-        o[:exitcode] = 0
-        o[:data].concat([
-          { :stdout => "Hello\r\n" },
-          { :stderr => "Psst\r\n" }
-        ])
-        o
-      end
-
-      before do
-        stub_cmd(shell_id, "echo", ["Hello"], echo_output, command_id)
-
-        executor.open
-      end
-
-      it "calls service#run_command" do
-        service.expects(:run_command).with(shell_id, "echo", ["Hello"])
-
-        executor.run_cmd("echo", ["Hello"])
-      end
-
-      it "calls service#get_command_output to get results" do
-        service.expects(:get_command_output).with(shell_id, command_id)
-
-        executor.run_cmd("echo", ["Hello"])
-      end
-
-      it "calls service#get_command_output with a block to get results" do
-        blk = proc { |_, _| "something" }
-        service.expects(:get_command_output).with(shell_id, command_id, &blk)
-
-        executor.run_cmd("echo", ["Hello"], &blk)
-      end
-
-      it "returns an Output object hash" do
-        executor.run_cmd("echo", ["Hello"]).must_equal echo_output
-      end
-
-      it "runs the block  in #get_command_output when given" do
-        io_out = StringIO.new
-        io_err = StringIO.new
-
-        output = executor.run_cmd("echo", ["Hello"]) do |stdout, stderr|
-          io_out << stdout if stdout
-          io_err << stderr if stderr
-        end
-
-        io_out.string.must_equal "Hello\r\n"
-        io_err.string.must_equal "Psst\r\n"
-        output.must_equal echo_output
-      end
-    end
-
-    describe "when called many times over time" do
-
-      # use a "old" version of windows with lower max_commands threshold
-      # to trigger quicker shell recyles
-      let(:version_output) do
-        o = WinRM::Output.new
-        o[:exitcode] = 0
-        o[:data].concat([{ :stdout => "6.1.8500.0\r\n" }])
-        o
-      end
-
-      let(:echo_output) do
-        o = WinRM::Output.new
-        o[:exitcode] = 0
-        o[:data].concat([{ :stdout => "Hello\r\n" }])
-        o
-      end
-
-      before do
-        service.stubs(:open_shell).returns("s1", "s2")
-        service.stubs(:close_shell)
-        service.stubs(:run_command).yields("command-xxx")
-        service.stubs(:get_command_output).returns(echo_output)
-        stub_powershell_script("s1",
-          "[environment]::OSVersion.Version.tostring()", version_output)
-      end
-
-      it "resets the shell when #max_commands threshold is tripped" do
-        iterations = 35
-        reset_times = iterations / (15 - 2)
-
-        service.expects(:close_shell).times(reset_times)
-        executor.open
-        iterations.times { executor.run_cmd("echo", ["Hello"]) }
-
-        logged_output.string.lines.select { |l|
-          l =~ debug_line_with("[CommandExecutor] Resetting WinRM shell")
-        }.size.must_equal reset_times
-      end
-    end
-  end
-
-  describe "#run_powershell_script" do
-
-    describe "when #open has not been previously called" do
-
-      it "raises a WinRMError error" do
-        err = proc {
-          executor.run_powershell_script("nope")
-        }.must_raise WinRM::WinRMError
-        err.message.must_equal "#{executor.class}#open must be called " \
-          "before any run methods are invoked"
-      end
-    end
-
-    describe "when #open has been previously called" do
-
-      let(:command_id) { "command-123" }
-
-      let(:echo_output) do
-        o = WinRM::Output.new
-        o[:exitcode] = 0
-        o[:data].concat([
-          { :stdout => "Hello\r\n" },
-          { :stderr => "Psst\r\n" }
-        ])
-        o
-      end
-
-      before do
-        stub_powershell_script(shell_id, "echo Hello", echo_output, command_id)
-
-        executor.open
-      end
-
-      it "calls service#run_command" do
-        service.expects(:run_command).with(
-          shell_id,
-          "powershell",
-          ["-encodedCommand", WinRM::PowershellScript.new("echo Hello").encoded]
-        )
-
-        executor.run_powershell_script("echo Hello")
-      end
-
-      it "calls service#get_command_output to get results" do
-        service.expects(:get_command_output).with(shell_id, command_id)
-
-        executor.run_powershell_script("echo Hello")
-      end
-
-      it "calls service#get_command_output with a block to get results" do
-        blk = proc { |_, _| "something" }
-        service.expects(:get_command_output).with(shell_id, command_id, &blk)
-
-        executor.run_powershell_script("echo Hello", &blk)
-      end
-
-      it "returns an Output object hash" do
-        executor.run_powershell_script("echo Hello").must_equal echo_output
-      end
-
-      it "runs the block  in #get_command_output when given" do
-        io_out = StringIO.new
-        io_err = StringIO.new
-
-        output = executor.run_powershell_script("echo Hello") do |stdout, stderr|
-          io_out << stdout if stdout
-          io_err << stderr if stderr
-        end
-
-        io_out.string.must_equal "Hello\r\n"
-        io_err.string.must_equal "Psst\r\n"
-        output.must_equal echo_output
-      end
-    end
-
-    describe "when called many times over time" do
-
-      # use a "old" version of windows with lower max_commands threshold
-      # to trigger quicker shell recyles
-      let(:version_output) do
-        o = WinRM::Output.new
-        o[:exitcode] = 0
-        o[:data].concat([{ :stdout => "6.1.8500.0\r\n" }])
-        o
-      end
-
-      let(:echo_output) do
-        o = WinRM::Output.new
-        o[:exitcode] = 0
-        o[:data].concat([{ :stdout => "Hello\r\n" }])
-        o
-      end
-
-      before do
-        service.stubs(:open_shell).returns("s1", "s2")
-        service.stubs(:close_shell)
-        service.stubs(:run_command).yields("command-xxx")
-        service.stubs(:get_command_output).returns(echo_output)
-        stub_powershell_script("s1",
-          "[environment]::OSVersion.Version.tostring()", version_output)
-      end
-
-      it "resets the shell when #max_commands threshold is tripped" do
-        iterations = 35
-        reset_times = iterations / (15 - 2)
-
-        service.expects(:close_shell).times(reset_times)
-        executor.open
-        iterations.times { executor.run_powershell_script("echo Hello") }
-
-        logged_output.string.lines.select { |l|
-          l =~ debug_line_with("[CommandExecutor] Resetting WinRM shell")
-        }.size.must_equal reset_times
-      end
-    end
-  end
-
-  describe "#shell" do
-
-    it "is initially nil" do
-      executor.shell.must_equal nil
-    end
-
-    it "is set after #open is called" do
-      executor.open
-
-      executor.shell.must_equal shell_id
-    end
-  end
-
-  def decode(powershell)
-    Base64.strict_decode64(powershell).encode("UTF-8", "UTF-16LE")
-  end
-
-  def debug_line_with(msg)
-    %r{^D, .* : #{Regexp.escape(msg)}}
-  end
-
-  def regexify(string)
-    Regexp.new(Regexp.escape(string))
-  end
-
-  def regexify_line(string)
-    Regexp.new("^#{Regexp.escape(string)}$")
-  end
-
-  # rubocop:disable Metrics/ParameterLists
-  def stub_cmd(shell_id, cmd, args, output, command_id = nil, &block)
-    command_id ||= SecureRandom.uuid
-
-    service.stubs(:run_command).with(shell_id, cmd, args).yields(command_id)
-    service.stubs(:get_command_output).with(shell_id, command_id, &block).
-      yields(output.stdout, output.stderr).returns(output)
-  end
-
-  def stub_powershell_script(shell_id, script, output, command_id = nil)
-    stub_cmd(
-      shell_id,
-      "powershell",
-      ["-encodedCommand", WinRM::PowershellScript.new(script).encoded],
-      output,
-      command_id
-    )
-  end
-  # rubocop:enable Metrics/ParameterLists
-end