busser 0.9.2 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cdaf83b2875620df49aa36203b6d4f7f2f6af8065ecbaa218705c949fa96fe04
-  data.tar.gz: 40471ed874096d5b55bb8c613a33a7729e761d691f6727e4a848edf0fe398dbd
+  metadata.gz: 22ea0046cc1c5cb2f4473f9315c506ee3ebd4b22d7cf35de392060ae02816ae9
+  data.tar.gz: a42365f1541af1364e6eb82d06049a2910fc5fbceb63cf137e6aaad5243f1d64
 SHA512:
-  metadata.gz: 01b77c64592e8bed4f630149be35b89e5b3ac9935119f0c62216b5c16c0ae32ef3feb75c61d68ddf1127ea7bafff7de31f5d11297f2498501d9641b74eab163d
-  data.tar.gz: 8efbe414c2a434a98ff91be2f368bd2811cf8110bfce65c337859fbe3806ddca29751f9969a1fa9718c75b8ced4b92176ee33b137bf93b2046cace29fe77f0f6
+  metadata.gz: 4fe454f0801dff2a7dac3677a73f98055bf2368ccaa503a1fb641997cf0210482bfd9ff456f853e4e4a8a7e40c4291e8c67f4f9dfc65ce574596fd8be1123cbd
+  data.tar.gz: 3138b112b0ac5a405361553b0a20e9ea43fbbf5df16fbeb6be0b7cb325811e6c494e8d44998af2dc15c6fc163b7568ec681c3a8edd7dddff79018ade13eb46c1

data/.github/workflows/integration.yml

@@ -0,0 +1,55 @@
+---
+name: "Test Kitchen"
+
+"on":
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ github.event_name == 'pull_request' }}
+
+jobs:
+  kitchen:
+    name: "kitchen verify on Ruby ${{ matrix.ruby }}"
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        # The ends of the supported range. The unit and feature suites already
+        # cover everything in between; this job is about the Test Kitchen
+        # integration, not Ruby compatibility.
+        ruby: ["3.2", "4.0"]
+    env:
+      # Outside the checkout on purpose. The runners require "bundler/setup",
+      # which walks up from the suite looking for a Gemfile -- so a Busser root
+      # inside the workspace finds this project's Gemfile and tries to
+      # materialize that bundle inside the isolated gem home, which fails. A
+      # real Busser root is /opt/busser, never inside the project.
+      BUSSER_ROOT: /tmp/busser-kitchen
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1  # v7.0.1
+
+      # Deliberately no bundler-cache, and nothing below runs under `bundle
+      # exec`. The verifier shells out to `gem list` to decide what to install,
+      # and bundler in the environment makes that report the bundle's gems
+      # rather than the Busser root's -- so it skips installing busser and the
+      # run dies on a path that was never created. Test Kitchen is not run from
+      # inside a project's bundle in real use either.
+      - uses: ruby/setup-ruby@95ef2b042f9d7a56d8268cba8559e2842e2ad01b  # v1.321.0
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: Install Test Kitchen
+        run: gem install test-kitchen --no-document --version "~> 4.1"
+
+      - name: Install this working tree into the Busser root
+        run: ./kitchen-preinstall.sh
+
+      - name: kitchen verify
+        run: kitchen verify

data/.gitignore

@@ -14,3 +14,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.kitchen/

data/.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.9.2"
+  ".": "0.9.3"
 }

data/CHANGELOG.md

@@ -33,6 +33,15 @@ main reason to take this version.
 * Rewritten README, and development documentation moved to
   CONTRIBUTING.md ([#63](https://github.com/test-kitchen/busser/pull/63))
 
+## [0.9.3](https://github.com/test-kitchen/busser/compare/v0.9.2...v0.9.3) (2026-08-29)
+
+
+### Bug Fixes
+
+* bring the generated plugin scaffold up to date ([#81](https://github.com/test-kitchen/busser/issues/81)) ([f67b8d0](https://github.com/test-kitchen/busser/commit/f67b8d0979d924b2cb653dace74a80fec03a3da5))
+* reject plugin names that cannot be a Ruby constant ([#80](https://github.com/test-kitchen/busser/issues/80)) ([bd7ac17](https://github.com/test-kitchen/busser/commit/bd7ac1749afe458e35328ebb7b57c64634ad1acc))
+* use the Windows path separator in the bat binstub ([#79](https://github.com/test-kitchen/busser/issues/79)) ([1eb0cbf](https://github.com/test-kitchen/busser/commit/1eb0cbf744ce68fc3c4126bf2eec73f784f422e5))
+
 ## [0.9.2](https://github.com/test-kitchen/busser/compare/v0.9.1...v0.9.2) (2026-08-28)
 
 

data/kitchen-preinstall.sh

@@ -0,0 +1,55 @@
+#!/usr/bin/env bash
+# Installs this working tree into the Busser root the Test Kitchen verifier
+# will use, so `kitchen verify` exercises the code on this branch rather than
+# the last release from RubyGems.
+#
+# The verifier's install script skips its own install when `gem list` already
+# shows what it wants, so putting things in place first is all that is needed.
+# Two consequences to handle:
+#
+#   * It also has to install busser itself. That check is `grep "^busser"` with
+#     no anchor at the end, so a plugin named busser-* satisfies it and busser
+#     would otherwise never be installed at all.
+#   * Skipping `busser plugin install` also skips the plugin's postinstall,
+#     which is where a plugin installs the test framework it drives. So run the
+#     postinstall here, which is what the verifier would have done.
+set -euo pipefail
+
+BUSSER_ROOT="${BUSSER_ROOT:-/tmp/busser-kitchen}"
+gemspec="$(ls ./*.gemspec)"
+gem_name="$(basename "${gemspec}" .gemspec)"
+
+install_opts=(
+  --install-dir "${BUSSER_ROOT}/gems"
+  --bindir "${BUSSER_ROOT}/bin"
+  --no-document
+)
+
+mkdir -p "${BUSSER_ROOT}/gems"
+
+gem build "${gemspec}" --output "${BUSSER_ROOT}/${gem_name}.gem" >/dev/null
+
+if [ "${gem_name}" = "busser" ]; then
+  # No --local: a plugin's runtime dependencies are things its runner needs on
+  # the machine under test, and they have to be fetched into the Busser root
+  # like everything else.
+  gem install "${BUSSER_ROOT}/${gem_name}.gem" "${install_opts[@]}" >/dev/null
+else
+  gem install busser "${install_opts[@]}" >/dev/null
+  # Not --ignore-dependencies: a plugin's runtime dependencies are things its
+  # runner needs on the machine under test, and they have to be in the Busser
+  # root like everything else.
+  # No --local: a plugin's runtime dependencies are things its runner needs on
+  # the machine under test, and they have to be fetched into the Busser root
+  # like everything else.
+  gem install "${BUSSER_ROOT}/${gem_name}.gem" "${install_opts[@]}" >/dev/null
+
+  # The same environment the verifier exports, so the framework this plugin
+  # installs lands in the Busser root rather than the ambient gem home.
+  BUSSER_ROOT="${BUSSER_ROOT}" \
+    GEM_HOME="${BUSSER_ROOT}/gems" \
+    GEM_PATH="${BUSSER_ROOT}/gems" \
+    "${BUSSER_ROOT}/bin/busser" plugin install "${gem_name}" --force-postinstall
+fi
+
+echo "pre-installed ${gem_name} from the working tree into ${BUSSER_ROOT}"

data/kitchen.yml

@@ -0,0 +1,27 @@
+---
+# Runs Busser the way Test Kitchen actually runs it -- real verifier,
+# real busser, real suite transfer -- but against the machine running the tests
+# rather than a VM or container, so it works unchanged in CI.
+driver:
+  name: exec
+
+provisioner:
+  name: dummy
+
+verifier:
+  name: busser
+  # The verifier defaults to Chef's omnibus Ruby, which is not what is running
+  # here, and to sudo, which is not needed for a path under the workspace.
+  ruby_bindir: <%= RbConfig::CONFIG["bindir"] %>
+  sudo: false
+  root_path: <%= ENV.fetch("BUSSER_ROOT", "/tmp/busser-kitchen") %>
+
+platforms:
+  - name: local
+
+suites:
+  # busser-bash is the exercise: a real plugin, installed by the verifier from
+  # RubyGems, driven by the busser built from this working tree. The internal
+  # dummy runner would prove the chain runs but can never fail, so it would not
+  # notice a regression.
+  - name: default

data/lib/busser/command/plugin_create.rb

@@ -39,7 +39,22 @@ module Busser
       # Generates a new runner plugin project.
       #
       # @return [void]
+      # A plugin name becomes three things: a require path, a directory name and
+      # a Ruby constant. Only the last is fussy, and Thor's camel_case only
+      # folds underscores -- so "my-junit" produced `module My-junit`, which is
+      # not parseable Ruby. The generator ran to completion and wrote a project
+      # that could not be loaded at all.
+      NAME_PATTERN = /\A[a-z][a-z0-9_]*\z/
+
       def create
+        unless NAME_PATTERN.match?(name)
+          raise ::Thor::Error,
+            "'#{name}' is not a usable plugin name. A name becomes a Ruby " \
+            "constant, so it must start with a lowercase letter and contain " \
+            "only lowercase letters, digits and underscores. Try " \
+            "'#{suggested_name}'."
+        end
+
         self.class.source_root(Busser.source_root.join("templates", "plugin"))
 
         create_core_files
@@ -126,6 +141,12 @@ module Busser
       end
 
       # @return [String] directory the new plugin is generated into
+      # @return [String] the given name reshaped into something usable, for the
+      #   error message
+      def suggested_name
+        name.to_s.downcase.gsub(/[^a-z0-9_]+/, "_").sub(/\A[^a-z]+/, "").squeeze("_")
+      end
+
       def target_dir
         File.join(Dir.pwd, "busser-#{name}")
       end

data/lib/busser/command/setup.rb

@@ -175,9 +175,15 @@ module Busser
         Gem.paths.home.dup.tap { |p| p.gsub!("/", "\\") if bat? }
       end
 
+      # The separator differs by platform, and the bat binstub is generated on
+      # and for Windows, where RubyGems splits GEM_PATH on ";". Joining with
+      # ":" there produced one unusable entry -- every Windows path already
+      # contains a colon after its drive letter -- so the isolated gem
+      # environment the binstub exists to create silently did not exist.
+      #
       # @return [String] the gem path the binstub exports
       def gem_path
-        Gem.paths.path.join(":").dup.tap { |p| p.gsub!("/", "\\") if bat? }
+        Gem.paths.path.join(bat? ? ";" : ":").dup.tap { |p| p.gsub!("/", "\\") if bat? }
       end
 
       # @return [String] directory holding the real busser executable

data/lib/busser/version.rb

@@ -17,5 +17,5 @@
 
 module Busser
   # Version string for Busser
-  VERSION = "0.9.2".freeze
+  VERSION = "0.9.3".freeze
 end

data/renovate.json

@@ -2,6 +2,7 @@
   "$schema": "https://docs.renovatebot.com/renovate-schema.json",
   "extends": [
     "config:recommended",
+    ":disableDependencyDashboard",
     "helpers:pinGitHubActionDigests",
     ":semanticCommits"
   ]

data/spec/busser/command/plugin_create_spec.rb

@@ -86,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
@@ -112,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
@@ -152,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/setup_spec.rb

@@ -96,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/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.2
+  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
@@ -47,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"
@@ -70,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
@@ -121,6 +124,7 @@ 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