busser-bats 0.1.0 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 18630d2d9565f35fc8ff4775d029ad7f673f2b27
+  data.tar.gz: 595d8d03ac3def1fb0bb04a2d3da5a6552aac118
+SHA512:
+  metadata.gz: 63d6b127a618ea52cb66ec622460f81de14f7f22381049e5ac9ef0b79cf23d7f10bde35e501d2d77f61de211a09b134d4c489c11eb7738a882e44271773bd68c
+  data.tar.gz: 94435202e166dae20daafaefcb08552fb74f324d017eb323b6ed0bc5d724c1c80a2a5da5de6814bba19ab24555ab233bf17cb8683f637446a830a31859029e9f

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 0.2.0 / 2014-03-23
+
+### Improvements
+
+* Vendor a copy of Bats locally (v0.3.1) to speed & simplify plugin installations. ([@fnichol][])
+
+
 ## 0.1.0 / 2013-04-10
 
 * Initial release
+
+<!--- The following link definition list is generated by PimpMyChangelog --->
+[@fnichol]: https://github.com/fnichol

data/README.md

@@ -1,7 +1,7 @@
 # <a name="title"></a> Busser::RunnerPlugin::Bats
 
-[![Build Status](https://travis-ci.org/fnichol/busser-bats.png?branch=master)](https://travis-ci.org/fnichol/busser-bats)
-[![Code Climate](https://codeclimate.com/github/fnichol/busser-bats.png)](https://codeclimate.com/github/fnichol/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]
 
@@ -36,6 +36,8 @@ Created and maintained by [Fletcher Nichol][author] (<fnichol@nichol.ca>)
 
 Apache 2.0 (see [LICENSE][license])
 
+[Bats][bats_site] is released under an MIT-style license, copyright Sam Stephenson.
+
 
 [author]:           https://github.com/fnichol
 [issues]:           https://github.com/fnichol/busser-bats/issues

data/Rakefile

@@ -1,8 +1,46 @@
 require "bundler/gem_tasks"
 require 'cucumber/rake/task'
 require 'cane/rake_task'
+require 'open-uri'
 require 'tailor/rake_task'
 
+namespace :bats do
+
+  version = ENV.fetch("BATS_VERSION", "v0.3.1")
+  url = "https://github.com/sstephenson/bats/archive/#{version}.tar.gz"
+  tarball = "tmp/bats-#{version}.tar.gz"
+  vendor = "vendor/bats"
+
+  desc "Vendors bats #{version} source code into gem codebase"
+  task :vendor => "#{vendor}/VERSION.txt"
+
+  directory File.dirname(tarball)
+  directory vendor
+
+  file tarball => File.dirname(tarball) do |t|
+    begin
+      src = open(url).binmode
+      dst = open(t.name, "wb")
+      IO.copy_stream(src, dst)
+    ensure
+      src.close
+      dst.close
+    end
+  end
+
+  file "#{vendor}/VERSION.txt" => [vendor, tarball] do |t|
+    abs_tarball = File.expand_path(tarball)
+    Dir.chdir(vendor) { sh "tar xzf #{abs_tarball} --strip-components=1" }
+    rm_rf "#{vendor}/test"
+    IO.write(t.name, url + "\n")
+  end
+
+  desc "Clean up a vendored bats in preparation for a new vendored version"
+  task :clean do
+    rm_rf [vendor, tarball]
+  end
+end
+
 Cucumber::Rake::Task.new(:features) do |t|
   t.cucumber_opts = ['features', '-x', '--format progress']
 end

data/busser-bats.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['fnichol@nichol.ca']
   spec.description   = %q{A Busser runner plugin for Bats}
   spec.summary       = spec.description
-  spec.homepage      = 'https://github.com/fnichol/busser-bats'
+  spec.homepage      = 'https://github.com/test-kitchen/busser-bats'
   spec.license       = 'Apache 2.0'
 
   spec.files         = `git ls-files`.split($/)

data/lib/busser/bats/version.rb

@@ -21,6 +21,6 @@ module Busser
   module Bats
 
     # Version string for the Bats Busser runner plugin
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/busser/runner_plugin/bats.rb

@@ -17,7 +17,6 @@
 # limitations under the License.
 
 require 'pathname'
-require 'tmpdir'
 
 require 'busser/runner_plugin'
 
@@ -28,19 +27,10 @@ require 'busser/runner_plugin'
 class Busser::RunnerPlugin::Bats < Busser::RunnerPlugin::Base
 
   postinstall do
-    tmp_root      = Pathname.new(Dir.mktmpdir("bats"))
-    tarball_url   = "https://github.com/sstephenson/bats/archive/master.tar.gz"
-    tarball_file  = tmp_root.join("bats.tar.gz")
-    extract_root  = tmp_root.join("bats")
-    dest_path     = vendor_path("bats")
-
-    empty_directory(extract_root)
-    get(tarball_url, tarball_file)
-    inside(extract_root) do
-      run!(%{gunzip -c "#{tarball_file}" | tar xf - --strip-components=1})
-      run!(%{./install.sh #{dest_path}})
+    inside(Pathname.new(__FILE__).dirname.join("../../../vendor/bats")) do
+      FileUtils.ln_sf("../libexec/bats", "bin/bats")
+      run!(%{./install.sh #{vendor_path("bats")}})
     end
-    remove_dir(tmp_root)
   end
 
   def test

data/vendor/bats/.gitattributes

@@ -0,0 +1,3 @@
+* text=auto
+*.sh eol=lf
+libexec/* eol=lf

data/vendor/bats/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Sam Stephenson
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/vendor/bats/README.md

@@ -0,0 +1,272 @@
+# Bats: Bash Automated Testing System
+
+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.
+
+A Bats test file is a Bash script with special syntax for defining
+test cases. Under the hood, each test case is just a function with a
+description.
+
+```bash
+#!/usr/bin/env bats
+
+@test "addition using bc" {
+  result="$(echo 2+2 | bc)"
+  [ "$result" -eq 4 ]
+}
+
+@test "addition using dc" {
+  result="$(echo 2 2+p | dc)"
+  [ "$result" -eq 4 ]
+}
+```
+
+Bats is most useful when testing software written in Bash, but you can
+use it to test any UNIX program.
+
+Test cases consist of standard shell commands. Bats makes use of
+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
+file. The file's test cases are run sequentially and in isolation. If
+all the test cases pass, `bats` exits with a `0` status code. If there
+are any failures, `bats` exits with a `1` status code.
+
+When you run Bats from a terminal, you'll see output as each test is
+performed, with a check-mark next to the test's name if it passes or
+an "X" if it fails.
+
+    $ bats addition.bats
+     ✓ addition using bc
+     ✓ addition using dc
+
+    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
+a file—the results are displayed in human-readable, machine-parsable
+[TAP format](http://testanything.org/wiki/index.php/TAP_specification#THE_TAP_FORMAT).
+You can force TAP output from a terminal by invoking Bats with the
+`--tap` option.
+
+    $ bats --tap addition.bats
+    1..2
+    ok 1 addition using bc
+    ok 2 addition using dc
+
+### Test suites
+
+You can invoke the `bats` interpreter with multiple test file
+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
+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)
+on the wiki.
+
+### The _run_ helper
+
+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
+its arguments as a command, saves the exit status and output into
+special global variables, and then returns with a `0` status code so
+you can continue to make assertions in your test case.
+
+For example, let's say you're testing that the `foo` command, when
+passed a nonexistent filename, exits with a `1` status code and prints
+an error message.
+
+```bash
+@test "invoking foo with a nonexistent file prints an error" {
+  run foo nonexistent_filename
+  [ "$status" -eq 1 ]
+  [ "$output" = "foo: no such file 'nonexistent_filename'" ]
+}
+```
+
+The `$status` variable contains the status code of the command, and
+the `$output` variable contains the combined contents of the command's
+standard output and standard error streams.
+
+A third special variable, the `$lines` array, is available for easily
+accessing individual lines of output. For example, if you want to test
+that invoking `foo` without any arguments prints usage information on
+the first line:
+
+```bash
+@test "invoking foo without arguments prints usage" {
+  run foo
+  [ "$status" -eq 1 ]
+  [ "${lines[0]}" = "usage: foo <filename>" ]
+}
+```
+
+### The _load_ command
+
+You may want to share common code across multiple test files. Bats
+includes a convenient `load` command for sourcing a Bash source file
+relative to the location of the current test file. For example, if you
+have a Bats test in `test/foo.bats`, the command
+
+```bash
+load test_helper
+```
+
+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
+
+Tests can be skipped by using the `skip` command at the point in a
+test you wish to skip.
+
+```bash
+@test "A test I don't want to execute for now" {
+  skip
+  run foo
+  [ "$status" -eq 0 ]
+}
+```
+
+Optionally, you may include a reason for skipping:
+
+```bash
+@test "A test I don't want to execute for now" {
+  skip "This command will return zero soon, but not now"
+  run foo
+  [ "$status" -eq 0 ]
+}
+```
+
+Or you can skip conditionally:
+
+```bash
+@test "A test which should run" {
+  if [ foo != bar ]; then
+    skip "foo isn't bar"
+  fi
+
+  run foo
+  [ "$status" -eq 0 ]
+}
+```
+
+### Setup and teardown functions
+
+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.
+
+### Code outside of test cases
+
+You can include code in your test file outside of `@test` functions.
+For example, this may be useful if you want to check for dependencies
+and fail immediately if they're not present. However, any output that
+you print in code outside of `@test`, `setup` or `teardown` functions
+must be redirected to `stderr` (`>&2`). Otherwise, the output may
+cause Bats to fail by polluting the TAP stream on `stdout`.
+
+### Special variables
+
+There are several global variables you can use to introspect on Bats
+tests:
+
+* `$BATS_TEST_FILENAME` is the fully expanded path to the Bats test
+file.
+* `$BATS_TEST_DIRNAME` is the directory in which the Bats test file is
+located.
+* `$BATS_TEST_NAMES` is an array of function names for each test case.
+* `$BATS_TEST_NAME` is the name of the function containing the current
+test case.
+* `$BATS_TEST_DESCRIPTION` is the description of the current test
+case.
+* `$BATS_TEST_NUMBER` is the (1-based) index of the current test case
+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
+`bin` directory to your `$PATH`, or run the provided `install.sh`
+command with the location to the prefix in which you want to install
+Bats. For example, to install Bats into `/usr/local`,
+
+    $ git clone https://github.com/sstephenson/bats.git
+    $ cd bats
+    $ ./install.sh /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
+GitHub](https://github.com/sstephenson/bats). There you can file bugs
+on the issue tracker or submit tested pull requests for review.
+
+For real-world examples from open-source projects using Bats, see
+[Projects Using Bats](https://github.com/sstephenson/bats/wiki/Projects-Using-Bats)
+on the wiki.
+
+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
+
+*0.3.1* (October 28, 2013)
+
+* Fixed an incompatibility with the pretty formatter in certain
+  environments such as tmux.
+* Fixed a bug where the pretty formatter would crash if the first line
+  of a test file's output was invalid TAP.
+
+*0.3.0* (October 21, 2013)
+
+* Improved formatting for tests run from a terminal. Failing tests
+  are now colored in red, and the total number of failing tests is
+  displayed at the end of the test run. When Bats is not connected to
+  a terminal (e.g. in CI runs), or when invoked with the `--tap` flag,
+  output is displayed in standard TAP format.
+* Added the ability to skip tests using the `skip` command.
+* Added a message to failing test case output indicating the file and
+  line number of the statement that caused the test to fail.
+* Added "ad-hoc" test suite support. You can now invoke `bats` with
+  multiple filename or directory arguments to run all the specified
+  tests in aggregate.
+* Added support for test files with Windows line endings.
+* Fixed regular expression warnings from certain versions of Bash.
+* Fixed a bug running tests containing lines that begin with `-e`.
+
+*0.2.0* (November 16, 2012)
+
+* Added test suite support. The `bats` command accepts a directory
+  name containing multiple test files to be run in aggregate.
+* Added the ability to count the number of test cases in a file or
+  suite by passing the `-c` flag to `bats`.
+* Preprocessed sources are cached between test case runs in the same
+  file for better performance.
+
+*0.1.0* (December 30, 2011)
+
+* Initial public release.
+
+---
+
+© 2013 Sam Stephenson. Bats is released under an MIT-style license;
+see `LICENSE` for details.

data/vendor/bats/VERSION.txt

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

data/vendor/bats/bin/bats

@@ -0,0 +1,140 @@
+#!/usr/bin/env bash
+set -e
+
+version() {
+  echo "Bats 0.3.1"
+}
+
+usage() {
+  version
+  echo "Usage: bats [-c] [-p | -t] <test> [<test> ...]"
+}
+
+help() {
+  usage
+  echo
+  echo "  <test> is the path to a Bats test file, or the path to a directory"
+  echo "  containing Bats test files."
+  echo
+  echo "  -c, --count    Count the number of test cases without running any tests"
+  echo "  -h, --help     Display this help message"
+  echo "  -p, --pretty   Show results in pretty format (default for terminals)"
+  echo "  -t, --tap      Show results in TAP format"
+  echo "  -v, --version  Display the version number"
+  echo
+  echo "  For more information, see https://github.com/sstephenson/bats"
+  echo
+}
+
+resolve_link() {
+  $(type -p greadlink readlink | head -1) "$1"
+}
+
+abs_dirname() {
+  local cwd="$(pwd)"
+  local path="$1"
+
+  while [ -n "$path" ]; do
+    cd "${path%/*}"
+    local name="${path##*/}"
+    path="$(resolve_link "$name" || true)"
+  done
+
+  pwd
+  cd "$cwd"
+}
+
+expand_path() {
+  { cd "$(dirname "$1")" 2>/dev/null
+    local dirname="$PWD"
+    cd "$OLDPWD"
+    echo "$dirname/$(basename "$1")"
+  } || echo "$1"
+}
+
+BATS_LIBEXEC="$(abs_dirname "$0")"
+export BATS_PREFIX="$(abs_dirname "$BATS_LIBEXEC")"
+export PATH="$BATS_LIBEXEC:$PATH"
+
+options=()
+arguments=()
+for arg in "$@"; do
+  if [ "${arg:0:1}" = "-" ]; then
+    if [ "${arg:1:1}" = "-" ]; then
+      options[${#options[*]}]="${arg:2}"
+    else
+      index=1
+      while option="${arg:$index:1}"; do
+        [ -n "$option" ] || break
+        options[${#options[*]}]="$option"
+        index=$(($index+1))
+      done
+    fi
+  else
+    arguments[${#arguments[*]}]="$arg"
+  fi
+done
+
+unset count_flag pretty
+[ -t 0 ] && [ -t 1 ] && pretty="1"
+
+for option in "${options[@]}"; do
+  case "$option" in
+  "h" | "help" )
+    help
+    exit 0
+    ;;
+  "v" | "version" )
+    version
+    exit 0
+    ;;
+  "c" | "count" )
+    count_flag="-c"
+    ;;
+  "t" | "tap" )
+    pretty=""
+    ;;
+  "p" | "pretty" )
+    pretty="1"
+    ;;
+  * )
+    usage >&2
+    exit 1
+    ;;
+  esac
+done
+
+if [ "${#arguments[@]}" -eq 0 ]; then
+  usage >&2
+  exit 1
+fi
+
+filenames=()
+for filename in "${arguments[@]}"; do
+  if [ -d "$filename" ]; then
+    shopt -s nullglob
+    for suite_filename in "$(expand_path "$filename")"/*.bats; do
+      filenames["${#filenames[@]}"]="$suite_filename"
+    done
+    shopt -u nullglob
+  else
+    filenames["${#filenames[@]}"]="$(expand_path "$filename")"
+  fi
+done
+
+if [ "${#filenames[@]}" -eq 1 ]; then
+  command="bats-exec-test"
+else
+  command="bats-exec-suite"
+fi
+
+if [ -n "$pretty" ]; then
+  extended_syntax_flag="-x"
+  formatter="bats-format-tap-stream"
+else
+  extended_syntax_flag=""
+  formatter="cat"
+fi
+
+set -o pipefail execfail
+exec "$command" $count_flag $extended_syntax_flag "${filenames[@]}" | "$formatter"