test-kitchen 1.3.1 → 1.4.0.beta.1

data/support/chef_base_install_command.sh

@@ -0,0 +1,137 @@
+# Check whether a command exists - returns 0 if it does, 1 if it does not
+exists() {
+  if command -v $1 >/dev/null 2>&1
+  then
+    return 0
+  else
+    return 1
+  fi
+}
+
+# do_wget URL FILENAME
+do_wget() {
+  echo "trying wget..."
+  wget -O "$2" "$1" 2>/tmp/stderr
+  # check for bad return status
+  test $? -ne 0 && return 1
+  # check for 404 or empty file
+  grep "ERROR 404" /tmp/stderr 2>&1 >/dev/null
+  if test $? -eq 0 || test ! -s "$2"; then
+    return 1
+  fi
+  return 0
+}
+
+# do_curl URL FILENAME
+do_curl() {
+  echo "trying curl..."
+  curl -L "$1" > "$2"
+  # check for bad return status
+  [ $? -ne 0 ] && return 1
+  # check for bad output or empty file
+  grep "The specified key does not exist." "$2" 2>&1 >/dev/null
+  if test $? -eq 0 || test ! -s "$2"; then
+    return 1
+  fi
+  return 0
+}
+
+# do_fetch URL FILENAME
+do_fetch() {
+  echo "trying fetch..."
+  fetch -o "$2" "$1" 2>/tmp/stderr
+  # check for bad return status
+  test $? -ne 0 && return 1
+  return 0
+}
+
+# do_perl URL FILENAME
+do_perl() {
+  echo "trying perl..."
+  perl -e "use LWP::Simple; getprint($ARGV[0]);" "$1" > "$2"
+  # check for bad return status
+  test $? -ne 0 && return 1
+  # check for bad output or empty file
+  # grep "The specified key does not exist." "$2" 2>&1 >/dev/null
+  # if test $? -eq 0 || test ! -s "$2"; then
+  #   unable_to_retrieve_package
+  # fi
+  return 0
+}
+
+# do_python URL FILENAME
+do_python() {
+  echo "trying python..."
+  python -c "import sys,urllib2 ; sys.stdout.write(urllib2.urlopen(sys.argv[1]).read())" "$1" > "$2"
+  # check for bad return status
+  test $? -ne 0 && return 1
+  # check for bad output or empty file
+  #grep "The specified key does not exist." "$2" 2>&1 >/dev/null
+  #if test $? -eq 0 || test ! -s "$2"; then
+  #  unable_to_retrieve_package
+  #fi
+  return 0
+}
+
+# do_download URL FILENAME
+do_download() {
+  PATH=/opt/local/bin:/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin
+  export PATH
+
+  echo "downloading $1"
+  echo "  to file $2"
+
+  # we try all of these until we get success.
+  # perl, in particular may be present but LWP::Simple may not be installed
+
+  if exists wget; then
+    do_wget $1 $2 && return 0
+  fi
+
+  if exists curl; then
+    do_curl $1 $2 && return 0
+  fi
+
+  if exists fetch; then
+    do_fetch $1 $2 && return 0
+  fi
+
+  if exists perl; then
+    do_perl $1 $2 && return 0
+  fi
+
+  if exists python; then
+    do_python $1 $2 && return 0
+  fi
+
+  echo ">>>>>> wget, curl, fetch, perl or python not found on this instance."
+  return 16
+}
+
+# @param $1 the omnibus root directory
+# @param $2 the requested version of omnibus package
+# @return 0 if omnibus needs to be installed, non-zero otherwise
+should_update_chef() {
+  if test ! -d "$1" ; then return 0
+  elif test "$2" = "true" ; then return 1
+  elif test "$2" = "latest" ; then return 0
+  fi
+
+  local version="`$1/bin/chef-solo -v | cut -d " " -f 2`"
+
+  echo "$version" | grep "^$2" 2>&1 >/dev/null
+  if test $? -eq 0 ; then
+    return 1
+  else
+    return 0
+  fi
+}
+
+should_update_chef "$chef_omnibus_root" "$version"
+if test $? -eq 0 ; then
+  echo "-----> Installing Chef Omnibus ($pretty_version)"
+  do_download "$chef_omnibus_url" /tmp/install.sh
+  $sudo_sh /tmp/install.sh $install_flags
+else
+  echo "-----> Chef Omnibus installation detected ($pretty_version)"
+fi

data/support/chef_zero_prepare_command_legacy.ps1

@@ -0,0 +1,9 @@
+# we are installing the first version of chef that bundled chef-zero in order
+# to get chef-zero and Chef::ChefFS only. The version of Chef that gets run
+# will be the installed omnibus package. Yep, this is funky :)
+
+if ((& "$gem" list chef-zero -i) -ne "true") {
+  Write-Host ">>>>>> Attempting to use chef-zero with old version of Chef`n"
+  Write-Host "-----> Installing chef zero dependencies`n"
+  & "$gem" install chef --version 11.8.0 --no-ri --no-rdoc --conservative
+}

data/support/chef_zero_prepare_command_legacy.sh

@@ -0,0 +1,10 @@
+# we are installing the first version of chef that bundled chef-zero in order
+# to get chef-zero and Chef::ChefFS only. The version of Chef that gets run
+# will be the installed omnibus package. Yep, this is funky :)
+
+$gem list chef-zero -i 2>&1 >/dev/null
+if test $? -ne 0 ; then
+  echo ">>>>>> Attempting to use chef-zero with old version of Chef"
+  echo "-----> Installing chef zero dependencies"
+  $gem install chef --version 11.8.0 --no-ri --no-rdoc --conservative
+fi

data/support/decode_files.ps1.erb

@@ -0,0 +1,61 @@
+$hash_file = "<%= hash_file %>"
+
+Function Cleanup($o) { if (($o -ne $null) -and ($o.GetType().GetMethod("Dispose") -ne $null)) { $o.Dispose() } }
+
+Function Decode-Base64File($src, $dst) {
+  Try {
+    $in = (Get-Item $src).OpenRead()
+    $b64 = New-Object -TypeName System.Security.Cryptography.FromBase64Transform
+    $m = [System.Security.Cryptography.CryptoStreamMode]::Read
+    $d = New-Object -TypeName System.Security.Cryptography.CryptoStream $in,$b64,$m
+    Copy-Stream $d ($out = [System.IO.File]::OpenWrite($dst))
+  } Finally { Cleanup $in; Cleanup $out; Cleanup $d }
+}
+
+Function Copy-Stream($src, $dst) { $b = New-Object Byte[] 4096; while (($i = $src.Read($b, 0, $b.Length)) -ne 0) { $dst.Write($b, 0, $i) } }
+
+Function Decode-Files($hash) {
+  $hash.GetEnumerator() | ForEach-Object {
+    $tmp = Unresolve-Path $_.Key
+    $sMd5 = (Get-Item $tmp).BaseName.Replace("b64-", "")
+    $tzip, $dst = (Unresolve-Path $_.Value["tmpzip"]), (Unresolve-Path $_.Value["dst"])
+    $decoded = if ($tzip -ne $null) { $tzip } else { $dst }
+    Decode-Base64File $tmp $decoded
+    Remove-Item $tmp -Force
+    $dMd5 = Get-MD5Sum $decoded
+    $verifies = if ($sMd5 -eq $dMd5) { $true } else { $false }
+    if ($tzip) { Unzip-File $tzip $dst; Remove-Item $tzip -Force }
+    New-Object psobject -Property @{ dst = $dst; verifies = $verifies; src_md5 = $sMd5; dst_md5 = $dMd5; tmpfile = $tmp; tmpzip = $tzip }
+  } | Select-Object -Property dst,verifies,src_md5,dst_md5,tmpfile,tmpzip
+}
+
+Function Get-MD5Sum($src) {
+  Try {
+    $c = New-Object -TypeName System.Security.Cryptography.MD5CryptoServiceProvider
+    $bytes = $c.ComputeHash(($in = (Get-Item $src).OpenRead()))
+    return ([System.BitConverter]::ToString($bytes)).Replace("-", "").ToLower()
+  } Finally { Cleanup $c; Cleanup $in }
+}
+
+Function Invoke-Input($in) {
+  $in = Unresolve-Path $in
+  Decode-Base64File $in ($decoded = "$($in).ps1")
+  $expr = Get-Content $decoded | Out-String
+  Remove-Item $in,$decoded -Force
+  return Invoke-Expression "$expr"
+}
+
+Function Release-COM($o) { if ($o -ne $null) { [void][System.Runtime.Interopservices.Marshal]::ReleaseComObject($o) } }
+
+Function Unresolve-Path($p) { if ($p -eq $null) { return $null } else { return $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath($p) } }
+
+Function Unzip-File($src, $dst) {
+  $r = "HKLM:\Software\Microsoft\NET Framework Setup\NDP\v4"
+  if (($PSVersionTable.PSVersion.Major -ge 3) -and ((gp "$r\Full").Version -like "4.5*" -or (gp "$r\Client").Version -like "4.5*")) {
+    [System.Reflection.Assembly]::LoadWithPartialName("System.IO.Compression.FileSystem") | Out-Null; [System.IO.Compression.ZipFile]::ExtractToDirectory("$src", "$dst")
+  } else {
+    Try { $s = New-Object -ComObject Shell.Application; ($dp = $s.NameSpace($dst)).CopyHere(($z = $s.NameSpace($src)).Items(), 0x610) } Finally { Release-Com $s; Release-Com $z; Release-COM $dp }
+  }
+}
+
+Decode-Files (Invoke-Input $hash_file) | ConvertTo-Csv -NoTypeInformation

data/test-kitchen.gemspec

@@ -26,8 +26,10 @@ Gem::Specification.new do |gem|
   gem.add_dependency "mixlib-shellout", ">= 1.2", "< 3.0"
   gem.add_dependency "net-scp",         "~> 1.1"
   gem.add_dependency "net-ssh",         "~> 2.7"
+  gem.add_dependency "winrm",           "~> 1.3"
   gem.add_dependency "safe_yaml",       "~> 1.0"
   gem.add_dependency "thor",            "~> 0.18"
+  gem.add_dependency "rubyzip",         ">= 1.1.7", "~> 1.1"
 
   gem.add_development_dependency "pry"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-kitchen
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0.beta.1
 platform: ruby
 authors:
 - Fletcher Nichol
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-16 00:00:00.000000000 Z
+date: 2015-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mixlib-shellout
@@ -58,6 +58,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: winrm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: safe_yaml
   requirement: !ruby/object:Gem::Requirement
@@ -86,6 +100,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.7
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.7
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -292,6 +326,7 @@ files:
 - features/kitchen_action_commands.feature
 - features/kitchen_command.feature
 - features/kitchen_console_command.feature
+- features/kitchen_defaults.feature
 - features/kitchen_diagnose_command.feature
 - features/kitchen_driver_create_command.feature
 - features/kitchen_driver_discover_command.feature
@@ -307,7 +342,6 @@ files:
 - features/support/env.rb
 - lib/kitchen.rb
 - lib/kitchen/base64_stream.rb
-- lib/kitchen/busser.rb
 - lib/kitchen/cli.rb
 - lib/kitchen/collection.rb
 - lib/kitchen/color.rb
@@ -344,6 +378,7 @@ files:
 - lib/kitchen/provisioner.rb
 - lib/kitchen/provisioner/base.rb
 - lib/kitchen/provisioner/chef/berkshelf.rb
+- lib/kitchen/provisioner/chef/common_sandbox.rb
 - lib/kitchen/provisioner/chef/librarian.rb
 - lib/kitchen/provisioner/chef_base.rb
 - lib/kitchen/provisioner/chef_solo.rb
@@ -356,11 +391,25 @@ files:
 - lib/kitchen/state_file.rb
 - lib/kitchen/suite.rb
 - lib/kitchen/thor_tasks.rb
+- lib/kitchen/transport.rb
+- lib/kitchen/transport/base.rb
+- lib/kitchen/transport/dummy.rb
+- lib/kitchen/transport/ssh.rb
+- lib/kitchen/transport/winrm.rb
+- lib/kitchen/transport/winrm/command_executor.rb
+- lib/kitchen/transport/winrm/file_transporter.rb
+- lib/kitchen/transport/winrm/logging.rb
+- lib/kitchen/transport/winrm/template.rb
+- lib/kitchen/transport/winrm/tmp_zip.rb
 - lib/kitchen/util.rb
+- lib/kitchen/verifier.rb
+- lib/kitchen/verifier/base.rb
+- lib/kitchen/verifier/busser.rb
+- lib/kitchen/verifier/dummy.rb
 - lib/kitchen/version.rb
 - lib/vendor/hash_recursive_merge.rb
 - spec/kitchen/base64_stream_spec.rb
-- spec/kitchen/busser_spec.rb
+- spec/kitchen/cli_spec.rb
 - spec/kitchen/collection_spec.rb
 - spec/kitchen/color_spec.rb
 - spec/kitchen/config_spec.rb
@@ -385,17 +434,41 @@ files:
 - spec/kitchen/provisioner/chef_base_spec.rb
 - spec/kitchen/provisioner/chef_solo_spec.rb
 - spec/kitchen/provisioner/chef_zero_spec.rb
+- spec/kitchen/provisioner/dummy_spec.rb
 - spec/kitchen/provisioner/shell_spec.rb
 - spec/kitchen/provisioner_spec.rb
 - spec/kitchen/shell_out_spec.rb
 - spec/kitchen/ssh_spec.rb
 - spec/kitchen/state_file_spec.rb
 - spec/kitchen/suite_spec.rb
+- spec/kitchen/transport/base_spec.rb
+- spec/kitchen/transport/ssh_spec.rb
+- spec/kitchen/transport/winrm/command_executor_spec.rb
+- spec/kitchen/transport/winrm/file_transporter_spec.rb
+- spec/kitchen/transport/winrm/logging_spec.rb
+- spec/kitchen/transport/winrm/template_spec.rb
+- spec/kitchen/transport/winrm/tmp_zip_spec.rb
+- spec/kitchen/transport/winrm_spec.rb
+- spec/kitchen/transport_spec.rb
 - spec/kitchen/util_spec.rb
+- spec/kitchen/verifier/base_spec.rb
+- spec/kitchen/verifier/busser_spec.rb
+- spec/kitchen/verifier/dummy_spec.rb
+- spec/kitchen/verifier_spec.rb
 - spec/kitchen_spec.rb
 - spec/spec_helper.rb
+- spec/support/powershell_max_size_spec.rb
+- support/busser_install_command.ps1
+- support/busser_install_command.sh
+- support/check_files.ps1.erb
 - support/chef-client-zero.rb
-- support/chef_helpers.sh
+- support/chef_base_init_command.ps1
+- support/chef_base_init_command.sh
+- support/chef_base_install_command.ps1
+- support/chef_base_install_command.sh
+- support/chef_zero_prepare_command_legacy.ps1
+- support/chef_zero_prepare_command_legacy.sh
+- support/decode_files.ps1.erb
 - support/download_helpers.sh
 - support/dummy-validation.pem
 - templates/driver/CHANGELOG.md.erb
@@ -429,9 +502,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 1.9.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.5
@@ -443,6 +516,7 @@ test_files:
 - features/kitchen_action_commands.feature
 - features/kitchen_command.feature
 - features/kitchen_console_command.feature
+- features/kitchen_defaults.feature
 - features/kitchen_diagnose_command.feature
 - features/kitchen_driver_create_command.feature
 - features/kitchen_driver_discover_command.feature
@@ -457,7 +531,7 @@ test_files:
 - features/step_definitions/output_steps.rb
 - features/support/env.rb
 - spec/kitchen/base64_stream_spec.rb
-- spec/kitchen/busser_spec.rb
+- spec/kitchen/cli_spec.rb
 - spec/kitchen/collection_spec.rb
 - spec/kitchen/color_spec.rb
 - spec/kitchen/config_spec.rb
@@ -482,13 +556,28 @@ test_files:
 - spec/kitchen/provisioner/chef_base_spec.rb
 - spec/kitchen/provisioner/chef_solo_spec.rb
 - spec/kitchen/provisioner/chef_zero_spec.rb
+- spec/kitchen/provisioner/dummy_spec.rb
 - spec/kitchen/provisioner/shell_spec.rb
 - spec/kitchen/provisioner_spec.rb
 - spec/kitchen/shell_out_spec.rb
 - spec/kitchen/ssh_spec.rb
 - spec/kitchen/state_file_spec.rb
 - spec/kitchen/suite_spec.rb
+- spec/kitchen/transport/base_spec.rb
+- spec/kitchen/transport/ssh_spec.rb
+- spec/kitchen/transport/winrm/command_executor_spec.rb
+- spec/kitchen/transport/winrm/file_transporter_spec.rb
+- spec/kitchen/transport/winrm/logging_spec.rb
+- spec/kitchen/transport/winrm/template_spec.rb
+- spec/kitchen/transport/winrm/tmp_zip_spec.rb
+- spec/kitchen/transport/winrm_spec.rb
+- spec/kitchen/transport_spec.rb
 - spec/kitchen/util_spec.rb
+- spec/kitchen/verifier/base_spec.rb
+- spec/kitchen/verifier/busser_spec.rb
+- spec/kitchen/verifier/dummy_spec.rb
+- spec/kitchen/verifier_spec.rb
 - spec/kitchen_spec.rb
 - spec/spec_helper.rb
+- spec/support/powershell_max_size_spec.rb
 has_rdoc: 

data/lib/kitchen/busser.rb

@@ -1,316 +0,0 @@
-# -*- encoding: utf-8 -*-
-#
-# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
-#
-# Copyright (C) 2012, 2013, 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 "base64"
-require "digest"
-
-module Kitchen
-
-  # Command string generator to interface with Busser. The commands that are
-  # generated are safe to pass to an SSH command or as an unix command
-  # argument (escaped in single quotes).
-  #
-  # @author Fletcher Nichol <fnichol@nichol.ca>
-  class Busser
-
-    # Constructs a new Busser command generator, given a suite name.
-    #
-    # @param [String] suite_name name of suite on which to operate
-    #   (**Required**)
-    # @param [Hash] opts optional configuration
-    # @option opts [String] :kitchen_root local path to the root of the project
-    # @option opts [String] :instance_ruby_bindir path to the directory
-    #   containing the Ruby binary on the remote instance
-    # @option opts [TrueClass, FalseClass] :sudo whether or not to invoke
-    #   sudo before commands requiring root access (default: `true`)
-    def initialize(suite_name, opts = {})
-      validate_options(suite_name)
-
-      kitchen_root = opts.fetch(:kitchen_root) { Dir.pwd }
-      test_base_path = opts.fetch(:test_base_path, Kitchen::DEFAULT_TEST_DIR)
-
-      @config = Hash.new
-      @config[:kitchen_root] = kitchen_root
-      @config[:test_base_path] = File.expand_path(test_base_path, kitchen_root)
-      @config[:suite_name] = suite_name
-      @config[:sudo] = opts.fetch(:sudo, true)
-      @config[:ruby_bindir] = opts.fetch(:ruby_bindir, DEFAULT_RUBY_BINDIR)
-      @config[:root_path] = opts.fetch(:root_path, DEFAULT_ROOT_PATH)
-      @config[:version] = opts.fetch(:version, "busser")
-      @config[:busser_bin] = opts.fetch(:busser_bin, File.join(@config[:root_path], "bin/busser"))
-    end
-
-    # Returns the name of this busser, suitable for display in a CLI.
-    #
-    # @return [String] name of this busser
-    def name
-      config[:suite_name]
-    end
-
-    # Returns an array of configuration keys.
-    #
-    # @return [Array] array of configuration keys
-    def config_keys
-      config.keys
-    end
-
-    # Provides hash-like access to configuration keys.
-    #
-    # @param attr [Object] configuration key
-    # @return [Object] value at configuration key
-    def [](attr)
-      config[attr]
-    end
-
-    # Returns a Hash of configuration and other useful diagnostic information.
-    #
-    # @return [Hash] a diagnostic hash
-    def diagnose
-      result = Hash.new
-      config_keys.sort.each { |k| result[k] = config[k] }
-      result
-    end
-
-    # Returns a command string which installs Busser, and installs all
-    # required Busser plugins for the suite.
-    #
-    # If no work needs to be performed, for example if there are no tests for
-    # the given suite, then `nil` will be returned.
-    #
-    # @return [String] a command string to setup the test suite, or nil if no
-    #   work needs to be performed
-    def setup_cmd
-      return if local_suite_files.empty?
-
-      ruby    = "#{config[:ruby_bindir]}/ruby"
-      gem     = sudo("#{config[:ruby_bindir]}/gem")
-      busser  = sudo(config[:busser_bin])
-
-      cmd = <<-CMD.gsub(/^ {8}/, "")
-        #{busser_setup_env}
-        gem_bindir=`#{ruby} -rrubygems -e "puts Gem.bindir"`
-
-        if ! #{gem} list busser -i >/dev/null; then
-          #{gem} install #{gem_install_args}
-        fi
-        #{sudo("${gem_bindir}")}/busser setup
-        #{busser} plugin install #{plugins.join(" ")}
-      CMD
-      Util.wrap_command(cmd)
-    end
-
-    # Returns a command string which transfers all suite test files to the
-    # instance.
-    #
-    # If no work needs to be performed, for example if there are no tests for
-    # the given suite, then `nil` will be returned.
-    #
-    # @return [String] a command string to transfer all suite test files, or
-    #   nil if no work needs to be performed.
-    def sync_cmd
-      return if local_suite_files.empty?
-
-      cmd = <<-CMD.gsub(/^ {8}/, "")
-        #{busser_setup_env}
-
-        #{sudo(config[:busser_bin])} suite cleanup
-
-      CMD
-      local_suite_files.each do |f|
-        cmd << stream_file(f, remote_file(f, config[:suite_name])).concat("\n")
-      end
-      helper_files.each do |f|
-        cmd << stream_file(f, remote_file(f, "helpers")).concat("\n")
-      end
-
-      Util.wrap_command(cmd)
-    end
-
-    # Returns a command string which runs all Busser suite tests for the suite.
-    #
-    # If no work needs to be performed, for example if there are no tests for
-    # the given suite, then `nil` will be returned.
-    #
-    # @return [String] a command string to run the test suites, or nil if no
-    #   work needs to be performed
-    def run_cmd
-      return if local_suite_files.empty?
-
-      cmd = <<-CMD.gsub(/^ {8}/, "")
-        #{busser_setup_env}
-
-        #{sudo(config[:busser_bin])} test
-      CMD
-
-      Util.wrap_command(cmd)
-    end
-
-    private
-
-    DEFAULT_RUBY_BINDIR = "/opt/chef/embedded/bin".freeze
-    DEFAULT_ROOT_PATH = "/tmp/busser".freeze
-
-    # @return [Hash] a configuration hash
-    # @api private
-    attr_reader :config
-
-    # Ensures that the object is internally consistent and otherwise raising
-    # an exception.
-    #
-    # @param suite_name [String] the suite name
-    # @raise [ClientError] if a suite name is missing
-    # @raise [UserError] if the suite name is invalid
-    # @api private
-    def validate_options(suite_name)
-      if suite_name.nil?
-        raise ClientError, "Busser#new requires a suite_name"
-      end
-
-      if suite_name == "helper"
-        raise UserError,
-          "Suite name invalid: 'helper' is a reserved directory name."
-      end
-    end
-
-    # Returns a uniquely sorted Array of Busser plugin gems that need to
-    # be installed for the related suite.
-    #
-    # @return [Array<String>] a lexically sorted, unique item array of Busser
-    #   plugin gem names
-    # @api private
-    def plugins
-      non_suite_dirs = %w[data data_bags environments nodes roles]
-      glob = File.join(config[:test_base_path], config[:suite_name], "*")
-      Dir.glob(glob).reject { |d|
-        !File.directory?(d) || non_suite_dirs.include?(File.basename(d))
-      }.map { |d| "busser-#{File.basename(d)}" }.sort.uniq
-    end
-
-    # Returns an Array of test suite filenames for the related suite currently
-    # residing on the local workstation. Any special provisioner-specific
-    # directories (such as a Chef roles/ directory) are excluded.
-    #
-    # @return [Array<String>] array of suite files
-    # @api private
-    def local_suite_files
-      base = File.join(config[:test_base_path], config[:suite_name])
-      glob = File.join(base, "*/**/*")
-      Dir.glob(glob).reject do |f|
-        chef_data_dir?(base, f) || File.directory?(f)
-      end
-    end
-
-    # Determines whether or not a local workstation file exists under a
-    # Chef-related directory.
-    #
-    # @return [truthy,falsey] whether or not a given file is some kind of
-    #   Chef-related file
-    # @api private
-    def chef_data_dir?(base, file)
-      file =~ %r{^#{base}/(data|data_bags|environments|nodes|roles)/}
-    end
-
-    # Returns an Array of common helper filenames currently residing on the
-    # local workstation.
-    #
-    # @return [Array<String>] array of helper files
-    # @api private
-    def helper_files
-      glob = File.join(config[:test_base_path], "helpers", "*/**/*")
-      Dir.glob(glob).reject { |f| File.directory?(f) }
-    end
-
-    # Returns a command string that will, once evaluated, result in the
-    # fully qualified destination path of a file on an instance.
-    #
-    # @param file [String] absolute path to the local file
-    # @param dir [String] suite directory or helper directory name
-    # @return [String] command string
-    # @api private
-    def remote_file(file, dir)
-      local_prefix = File.join(config[:test_base_path], dir)
-      "`#{sudo(config[:busser_bin])} suite path`/".
-        concat(file.sub(%r{^#{local_prefix}/}, ""))
-    end
-
-    # Returns a command string that will, once evaluated, result in the copying
-    # of a local file to a remote instance.
-    #
-    # @param local_path [String] the path to a local source file for copying
-    # @param remote_path [String] the destrination path on the remote instance
-    # @return [String] command string
-    # @api private
-    def stream_file(local_path, remote_path)
-      local_file = IO.read(local_path)
-      encoded_file = Base64.encode64(local_file).gsub("\n", "")
-      md5 = Digest::MD5.hexdigest(local_file)
-      perms = format("%o", File.stat(local_path).mode)[2, 4]
-      stream_cmd = [
-        sudo(config[:busser_bin]),
-        "deserialize",
-        "--destination=#{remote_path}",
-        "--md5sum=#{md5}",
-        "--perms=#{perms}"
-      ].join(" ")
-
-      [
-        %{echo "Uploading #{remote_path} (mode=#{perms})"},
-        %{echo "#{encoded_file}" | #{stream_cmd}}
-      ].join("\n").concat("\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(command)
-      config[:sudo] ? "sudo -E #{command}" : command
-    end
-
-    # Returns a command string that sets appropriate environment variables for
-    # busser commands.
-    #
-    # @return [String] command string
-    # @api private
-    def busser_setup_env
-      [
-        %{BUSSER_ROOT="#{config[:root_path]}"},
-        %{GEM_HOME="#{config[:root_path]}/gems"},
-        %{GEM_PATH="#{config[:root_path]}/gems"},
-        %{GEM_CACHE="#{config[:root_path]}/gems/cache"},
-        %{\nexport BUSSER_ROOT GEM_HOME GEM_PATH GEM_CACHE}
-      ].join(" ")
-    end
-
-    # Returns arguments to a `gem install` command, suitable to install the
-    # Busser gem.
-    #
-    # @return [String] arguments string
-    # @api private
-    def gem_install_args
-      gem, version = config[:version].split("@")
-      gem, version = "busser", gem if gem =~ /^\d+\.\d+\.\d+/
-
-      args = gem
-      args += " --version #{version}" if version
-      args += " --no-rdoc --no-ri"
-      args
-    end
-  end
-end