busser 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 461cec059616e39a6f7f86d6c7bf2478e36116fab040dc2b9076dc09641963c7
-  data.tar.gz: 2a21f5a58dc7a107b6af55e86a267143f3d9d5212b8590b3d0996ac182625074
+  metadata.gz: a59df776e51a951b813e8427048a91915f8a51488899ea85ed38e244704f7fc4
+  data.tar.gz: 4fa1ecc9d303f82f4a26629993229a7a82c46edd1d1f14a77c544689b7e8642a
 SHA512:
-  metadata.gz: d2f10dfebb25a155b78f91a0d9b06d7f06fe5bf33174c48ee5078543d271a44f1cdb040ca8ed54ce26c9b3210b5264c5e7e89406b6669f8a1e9126bec1063979
-  data.tar.gz: b29b1a3e4a4392dd74a6a4f0e2d3475b267bdd253b3d745da2687b44621777ae95c34beef7db82102a48dcdac6f1de22e1e7ef0ee6fa27e7e54d913ad3be2cda
+  metadata.gz: 18e4d5ef6b17149137cade75655c0406194ad432fbb14835a0ce05cd8e32bf0b60c8fa00f2dc4a7015990110972284d23b24488324fcd5af1cce5f445b0806e7
+  data.tar.gz: 8bc4b488740a43e4a28a40edf93f0b021fbac496f2edaee2df43f0eb898f708b447b69f14e72498d9d46ffb7b34821d2f1a1f25fae4373c9b62d76cb8e85e84f

data/.github/workflows/ci.yml

@@ -0,0 +1,32 @@
+---
+name: "Test"
+
+"on":
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
+
+# The default token is granted write access to most of the repository.
+# Nothing here needs more than the checkout.
+permissions:
+  contents: read
+
+# Supersede in-flight runs for a branch. Pull requests cancel freely, but
+# pushes to main do not: every commit on main should keep a build of its own.
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ github.event_name == 'pull_request' }}
+
+jobs:
+  lint-unit:
+    # Pinned to a commit rather than @main so an upstream edit cannot reach
+    # this repository's CI without a reviewed pull request. The trailing
+    # comment names the release the commit belongs to, which is what lets
+    # Renovate track the pin by version and keep both in step.
+    uses: test-kitchen/.github/.github/workflows/lint-unit.yml@95ef7803cf23aae5ee68593de5b7e0a731c1a929  # v0.4.0
+    with:
+      # This gem requires Ruby 3.2, and so do minitest 6 and cucumber 11.
+      # Without this the shared workflow would still start a Ruby 3.1 job and
+      # bundler would refuse to resolve there.
+      ruby_versions: '["3.2", "3.3", "3.4", "4.0"]'

data/.github/workflows/pr-title.yml

@@ -0,0 +1,28 @@
+---
+name: "PR Title"
+
+"on":
+  pull_request_target:
+    types: [opened, edited, reopened, synchronize]
+
+permissions:
+  contents: read
+
+jobs:
+  conventional-title:
+    name: "Conventional commit title"
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: read
+    steps:
+      # Pull requests here are squash merged, so the pull request title becomes
+      # the commit subject on main. That makes the title the one place worth
+      # checking: release-please reads those subjects to decide the next
+      # version and to build the changelog.
+      #
+      # pull_request_target is used so the check also runs for pull requests
+      # from forks. No repository code is checked out in this job, so none of
+      # the usual pull_request_target risk applies.
+      - uses: amannn/action-semantic-pull-request@48f256284bd46cdaab1048c3721360e808335d50  # v6.1.1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/.github/workflows/publish.yml

@@ -0,0 +1,45 @@
+---
+name: "Release"
+
+"on":
+  push:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write        # tag the release and commit the version bump
+      pull-requests: write   # open and update the release pull request
+      packages: write        # push the gem to GitHub Packages
+    steps:
+      # Opens and maintains a release pull request. Merging that pull request
+      # is what actually cuts a release, so every step below is skipped until
+      # release_created is set.
+      - uses: googleapis/release-please-action@45996ed1f6d02564a971a2fa1b5860e934307cf7  # v5.0.0
+        id: release
+        with:
+          token: ${{ secrets.PORTER_GITHUB_TOKEN }}
+
+      - name: Checkout code
+        if: ${{ steps.release.outputs.release_created }}
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1  # v7.0.1
+
+      # These two steps are handed publishing credentials, so they are pinned
+      # to a commit rather than a branch. A floating ref would let whoever
+      # controls that branch run code with a token that can push this gem.
+      - name: Publish to GitHub Packages
+        if: ${{ steps.release.outputs.release_created }}
+        uses: actionshub/publish-gem-to-github@86eb0ce1ced1072298bf68776a32a5c9703ad9aa  # v1.0.13
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          owner: ${{ github.repository_owner }}
+
+      - name: Publish to RubyGems
+        if: ${{ steps.release.outputs.release_created }}
+        uses: actionshub/publish-gem-to-rubygems@f9126f7a2d36a4fd31a13e78fde5fbdcc4b7b251  # v2.0.6
+        with:
+          token: ${{ secrets.RUBYGEMS_API_KEY }}

data/.gitignore

@@ -6,7 +6,6 @@
 Gemfile.lock
 InstalledFiles
 _yardoc
-coverage
 doc/
 lib/bundler/man
 pkg

data/.markdownlint.yaml

@@ -0,0 +1,6 @@
+---
+default: true
+MD004: false
+MD012: false
+MD013: false
+MD024: false

data/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.9.0"
+}

data/.rubocop.yml

@@ -0,0 +1,9 @@
+---
+require:
+  - cookstyle/chefstyle
+
+AllCops:
+  TargetRubyVersion: 3.1
+  Exclude:
+    - "vendor/**/*"
+    - "spec/**/*"

data/.yamllint

@@ -0,0 +1,6 @@
+---
+extends: default
+rules:
+  line-length:
+    max: 256
+    level: warning

data/CHANGELOG.md

@@ -1,3 +1,38 @@
+## [0.9.0](https://github.com/test-kitchen/busser/compare/v0.8.0...v0.9.0) (2026-08-28)
+
+The first release since 2020. Busser now runs on current Ruby, which is the
+main reason to take this version.
+
+### Breaking changes
+
+* Ruby 3.2 or newer is now required ([#61](https://github.com/test-kitchen/busser/pull/61))
+
+### Bug fixes
+
+* The CLI no longer crashes on startup on modern Ruby. thor 1.1 and newer are
+  required, because earlier versions reference `DidYouMean::SPELL_CHECKERS`,
+  which Ruby 3.1 removed ([#54](https://github.com/test-kitchen/busser/pull/54))
+* `base64` is declared as a runtime dependency. It stopped being a default gem,
+  so `busser deserialize` failed to load on Ruby 3.4 and
+  newer ([#54](https://github.com/test-kitchen/busser/pull/54))
+* A plugin installed at more than one version is no longer reported once per
+  version. `busser test` ran that plugin's suite repeatedly and
+  `busser plugin list` printed it repeatedly ([#64](https://github.com/test-kitchen/busser/pull/64))
+* `busser deserialize` verifies the md5 digest before writing. It previously
+  checked afterwards, so a corrupted or truncated stream left the unverified
+  file on disk with its requested permissions, even though the command
+  failed ([#64](https://github.com/test-kitchen/busser/pull/64))
+
+### Maintenance
+
+* Test suites run on Ruby 3.2 through 4.0 with minitest 6 and cucumber 11, and
+  the cucumber suite moved to aruba 2 ([#54](https://github.com/test-kitchen/busser/pull/54), [#60](https://github.com/test-kitchen/busser/pull/60), [#61](https://github.com/test-kitchen/busser/pull/61))
+* CI runs on pushes to main, uses a least privilege token, and pins the shared
+  workflow to a release ([#59](https://github.com/test-kitchen/busser/pull/59))
+* Releases are automated with release-please ([#62](https://github.com/test-kitchen/busser/pull/62))
+* Rewritten README, and development documentation moved to
+  CONTRIBUTING.md ([#63](https://github.com/test-kitchen/busser/pull/63))
+
 ## 0.8.0 / 2020-08-20
 
 - Add http_proxy support to `busser plugin install`

data/CONTRIBUTING.md

@@ -0,0 +1,103 @@
+# Contributing to Busser
+
+Thanks for taking the time to contribute. This document covers how to get the
+project running locally, how to check your work before opening a pull request,
+and the commit convention releases depend on.
+
+## Getting set up
+
+Busser requires **Ruby 3.2 or newer**. Clone the repository and install the
+development dependencies:
+
+```bash
+git clone https://github.com/test-kitchen/busser.git
+cd busser
+bundle install
+```
+
+Run the CLI from the working tree with `bundle exec busser`.
+
+## Running the tests
+
+There are two suites, and `rake` runs both:
+
+```bash
+bundle exec rake test        # everything
+bundle exec rake unit        # minitest specs only
+bundle exec rake features    # cucumber features only
+```
+
+**Unit specs** live in `spec/` and cover library code directly. They use
+minitest's spec syntax with the `_()` expectation form:
+
+```ruby
+_(suite_path.to_s).must_match %r{/suites$}
+```
+
+The bare `suite_path.to_s.must_match` form was removed in minitest 6 and will
+not work.
+
+**Cucumber features** live in `features/` and drive the real `busser`
+executable through [aruba](https://github.com/cucumber/aruba), so they cover
+the CLI end to end. The step definitions are in `lib/busser/cucumber.rb`
+because plugin authors reuse them.
+
+Features that install plugins sandbox `GEM_HOME` into a temporary directory and
+strip bundler out of the environment, so a test never installs a gem into your
+bundle. If you add a step that shells out, be careful not to reintroduce
+bundler variables: modern RubyGems re-requires `bundler/setup` whenever
+`BUNDLER_SETUP` is present, which silently redirects `GEM_HOME` back at the
+bundle.
+
+## Linting
+
+CI runs three linters, all of which you can run locally:
+
+```bash
+bundle exec cookstyle --chefstyle   # Ruby
+yamllint --strict .                 # YAML
+markdownlint-cli2 "**/*.md" "!**/CHANGELOG*.md"
+```
+
+## Commit messages
+
+This project uses [Conventional Commits](https://www.conventionalcommits.org).
+Releases are automated, and the commit subject on `main` is what decides the
+next version number and what appears in the changelog.
+
+Pull requests are **squash merged, so the pull request title becomes that
+subject**. A CI check enforces the format on the title; the individual commits
+on your branch are not checked.
+
+| Prefix | Effect on the next release |
+| --- | --- |
+| `fix:` | Patch version bump |
+| `feat:` | Minor version bump |
+| `feat!:`, or a `BREAKING CHANGE:` footer | Major version bump |
+| `chore:`, `docs:`, `ci:`, `test:`, `refactor:` | No release |
+
+For example:
+
+```text
+fix: install plugins into GEM_HOME rather than the bundle
+feat: add a --verbose flag to plugin install
+ci: pin the shared workflow to a release
+```
+
+## Opening a pull request
+
+1. Fork the repository and create a branch for your change.
+2. Add or update tests. A bug fix should come with a test that fails without it.
+3. Run `bundle exec rake test` and the linters above.
+4. Open a pull request with a Conventional Commits title.
+
+## Releases
+
+Releases are handled by
+[release-please](https://github.com/googleapis/release-please). It watches
+commits landing on `main` and keeps a release pull request open with the next
+version number and the accumulated changelog. Merging that pull request tags
+the release and publishes the gem to RubyGems and GitHub Packages.
+
+Maintainers do not bump `lib/busser/version.rb` or edit `CHANGELOG.md` by
+hand; release-please owns both files.

data/Gemfile

@@ -1,9 +1,13 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-gemspec
+gemspec development_group: :test
+group :cookstyle do
+  gem "cookstyle"
+end
 
-group :guard do
-  gem 'guard-minitest'
-  gem 'guard-cucumber'
-  gem 'guard-cane'
+group :test do
+  gem "minitest", ">= 6.0"
+  gem "base64" # cucumber needs it; not a default gem on Ruby 4.0
+  gem "cucumber", ">= 11.1"
+  gem "rake"
 end

data/README.md

@@ -1,40 +1,98 @@
 # Busser
 
 [![Gem Version](https://badge.fury.io/rb/busser.svg)](http://badge.fury.io/rb/busser)
-[![Build Status](https://travis-ci.org/test-kitchen/busser.svg?branch=master)](https://travis-ci.org/test-kitchen/busser)
-[![Code Climate](https://codeclimate.com/github/test-kitchen/busser.svg)](https://codeclimate.com/github/test-kitchen/busser)
 
-Busser is a test setup and execution framework designed to
-work on remote nodes whose system dependencies cannot be relied upon, except
-for an Omnibus installation of Chef. It uses a plugin architecture to add
-support for different testing strategies such minitest, cucumber, bash, etc.
+Busser runs your integration tests on the machine under test.
+
+It is built for remote nodes whose system dependencies cannot be relied upon,
+so it assumes very little about where it lands. Test frameworks are added as
+plugins, each a `busser-*` gem, which lets a single suite run bash scripts,
+minitest specs, RSpec examples or anything else a plugin knows how to execute.
+
+Busser is normally invoked for you by
+[Test Kitchen](https://github.com/test-kitchen/test-kitchen), which installs it
+on the instance under test and runs `busser test` as part of `kitchen verify`.
+You can also drive it directly, which is what the rest of this document covers.
 
 ## Status
 
 This software project is no longer under active development as it has no active maintainers. The software may continue to work for some or all use cases, but issues filed in GitHub will most likely not be triaged. If a new maintainer is interested in working on this project please come chat with us in #test-kitchen on Chef Community Slack.
 
+## Requirements
+
+Ruby 3.2 or newer.
+
 ## Installation
 
-Add this line to your application's Gemfile:
+```bash
+gem install busser
+```
+
+Or add it to your `Gemfile`:
 
-    gem 'busser'
+```ruby
+gem "busser"
+```
 
-And then execute:
+## Usage
 
-    $ bundle
+Busser is driven by the `busser` command. Run `busser help`, or
+`busser help SUBCOMMAND`, for the full option list.
 
-Or install it yourself as:
+### Setting up
 
-    $ gem install busser
+Create the Busser home directory, where plugins and suites are installed:
 
-## Usage
+```bash
+busser setup
+```
+
+By default this is `/opt/busser`. Set `BUSSER_ROOT` to put it elsewhere.
+
+### Working with plugins
+
+Each test framework is a separate `busser-*` gem:
 
-TODO: Write usage instructions here
+```bash
+busser plugin install busser-bash    # install a plugin
+busser plugin install busser-bash@0.3.0  # install a specific version
+busser plugin list                   # list installed plugins
+busser plugin create junit           # scaffold a new plugin
+```
+
+### Laying out tests
+
+Each plugin picks up the tests belonging to it, from a directory named after
+the plugin inside the suite:
+
+```text
+test
+`-- integration
+    `-- default        # suite name
+        |-- bash       # picked up by busser-bash
+        |   `-- my_test.sh
+        `-- minitest   # picked up by busser-minitest
+            `-- test_default.rb
+```
+
+Use `busser suite path` to print where suites live, and `busser suite cleanup`
+to remove them.
+
+### Running tests
+
+Run every installed plugin's suites, or name specific plugins:
+
+```bash
+busser test
+busser test bash minitest
+```
 
 ## Contributing
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+Bug reports and pull requests are welcome. See
+[CONTRIBUTING.md](CONTRIBUTING.md) for how to set up the project, run the test
+suites, and format your commits.
+
+## License
+
+Apache License 2.0. See [LICENSE](LICENSE).

data/Rakefile

@@ -1,35 +1,18 @@
 require "bundler/gem_tasks"
-require 'rake/testtask'
-require 'cucumber/rake/task'
-require 'cane/rake_task'
+require "rake/testtask"
+require "cucumber/rake/task"
 
 Rake::TestTask.new(:unit) do |t|
   t.libs.push "lib"
-  t.test_files = FileList['spec/**/*_spec.rb']
+  t.test_files = FileList["spec/**/*_spec.rb"]
   t.verbose = true
 end
 
 Cucumber::Rake::Task.new(:features) do |t|
-  t.cucumber_opts = ['features', '-x', '--format progress', '--no-color', '-b']
+  t.cucumber_opts = ["features", "-x", "--format progress", "--no-color", "-b"]
 end
 
 desc "Run all test suites"
-task :test => [:unit, :features]
+task test: %i{unit features}
 
-desc "Run cane to check quality metrics"
-Cane::RakeTask.new do |cane|
-  cane.canefile = './.cane'
-end
-
-desc "Display LOC stats"
-task :stats do
-  puts "\n## Production Code Stats"
-  sh "countloc -r lib"
-  puts "\n## Test Code Stats"
-  sh "countloc -r spec features"
-end
-
-desc "Run all quality tasks"
-task :quality => [:cane, :stats]
-
-task :default => [:test, :quality]
+task default: [:test]

data/bin/busser

@@ -1,8 +1,6 @@
 #!/usr/bin/env ruby
-# -*- encoding: utf-8 -*-
-
 $:.unshift File.join(File.dirname(__FILE__), %w{.. lib})
-require 'rubygems' unless defined?(Gem)
-require 'busser/cli'
+require "rubygems" unless defined?(Gem)
+require "busser/cli"
 
 Busser::CLI.start

data/busser.gemspec

@@ -1,7 +1,6 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'busser/version'
+require "busser/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "busser"
@@ -11,24 +10,22 @@ Gem::Specification.new do |spec|
   spec.description   = %q{Busser - Runs tests for projects in Test Kitchen}
   spec.summary       = spec.description
   spec.homepage      = "https://github.com/test-kitchen/busser"
-  spec.license       = 'Apache 2.0'
+  spec.license       = "Apache-2.0"
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 1.9.1"
+  spec.required_ruby_version = ">= 3.2"
 
-  spec.add_dependency 'thor', '<= 0.19.0'
+  # thor 1.1.0 references DidYouMean::SPELL_CHECKERS, removed in Ruby 3.1,
+  # so the CLI crashed on startup on every supported Ruby
+  spec.add_dependency "thor", ">= 1.1"
+  # base64 is no longer a default gem; deserialize needs it at runtime
+  spec.add_dependency "base64"
 
-  spec.add_development_dependency 'aruba', "0.7.4"
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency 'cane'
-  spec.add_development_dependency 'countloc'
-  spec.add_development_dependency 'fakefs'
-  spec.add_development_dependency 'minitest'
-  spec.add_development_dependency 'mocha'
+  spec.add_development_dependency "aruba", ">= 2.0"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "mocha"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency 'simplecov'
 end

data/features/deserialize_command.feature

@@ -16,4 +16,7 @@ Feature: Deserialize command
   Scenario: Mismatching MD5 sum fails command
     When I run `bash -c "cat ../../features/files/base64.txt | busser deserialize --destination=decoded.txt --md5sum=nope --perms=0755"`
     Then the output should contain "does not match source file"
-    Then the exit status should not be 0
+    And the exit status should not be 0
+    # The digest was once checked only after the write, so the command failed
+    # while still leaving the unverified file on disk.
+    And the file "decoded.txt" should not exist

data/features/plugin_install_command.feature

@@ -20,7 +20,7 @@ Feature: Plugin install command
     And the exit status should be 0
     And a gem named "busser-bash" is installed with version "0.1.0"
 
-  Scenario: Installing a specfic newer version of an existing plugin
+  Scenario: Installing a specific newer version of an existing plugin
     When I successfully run `busser plugin install busser-bash@0.1.0`
     And I run `busser plugin install busser-bash@0.1.1`
     Then the output should contain "Plugin bash installed (version 0.1.1)"

data/features/support/env.rb

@@ -1,18 +1,6 @@
-require 'aruba/cucumber'
-require 'busser/cucumber'
+require "aruba/cucumber"
+require "busser/cucumber"
 
-if ENV["COVERAGE"]
-  require 'simplecov'
-  SimpleCov.command_name "features"
-end
-
-Before do
-  @aruba_timeout_seconds = 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?
+Aruba.configure do |config|
+  config.exit_timeout = 20
 end

data/lib/busser/cli.rb

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