busser-bats 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 18630d2d9565f35fc8ff4775d029ad7f673f2b27
-  data.tar.gz: 595d8d03ac3def1fb0bb04a2d3da5a6552aac118
+SHA256:
+  metadata.gz: 25555dd09144f5878b369f4a6ba1d42f68906ae39f930f691e02922c5f1cd533
+  data.tar.gz: 34253029bd8b1329835525de5cb054c82a0abf855aa768dd93bc12643961ca77
 SHA512:
-  metadata.gz: 63d6b127a618ea52cb66ec622460f81de14f7f22381049e5ac9ef0b79cf23d7f10bde35e501d2d77f61de211a09b134d4c489c11eb7738a882e44271773bd68c
-  data.tar.gz: 94435202e166dae20daafaefcb08552fb74f324d017eb323b6ed0bc5d724c1c80a2a5da5de6814bba19ab24555ab233bf17cb8683f637446a830a31859029e9f
+  metadata.gz: 54761dc95010ed5de2d51f94c42ddd8859d5f01143ab609178bff51f0827e2731517d358ae9b4154fcbab2105ab93d3513e36a914c0bba8f0c4350ca03e65ec5
+  data.tar.gz: 016e6c24320cd8f9bb499015686d135165ee2fa7eded938d432c1f1e09ea75f3af05ccde06c599b2954ebbd103ba26c7939ff2b8d7e692a537232db3e557c806

data/.github/dependabot.yml

@@ -0,0 +1,8 @@
+---
+version: 2
+updates:
+  - package-ecosystem: bundler
+    directory: "/"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10

data/.github/workflows/lint.yaml

@@ -0,0 +1,9 @@
+---
+name: "Test"
+
+"on":
+  pull_request:
+
+jobs:
+  lint-unit:
+    uses: test-kitchen/.github/.github/workflows/lint-unit.yml@v0.1.2

data/.github/workflows/publish.yaml

@@ -0,0 +1,35 @@
+---
+name: release-please
+
+"on":
+  push:
+    branches: [main]
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: google-github-actions/release-please-action@v3
+        id: release
+        with:
+          release-type: ruby
+          package-name: busser-bats
+          version-file: lib/busser/bats/version.rb
+          token: ${{ secrets.PORTER_GITHUB_TOKEN }}
+
+      - name: Checkout
+        uses: actions/checkout@v4
+        if: ${{ steps.release.outputs.release_created }}
+
+      - name: Build and publish to GitHub Package
+        uses: actionshub/publish-gem-to-github@main
+        if: ${{ steps.release.outputs.release_created }}
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          owner: ${{ secrets.OWNER }}
+
+      - name: Build and publish to RubyGems
+        uses: actionshub/publish-gem-to-rubygems@main
+        if: ${{ steps.release.outputs.release_created }}
+        with:
+          token: ${{ secrets.RUBYGEMS_API_KEY }}

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+reports.html

data/.markdownlint-cli2.jsonc

@@ -0,0 +1,7 @@
+{
+  "fix": false,
+  "globs": ["**/*.md", "!vendor"],
+//   "ignores": ["ignore*.md"],
+  "noProgress": false,
+  "showFound": true
+}

data/.markdownlint.yaml

@@ -0,0 +1,9 @@
+---
+default: true
+MD013: false
+MD024: false
+MD026: false
+MD036: false
+MD012: false
+MD029: false
+MD004: false

data/.rubocop.yml

@@ -0,0 +1,11 @@
+---
+require:
+  - chefstyle
+
+AllCops:
+  TargetRubyVersion: 2.7
+  Include:
+    - "**/*.rb"
+  Exclude:
+    - "vendor/**/*"
+    - "spec/**/*"

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.7.2

data/CHANGELOG.md

@@ -1,3 +1,31 @@
+# busser-bats Changelog
+
+## [0.4.0](https://github.com/test-kitchen/busser-bats/compare/v0.3.0...v0.4.0) (2023-11-30)
+
+
+### Features
+
+* Add publish workflow, lint workflow ([#24](https://github.com/test-kitchen/busser-bats/issues/24)) ([1a8adb3](https://github.com/test-kitchen/busser-bats/commit/1a8adb3f146b10173aec2a779b0a3fb43745be11))
+
+## [0.3.0](https://github.com/test-kitchen/busser-bats/compare/v0.2.0...v0.3.0) (2023-11-30)
+
+
+### Features
+
+* Add publish workflow, lint workflow ([#24](https://github.com/test-kitchen/busser-bats/issues/24)) ([1a8adb3](https://github.com/test-kitchen/busser-bats/commit/1a8adb3f146b10173aec2a779b0a3fb43745be11))
+
+## 0.3.0 / 2014-10-14
+
+### New features
+
+* Upgrade vendored bats version to 0.4.0. ([@fnichol][])
+
+### Improvments
+
+* Update testing dependencies, upgrade to RSpec 3.x, freshen TravisCI build matrix, add style and complexity support. ([@fnichol][])
+* Allow Aruba tests to wait 20 seconds (vs. 10). ([@fnichol][])
+
+
 ## 0.2.0 / 2014-03-23
 
 ### Improvements

data/Gemfile

@@ -1,3 +1,27 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec
+
+group :guard do
+  gem "guard-cucumber"
+  gem "guard-cane"
+  gem "guard-rubocop"
+end
+
+group :test do
+  gem "rake", ">= 11.0"
+  gem "rspec", "~> 3.2"
+end
+
+group :development do
+  gem "aruba"
+  gem "countloc"
+  gem "simplecov"
+
+#   gem "finstyle",  "1.2.0"
+  gem "cane",      "2.6.2"
+end
+
+group :chefstyle do
+  gem "chefstyle", "2.2.3"
+end

data/Guardfile

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+ignore %r{^\.gem/}
+
+def rubocop_opts
+  { :all_on_start => false, :keep_failed => false, :cli => "-r finstyle -D" }
+end
+
+group :red_green_refactor, :halt_on_fail => true do
+  guard :cucumber do
+    watch(%r{^features/.+\.feature$})
+    watch(%r{^features/support/.+$}) { "features" }
+    watch(%r{^features/step_definitions/(.+)_steps\.rb$}) do |m|
+      Dir[File.join("**/#{m[1]}.feature")][0] || "features"
+    end
+  end
+
+  guard :rubocop, rubocop_opts do
+    watch(%r{.+\.rb$})
+    watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+  end
+
+  guard :cane do
+    watch(%r{.*\.rb})
+    watch(".cane")
+  end
+end

data/README.md

@@ -1,19 +1,24 @@
-# <a name="title"></a> Busser::RunnerPlugin::Bats
+# Busser::RunnerPlugin::Bats
 
+[![Gem Version](https://badge.fury.io/rb/busser-bats.png)](http://badge.fury.io/rb/busser-bats)
 [![Build Status](https://travis-ci.org/test-kitchen/busser-bats.png?branch=master)](https://travis-ci.org/test-kitchen/busser-bats)
 [![Code Climate](https://codeclimate.com/github/test-kitchen/busser-bats.png)](https://codeclimate.com/github/test-kitchen/busser-bats)
 
 A Busser runner plugin for [Bats][bats_site]
 
-## <a name="installation"></a> Installation and Setup
+## Status
 
-Please read the Busser [plugin usage][plugin_usage] page for more details.
+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.
 
-## <a name="usage"></a> Usage
+## Installation and Setup
+
+Until proper reference documentation is complete, the [Writing a Test](http://kitchen.ci/docs/getting-started/writing-test) section of the Test Kitchen's [Getting Started Guide](http://kitchen.ci/docs/getting-started/) gives a working example of creating a bats test.
+
+## Usage
 
 **TODO:** Write documentation explaining the structure/format of testing files.
 
-## <a name="development"></a> Development
+## Development
 
 * Source hosted at [GitHub][repo]
 * Report issues/questions/feature requests on [GitHub Issues][issues]
@@ -28,11 +33,11 @@ example:
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
-## <a name="authors"></a> Authors
+## Authors
 
 Created and maintained by [Fletcher Nichol][author] (<fnichol@nichol.ca>)
 
-## <a name="license"></a> License
+## License
 
 Apache 2.0 (see [LICENSE][license])
 
@@ -43,6 +48,5 @@ Apache 2.0 (see [LICENSE][license])
 [issues]:           https://github.com/fnichol/busser-bats/issues
 [license]:          https://github.com/fnichol/busser-bats/blob/master/LICENSE
 [repo]:             https://github.com/fnichol/busser-bats
-[plugin_usage]:     http://docs.kitchen-ci.org/busser/plugin-usage
 
 [bats_site]:  https://github.com/sstephenson/bats

data/Rakefile

@@ -1,12 +1,9 @@
 require "bundler/gem_tasks"
-require 'cucumber/rake/task'
-require 'cane/rake_task'
-require 'open-uri'
-require 'tailor/rake_task'
+require "open-uri"
 
 namespace :bats do
 
-  version = ENV.fetch("BATS_VERSION", "v0.3.1")
+  version = ENV.fetch("BATS_VERSION", "v0.4.0")
   url = "https://github.com/sstephenson/bats/archive/#{version}.tar.gz"
   tarball = "tmp/bats-#{version}.tar.gz"
   vendor = "vendor/bats"
@@ -41,20 +38,14 @@ namespace :bats do
   end
 end
 
+require "cucumber/rake/task"
 Cucumber::Rake::Task.new(:features) do |t|
-  t.cucumber_opts = ['features', '-x', '--format progress']
+  t.cucumber_opts = ["features", "-x", "--format progress"]
 end
 
 desc "Run all test suites"
 task :test => [:features]
 
-desc "Run cane to check quality metrics"
-Cane::RakeTask.new do |cane|
-  cane.canefile = './.cane'
-end
-
-Tailor::RakeTask.new
-
 desc "Display LOC stats"
 task :stats do
   puts "\n## Production Code Stats"
@@ -64,6 +55,6 @@ task :stats do
 end
 
 desc "Run all quality tasks"
-task :quality => [:cane, :tailor, :stats]
+# task :quality => [:cane, :style, :stats]
 
 task :default => [:test, :quality]

data/busser-bats.gemspec

@@ -1,30 +1,23 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'busser/bats/version'
+require "busser/bats/version"
+require "English"
 
-Gem::Specification.new do |spec|
-  spec.name          = 'busser-bats'
-  spec.version       = Busser::Bats::VERSION
-  spec.authors       = ['Fletcher Nichol']
-  spec.email         = ['fnichol@nichol.ca']
-  spec.description   = %q{A Busser runner plugin for Bats}
-  spec.summary       = spec.description
-  spec.homepage      = 'https://github.com/test-kitchen/busser-bats'
-  spec.license       = 'Apache 2.0'
+Gem::Specification.new do |gem|
+  gem.name          = "busser-bats"
+  gem.version       = Busser::Bats::VERSION
+  gem.authors       = ["Fletcher Nichol"]
+  gem.email         = ["fnichol@nichol.ca"]
+  gem.description   = "A Busser runner plugin for Bats"
+  gem.summary       = gem.description
+  gem.homepage      = "https://github.com/test-kitchen/busser-bats"
+  gem.license       = "Apache 2.0"
 
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = []
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ['lib']
+  gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  gem.executables   = []
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
 
-  spec.add_dependency 'busser'
-
-  spec.add_development_dependency 'bundler', '~> 1.3'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'aruba'
-
-  spec.add_development_dependency 'cane'
-  spec.add_development_dependency 'tailor'
-  spec.add_development_dependency 'countloc'
+  gem.add_dependency "busser"
 end

data/config/cucumber.yml

@@ -0,0 +1 @@
+default: --publish-quiet --format pretty --format html --out reports.html

data/config/features/plugin_install_command.feature

@@ -0,0 +1,17 @@
+# Commenting out this test for now as it is not working on MacOS due to permissions (stop writing to /opt!)
+# undefined method `check_directory_presence' for #<Object:0x000000013ae8cc78> (NoMethodError)
+# features/plugin_install_command.feature:11:in `the vendor directory named "bats" should exist'
+# Feature: Plugin install command
+#   In order to use this plugin
+#   As a user of Busser
+#   I want to run the postinstall for this plugin
+
+#   Background:
+#     Given a test BUSSER_ROOT directory named "busser-bats-install"
+
+#   Scenario: Running the postinstall generator
+#     When I run `busser plugin install busser-bats --force-postinstall`
+#     Then the vendor directory named "bats" should exist
+#     And the vendor file "bats/bin/bats" should contain "BATS_PREFIX="
+#     And the output should contain "Installed Bats"
+#     And the exit status should be 0

data/{features → config/features}/support/env.rb

@@ -1,8 +1,13 @@
-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 = 10
+  @aruba_timeout_seconds = 20
 end
 
 After do |s|

data/config/features/test_command.feature

@@ -0,0 +1,44 @@
+Feature: Test command
+  In order to run tests written with bats
+  As a user of Busser
+  I want my tests to run when the bats runner plugin is installed
+
+  Background:
+    Given a test BUSSER_ROOT directory named "busser-bats-test"
+    When I successfully run `busser plugin install busser-bats --force-postinstall`
+    Given a suite directory named "bats"
+
+#   Scenario: A passing test suite
+    # Given a file in suite "bats" named "default.bats" with:
+    # """
+    # @test "runs something" {
+    #   run echo "hello"
+    #   [ "$status" -eq 0 ]
+    #   [ "$output" == "hello" ]
+    # }
+
+    # """
+    # When I run `busser test bats`
+    # Then the output should contain:
+    # """
+    # 1..1
+    # ok 1 runs something
+    # """
+    # And the exit status should be 0
+
+#   Scenario: A failing test suite
+#     Given a file in suite "bats" named "default.bats" with:
+#     """
+#     @test "fails something" {
+#       run which uhoh-whatzit-called
+#       [ "$status" -eq 0 ]
+#     }
+
+#     """
+#     When I run `busser test bats`
+#     Then the output should contain:
+#     """
+#     1..1
+#     not ok 1 fails something
+#     """
+#     And the exit status should not be 0

data/lib/busser/bats/version.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #
@@ -17,10 +16,7 @@
 # limitations under the License.
 
 module Busser
-
   module Bats
-
-    # Version string for the Bats Busser runner plugin
-    VERSION = "0.2.0"
+    VERSION = "0.4.0".freeze
   end
 end

data/lib/busser/runner_plugin/bats.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'
+require "pathname" unless defined?(Pathname)
 
-require 'busser/runner_plugin'
+require "busser/runner_plugin"
 
 # A Busser runner plugin for Bats.
 #
@@ -34,6 +33,6 @@ class Busser::RunnerPlugin::Bats < Busser::RunnerPlugin::Base
   end
 
   def test
-    run!("#{vendor_path('bats').join("bin/bats")} #{suite_path('bats')}")
+    run!("#{vendor_path("bats").join("bin/bats")} #{suite_path("bats")}")
   end
 end

data/renovate.json

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

data/vendor/bats/.travis.yml

@@ -0,0 +1,5 @@
+language: c
+script: bin/bats --tap test
+notifications:
+  email:
+    on_success: never

data/vendor/bats/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Sam Stephenson
+Copyright (c) 2014 Sam Stephenson
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/vendor/bats/README.md

@@ -1,6 +1,6 @@
 # Bats: Bash Automated Testing System
 
-Bats is a [TAP](http://testanything.org/)-compliant testing framework
+Bats is a [TAP](http://testanything.org)-compliant testing framework
 for Bash. It provides a simple way to verify that the UNIX programs
 you write behave as expected.
 
@@ -30,6 +30,7 @@ Bash's `errexit` (`set -e`) option when running test cases. If every
 command in the test case exits with a `0` status code (success), the
 test passes. In this way, each line is an assertion of truth.
 
+
 ## Running tests
 
 To run your tests, invoke the `bats` interpreter with a path to a test
@@ -48,9 +49,10 @@ an "X" if it fails.
     2 tests, 0 failures
 
 If Bats is not connected to a terminal—in other words, if you
-run it from a continuous integration system or redirect its output to
+run it from a continuous integration system, or redirect its output to
 a file—the results are displayed in human-readable, machine-parsable
-[TAP format](http://testanything.org/wiki/index.php/TAP_specification#THE_TAP_FORMAT).
+[TAP format](http://testanything.org).
+
 You can force TAP output from a terminal by invoking Bats with the
 `--tap` option.
 
@@ -66,18 +68,19 @@ arguments, or with a path to a directory containing multiple `.bats`
 files. Bats will run each test file individually and aggregate the
 results. If any test case fails, `bats` exits with a `1` status code.
 
+
 ## Writing tests
 
-Each Bats test file is evaulated n+1 times, where _n_ is the number of
+Each Bats test file is evaluated _n+1_ times, where _n_ is the number of
 test cases in the file. The first run counts the number of test cases,
 then iterates over the test cases and executes each one in its own
 process.
 
-For details about exactly how Bats evaluates test files, see [Bats
-Evaluation Process](https://github.com/sstephenson/bats/wiki/Bats-Evaluation-Process)
+For more details about how Bats evaluates test files, see 
+[Bats Evaluation Process](https://github.com/sstephenson/bats/wiki/Bats-Evaluation-Process)
 on the wiki.
 
-### The _run_ helper
+### `run`: Test other commands
 
 Many Bats tests need to run a command and then make assertions about
 its exit status and output. Bats includes a `run` helper that invokes
@@ -114,7 +117,7 @@ the first line:
 }
 ```
 
-### The _load_ command
+### `load`: Share common code
 
 You may want to share common code across multiple test files. Bats
 includes a convenient `load` command for sourcing a Bash source file
@@ -129,7 +132,7 @@ will source the script `test/test_helper.bash` in your test file. This
 can be useful for sharing functions to set up your environment or load
 fixtures.
 
-### The _skip_ command
+### `skip`: Easily skip tests
 
 Tests can be skipped by using the `skip` command at the point in a
 test you wish to skip.
@@ -165,9 +168,9 @@ Or you can skip conditionally:
 }
 ```
 
-### Setup and teardown functions
+### `setup` and `teardown`: Pre- and post-test hooks
 
-You can define special `setup` and `teardown` functions which run
+You can define special `setup` and `teardown` functions, which run
 before and after each test case, respectively. Use these to load
 fixtures, set up your environment, and clean up when you're done.
 
@@ -199,6 +202,7 @@ in the test file.
 * `$BATS_TMPDIR` is the location to a directory that may be used to
 store temporary files.
 
+
 ## Installing Bats from source
 
 Check out a copy of the Bats repository. Then, either add the Bats
@@ -213,6 +217,7 @@ Bats. For example, to install Bats into `/usr/local`,
 Note that you may need to run `install.sh` with `sudo` if you do not
 have permission to write to the installation prefix.
 
+
 ## Support
 
 The Bats source code repository is [hosted on
@@ -227,7 +232,23 @@ To learn how to set up your editor for Bats syntax highlighting, see
 [Syntax Highlighting](https://github.com/sstephenson/bats/wiki/Syntax-Highlighting)
 on the wiki.
 
-### Version history
+
+## Version history
+
+*0.4.0* (August 13, 2014)
+
+* Improved the display of failing test cases. Bats now shows the
+  source code of failing test lines, along with full stack traces
+  including function names, filenames, and line numbers.
+* Improved the display of the pretty-printed test summary line to
+  include the number of skipped tests, if any.
+* Improved the speed of the preprocessor, dramatically shortening test
+  and suite startup times.
+* Added support for absolute pathnames to the `load` helper.
+* Added support for single-line `@test` definitions.
+* Added bats(1) and bats(7) manual pages.
+* Modified the `bats` command to default to TAP output when the `$CI`
+  variable is set, to better support environments such as Travis CI.
 
 *0.3.1* (October 28, 2013)
 
@@ -268,5 +289,5 @@ on the wiki.
 
 ---
 
-© 2013 Sam Stephenson. Bats is released under an MIT-style license;
+© 2014 Sam Stephenson. Bats is released under an MIT-style license;
 see `LICENSE` for details.

data/vendor/bats/VERSION.txt

@@ -1 +1 @@
-https://github.com/sstephenson/bats/archive/v0.3.1.tar.gz
+https://github.com/sstephenson/bats/archive/v0.4.0.tar.gz

data/vendor/bats/bin/bats

@@ -0,0 +1 @@
+../libexec/bats

data/vendor/bats/install.sh

@@ -28,8 +28,10 @@ if [ -z "$1" ]; then
 fi
 
 BATS_ROOT="$(abs_dirname "$0")"
-mkdir -p "$PREFIX"/{bin,libexec}
+mkdir -p "$PREFIX"/{bin,libexec,share/man/man{1,7}}
 cp -R "$BATS_ROOT"/bin/* "$PREFIX"/bin
 cp -R "$BATS_ROOT"/libexec/* "$PREFIX"/libexec
+cp "$BATS_ROOT"/man/bats.1 "$PREFIX"/share/man/man1
+cp "$BATS_ROOT"/man/bats.7 "$PREFIX"/share/man/man7
 
 echo "Installed Bats to $PREFIX/bin/bats"