busser 0.8.0 → 0.9.0

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
 

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.0".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

data/spec/busser/helpers_spec.rb

@@ -9,17 +9,17 @@ describe Busser::Helpers do
   describe ".suite_path" do
 
     it "returns a Pathname" do
-      suite_path.must_be_kind_of Pathname
+      _(suite_path).must_be_kind_of Pathname
     end
 
     describe "with a default root path" do
 
       it "returns a base path if no suite name is given" do
-        suite_path.to_s.must_match %r{/opt/busser/suites$}
+        _(suite_path.to_s).must_match %r{/opt/busser/suites$}
       end
 
       it "returns a suite path given a suite name" do
-        suite_path("fuzzy").to_s.must_match %r{/opt/busser/suites/fuzzy$}
+        _(suite_path("fuzzy").to_s).must_match %r{/opt/busser/suites/fuzzy$}
       end
     end
 
@@ -30,12 +30,12 @@ describe Busser::Helpers do
 
       it "returns a base path if no suite name is given" do
         ENV['BUSSER_ROOT'] = "/path/to/busser"
-        suite_path.to_s.must_match %r{/path/to/busser/suites$}
+        _(suite_path.to_s).must_match %r{/path/to/busser/suites$}
       end
 
       it "returns a suite path given a suite name" do
         ENV['BUSSER_ROOT'] = "/path/to/busser"
-        suite_path("fuzzy").to_s.must_match %r{/path/to/busser/suites/fuzzy$}
+        _(suite_path("fuzzy").to_s).must_match %r{/path/to/busser/suites/fuzzy$}
       end
     end
   end
@@ -43,17 +43,17 @@ describe Busser::Helpers do
   describe ".vendor_path" do
 
     it "returns a Pathname" do
-      vendor_path.must_be_kind_of Pathname
+      _(vendor_path).must_be_kind_of Pathname
     end
 
     describe "with a default root path" do
 
       it "returns a base path if no product name is given" do
-        vendor_path.to_s.must_match %r{/opt/busser/vendor$}
+        _(vendor_path.to_s).must_match %r{/opt/busser/vendor$}
       end
 
       it "returns a vendor path given a product name" do
-        vendor_path("supreme").to_s.must_match %r{/opt/busser/vendor/supreme$}
+        _(vendor_path("supreme").to_s).must_match %r{/opt/busser/vendor/supreme$}
       end
     end
 
@@ -64,12 +64,12 @@ describe Busser::Helpers do
 
       it "returns a base path if no product name is given" do
         ENV['BUSSER_ROOT'] = "/path/to/busser"
-        vendor_path.to_s.must_match %r{/path/to/busser/vendor$}
+        _(vendor_path.to_s).must_match %r{/path/to/busser/vendor$}
       end
 
       it "returns a suite path given a product name" do
         ENV['BUSSER_ROOT'] = "/path/to/busser"
-        vendor_path("maximal").to_s.must_match \
+        _(vendor_path("maximal").to_s).must_match \
           %r{/path/to/busser/vendor/maximal$}
       end
     end

data/spec/busser/plugin_spec.rb

@@ -0,0 +1,133 @@
+# -*- 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 "busser/plugin"
+require "busser/ui"
+
+describe Busser::Plugin do
+
+  describe ".runner_plugin" do
+
+    it "builds the require path for a plugin name" do
+      _(Busser::Plugin.runner_plugin("bash"))
+        .must_equal "busser/runner_plugin/bash"
+    end
+  end
+
+  describe ".runner_plugins" do
+
+    it "maps each given name to its require path" do
+      _(Busser::Plugin.runner_plugins(%w{bash minitest})).must_equal [
+        "busser/runner_plugin/bash",
+        "busser/runner_plugin/minitest",
+      ]
+    end
+
+    it "accepts a single name that is not in an array" do
+      _(Busser::Plugin.runner_plugins("bash"))
+        .must_equal ["busser/runner_plugin/bash"]
+    end
+
+    # Callers run one suite per entry, so a repeated name would run that
+    # suite twice.
+    it "returns a name given more than once only once" do
+      _(Busser::Plugin.runner_plugins(%w{bash bash}))
+        .must_equal ["busser/runner_plugin/bash"]
+    end
+
+    it "falls back to every installed plugin when given no names" do
+      Busser::Plugin.expects(:all_runner_plugins).returns(["stubbed"])
+
+      _(Busser::Plugin.runner_plugins).must_equal ["stubbed"]
+    end
+  end
+
+  describe ".all_runner_plugins" do
+
+    it "turns each found file into a require path" do
+      stub_found_files %w{
+        /gems/busser-bash-0.1.1/lib/busser/runner_plugin/bash.rb
+        /gems/busser-serverspec-0.5.0/lib/busser/runner_plugin/serverspec.rb
+      }
+
+      _(Busser::Plugin.all_runner_plugins).must_equal [
+        "busser/runner_plugin/bash",
+        "busser/runner_plugin/serverspec",
+      ]
+    end
+
+    # Gem.find_files searches every installed version of every gem. A machine
+    # that has installed a plugin more than once therefore reports it once per
+    # version, which made `busser test` run that suite repeatedly and
+    # `busser plugin list` print it repeatedly.
+    it "reports a plugin once when several versions of its gem are installed" do
+      stub_found_files %w{
+        /gems/busser-bash-0.1.1/lib/busser/runner_plugin/bash.rb
+        /gems/busser-bash-0.1.0/lib/busser/runner_plugin/bash.rb
+      }
+
+      _(Busser::Plugin.all_runner_plugins)
+        .must_equal ["busser/runner_plugin/bash"]
+    end
+
+    it "keeps the first occurrence, which is the newest version found" do
+      stub_found_files %w{
+        /gems/busser-bash-0.1.1/lib/busser/runner_plugin/bash.rb
+        /gems/busser-bash-0.1.0/lib/busser/runner_plugin/bash.rb
+        /gems/busser-serverspec-0.5.0/lib/busser/runner_plugin/serverspec.rb
+      }
+
+      _(Busser::Plugin.all_runner_plugins).must_equal [
+        "busser/runner_plugin/bash",
+        "busser/runner_plugin/serverspec",
+      ]
+    end
+
+    it "returns nothing when no plugins are installed" do
+      stub_found_files []
+
+      _(Busser::Plugin.all_runner_plugins).must_equal []
+    end
+
+    def stub_found_files(files)
+      Gem.expects(:find_files)
+        .with("busser/runner_plugin/*.rb")
+        .returns(files)
+    end
+  end
+
+  describe ".require!" do
+
+    it "requires the given path" do
+      Busser::Plugin.expects(:require).with("busser/runner_plugin/bash")
+
+      Busser::Plugin.require!("busser/runner_plugin/bash")
+    end
+
+    # A plugin gem that is listed but not loadable is a common failure on a
+    # test instance, and the message is the only clue the user gets.
+    it "dies with the offending path when the plugin cannot be loaded" do
+      Busser::Plugin.stubs(:require).raises(LoadError, "no such file")
+      Busser::UI.expects(:die).with do |message|
+        message.include?("busser/runner_plugin/nope") &&
+          message.include?("LoadError") &&
+          message.include?("no such file")
+      end
+
+      Busser::Plugin.require!("busser/runner_plugin/nope")
+    end
+  end
+end