test-kitchen 1.3.1 → 1.4.0.beta.1

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

@@ -0,0 +1,50 @@
+# -*- 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

@@ -0,0 +1,74 @@
+# -*- 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

@@ -0,0 +1,187 @@
+# -*- 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/lib/kitchen/verifier.rb

@@ -0,0 +1,55 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Fletcher Nichol (<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 "thor/util"
+
+require "kitchen/errors"
+
+module Kitchen
+
+  # A verifier is responsible for running tests post-converge to confirm that
+  # the instance is in a known/consistent state.
+  #
+  # @author Fletcher Nichol <fnichol@nichol.ca>
+  module Verifier
+
+    # Default verifier to use
+    DEFAULT_PLUGIN = "busser".freeze
+
+    # Returns an instance of a verifier given a plugin type string.
+    #
+    # @param plugin [String] a verifier plugin type, to be constantized
+    # @param config [Hash] a configuration hash to initialize the verifier
+    # @return [Verifier::Base] a verifier instance
+    # @raise [ClientError] if a verifier instance could not be created
+    def self.for_plugin(plugin, config)
+      first_load = require("kitchen/verifier/#{plugin}")
+
+      str_const = Thor::Util.camel_case(plugin)
+      klass = const_get(str_const)
+      object = klass.new(config)
+      object.verify_dependencies if first_load
+      object
+    rescue LoadError, NameError
+      raise ClientError,
+        "Could not load the '#{plugin}' verifier from the load path." \
+          " Please ensure that your transport is installed as a gem or" \
+          " included in your Gemfile if using Bundler."
+    end
+  end
+end

data/lib/kitchen/verifier/base.rb

@@ -0,0 +1,191 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Fletcher Nichol (<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 "kitchen/errors"
+require "kitchen/configurable"
+require "kitchen/logging"
+
+module Kitchen
+
+  module Verifier
+
+    # Base class for a verifier.
+    #
+    # @author Fletcher Nichol <fnichol@nichol.ca>
+    class Base
+
+      include Configurable
+      include Logging
+
+      default_config :http_proxy, nil
+
+      default_config :https_proxy, nil
+
+      default_config :root_path do |verifier|
+        verifier.windows_os? ? "$env:TEMP\\verifier" : "/tmp/verifier"
+      end
+
+      default_config :sudo do |verifier|
+        verifier.windows_os? ? nil : true
+      end
+
+      default_config(:suite_name) { |busser| busser.instance.suite.name }
+
+      # Creates a new Verifier object using the provided configuration data
+      # which will be merged with any default configuration.
+      #
+      # @param config [Hash] provided verifier configuration
+      def initialize(config = {})
+        init_config(config)
+      end
+
+      # Runs the verifier on the instance.
+      #
+      # @param state [Hash] mutable instance state
+      # @raise [ActionFailed] if the action could not be completed
+      def call(state)
+        create_sandbox
+        sandbox_dirs = Dir.glob(File.join(sandbox_path, "*"))
+
+        instance.transport.connection(state) do |conn|
+          conn.execute(install_command)
+          conn.execute(init_command)
+          info("Transferring files to #{instance.to_str}")
+          conn.upload(sandbox_dirs, config[:root_path])
+          debug("Transfer complete")
+          conn.execute(prepare_command)
+          conn.execute(run_command)
+        end
+      rescue Kitchen::Transport::TransportFailed => ex
+        raise ActionFailed, ex.message
+      ensure
+        cleanup_sandbox
+      end
+
+      # Deletes the sandbox path. Without calling this method, the sandbox path
+      # will persist after the process terminates. In other words, cleanup is
+      # explicit. This method is safe to call multiple times.
+      def cleanup_sandbox
+        return if sandbox_path.nil?
+
+        debug("Cleaning up local sandbox in #{sandbox_path}")
+        FileUtils.rmtree(sandbox_path)
+      end
+
+      # Creates a temporary directory on the local workstation into which
+      # verifier related files and directories can be copied or created. The
+      # contents of this directory will be copied over to the instance before
+      # invoking the verifier's run command. After this method completes, it
+      # is expected that the contents of the sandbox is complete and ready for
+      # copy to the remote instance.
+      #
+      # **Note:** any subclasses would be well advised to call super first when
+      # overriding this method, for example:
+      #
+      # @example overriding `#create_sandbox`
+      #
+      #   class MyVerifier < Kitchen::Verifier::Base
+      #     def create_sandbox
+      #       super
+      #       # any further file copies, preparations, etc.
+      #     end
+      #   end
+      def create_sandbox
+        @sandbox_path = Dir.mktmpdir("#{instance.name}-sandbox-")
+        File.chmod(0755, sandbox_path)
+        info("Preparing files for transfer")
+        debug("Creating local sandbox in #{sandbox_path}")
+      end
+
+      # Generates a command string which will install and configure the
+      # verifier software on an instance. If no work is required, then `nil`
+      # will be returned.
+      #
+      # @return [String] a command string
+      def install_command
+      end
+
+      # Generates a command string which will perform any data initialization
+      # or configuration required after the verifier software is installed
+      # but before the sandbox has been transferred to the instance. If no work
+      # is required, then `nil` will be returned.
+      #
+      # @return [String] a command string
+      def init_command
+      end
+
+      # Generates a command string which will perform any commands or
+      # configuration required just before the main verifier run command but
+      # after the sandbox has been transferred to the instance. If no work is
+      # required, then `nil` will be returned.
+      #
+      # @return [String] a command string
+      def prepare_command
+      end
+
+      # Generates a command string which will invoke the main verifier
+      # command on the prepared instance. If no work is required, then `nil`
+      # will be returned.
+      #
+      # @return [String] a command string
+      def run_command
+      end
+
+      # Returns the absolute path to the sandbox directory or raises an
+      # exception if `#create_sandbox` has not yet been called.
+      #
+      # @return [String] the absolute path to the sandbox directory
+      # @raise [ClientError] if the sandbox directory has no yet been created
+      #   by calling `#create_sandbox`
+      def sandbox_path
+        @sandbox_path || (raise ClientError, "Sandbox directory has not yet " \
+          "been created. Please run #{self.class}#create_sandox before " \
+          "trying to access the path.")
+      end
+
+      private
+
+      # Builds a complete command given a variables String preamble and a file
+      # containing shell code.
+      #
+      # @param vars [String] shell variables, as a String
+      # @param file [String] file basename (without extension) containing
+      #   shell code
+      # @return [String] command
+      # @api private
+      def shell_code_from_file(vars, file)
+        src_file = File.join(
+          File.dirname(__FILE__),
+          %w[.. .. .. support],
+          file + (powershell_shell? ? ".ps1" : ".sh")
+        )
+
+        wrap_shell_code([vars, "", IO.read(src_file)].join("\n"))
+      end
+
+      # Conditionally prefixes a command with a sudo command.
+      #
+      # @param command [String] command to be prefixed
+      # @return [String] the command, conditionaly prefixed with sudo
+      # @api private
+      def sudo(script)
+        config[:sudo] ? "sudo -E #{script}" : script
+      end
+    end
+  end
+end