busser 0.9.1 → 0.9.3

data/spec/busser/command/plugin_create_spec.rb

@@ -1,4 +1,3 @@
-# -*- 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.
@@ -87,12 +86,24 @@ describe Busser::Command::PluginCreate do
       end
     end
 
-    it "depends on what the generated Rakefile needs" do
+    # These moved into the Gemfile, so the gemspec declares only what a
+    # consumer of the gem needs at runtime -- matching the busser-* plugins.
+    it "leaves development dependencies out of the gemspec" do
       generate
 
-      _(dev_dependencies).must_include "rake"
-      _(dev_dependencies).must_include "cucumber"
-      _(dev_dependencies).must_include "aruba"
+      _(dev_dependencies).must_be_empty
+    end
+
+    # busser-bash resolved busser 0.6.0 and failed its own suite because the
+    # requirement was open. A generated plugin should not start there.
+    it "requires a busser new enough to run the generated features" do
+      generate
+
+      busser = gemspec.dependencies.find { |d| d.name == "busser" }
+
+      _(busser).wont_be_nil
+      _(busser.requirement.satisfied_by?(Gem::Version.new("0.9.0"))).must_equal true
+      _(busser.requirement.satisfied_by?(Gem::Version.new("0.6.0"))).must_equal false
     end
 
     it "states a supported Ruby version" do
@@ -113,6 +124,25 @@ describe Busser::Command::PluginCreate do
     end
   end
 
+  describe "the generated Gemfile" do
+
+    it "declares what the generated Rakefile needs" do
+      generate
+
+      body = File.read(File.join(plugin_dir, "Gemfile"))
+
+      %w{rake cucumber aruba}.each { |g| _(body).must_include "'#{g}'" }
+    end
+
+    # cucumber needs base64 on Ruby 4.0, where it is no longer a default gem.
+    it "declares base64" do
+      generate
+
+      _(File.read(File.join(plugin_dir, "Gemfile"))).must_include "'base64'"
+    end
+
+  end
+
   describe "the generated project" do
 
     it "ships a CI workflow rather than a Travis config" do
@@ -153,9 +183,51 @@ describe Busser::Command::PluginCreate do
     end
   end
 
-  def generate(license: "apachev2")
+  # A name becomes a Ruby constant, and Thor's camel_case only folds
+  # underscores. "my-junit" produced `module My-junit`, which does not parse --
+  # and the generator ran to completion anyway, leaving a project that could
+  # not be loaded at all.
+  describe "the plugin name" do
+
+    %w{demo junit my_junit j2 x}.each do |name|
+      it "accepts #{name.inspect}" do
+        generate(name: name)
+
+        _(Dir.exist?(File.join(@tmpdir, "busser-#{name}"))).must_equal true
+      end
+    end
+
+    {
+      "my-junit" => "a hyphen cannot appear in a constant",
+      "My_Junit" => "an uppercase start is not a plugin name",
+      "2fast" => "a constant cannot start with a digit",
+      "my junit" => "a space cannot appear in a constant or a path",
+      "" => "an empty name",
+      "../escaped" => "a path fragment",
+    }.each do |name, why|
+      it "rejects #{name.inspect} -- #{why}" do
+        err = _(proc { generate(name: name) }).must_raise ::Thor::Error
+
+        _(err.message).must_include "not a usable plugin name"
+      end
+    end
+
+    it "writes nothing when the name is rejected" do
+      _(proc { generate(name: "my-junit") }).must_raise ::Thor::Error
+
+      _(Dir.glob(File.join(@tmpdir, "*"))).must_be_empty
+    end
+
+    it "suggests a usable name" do
+      err = _(proc { generate(name: "my-junit") }).must_raise ::Thor::Error
+
+      _(err.message).must_include "'my_junit'"
+    end
+  end
+
+  def generate(license: "apachev2", name: "demo")
     command = Busser::Command::PluginCreate.new(
-      ["demo"], { "type" => "runner", "license" => license }
+      [name], { "type" => "runner", "license" => license }
     )
     command.stubs(:initialize_git)
     capture_stdout { command.create }

data/spec/busser/command/plugin_install_spec.rb

@@ -0,0 +1,44 @@
+require_relative "../../spec_helper"
+
+require "busser/command/plugin_install"
+
+describe Busser::Command::PluginInstall do
+  let(:command) { Busser::Command::PluginInstall.new([%w{busser-dummy}]) }
+
+  describe "#drop_ssl_verify_peer" do
+    # VERIFY_PEER is a process-global constant, so anything that leaves it
+    # lowered affects every later gem download in the same run. `busser plugin
+    # install` takes a list of plugins, which is exactly that situation.
+    it "lowers verification for the block" do
+      inside = nil
+      command.send(:drop_ssl_verify_peer) { inside = OpenSSL::SSL::VERIFY_PEER }
+
+      _(inside).must_equal OpenSSL::SSL::VERIFY_NONE
+    end
+
+    it "restores verification afterwards" do
+      before = OpenSSL::SSL::VERIFY_PEER
+      command.send(:drop_ssl_verify_peer) { nil }
+
+      _(OpenSSL::SSL::VERIFY_PEER).must_equal before
+    end
+
+    # The regression this guards. A postinstall raising is not exotic: it is
+    # how a plugin reports that it could not install its test framework.
+    it "restores verification when the block raises" do
+      before = OpenSSL::SSL::VERIFY_PEER
+
+      _(proc { command.send(:drop_ssl_verify_peer) { raise "postinstall blew up" } })
+        .must_raise RuntimeError
+
+      _(OpenSSL::SSL::VERIFY_PEER).must_equal before
+    end
+
+    it "restores verification when the block throws" do
+      before = OpenSSL::SSL::VERIFY_PEER
+      catch(:done) { command.send(:drop_ssl_verify_peer) { throw :done } }
+
+      _(OpenSSL::SSL::VERIFY_PEER).must_equal before
+    end
+  end
+end

data/spec/busser/command/plugin_list_spec.rb

@@ -0,0 +1,49 @@
+require_relative "../../spec_helper"
+
+require "busser/command/plugin_list"
+
+describe Busser::Command::PluginList do
+  let(:command) { Busser::Command::PluginList.new }
+
+  describe "#plugin_data" do
+    def stub_plugins(paths, specs = {})
+      Busser::Plugin.stubs(:runner_plugins).returns(paths)
+      paths.each do |path|
+        Busser::Plugin.stubs(:gem_from_path).with(path).returns(specs[path])
+      end
+    end
+
+    def spec_for(name, version)
+      Gem::Specification.new { |s| s.name = name; s.version = version }
+    end
+
+    it "reports each plugin's short name and version" do
+      stub_plugins(["busser/runner_plugin/bash"],
+        "busser/runner_plugin/bash" => spec_for("busser-bash", "0.2.0"))
+
+      _(command.send(:plugin_data)).must_equal [["bash", Gem::Version.new("0.2.0")]]
+    end
+
+    # dummy is a fixture shipped inside busser for its own tests, not something
+    # anyone installed. `busser test` already passes over it, so listing it was
+    # inconsistent as well as confusing.
+    it "leaves out the internal dummy runner" do
+      stub_plugins(["busser/runner_plugin/dummy", "busser/runner_plugin/bash"],
+        "busser/runner_plugin/bash" => spec_for("busser-bash", "0.2.0"))
+
+      _(command.send(:plugin_data).map(&:first)).must_equal %w{bash}
+    end
+
+    it "reports a nil version rather than raising when no spec is found" do
+      stub_plugins(["busser/runner_plugin/bash"])
+
+      _(command.send(:plugin_data)).must_equal [["bash", nil]]
+    end
+
+    it "returns an empty list when dummy is all there is" do
+      stub_plugins(["busser/runner_plugin/dummy"])
+
+      _(command.send(:plugin_data)).must_be_empty
+    end
+  end
+end

data/spec/busser/command/setup_spec.rb

@@ -1,4 +1,3 @@
-# -*- 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.
@@ -97,6 +96,27 @@ describe Busser::Command::Setup do
       end
     end
 
+    # Windows RubyGems splits GEM_PATH on ";". Joining with ":" produced one
+    # unusable entry, because every Windows path already contains a colon after
+    # its drive letter -- so the isolated gem environment silently did not
+    # exist and Busser resolved gems from wherever it happened to land.
+    it "separates GEM_PATH entries with the Windows separator" do
+      Gem.paths.stubs(:path).returns(["C:/Ruby34/lib/ruby/gems", "C:/Users/kitchen/.gem"])
+      run_setup(type: "bat")
+
+      _(binstub_body).must_include(
+        'SET "GEM_PATH=C:\\Ruby34\\lib\\ruby\\gems;C:\\Users\\kitchen\\.gem"'
+      )
+    end
+
+    it "does not separate GEM_PATH entries with a colon" do
+      Gem.paths.stubs(:path).returns(["C:/a", "C:/b"])
+      run_setup(type: "bat")
+
+      gem_path = binstub_body[/^SET "GEM_PATH=(.*)"$/, 1]
+      _(gem_path.split(";").length).must_equal 2
+    end
+
     def binstub
       File.join(@tmpdir, "bin", "busser.bat")
     end

data/spec/busser/command/test_spec.rb

@@ -0,0 +1,36 @@
+require_relative "../../spec_helper"
+
+require "shellwords"
+require "busser/command/test"
+
+describe Busser::Command::Test do
+  describe ".prepare_sh_command" do
+    it "runs the script with sh" do
+      cmd = Busser::Command::Test.prepare_sh_command("/opt/busser/suites/bats/prepare.sh")
+
+      _(Shellwords.split(cmd)).must_equal ["/bin/sh", "/opt/busser/suites/bats/prepare.sh"]
+    end
+
+    # BUSSER_ROOT is chosen by whoever runs Busser, and Test Kitchen puts it
+    # under a path the user controls. Unquoted, a space split the path and sh
+    # was handed a fragment.
+    it "quotes a path containing spaces" do
+      cmd = Busser::Command::Test.prepare_sh_command("/tmp/my tests/suites/bats/prepare.sh")
+
+      _(Shellwords.split(cmd))
+        .must_equal ["/bin/sh", "/tmp/my tests/suites/bats/prepare.sh"]
+    end
+
+    it "neutralises shell metacharacters in the path" do
+      cmd = Busser::Command::Test.prepare_sh_command("/tmp/a;touch pwned/prepare.sh")
+
+      _(Shellwords.split(cmd)).must_equal ["/bin/sh", "/tmp/a;touch pwned/prepare.sh"]
+    end
+
+    it "accepts a Pathname" do
+      cmd = Busser::Command::Test.prepare_sh_command(Pathname.new("/a/prepare.sh"))
+
+      _(Shellwords.split(cmd).last).must_equal "/a/prepare.sh"
+    end
+  end
+end

data/spec/busser/helpers_spec.rb

@@ -1,6 +1,6 @@
-require_relative '../spec_helper'
+require_relative "../spec_helper"
 
-require 'busser/helpers'
+require "busser/helpers"
 
 describe Busser::Helpers do
 
@@ -25,16 +25,16 @@ describe Busser::Helpers do
 
     describe "with a custom root path" do
 
-      before  { ENV['_SPEC_BUSSER_ROOT'] = ENV['BUSSER_ROOT'] }
-      after   { ENV['BUSSER_ROOT'] = ENV.delete('_SPEC_BUSSER_ROOT') }
+      before  { ENV["_SPEC_BUSSER_ROOT"] = ENV["BUSSER_ROOT"] }
+      after   { ENV["BUSSER_ROOT"] = ENV.delete("_SPEC_BUSSER_ROOT") }
 
       it "returns a base path if no suite name is given" do
-        ENV['BUSSER_ROOT'] = "/path/to/busser"
+        ENV["BUSSER_ROOT"] = "/path/to/busser"
         _(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"
+        ENV["BUSSER_ROOT"] = "/path/to/busser"
         _(suite_path("fuzzy").to_s).must_match %r{/path/to/busser/suites/fuzzy$}
       end
     end
@@ -59,16 +59,16 @@ describe Busser::Helpers do
 
     describe "with a custom root path" do
 
-      before  { ENV['_SPEC_BUSSER_ROOT'] = ENV['BUSSER_ROOT'] }
-      after   { ENV['BUSSER_ROOT'] = ENV.delete('_SPEC_BUSSER_ROOT') }
+      before  { ENV["_SPEC_BUSSER_ROOT"] = ENV["BUSSER_ROOT"] }
+      after   { ENV["BUSSER_ROOT"] = ENV.delete("_SPEC_BUSSER_ROOT") }
 
       it "returns a base path if no product name is given" do
-        ENV['BUSSER_ROOT'] = "/path/to/busser"
+        ENV["BUSSER_ROOT"] = "/path/to/busser"
         _(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"
+        ENV["BUSSER_ROOT"] = "/path/to/busser"
         _(vendor_path("maximal").to_s).must_match \
           %r{/path/to/busser/vendor/maximal$}
       end

data/spec/busser/plugin_spec.rb

@@ -1,4 +1,3 @@
-# -*- 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.

data/spec/busser/ui_spec.rb

@@ -1,6 +1,6 @@
-require_relative '../spec_helper'
+require_relative "../spec_helper"
 
-require 'busser/ui'
+require "busser/ui"
 
 # Dummy class containing diagnostic methods approximating Thor mixins
 class SneakyUI
@@ -11,7 +11,7 @@ class SneakyUI
   attr_accessor :status
 
   def say(msg)
-     msg
+    msg
   end
 
   def error(msg)
@@ -111,7 +111,7 @@ describe Busser::UI do
 
       _(ui.run_args).must_equal([
         "doitpls",
-        { :capture => false, :verbose => false}
+        { capture: false, verbose: false },
       ])
     end
 
@@ -181,16 +181,16 @@ describe Busser::UI do
 
       _(ui.run_ruby_script_args).must_equal([
         "theworks.rb",
-        { :capture => false, :verbose => false }
+        { capture: false, verbose: false },
       ])
     end
 
     it "calls #run_ruby_script with correct default options" do
-      ui.invoke_run_ruby_script!("theworks.rb", :verbose => true)
+      ui.invoke_run_ruby_script!("theworks.rb", verbose: true)
 
       _(ui.run_ruby_script_args).must_equal([
         "theworks.rb",
-        { :capture => false, :verbose => true }
+        { capture: false, verbose: true },
       ])
     end
 

data/spec/spec_helper.rb

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

data/templates/plugin/Gemfile.erb

@@ -1,3 +1,10 @@
 source 'https://rubygems.org'
 
 gemspec
+
+group :test do
+  gem 'aruba', '>= 2.4'
+  gem 'base64', '>= 0.3' # cucumber needs it; not a default gem on Ruby 4.0
+  gem 'cucumber', '>= 11.1'
+  gem 'rake', '>= 13.4'
+end

data/templates/plugin/Rakefile.erb

@@ -2,7 +2,11 @@ require "bundler/gem_tasks"
 require "cucumber/rake/task"
 
 Cucumber::Rake::Task.new(:features) do |t|
-  t.cucumber_opts = ["features", "-x", "--format progress", "--no-color"]
+  # --strict-undefined so the scenarios generated with <YOUR_FILE> placeholders
+  # fail until they are filled in. Undefined steps otherwise pass silently, and
+  # a new plugin reports a green suite that asserts nothing.
+  t.cucumber_opts = ["features", "--format progress", "--fail-fast",
+                     "--strict-undefined"]
 end
 
 desc "Run all test suites"

data/templates/plugin/features_env.rb.erb

@@ -1,13 +1,8 @@
 require "aruba/cucumber"
 require "busser/cucumber"
 
+# Installing a plugin and its gems into a cold sandbox does not fit in aruba's
+# 15 second default.
 Aruba.configure do |config|
-  config.exit_timeout = 20
-end
-
-After do |s|
-  # Tell Cucumber to quit after this scenario is done - if it failed.
-  # This is useful to inspect the 'tmp/aruba' directory before any other
-  # steps are executed and clear it out.
-  Cucumber.wants_to_quit = true if s.failed?
+  config.exit_timeout = 60
 end

data/templates/plugin/gemspec.erb

@@ -15,15 +15,11 @@ Gem::Specification.new do |spec|
   spec.license       = '<%= config[:license_spdx] %>'
 <% end -%>
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = []
   spec.require_paths = ['lib']
 
   spec.required_ruby_version = '>= 3.2'
 
-  spec.add_dependency 'busser'
-
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'aruba', '>= 2.0'
-  spec.add_development_dependency 'cucumber', '>= 9.0'
+  spec.add_dependency 'busser', '>= 0.9.0'
 end

data/templates/plugin/github_workflow.yml.erb

@@ -16,7 +16,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ["3.2", "3.3", "3.4"]
+        ruby: ["3.2", "3.3", "3.4", "4.0"]
     steps:
       - uses: actions/checkout@v5
       - uses: ruby/setup-ruby@v1

data/test/integration/default/bash/smoke_test.sh

@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+# Runs on the machine under test, put there by Busser and executed by
+# busser-bash. Exit status is the verdict.
+set -euo pipefail
+
+# Busser exports these for the suite, and getting them wrong is how the
+# isolated gem environment silently stops being isolated.
+test -n "${BUSSER_ROOT:-}"
+test -d "${BUSSER_ROOT}"
+test -x "${BUSSER_ROOT}/bin/busser"
+
+echo "busser handed this script to busser-bash under ${BUSSER_ROOT}"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: busser
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.3
 platform: ruby
 authors:
 - Fletcher Nichol
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-08-28 00:00:00.000000000 Z
+date: 2026-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -38,62 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: aruba
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: mocha
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Busser - Runs tests for projects in Test Kitchen
 email:
 - fnichol@nichol.ca
@@ -103,6 +47,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/ci.yml"
+- ".github/workflows/integration.yml"
 - ".github/workflows/pr-title.yml"
 - ".github/workflows/publish.yml"
 - ".gitignore"
@@ -126,6 +71,8 @@ files:
 - features/suite_cleanup_command.feature
 - features/suite_path_command.feature
 - features/support/env.rb
+- kitchen-preinstall.sh
+- kitchen.yml
 - lib/busser.rb
 - lib/busser/cli.rb
 - lib/busser/command/deserialize.rb
@@ -152,7 +99,10 @@ files:
 - renovate.json
 - spec/busser/command/deserialize_spec.rb
 - spec/busser/command/plugin_create_spec.rb
+- spec/busser/command/plugin_install_spec.rb
+- spec/busser/command/plugin_list_spec.rb
 - spec/busser/command/setup_spec.rb
+- spec/busser/command/test_spec.rb
 - spec/busser/helpers_spec.rb
 - spec/busser/plugin_spec.rb
 - spec/busser/ui_spec.rb
@@ -174,10 +124,16 @@ files:
 - templates/plugin/license_reserved.erb
 - templates/plugin/runner_plugin.rb.erb
 - templates/plugin/version.rb.erb
+- test/integration/default/bash/smoke_test.sh
 homepage: https://github.com/test-kitchen/busser
 licenses:
 - Apache-2.0
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/test-kitchen/busser/issues
+  changelog_uri: https://github.com/test-kitchen/busser/blob/main/CHANGELOG.md
+  documentation_uri: https://github.com/test-kitchen/busser/blob/main/README.md
+  homepage_uri: https://github.com/test-kitchen/busser
+  source_code_uri: https://github.com/test-kitchen/busser
 post_install_message:
 rdoc_options: []
 require_paths: