kitchen-binding 0.2.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.ruby-version

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in kitchen-vagrant.gemspec
+gemspec
+
+group :test do
+  gem 'rake'
+end

data/LICENSE

@@ -0,0 +1,15 @@
+Author:: Jacob McCann (<jmccann.git@gmail.com>)
+
+Copyright (C) 2014, Jacob McCann
+
+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.

data/README.md

@@ -0,0 +1,100 @@
+kitchen-binding
+===============
+
+kitchen-binding is an extension to [test-kitchen](https://github.com/test-kitchen/test-kitchen) to allow setting breakpoints in your cookbooks.  When encountered during a converge test-kitchen will then login to an interactive ruby shell for your debugging pleasure.  When you are finished the converge will continue where it left of.  It will continue to pickup any other breakpoints you may have setup through the run as well.
+
+A product from discussion @ [Chef Summit 2014](https://github.com/opscode/chef-summit-2014/wiki/friday_metropolitan_1000)
+
+Try It Out
+----------
+Check out what it does with the help of my cookbook [tk-bindings](https://github.com/jmccann/tk-bindings).  Make sure to adhear to the [Pre-Setup for Ruby](https://github.com/jmccann/kitchen-binding#ruby-version-dependencies) below first.  The other items are already in the .kitchen.yml for tk-bindings.
+
+Pre-Setup
+---------
+
+Currently there is some required pre-setup you will need to do in order to use this extension.
+
+### Instance Networking
+
+The instance must currently have a 33.33.33.200 IP accessbile from the host as this is currently hardcoded.  This is one of the first things I plan on working to address.
+
+#### Vagrant
+If you are using a vagrant driver you will need to have a virtual private newtwork setup on the guest with an IP.  This is a requirement for the default binding plugin 'pry-remote' as pry-remote's dependencies use RPC which eventually uses a random port that you can not dynamically create a port forward for (or atleast not easily).  An idea to make this easier would be to setup a virtual private network for all of your vagrant instances by setting the following in your ~/.kitchen/config.yml
+
+```ruby
+driver:
+  network:
+  - ["private_network", {ip: "33.33.33.200"}]
+```
+
+### Ruby Version Dependencies
+The version of uby you use on your host system must match the version of ruby being used by Chef in the instance.  This is ruby 1.9.3-p547 for Chef 11.  This is a requirement because DRB libraries used by 'pry-remote' do not seem compatible across ruby versions.
+
+This can be easily controlled by using a ruby version/environment manager.
+
+#### rbenv
+If you use rbenv with ruby-build
+
+Install needed ruby:
+```
+rbenv install 1.9.3-p547
+```
+
+Then while inside the repo for the cookbook you want to test pin the repo version specifically for that cookbook:
+```
+rbenv local 1.9.3-p547
+```
+
+Then you'll probably need to install bundler and/or the required gems:
+```
+gem install bundler
+bundle install
+```
+
+How to Use
+----------
+
+The default remote binding supported is [pry-remote](https://github.com/Mon-Ouie/pry-remote).  Add anywhere in your Chef rubies code the following:
+
+```ruby
+require 'pry-remote'
+binding.remote_pry '0.0.0.0'
+```
+
+This will insert a breakpoint into the code that will start a pry-remote server listening on all addresses (by default it listens only on localhost).
+
+Setup your Gemfile for your cookbook with the line:
+
+```
+gem 'kitchen-binding'
+```
+
+Then finally you need to add some ERB to your .kitchen.yml to load the library:
+
+```ruby
+# <% require 'kitchen/binding' %>
+# <% require 'kitchen/binding/base' %>
+```
+
+The above could also be added to your ~/.kitchen/config.yml if you wanted it always available.
+
+Then do a kitchen converge doing `bundle exec kitchen converge` and if the breakpoint is hit you should get dropped into an interactive ruby shell.
+
+Contributing
+------------
+* Source hosted at [GitHub](https://github.com/jmccann/kitchen-binding)
+* Report issues/questions/feature requests on [GitHub Issues](https://github.com/jmccann/kitchen-binding/issues)
+
+Pull requests are very welcome! Make sure your patches are well tested.
+Ideally create a topic branch for every separate change you make. For
+example:
+
+1. Fork the repo
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+Authors
+-------
+Created and maintained by Jacob McCann (<jmccann.git@gmail.com>)

data/kitchen-binding.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.name          = 'kitchen-binding'
+  gem.version       = '0.2.0'
+  gem.license       = 'Apache 2.0'
+  gem.authors       = ['Jacob McCann']
+  gem.email         = ['jmcann.git@gmail.com']
+  gem.description   = 'Test Kitchen extension for remote ruby shells'
+  gem.summary       = gem.description
+  gem.homepage      = 'https://github.com/jmccann/kitchen-binding/'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = []
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'test-kitchen', '~> 1.2.1'
+  gem.add_dependency 'pry-remote', '~> 0.1.8'
+end

data/lib/kitchen/binding.rb

@@ -0,0 +1,50 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Jacob McCann (<jmccann.git@gmail.com>)
+#
+# Copyright (C) 2014, Jacob McCann
+#
+# 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'
+
+module Kitchen
+  # A binding is responsible for generating the commands necessary to
+  # install, set up and use a interactive ruby shell for debugging called
+  # from a Provisioner (e.g. Chef Cookbook during Chef Run)
+  #
+  # @author Jacob McCann <jmccann.git@gmail.com>
+  module Binding
+    # Default provisioner to use
+    DEFAULT_PLUGIN = 'pry_remote'.freeze
+
+    # Returns an instance of a binding given a plugin type string.
+    #
+    # @param plugin [String] a binding plugin type, to be constantized
+    # @param config [Hash] a configuration hash to initialize the provisioner
+    # @return [Binding::Base] a driver instance
+    # @raise [ClientError] if a provisioner instance could not be created
+    def self.for_plugin(plugin, config)
+      require("kitchen/binding/#{plugin}")
+
+      str_const = Thor::Util.camel_case(plugin)
+      klass = const_get(str_const)
+      klass.new(config)
+    rescue LoadError, NameError
+      raise ClientError,
+        "Could not load the '#{plugin}' binding from the load path." \
+          " Please ensure that your binding is installed as a gem or" \
+          " included in your Gemfile if using Bundler."
+    end
+  end
+end

data/lib/kitchen/binding/base.rb

@@ -0,0 +1,203 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Jacob McCann (<jmccann.git@gmail.com>)
+#
+# Copyright (C) 2014, Jacob McCann
+#
+# 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/configurable'
+
+require 'socket'
+
+require 'kitchen/binding/core_ext'
+require 'kitchen/lazy_hash'
+
+module Kitchen
+  module Binding
+    # Base class for a binding.
+    #
+    # @author Jacob McCann <jmccann.git@gmail.com>
+    class Base
+      # require 'pry'
+      # binding.pry
+
+      # include Configurable # Available in edge test-kitchen
+      include Logging
+
+      attr_accessor :state
+
+      attr_accessor :instance # Not required in edge
+
+      # Create a new Binding object using the provided configuration data
+      # which will be merged with any default configuration.
+      #
+      # @param config [Hash] provided binding configuration
+      def initialize(config = {})
+        # init_config(config) # Available in edge
+
+        # Following not required in edge test-kitchen
+        @config = LazyHash.new(config, self)
+        self.class.defaults.each do |attr, value|
+          @config[attr] = value unless @config.has_key?(attr)
+        end
+      end
+
+      # Not required in edge
+      def instance=(instance)
+        @instance = instance
+        expand_paths!
+        load_needed_dependencies!
+      end
+
+      # Returns the name of this transport, suitable for display in a CLI.
+      #
+      # @return [String] name of this transport
+      def name
+        self.class.name.split('::').last.downcase
+      end
+
+      # Returns the command that will install the remote interactive ruby shell.
+      #
+      # @return [String] the command to install the remote ruby shell
+      # @raise [ActionFailed] if the action could not be completed
+      def install_command
+      end
+
+      # Returns the command that will log into a remote interactive ruby shell.
+      #
+      # @raise [ActionFailed] if the action could not be completed
+      def connect_command
+      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
+
+      # Test a remote port's connectivity.
+      #
+      # @return [true,false] a truthy value if the connection is ready
+      # and false otherwise
+      def test_connection
+        debug("Testing binding connection <#{hostname}:#{port}>")
+        socket = TCPSocket.new(hostname, port)
+        IO.select([socket], nil, nil, 5)
+        true
+      rescue *SOCKET_EXCEPTIONS, Errno::EPERM, Errno::ETIMEDOUT
+        debug("No binding server detected")
+        sleep config[:binding_timeout] || 2
+        false
+      ensure
+        socket && socket.close
+      end
+
+      protected
+
+      attr_reader :config # Not required in edge
+
+      # TCP socket exceptions
+      SOCKET_EXCEPTIONS = [
+        SocketError, Errno::ECONNREFUSED, Errno::EHOSTUNREACH,
+        Errno::ENETUNREACH, IOError
+      ]
+
+      # @return [Hash] Transport options
+      attr_reader :options
+
+      # @return [Logger] the logger to use
+      # @api private
+      attr_reader :logger
+
+      # @return [Integer] Binding port
+      # @api private
+      def port
+        config[:port]
+      end
+
+      # @return [String] Binding hostname
+      # @api private
+      def hostname
+        '33.33.33.200'
+      end
+
+      # String representation of object, reporting its connection details and
+      # configuration.
+      #
+      # @api private
+      def to_s
+        "#{hostname}:#{port}<#{config.inspect}>"
+      end
+
+      # Returns a suitable logger to use for output.
+      #
+      # @return [Kitchen::Logger] a logger
+      def logger
+        instance ? instance.logger : Kitchen.logger
+      end
+
+      # Intercepts any bare #puts calls in subclasses and issues an INFO log
+      # event instead.
+      #
+      # @param msg [String] message string
+      def puts(msg) # rubocop:disable Lint/UnusedMethodArgument
+        info(msg)
+      end
+
+      # Intercepts any bare #print calls in subclasses and issues an INFO log
+      # event instead.
+      #
+      # @param msg [String] message string
+      def print(msg) # rubocop:disable Lint/UnusedMethodArgument
+        info(msg)
+      end
+
+      # Adds http and https proxy environment variables to a command, if set
+      # in configuration data.
+      #
+      # @param command [String] command string
+      # @return [String] command string
+      # @api private
+      def env_command(command) # rubocop:disable Lint/UnusedMethodArgument
+      end
+
+      # Not required in edge
+      def self.defaults
+        @defaults ||= Hash.new.merge(super_defaults)
+      end
+
+      # Not required in edge
+      def self.super_defaults
+        klass = self.superclass
+
+        if klass.respond_to?(:defaults)
+          klass.defaults
+        else
+          Hash.new
+        end
+      end
+
+      # Not required in edge
+      def self.default_config(attr, value = nil, &block)
+        defaults[attr] = block_given? ? block : value
+      end
+
+      # Can be moved to top later ... moved to bottom for current test-kitchen
+      default_config :port, 5000
+    end
+  end
+end

data/lib/kitchen/binding/core_ext.rb

@@ -0,0 +1,6 @@
+
+require 'kitchen/binding/core_ext/util'
+require 'kitchen/binding/core_ext/config'
+require 'kitchen/binding/core_ext/data_munger'
+require 'kitchen/binding/core_ext/instance'
+require 'kitchen/binding/core_ext/ssh_base'

data/lib/kitchen/binding/core_ext/config.rb

@@ -0,0 +1,76 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Jacob McCann (<jmccann.git@gmail.com>)
+#
+# Copyright (C) 2014, Jacob McCann
+#
+# 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
+  # Override certain methods from Kitchen::Config to allow use of
+  # Kitchen::Binding
+  class Config
+    # Generates the immutable Test Kitchen configuration and reasonable
+    # defaults for Drivers, Provisioners and Bindings.
+    #
+    # @return [Hash] a configuration Hash
+    # @api private
+    def kitchen_config
+      @kitchen_config ||= {
+        :defaults => {
+          :driver       => Driver::DEFAULT_PLUGIN,
+          :provisioner  => Provisioner::DEFAULT_PLUGIN,
+          :binding      => Binding::DEFAULT_PLUGIN
+        },
+        :kitchen_root   => kitchen_root,
+        :test_base_path => test_base_path,
+        :log_level      => log_level
+      }
+    end
+
+    # Builds a newly configured Instance object, for a given Suite and
+    # Platform.
+    #
+    # @param suite [Suite,#name] a Suite
+    # @param platform [Platform,#name] a Platform
+    # @param index [Integer] an index used for colorizing output
+    # @return [Instance] a new Instance object
+    # @api private
+    def new_instance(suite, platform, index)
+      Instance.new(
+        :busser       => new_busser(suite, platform),
+        :driver       => new_driver(suite, platform),
+        :logger       => new_logger(suite, platform, index),
+        :suite        => suite,
+        :platform     => platform,
+        :provisioner  => new_provisioner(suite, platform),
+        :binding      => new_binding(suite, platform),
+        :state_file   => new_state_file(suite, platform)
+      )
+    end
+
+    private
+
+    # Builds a newly configured Binding object, for a given Suite and
+    # Platform.
+    #
+    # @param suite [Suite,#name] a Suite
+    # @param platform [Platform,#name] a Platform
+    # @return [Binding] a new Binding object
+    # @api private
+    def new_binding(suite, platform)
+      bdata = data.binding_data_for(suite.name, platform.name)
+      Binding.for_plugin(bdata[:name], bdata)
+    end
+  end
+end

data/lib/kitchen/binding/core_ext/data_munger.rb

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Jacob McCann (<jmccann.git@gmail.com>)
+#
+# Copyright (C) 2014, Jacob McCann
+#
+# 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
+  # Add some additioanl methods to Kitchen::DataMunger to allow use of
+  # Kitchen::Binding
+  class DataMunger
+    # Generate a new Hash of configuration data that can be used to construct
+    # a new Binding object.
+    #
+    # @param suite [String] a suite name
+    # @param platform [String] a platform name
+    # @return [Hash] a new configuration Hash that can be used to construct a
+    #   new Binding
+    def binding_data_for(suite, platform)
+      merged_data_for(:binding, suite, platform).tap do |bdata|
+        set_kitchen_config_at!(bdata, :kitchen_root)
+        set_kitchen_config_at!(bdata, :test_base_path)
+        set_kitchen_config_at!(bdata, :log_level)
+      end
+    end
+  end
+end

data/lib/kitchen/binding/core_ext/instance.rb

@@ -0,0 +1,44 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Jacob McCann (<jmccann.git@gmail.com>)
+#
+# Copyright (C) 2014, Jacob McCann
+#
+# 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
+  # Add some additioanl methods to Kitchen::Instnace to allow use of
+  # Kitchen::Binding
+  class Instance
+    # @return [Binding::Base] binding object which will the setup
+    #   and invocation instructions for remote interactive ruby shells
+    attr_reader :binding
+
+    def initialize(options = {})
+      validate_options(options)
+
+      @suite        = options.fetch(:suite)
+      @platform     = options.fetch(:platform)
+      @name         = self.class.name_for(@suite, @platform)
+      @driver       = options.fetch(:driver)
+      @provisioner  = options.fetch(:provisioner)
+      @binding      = options.fetch(:binding)
+      @busser       = options.fetch(:busser)
+      @logger       = options.fetch(:logger) { Kitchen.logger }
+      @state_file   = options.fetch(:state_file)
+
+      setup_driver
+      setup_provisioner
+    end
+  end
+end

data/lib/kitchen/binding/core_ext/ssh_base.rb

@@ -0,0 +1,59 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Jacob McCann (<jmccann.git@gmail.com>)
+#
+# Copyright (C) 2014, Jacob McCann
+#
+# 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 Driver
+    # Override converge method from Kitchen::Driver::SSHBase to allow use of
+    # Kitchen::Binding
+    class SSHBase < Base
+      # Overriding to add watching Chef Converge and connecting to
+      # binding if started
+      def converge(state)
+        provisioner = instance.provisioner
+        provisioner.create_sandbox
+        sandbox_dirs = Dir.glob("#{provisioner.sandbox_path}/*")
+
+        binding = instance.binding
+        binding.state = state
+
+        Kitchen::SSH.new(*build_ssh_args(state)) do |conn|
+          run_remote(provisioner.install_command, conn)
+          run_remote(binding.install_command, conn)
+
+          run_remote(provisioner.init_command, conn)
+          transfer_path(sandbox_dirs, provisioner[:root_path], conn)
+          run_remote(provisioner.prepare_command, conn)
+
+          # Run converge in a thread
+          chef_run_thread = Thread.new do
+            run_remote(provisioner.run_command, conn)
+          end
+
+          # Endlessly check until converge has completed
+          while chef_run_thread.alive?
+            debug("Chef thread still running")
+            debug("Binding server running?: #{binding.test_connection}")
+            binding.connect_command if binding.test_connection
+          end
+        end
+      ensure
+        provisioner && provisioner.cleanup_sandbox
+      end
+    end
+  end
+end

data/lib/kitchen/binding/core_ext/util.rb

@@ -0,0 +1,147 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
+#
+# Copyright (C) 2012, 2013, 2014, 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
+
+  # Stateless utility methods used in different contexts. Essentially a mini
+  # PassiveSupport library.
+  #
+  # @author Fletcher Nichol <fnichol@nichol.ca>
+  module Util
+
+    # # Returns the standard library Logger level constants for a given symbol
+    # # representation.
+    # #
+    # # @param symbol [Symbol] symbol representation of a logger level (:debug,
+    # #   :info, :warn, :error, :fatal)
+    # # @return [Integer] Logger::Severity constant value or nil if input is not
+    # #   valid
+    # def self.to_logger_level(symbol)
+    #   return nil unless [:debug, :info, :warn, :error, :fatal].include?(symbol)
+
+    #   Logger.const_get(symbol.to_s.upcase)
+    # end
+
+    # # Returns the symbol represenation of a logging levels for a given
+    # # standard library Logger::Severity constant.
+    # #
+    # # @param const [Integer] Logger::Severity constant value for a logging
+    # #   level (Logger::DEBUG, Logger::INFO, Logger::WARN, Logger::ERROR,
+    # #   Logger::FATAL)
+    # # @return [Symbol] symbol representation of the logging level
+    # def self.from_logger_level(const)
+    #   case const
+    #   when Logger::DEBUG then :debug
+    #   when Logger::INFO then :info
+    #   when Logger::WARN then :warn
+    #   when Logger::ERROR then :error
+    #   else :fatal
+    #   end
+    # end
+
+    # # Returns a new Hash with all key values coerced to symbols. All keys
+    # # within a Hash are coerced by calling #to_sym and hashes within arrays
+    # # and other hashes are traversed.
+    # #
+    # # @param obj [Object] the hash to be processed. While intended for
+    # #   hashes, this method safely processes arbitrary objects
+    # # @return [Object] a converted hash with all keys as symbols
+    # def self.symbolized_hash(obj)
+    #   if obj.is_a?(Hash)
+    #     obj.inject({}) { |h, (k, v)| h[k.to_sym] = symbolized_hash(v); h }
+    #   elsif obj.is_a?(Array)
+    #     obj.inject([]) { |a, e| a << symbolized_hash(e); a }
+    #   else
+    #     obj
+    #   end
+    # end
+
+    # # Returns a new Hash with all key values coerced to strings. All keys
+    # # within a Hash are coerced by calling #to_s and hashes with arrays
+    # # and other hashes are traversed.
+    # #
+    # # @param obj [Object] the hash to be processed. While intended for
+    # #   hashes, this method safely processes arbitrary objects
+    # # @return [Object] a converted hash with all keys as strings
+    # def self.stringified_hash(obj)
+    #   if obj.is_a?(Hash)
+    #     obj.inject({}) { |h, (k, v)| h[k.to_s] = stringified_hash(v); h }
+    #   elsif obj.is_a?(Array)
+    #     obj.inject([]) { |a, e| a << stringified_hash(e); a }
+    #   else
+    #     obj
+    #   end
+    # end
+
+    # # Returns a formatted string representing a duration in seconds.
+    # #
+    # # @param total [Integer] the total number of seconds
+    # # @return [String] a formatted string of the form (XmYY.00s)
+    # def self.duration(total)
+    #   total = 0 if total.nil?
+    #   minutes = (total / 60).to_i
+    #   seconds = (total - (minutes * 60))
+    #   format("(%dm%.2fs)", minutes, seconds)
+    # end
+
+    # Generates a command (or series of commands) wrapped so that it can be
+    # invoked on a remote instance or locally.
+    #
+    # This method uses the Bourne shell (/bin/sh) to maximize the chance of
+    # cross platform portability on Unixlike systems.
+    #
+    # @param [String] the command
+    # @return [String] a wrapped command string
+    def self.wrap_command(cmd)
+      cmd = "false" if cmd.nil?
+      cmd = "true" if cmd.to_s.empty?
+      cmd = cmd.sub(/\n\Z/, "") if cmd =~ /\n\Z/
+
+      "sh -c '\n#{cmd}\n'"
+    end
+
+    # # Modifes the given string to strip leading whitespace on each line, the
+    # # amount which is calculated by using the first line of text.
+    # #
+    # # @example
+    # #
+    # #   string = <<-STRING
+    # #     a
+    # #       b
+    # #   c
+    # #   STRING
+    # #   Util.outdent!(string) # => "a\n  b\nc\n"
+    # #
+    # # @param string [String] the string that will be modified
+    # # @return [String] the modified string
+    # def self.outdent!(string)
+    #   string.gsub!(/^ {#{string.index(/[^ ]/)}}/, "")
+    # end
+
+    # # Returns a set of Bourne Shell (AKA /bin/sh) compatible helper
+    # # functions. This function is usually called inline in a string that
+    # # will be executed remotely on a test instance.
+    # #
+    # # @return [String] a string representation of useful helper functions
+    # def self.shell_helpers
+    #   IO.read(File.join(
+    #     File.dirname(__FILE__), %w[.. .. support download_helpers.sh]
+    #   ))
+    # end
+  end
+end

data/lib/kitchen/binding/pry_remote.rb

@@ -0,0 +1,72 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Jacob McCann (<jmccann.git@gmail.com>)
+#
+# Copyright (C) 2014, Jacob McCann
+#
+# 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 Binding
+    # pry-remote binding
+    #
+    # @author Jacob McCann <jmccann.git@gmail.com>
+    class PryRemote < Base
+      default_config :port, 9876
+      default_config :sudo, true
+
+      # (see Base#install_command)
+      def install_command
+        <<-INSTALL.gsub(/^ {10}/, "")
+          if [[ $(/opt/chef/embedded/bin/gem list | grep -c pry-remote) -eq 0 ]]; then
+            echo "-----> Installing Binding (pry-remote)"
+            #{sudo(install_string)}
+          else
+            echo "-----> Binding (pry-remote) installation detected"
+          fi
+        INSTALL
+      end
+
+      # (see Base#connect_command)
+      def connect_command
+        info("Connecting to remote binding")
+        require 'pry-remote'
+        ::Pry.config.input = STDIN
+        ::Pry.config.output = STDOUT
+
+        argv = ['--server', hostname, '--port', port.to_s]
+
+        client = ::PryRemote::CLI.new argv
+        client.run
+      end
+
+      private
+
+      def install_string
+        level = config[:log_level] == :info ? :auto : config[:log_level]
+
+        cmd = '/opt/chef/embedded/bin/gem install pry-remote'
+        args = [
+          '--no-rdoc',
+          '--no-ri'
+        ]
+        args << '--debug' if level == :debug
+
+        cmd = [cmd, *args].join(' ')
+        debug("Remote binding install command: #{cmd}")
+
+        cmd
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: kitchen-binding
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Jacob McCann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: test-kitchen
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: pry-remote
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.8
+description: Test Kitchen extension for remote ruby shells
+email:
+- jmcann.git@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- kitchen-binding.gemspec
+- lib/kitchen/binding.rb
+- lib/kitchen/binding/base.rb
+- lib/kitchen/binding/core_ext.rb
+- lib/kitchen/binding/core_ext/config.rb
+- lib/kitchen/binding/core_ext/data_munger.rb
+- lib/kitchen/binding/core_ext/instance.rb
+- lib/kitchen/binding/core_ext/ssh_base.rb
+- lib/kitchen/binding/core_ext/util.rb
+- lib/kitchen/binding/pry_remote.rb
+homepage: https://github.com/jmccann/kitchen-binding/
+licenses:
+- Apache 2.0
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23.2
+signing_key: 
+specification_version: 3
+summary: Test Kitchen extension for remote ruby shells
+test_files: []