busser 0.8.0 → 0.9.1

data/spec/busser/command/plugin_create_spec.rb

@@ -0,0 +1,175 @@
+# -*- 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.
+# 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/setup_spec.rb

@@ -0,0 +1,121 @@
+# -*- 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.
+# 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/helpers_spec.rb

@@ -9,17 +9,17 @@ describe Busser::Helpers do
   describe ".suite_path" do
 
     it "returns a Pathname" do
-      suite_path.must_be_kind_of Pathname
+      _(suite_path).must_be_kind_of Pathname
     end
 
     describe "with a default root path" do
 
       it "returns a base path if no suite name is given" do
-        suite_path.to_s.must_match %r{/opt/busser/suites$}
+        _(suite_path.to_s).must_match %r{/opt/busser/suites$}
       end
 
       it "returns a suite path given a suite name" do
-        suite_path("fuzzy").to_s.must_match %r{/opt/busser/suites/fuzzy$}
+        _(suite_path("fuzzy").to_s).must_match %r{/opt/busser/suites/fuzzy$}
       end
     end
 
@@ -30,12 +30,12 @@ describe Busser::Helpers do
 
       it "returns a base path if no suite name is given" do
         ENV['BUSSER_ROOT'] = "/path/to/busser"
-        suite_path.to_s.must_match %r{/path/to/busser/suites$}
+        _(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"
-        suite_path("fuzzy").to_s.must_match %r{/path/to/busser/suites/fuzzy$}
+        _(suite_path("fuzzy").to_s).must_match %r{/path/to/busser/suites/fuzzy$}
       end
     end
   end
@@ -43,17 +43,17 @@ describe Busser::Helpers do
   describe ".vendor_path" do
 
     it "returns a Pathname" do
-      vendor_path.must_be_kind_of Pathname
+      _(vendor_path).must_be_kind_of Pathname
     end
 
     describe "with a default root path" do
 
       it "returns a base path if no product name is given" do
-        vendor_path.to_s.must_match %r{/opt/busser/vendor$}
+        _(vendor_path.to_s).must_match %r{/opt/busser/vendor$}
       end
 
       it "returns a vendor path given a product name" do
-        vendor_path("supreme").to_s.must_match %r{/opt/busser/vendor/supreme$}
+        _(vendor_path("supreme").to_s).must_match %r{/opt/busser/vendor/supreme$}
       end
     end
 
@@ -64,12 +64,12 @@ describe Busser::Helpers do
 
       it "returns a base path if no product name is given" do
         ENV['BUSSER_ROOT'] = "/path/to/busser"
-        vendor_path.to_s.must_match %r{/path/to/busser/vendor$}
+        _(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"
-        vendor_path("maximal").to_s.must_match \
+        _(vendor_path("maximal").to_s).must_match \
           %r{/path/to/busser/vendor/maximal$}
       end
     end

data/spec/busser/plugin_spec.rb

@@ -0,0 +1,133 @@
+# -*- 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.
+# 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 "busser/plugin"
+require "busser/ui"
+
+describe Busser::Plugin do
+
+  describe ".runner_plugin" do
+
+    it "builds the require path for a plugin name" do
+      _(Busser::Plugin.runner_plugin("bash"))
+        .must_equal "busser/runner_plugin/bash"
+    end
+  end
+
+  describe ".runner_plugins" do
+
+    it "maps each given name to its require path" do
+      _(Busser::Plugin.runner_plugins(%w{bash minitest})).must_equal [
+        "busser/runner_plugin/bash",
+        "busser/runner_plugin/minitest",
+      ]
+    end
+
+    it "accepts a single name that is not in an array" do
+      _(Busser::Plugin.runner_plugins("bash"))
+        .must_equal ["busser/runner_plugin/bash"]
+    end
+
+    # Callers run one suite per entry, so a repeated name would run that
+    # suite twice.
+    it "returns a name given more than once only once" do
+      _(Busser::Plugin.runner_plugins(%w{bash bash}))
+        .must_equal ["busser/runner_plugin/bash"]
+    end
+
+    it "falls back to every installed plugin when given no names" do
+      Busser::Plugin.expects(:all_runner_plugins).returns(["stubbed"])
+
+      _(Busser::Plugin.runner_plugins).must_equal ["stubbed"]
+    end
+  end
+
+  describe ".all_runner_plugins" do
+
+    it "turns each found file into a require path" do
+      stub_found_files %w{
+        /gems/busser-bash-0.1.1/lib/busser/runner_plugin/bash.rb
+        /gems/busser-serverspec-0.5.0/lib/busser/runner_plugin/serverspec.rb
+      }
+
+      _(Busser::Plugin.all_runner_plugins).must_equal [
+        "busser/runner_plugin/bash",
+        "busser/runner_plugin/serverspec",
+      ]
+    end
+
+    # Gem.find_files searches every installed version of every gem. A machine
+    # that has installed a plugin more than once therefore reports it once per
+    # version, which made `busser test` run that suite repeatedly and
+    # `busser plugin list` print it repeatedly.
+    it "reports a plugin once when several versions of its gem are installed" do
+      stub_found_files %w{
+        /gems/busser-bash-0.1.1/lib/busser/runner_plugin/bash.rb
+        /gems/busser-bash-0.1.0/lib/busser/runner_plugin/bash.rb
+      }
+
+      _(Busser::Plugin.all_runner_plugins)
+        .must_equal ["busser/runner_plugin/bash"]
+    end
+
+    it "keeps the first occurrence, which is the newest version found" do
+      stub_found_files %w{
+        /gems/busser-bash-0.1.1/lib/busser/runner_plugin/bash.rb
+        /gems/busser-bash-0.1.0/lib/busser/runner_plugin/bash.rb
+        /gems/busser-serverspec-0.5.0/lib/busser/runner_plugin/serverspec.rb
+      }
+
+      _(Busser::Plugin.all_runner_plugins).must_equal [
+        "busser/runner_plugin/bash",
+        "busser/runner_plugin/serverspec",
+      ]
+    end
+
+    it "returns nothing when no plugins are installed" do
+      stub_found_files []
+
+      _(Busser::Plugin.all_runner_plugins).must_equal []
+    end
+
+    def stub_found_files(files)
+      Gem.expects(:find_files)
+        .with("busser/runner_plugin/*.rb")
+        .returns(files)
+    end
+  end
+
+  describe ".require!" do
+
+    it "requires the given path" do
+      Busser::Plugin.expects(:require).with("busser/runner_plugin/bash")
+
+      Busser::Plugin.require!("busser/runner_plugin/bash")
+    end
+
+    # A plugin gem that is listed but not loadable is a common failure on a
+    # test instance, and the message is the only clue the user gets.
+    it "dies with the offending path when the plugin cannot be loaded" do
+      Busser::Plugin.stubs(:require).raises(LoadError, "no such file")
+      Busser::UI.expects(:die).with do |message|
+        message.include?("busser/runner_plugin/nope") &&
+          message.include?("LoadError") &&
+          message.include?("no such file")
+      end
+
+      Busser::Plugin.require!("busser/runner_plugin/nope")
+    end
+  end
+end