busser 0.8.0 → 0.9.1

data/lib/busser/cucumber.rb

@@ -1,123 +1,143 @@
 begin
-  require 'aruba/cucumber'
+  require "aruba/cucumber"
 rescue LoadError
   abort "The aruba gem must be in your development dependencies"
 end
 
-require 'busser/cucumber/hooks'
+require "busser/cucumber/hooks"
 
-require 'tmpdir' unless defined?(Dir.mktmpdir)
-require 'pathname' unless defined?(Pathname)
+require "fileutils" unless defined?(FileUtils)
+require "tmpdir" unless defined?(Dir.mktmpdir)
+require "pathname" unless defined?(Pathname)
 
 Given(/^a BUSSER_ROOT of "(.*?)"$/) do |busser_root|
-  backup_envvar('BUSSER_ROOT')
+  backup_envvar("BUSSER_ROOT")
 
-  ENV['BUSSER_ROOT'] = busser_root
+  ENV["BUSSER_ROOT"] = busser_root
 end
 
 Given(/^a test BUSSER_ROOT directory named "(.*?)"$/) do |name|
-  backup_envvar('BUSSER_ROOT')
+  backup_envvar("BUSSER_ROOT")
 
   busser_root = Pathname.new(Dir.mktmpdir(name))
   (busser_root + "suites").mkpath
-  ENV['BUSSER_ROOT'] = busser_root.to_s
+  ENV["BUSSER_ROOT"] = busser_root.to_s
+  # aruba 2.x runs commands with its own environment, so set it there too
+  set_environment_variable("BUSSER_ROOT", busser_root.to_s)
   @busser_root_dirs << busser_root
 end
 
 Given(/^I delete the BUSSER_ROOT directory$/) do
-  FileUtils.rm_rf(ENV['BUSSER_ROOT'])
+  FileUtils.rm_rf(ENV["BUSSER_ROOT"])
 end
 
 Given(/^a suite directory named "(.*?)"$/) do |name|
-  FileUtils.mkdir_p(File.join(ENV['BUSSER_ROOT'], "suites", name))
+  FileUtils.mkdir_p(File.join(ENV["BUSSER_ROOT"], "suites", name))
 end
 
 Given(/^a file in suite "(.*?)" named "(.*?)" with:$/) do |suite, file, content|
-  file_name = File.join(ENV['BUSSER_ROOT'], "suites", suite, file)
-  write_file(file_name, content)
+  # BUSSER_ROOT is outside aruba's working directory, and aruba 1.0+ refuses
+  # absolute paths in its file helpers, so write it directly.
+  file_name = File.join(ENV["BUSSER_ROOT"], "suites", suite, file)
+  FileUtils.mkdir_p(File.dirname(file_name))
+  File.write(file_name, content)
 end
 
 Given(/^a sandboxed GEM_HOME directory named "(.*?)"$/) do |name|
-  backup_envvar('GEM_HOME')
-  backup_envvar('GEM_PATH')
+  backup_envvar("GEM_HOME")
+  backup_envvar("GEM_PATH")
 
   gem_home = Pathname.new(Dir.mktmpdir(name))
-  ENV['GEM_HOME'] = gem_home.to_s
-  ENV['GEM_PATH'] = [gem_home.to_s, ENV['GEM_PATH']].join(':')
+  ENV["GEM_HOME"] = gem_home.to_s
+  ENV["GEM_PATH"] = [gem_home.to_s, ENV["GEM_PATH"]].join(":")
+  set_environment_variable("GEM_HOME", ENV["GEM_HOME"])
+  set_environment_variable("GEM_PATH", ENV["GEM_PATH"])
   @busser_root_dirs << gem_home
 end
 
 Given(/^a non bundler environment$/) do
-  %w[BUNDLER_EDITOR BUNDLE_BIN_PATH BUNDLE_GEMFILE RUBYOPT].each do |key|
+  # Where bundler is currently serving gems from: vendor/bundle/ruby/<abi>
+  # when the bundle is vendored, the system gem directory otherwise. Busser's
+  # own runtime dependencies live there, so the child still needs it on
+  # GEM_PATH once bundler is gone. Read it while RubyGems still points at it.
+  bundled_gem_dir = Gem.dir
+
+  # RubyGems auto-requires bundler/setup whenever BUNDLER_SETUP is set, so
+  # leaving that behind lets bundler re-activate inside the child, walk up to
+  # this repository's Gemfile and .bundle/config, and reset GEM_HOME to the
+  # bundle -- plugins would install there instead of the sandbox.
+  %w{
+    BUNDLER_EDITOR BUNDLER_SETUP BUNDLER_VERSION
+    BUNDLE_BIN_PATH BUNDLE_GEMFILE BUNDLE_LOCKFILE BUNDLE_PATH
+    RUBYLIB RUBYOPT
+  }.each do |key|
     backup_envvar(key)
     ENV.delete(key)
+    delete_environment_variable(key)
   end
+
+  ENV["GEM_PATH"] =
+    [ENV["GEM_PATH"], bundled_gem_dir].compact.reject(&:empty?).join(":")
+  set_environment_variable("GEM_PATH", ENV["GEM_PATH"])
 end
 
 Then(/^the suite directory named "(.*?)" should exist$/) do |name|
-  directory = File.join(ENV['BUSSER_ROOT'], "suites", name)
-  check_directory_presence([directory], true)
+  directory = File.join(ENV["BUSSER_ROOT"], "suites", name)
+  expect(Dir).to exist(directory)
 end
 
 Then(/^the suite directory named "(.*?)" should not exist$/) do |name|
-  directory = File.join(ENV['BUSSER_ROOT'], "suites", name)
-  check_directory_presence([directory], false)
+  directory = File.join(ENV["BUSSER_ROOT"], "suites", name)
+  expect(Dir).to_not exist(directory)
 end
 
 Then(/^the suite file "(.*?)" should contain exactly:$/) do |file, content|
-  file_name = File.join(ENV['BUSSER_ROOT'], "suites", file)
-  check_file_content(file_name, content)
+  file_name = File.join(ENV["BUSSER_ROOT"], "suites", file)
+  expect(File.read(file_name)).to eq(content)
 end
 
 Then(/^the vendor directory named "(.*?)" should exist$/) do |name|
-  directory = File.join(ENV['BUSSER_ROOT'], "vendor", name)
-  check_directory_presence([directory], true)
+  directory = File.join(ENV["BUSSER_ROOT"], "vendor", name)
+  expect(Dir).to exist(directory)
 end
 
 Then(/^the vendor directory named "(.*?)" should not exist$/) do |name|
-  directory = File.join(ENV['BUSSER_ROOT'], "vendor", name)
-  check_directory_presence([directory], false)
+  directory = File.join(ENV["BUSSER_ROOT"], "vendor", name)
+  expect(Dir).to_not exist(directory)
 end
 
 Then(/^the vendor file "(.*?)" should contain "(.*?)"$/) do |file, content|
-  file_name = File.join(ENV['BUSSER_ROOT'], "vendor", file)
-  check_file_content(file_name, content, true)
+  file_name = File.join(ENV["BUSSER_ROOT"], "vendor", file)
+  expect(File.read(file_name)).to include(content)
 end
 
+# Check the sandboxed GEM_HOME directly. Shelling out to `gem list` depends on
+# the child process inheriting the sandbox and a bundler-free environment,
+# which aruba 2.x no longer arranges for us.
 Then(/^a gem named "(.*?)" is installed with version "(.*?)"$/) do |name, ver|
-  unbundlerize do
-    run_simple(unescape("gem list #{name} --version #{ver} -i"), true, nil)
-  end
+  specs = Dir.glob(File.join(ENV["GEM_HOME"], "specifications", "#{name}-#{ver}.gemspec"))
+  expect(specs).to_not be_empty
 end
 
 Then(/^a gem named "(.*?)" is installed$/) do |name|
-  unbundlerize do
-    run_simple(unescape("gem list #{name} -i"), true, nil)
-  end
+  specs = Dir.glob(File.join(ENV["GEM_HOME"], "specifications", "#{name}-*.gemspec"))
+  expect(specs).to_not be_empty
 end
 
 Then(/^the BUSSER_ROOT directory should exist$/) do
-  check_directory_presence([ENV['BUSSER_ROOT']], true)
+  expect(Dir).to exist(ENV["BUSSER_ROOT"])
 end
 
 Then(/^a busser binstub file should contain:$/) do |partial_content|
-  file = File.join(ENV['BUSSER_ROOT'], %w{bin busser})
-  check_file_content(file, Regexp.new(Regexp.escape(partial_content)), true)
+  file = File.join(ENV["BUSSER_ROOT"], %w{bin busser})
+  expect(File.read(file)).to include(partial_content)
 end
 
 Then(/^a bat busser binstub file should contain:$/) do |partial_content|
-  file = File.join(ENV['BUSSER_ROOT'], %w{bin busser.bat})
-  check_file_content(file, Regexp.new(Regexp.escape(partial_content)), true)
-end
-
-Then(/^the file "(.*?)" should have permissions "(.*?)"$/) do |file, perms|
-  in_current_directory do
-    file_perms = sprintf("%o", File.stat(file).mode)
-    file_perms = file_perms[2, 4]
-    expect(file_perms).to eq(perms)
-  end
+  file = File.join(ENV["BUSSER_ROOT"], %w{bin busser.bat})
+  expect(File.read(file)).to include(partial_content)
 end
 
 Then(/^pry me$/) do
-  require 'pry' ; binding.pry
+  require "pry"; binding.pry # rubocop:disable Lint/Debugger
 end

data/lib/busser/helpers.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #
@@ -16,9 +15,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'pathname' unless defined?(Pathname)
+require "pathname" unless defined?(Pathname)
 
-require 'busser/rubygems'
+require "busser/rubygems"
 
 module Busser
 
@@ -43,12 +42,12 @@ module Busser
     end
 
     def root_path
-      Pathname.new(ENV['BUSSER_ROOT'] || "/opt/busser")
+      Pathname.new(ENV["BUSSER_ROOT"] || "/opt/busser")
     end
 
     def chef_apply(config = {}, &block)
       warn "Apologies, but Busser no longer supports the chef_apply helper," +
-        " so the contents of this block will not be exectued. Please refactor" +
+        " so the contents of this block will not be executed. Please refactor" +
         " your code to use Thor actions, shell out commands or another" +
         " strategy"
     end

data/lib/busser/plugin.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #
@@ -35,16 +34,22 @@ module Busser
 
     def runner_plugins(plugin_names = nil)
       if plugin_names
-        Array(plugin_names).map { |plugin| runner_plugin(plugin) }
+        Array(plugin_names).map { |plugin| runner_plugin(plugin) }.uniq
       else
         all_runner_plugins
       end
     end
 
+    # Gem.find_files searches every installed gem version, not just the
+    # newest, so a machine holding two versions of a plugin gem reports that
+    # plugin twice. Callers treat each entry as one suite to run, so the
+    # duplicates made `busser test` run a suite twice and `busser plugin list`
+    # print it twice. The path is what gets required, and require resolves to
+    # the active version, so collapsing the repeats is safe.
     def all_runner_plugins
-      Gem.find_files('busser/runner_plugin/*.rb').map do |file|
-        "busser/runner_plugin/#{File.basename(file).sub(/\.rb$/, '')}"
-      end
+      Gem.find_files("busser/runner_plugin/*.rb").map do |file|
+        "busser/runner_plugin/#{File.basename(file).sub(/\.rb$/, "")}"
+      end.uniq
     end
 
     def require!(plugin_path)
@@ -60,7 +65,8 @@ module Busser
     def gem_from_path(plugin_path)
       local_gem_path = "#{File.expand_path(plugin_path, $LOAD_PATH.first)}"
       local_gemspec = File.join(
-        File.dirname($LOAD_PATH.first), "busser.gemspec")
+        File.dirname($LOAD_PATH.first), "busser.gemspec"
+      )
 
       if ! Dir.glob("#{local_gem_path}#{Gem.suffix_pattern}").empty?
         Gem::Specification.load(File.expand_path(local_gemspec))

data/lib/busser/rubygems.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #
@@ -16,7 +15,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'rubygems/dependency_installer'
+require "rubygems/dependency_installer"
 
 module Busser
 
@@ -33,29 +32,44 @@ module Busser
       ! Gem::Dependency.new(name, version).matching_specs.empty?
     end
 
-    def install_gem(gem, version)
+    def install_gem(gem_name, version)
       version = Gem::Requirement.default unless version
 
+      # A bundler-managed environment can leave Gem.dir pointing at the bundle,
+      # which is not where busser plugins belong. Point RubyGems at GEM_HOME.
+      gem_home = ENV.fetch("GEM_HOME", nil)
+      Gem.use_paths(gem_home, Gem.path) if gem_home && Gem.dir != gem_home
+
       inst = Gem::DependencyInstaller.new(rbg_options)
-      specs = inst.install(gem, Gem::Requirement.create(version))
+      specs = inst.install(gem_name, Gem::Requirement.create(version))
 
       Gem.clear_paths
-      specs.find { |s| s.name == gem }
+      spec = specs.find { |s| s.name == gem_name }
+      # Modern RubyGems does not put a freshly installed gem on the load path.
+      # Add it directly rather than activating, so installing a second version
+      # in the same process does not raise a Gem::LoadError conflict.
+      spec&.full_require_paths&.each do |path|
+        $LOAD_PATH.unshift(path) unless $LOAD_PATH.include?(path)
+      end
+      spec
     end
 
     def rbg_options
       @rbg_options ||= Gem::DependencyInstaller::DEFAULT_OPTIONS.merge(
-        :suggest_alternate => false,
-        :version => Gem::Requirement.default,
-        :without_groups => [],
-        :minimal_deps => true,
-        :http_proxy => ENV.fetch("http_proxy", ENV.fetch("HTTP_PROXY", nil))
+        suggest_alternate: false,
+        version: Gem::Requirement.default,
+        without_groups: [],
+        minimal_deps: true,
+        # Install into GEM_HOME explicitly. Under bundler Gem.dir points at the
+        # bundle path, which is not where busser plugins belong.
+        install_dir: ENV.fetch("GEM_HOME", nil),
+        http_proxy: ENV.fetch("http_proxy", ENV.fetch("HTTP_PROXY", nil))
       )
     end
 
     def silence_gem_ui
       interaction = Gem::DefaultUserInteraction.ui
-      if !Gem.configuration.really_verbose
+      unless Gem.configuration.really_verbose
         Gem::DefaultUserInteraction.ui = Gem::SilentUI.new
       end
       yield

data/lib/busser/runner_plugin/dummy.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #
@@ -16,7 +15,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'busser/runner_plugin'
+require "busser/runner_plugin"
 
 # Dummy runner plugin for Busser.
 #
@@ -37,7 +36,7 @@ class Busser::RunnerPlugin::Dummy < Busser::RunnerPlugin::Base
 
   def test
     banner "[dummy] Running"
-    if File.exists?(File.join(suite_path("dummy"), "foobar.txt"))
+    if File.exist?(File.join(suite_path("dummy"), "foobar.txt"))
       info "[dummy] The postinstall script has been called"
     else
       warn "[dummy] The postinstall script was not called"

data/lib/busser/runner_plugin.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #
@@ -16,7 +15,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'busser/thor'
+require "busser/thor"
 
 module Busser
 

data/lib/busser/thor.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #
@@ -16,10 +15,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'thor' unless defined?(Thor)
+require "thor" unless defined?(Thor)
 
-require 'busser/helpers'
-require 'busser/ui'
+require "busser/helpers"
+require "busser/ui"
 
 module Busser
 

data/lib/busser/ui.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #
@@ -16,7 +15,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'thor/shell'
+require "thor/shell"
 
 module Busser
 
@@ -28,6 +27,16 @@ module Busser
 
     module_function
 
+    # Thor::Shell's delegated methods are not mixed into this module, so
+    # provide the two output primitives it relies on.
+    def say(msg)
+      $stdout.puts(msg)
+    end
+
+    def error(msg)
+      $stderr.puts(msg)
+    end
+
     def banner(msg)
       say("-----> #{msg}")
     end
@@ -45,7 +54,7 @@ module Busser
     end
 
     def run!(cmd, config = {})
-      config = { :capture => false, :verbose => false }.merge(config)
+      config = { capture: false, verbose: false }.merge(config)
 
       handle_command("Command", cmd) do
         run(cmd, config)
@@ -53,7 +62,7 @@ module Busser
     end
 
     def run_ruby_script!(cmd, config = {})
-      config = { :capture => false, :verbose => false }.merge(config)
+      config = { capture: false, verbose: false }.merge(config)
 
       handle_command("Ruby Script", cmd) do
         run_ruby_script(cmd, config)
@@ -75,7 +84,8 @@ module Busser
       rescue => e
         fatal(
           "#{type} [#{cmd}] raised an exception: #{e.message}\n" +
-          e.backtrace.join("\n"))
+          e.backtrace.join("\n")
+        )
         raise
       end
 
@@ -86,6 +96,14 @@ module Busser
         )
       elsif status.success?
         true
+      elsif status.exitstatus.nil?
+        # A process killed by a signal has no exit status, and Kernel#exit
+        # rejects nil, so reporting it as an exit code raised a TypeError and
+        # took Busser down with a stack trace rather than a diagnosis. Signals
+        # are how the out of memory killer stops a test run, which is the same
+        # situation the nil status branch above was written for.
+        signal = status.termsig
+        die("#{type} [#{cmd}] was terminated by signal #{signal}", 128 + signal)
       else
         code = status.exitstatus
         die("#{type} [#{cmd}] exit code was #{code}", code)

data/lib/busser/version.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #
@@ -17,5 +16,5 @@
 # limitations under the License.
 
 module Busser
-  VERSION = "0.8.0"
+  VERSION = "0.9.1".freeze
 end

data/lib/busser.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #
@@ -16,9 +15,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'pathname' unless defined?(Pathname)
+require "pathname" unless defined?(Pathname)
 
-require 'busser/version'
+require "busser/version"
 
 # Busser - Runs tests for projects in Test Kitchen.
 #
@@ -30,6 +29,6 @@ module Busser
   #
   # @return [Pathname] root path of gem
   def self.source_root
-    @source_root ||= Pathname.new(File.expand_path('../../', __FILE__))
+    @source_root ||= Pathname.new(File.expand_path("..", __dir__))
   end
 end

data/release-please-config.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json",
+  "bootstrap-sha": "9ff44ee27bd8863c0a197d9976c25623c8c05fc0",
+  "packages": {
+    ".": {
+      "package-name": "busser",
+      "changelog-path": "CHANGELOG.md",
+      "release-type": "ruby",
+      "include-component-in-tag": false,
+      "version-file": "lib/busser/version.rb"
+    }
+  }
+}

data/renovate.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "config:recommended",
+    "helpers:pinGitHubActionDigests",
+    ":semanticCommits"
+  ]
+}

data/spec/busser/command/deserialize_spec.rb

@@ -0,0 +1,110 @@
+# -*- encoding: utf-8 -*-
+#
+# 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 "base64"
+require "digest/md5"
+require "tmpdir"
+
+require "busser/command/deserialize"
+
+# Deserialize is how Test Kitchen streams a file onto the instance under test,
+# so the thing worth pinning down is what ends up on disk.
+describe Busser::Command::Deserialize do
+
+  CONTENTS = "Hello there.\n".freeze
+
+  before do
+    @tmpdir = Dir.mktmpdir("busser-deserialize")
+    @file = File.join(@tmpdir, "nested", "decoded.txt")
+  end
+
+  after do
+    FileUtils.rm_rf(@tmpdir)
+  end
+
+  describe "with a matching digest" do
+
+    it "writes the decoded contents" do
+      deserialize(md5sum: Digest::MD5.hexdigest(CONTENTS))
+
+      _(File.read(@file)).must_equal CONTENTS
+    end
+
+    it "creates any missing parent directories" do
+      deserialize(md5sum: Digest::MD5.hexdigest(CONTENTS))
+
+      _(File.directory?(File.dirname(@file))).must_equal true
+    end
+
+    it "applies the requested permissions" do
+      deserialize(md5sum: Digest::MD5.hexdigest(CONTENTS), perms: "0755")
+
+      _(format("%o", File.stat(@file).mode & 0o777)).must_equal "755"
+    end
+
+    it "writes binary content unchanged" do
+      binary = "\x00\x01\x02\xFF".dup.force_encoding("ASCII-8BIT")
+
+      deserialize(contents: binary, md5sum: Digest::MD5.hexdigest(binary))
+
+      _(File.binread(@file)).must_equal binary
+    end
+  end
+
+  describe "with a mismatching digest" do
+
+    it "fails the command" do
+      _ { deserialize(md5sum: "not-the-right-digest") }.must_raise SystemExit
+    end
+
+    # The digest used to be checked only after the write, so a corrupted or
+    # truncated stream still landed on disk, with its requested permissions,
+    # for a later command to pick up and run.
+    it "leaves no file behind" do
+      _ { deserialize(md5sum: "not-the-right-digest") }.must_raise SystemExit
+
+      _(File.exist?(@file)).must_equal false
+    end
+
+    it "does not overwrite a file that is already there" do
+      FileUtils.mkdir_p(File.dirname(@file))
+      File.write(@file, "original contents")
+
+      _ { deserialize(md5sum: "not-the-right-digest") }.must_raise SystemExit
+
+      _(File.read(@file)).must_equal "original contents"
+    end
+  end
+
+  def deserialize(md5sum:, contents: CONTENTS, perms: "0644")
+    STDIN.stubs(:read).returns(Base64.encode64(contents))
+
+    command = Busser::Command::Deserialize.new([], {
+      "destination" => @file,
+      "md5sum" => md5sum,
+      "perms" => perms,
+    })
+    capture_stderr { command.perform }
+  end
+
+  def capture_stderr
+    original = $stderr
+    $stderr = StringIO.new
+    yield
+  ensure
+    $stderr = original
+  end
+end