busser 0.9.0 → 0.9.2

data/spec/busser/command/plugin_create_spec.rb

@@ -0,0 +1,174 @@
+#
+# 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 "tmpdir"
+
+require "busser/command/plugin_create"
+
+# The generated project is what a plugin author starts from, so the checks
+# worth having are the ones a new project would trip over on day one.
+describe Busser::Command::PluginCreate do
+
+  before do
+    @tmpdir = Dir.mktmpdir("busser-plugin-create")
+    @pwd = Dir.pwd
+    Dir.chdir(@tmpdir)
+  end
+
+  after do
+    Dir.chdir(@pwd)
+    FileUtils.rm_rf(@tmpdir)
+  end
+
+  describe "the generated gemspec" do
+
+    it "loads" do
+      generate
+
+      _(gemspec.name).must_equal "busser-demo"
+    end
+
+    # RubyGems validates spec.license against the SPDX list and warns on
+    # anything else. The generator used to emit "Apache 2.0", the human
+    # readable name rather than the identifier.
+    it "declares a license RubyGems recognises" do
+      generate
+
+      _(Gem::Licenses.match?(gemspec.license)).must_equal true
+    end
+
+    {
+      "apachev2" => "Apache-2.0",
+      "mit" => "MIT",
+      "lgplv3" => "LGPL-3.0-only",
+    }.each do |option, identifier|
+      it "maps --license #{option} to #{identifier}" do
+        generate(license: option)
+
+        _(gemspec.license).must_equal identifier
+      end
+    end
+
+    # "All rights reserved" has no SPDX identifier, so declaring nothing is
+    # the only correct option.
+    it "declares no license for an all rights reserved plugin" do
+      generate(license: "reserved")
+
+      _(gemspec.license).must_be_nil
+    end
+
+    # bundler ~> 1.3 cannot be satisfied by any bundler in use today, so a
+    # freshly generated plugin failed to resolve before running anything.
+    it "does not constrain bundler" do
+      generate
+
+      _(dev_dependencies).wont_include "bundler"
+    end
+
+    # cane, tailor and countloc have been unmaintained for about a decade.
+    %w{cane tailor countloc}.each do |gem_name|
+      it "does not depend on #{gem_name}" do
+        generate
+
+        _(dev_dependencies).wont_include gem_name
+      end
+    end
+
+    it "depends on what the generated Rakefile needs" do
+      generate
+
+      _(dev_dependencies).must_include "rake"
+      _(dev_dependencies).must_include "cucumber"
+      _(dev_dependencies).must_include "aruba"
+    end
+
+    it "states a supported Ruby version" do
+      generate
+
+      requirement = gemspec.required_ruby_version
+
+      _(requirement.satisfied_by?(Gem::Version.new("3.2.0"))).must_equal true
+      _(requirement.satisfied_by?(Gem::Version.new("2.7.0"))).must_equal false
+    end
+
+    def gemspec
+      Gem::Specification.load(File.join(plugin_dir, "busser-demo.gemspec"))
+    end
+
+    def dev_dependencies
+      gemspec.development_dependencies.map(&:name)
+    end
+  end
+
+  describe "the generated project" do
+
+    it "ships a CI workflow rather than a Travis config" do
+      generate
+
+      _(File.exist?(File.join(plugin_dir, ".github/workflows/test.yml")))
+        .must_equal true
+      _(File.exist?(File.join(plugin_dir, ".travis.yml"))).must_equal false
+    end
+
+    # Both linters are long dead, and the Rakefile's default task depended on
+    # them, so `rake` failed on a freshly generated plugin.
+    it "ships no dead linter configuration" do
+      generate
+
+      _(File.exist?(File.join(plugin_dir, ".tailor"))).must_equal false
+      _(File.exist?(File.join(plugin_dir, ".cane"))).must_equal false
+    end
+
+    it "has a Rakefile that only references tasks it defines" do
+      generate
+
+      rakefile = File.read(File.join(plugin_dir, "Rakefile"))
+
+      _(rakefile).wont_match(/cane|tailor|countloc/)
+      _(rakefile).must_match(/Cucumber::Rake::Task/)
+    end
+
+    # aruba 1.0 dropped @aruba_timeout_seconds, and setting it on aruba 2 is
+    # silently ignored, so the generated timeout did nothing at all.
+    it "configures aruba through the supported API" do
+      generate
+
+      env = File.read(File.join(plugin_dir, "features/support/env.rb"))
+
+      _(env).wont_match(/@aruba_timeout_seconds/)
+      _(env).must_match(/Aruba\.configure/)
+    end
+  end
+
+  def generate(license: "apachev2")
+    command = Busser::Command::PluginCreate.new(
+      ["demo"], { "type" => "runner", "license" => license }
+    )
+    command.stubs(:initialize_git)
+    capture_stdout { command.create }
+  end
+
+  def plugin_dir
+    File.join(@tmpdir, "busser-demo")
+  end
+
+  def capture_stdout
+    original = $stdout
+    $stdout = StringIO.new
+    yield
+  ensure
+    $stdout = original
+  end
+end

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

@@ -0,0 +1,120 @@
+#
+# 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 "tmpdir"
+
+require "busser/command/setup"
+
+# The binstub exists to give Busser an isolated gem environment on the machine
+# under test, so what it does to the environment before exec is the contract
+# worth pinning down.
+describe Busser::Command::Setup do
+
+  # Anything left set here lets the calling Ruby environment reach into
+  # Busser's. RUBYOPT was once the only way in; RubyGems now requires
+  # bundler/setup whenever BUNDLER_SETUP is present, and bundler then resets
+  # GEM_HOME to the calling project's bundle.
+  LEAKY_VARIABLES = %w{
+    RUBYOPT GEMRC RUBYLIB
+    BUNDLER_SETUP BUNDLER_VERSION
+    BUNDLE_BIN_PATH BUNDLE_GEMFILE BUNDLE_LOCKFILE BUNDLE_PATH
+  }.freeze
+
+  before do
+    @tmpdir = Dir.mktmpdir("busser-setup")
+    @original_root = ENV["BUSSER_ROOT"]
+    ENV["BUSSER_ROOT"] = @tmpdir
+  end
+
+  after do
+    ENV["BUSSER_ROOT"] = @original_root
+    FileUtils.rm_rf(@tmpdir)
+  end
+
+  describe "the bourne binstub" do
+
+    it "is created and executable" do
+      run_setup
+
+      _(File.exist?(binstub)).must_equal true
+      _(File.stat(binstub).mode & 0o111).wont_equal 0
+    end
+
+    it "pins BUSSER_ROOT and the gem paths" do
+      run_setup
+
+      _(binstub_body).must_match(/BUSSER_ROOT="#{Regexp.escape(@tmpdir)}"/)
+      _(binstub_body).must_match(/^GEM_HOME=/)
+      _(binstub_body).must_match(/^GEM_PATH=/)
+    end
+
+    LEAKY_VARIABLES.each do |name|
+      it "unsets #{name} before exec" do
+        run_setup
+
+        _(unset_variables).must_include name
+      end
+    end
+
+    it "unsets everything before handing off to ruby" do
+      run_setup
+
+      unset_line = binstub_body.index("unset ")
+      exec_line = binstub_body.index("exec ")
+
+      _(unset_line).must_be :<, exec_line
+    end
+
+    def binstub
+      File.join(@tmpdir, "bin", "busser")
+    end
+
+    def unset_variables
+      binstub_body.scan(/^unset (.+)$/).flatten.join(" ").split(/\s+/)
+    end
+  end
+
+  describe "the bat binstub" do
+
+    LEAKY_VARIABLES.each do |name|
+      it "clears #{name} before exec" do
+        run_setup(type: "bat")
+
+        _(binstub_body).must_match(/^SET #{name}=\s*$/)
+      end
+    end
+
+    def binstub
+      File.join(@tmpdir, "bin", "busser.bat")
+    end
+  end
+
+  def run_setup(type: "bourne")
+    command = Busser::Command::Setup.new([], { "type" => type })
+    capture_stdout { command.perform }
+  end
+
+  def binstub_body
+    File.read(binstub)
+  end
+
+  def capture_stdout
+    original = $stdout
+    $stdout = StringIO.new
+    yield
+  ensure
+    $stdout = original
+  end
+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)
@@ -45,10 +45,16 @@ end
 # Stub that mimics a Process::Status object
 class FakeStatus
 
-  attr_reader :exitstatus
+  attr_reader :exitstatus, :termsig
 
-  def initialize(success = true, exitstatus = 0)
-    @success, @exitstatus = success, exitstatus
+  # A process stopped by a signal reports success? as nil rather than false,
+  # carries no exitstatus, and sets termsig instead.
+  def self.signalled(termsig)
+    new(nil, nil, termsig)
+  end
+
+  def initialize(success = true, exitstatus = 0, termsig = nil)
+    @success, @exitstatus, @termsig = success, exitstatus, termsig
   end
 
   def success?
@@ -105,7 +111,7 @@ describe Busser::UI do
 
       _(ui.run_args).must_equal([
         "doitpls",
-        { :capture => false, :verbose => false}
+        { capture: false, verbose: false },
       ])
     end
 
@@ -138,6 +144,26 @@ describe Busser::UI do
       end
     end
 
+    # The out of memory killer stops a run with SIGKILL. exitstatus is nil
+    # there, and reporting it as an exit code used to raise a TypeError from
+    # Kernel#exit, so Busser died with a stack trace instead of saying what
+    # happened.
+    it "reports the signal when the command was killed" do
+      ui.status = FakeStatus.signalled(9)
+      output = capture_stderr { ui.invoke_run!("failwhale") }
+
+      _(output).must_match(/terminated by signal 9/)
+      _(ui.died?).must_equal true
+    end
+
+    it "terminates with 128 plus the signal when the command was killed" do
+      ui.status = FakeStatus.signalled(9)
+
+      capture_stderr do
+        _(ui.invoke_run!("failwhale")).must_equal 137
+      end
+    end
+
     it "terminates the program if status is nil" do
       ui.status = nil
       output = capture_stderr { ui.invoke_run!("failwhale") }
@@ -155,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
 
@@ -197,6 +223,26 @@ describe Busser::UI do
       end
     end
 
+    # The out of memory killer stops a run with SIGKILL. exitstatus is nil
+    # there, and reporting it as an exit code used to raise a TypeError from
+    # Kernel#exit, so Busser died with a stack trace instead of saying what
+    # happened.
+    it "reports the signal when the command was killed" do
+      ui.status = FakeStatus.signalled(9)
+      output = capture_stderr { ui.invoke_run_ruby_script!("nope.rb") }
+
+      _(output).must_match(/terminated by signal 9/)
+      _(ui.died?).must_equal true
+    end
+
+    it "terminates with 128 plus the signal when the command was killed" do
+      ui.status = FakeStatus.signalled(9)
+
+      capture_stderr do
+        _(ui.invoke_run_ruby_script!("nope.rb")).must_equal 137
+      end
+    end
+
     it "terminates the program if status is nil" do
       ui.status = nil
       output = capture_stderr { ui.invoke_run_ruby_script!("nope.rb") }

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/Rakefile.erb

@@ -1,31 +1,11 @@
 require "bundler/gem_tasks"
-require 'cucumber/rake/task'
-require 'cane/rake_task'
-require 'tailor/rake_task'
+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", "--no-color"]
 end
 
 desc "Run all test suites"
-task :test => [:features]
+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"
-  sh "countloc -r lib"
-  puts "\n## Test Code Stats"
-  sh "countloc -r features"
-end
-
-desc "Run all quality tasks"
-task :quality => [:cane, :tailor, :stats]
-
-task :default => [:test, :quality]
+task default: [:test]

data/templates/plugin/features_env.rb.erb

@@ -1,8 +1,8 @@
-require 'aruba/cucumber'
-require 'busser/cucumber'
+require "aruba/cucumber"
+require "busser/cucumber"
 
-Before do
-  @aruba_timeout_seconds = 10
+Aruba.configure do |config|
+  config.exit_timeout = 20
 end
 
 After do |s|