jet_black 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d0380fc2fc0e5a1a92c769bd696b8b6ed50ff314299f41dee11b9a1637ba7af
-  data.tar.gz: 2e5d5cef1ba46569904b89cd4af6893cad9b7041bcba910fe987ba885441cd32
+  metadata.gz: aa0fa42b8b1218e280038ce18fa583a3a8288d4cd91c5a6445c34d03b8c68c5f
+  data.tar.gz: d5c94f0eb5852106f2959dd4745f27d401f67adcc2d79247e9979dd3760a8935
 SHA512:
-  metadata.gz: 586f355aa9142484c739bde06cd412e8096932b7557e28fed5c93c98f850263517226139592308cf0063447da12d457494a859a852e660ac9f2585f1aaa0b81c
-  data.tar.gz: aac1249839146336bb8a414b01073bbfb70ff457a27b3160094c868b61a92b798c578f38e2ae73d5ca126a14ae5b9d42fa71aafa4cfcd612a1d5ab4dcb6a0f57
+  metadata.gz: 5ca15f316fac15876965b704f37432ee80ceb4867c13b1a0cc0e4063f79bd50ec3b60a2a462f600afb753c08c260c665a71065ba3e35d8dd470436acb0128e83
+  data.tar.gz: c371bf859447eeac0514167f9f1869132595cf745d6086dcb1482d0feb7622c886ed3f89ffd8cd881c8f5855718be2386bb0c17bd236ad664a9594e8353dbdde

data/.circleci/config.yml

@@ -0,0 +1,41 @@
+version: 2
+jobs:
+  build:
+    docker:
+       - image: circleci/ruby:2.5
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "Gemfile.lock" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            bundle exec rspec --format progress \
+                            --format RspecJunitFormatter \
+                            --out /tmp/test-results/rspec.xml
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+## v0.2.0
+
+- Adds RSpec matchers `have_stdout`, `have_stderr`, `have_no_stdout`, &
+  `have_no_stderr`.
+- Adds support for RSpec predicate matchers `be_success` & `be_failure`.
+- Requiring `jet_black/rspec` sets up inference of spec type and inclusion
+  matchers (place specs in `spec/black_box`).
+
+## v0.1.0
+
+- Initial release.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jet_black (0.1.0)
+    jet_black (0.2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -26,6 +26,8 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
     rspec-support (3.7.1)
+    rspec_junit_formatter (0.3.0)
+      rspec-core (>= 2, < 4, != 2.12.0)
 
 PLATFORMS
   ruby
@@ -36,6 +38,7 @@ DEPENDENCIES
   pry
   rake (~> 10.0)
   rspec (~> 3.0)
+  rspec_junit_formatter
 
 BUNDLED WITH
    1.16.1

data/README.md

@@ -1,12 +1,16 @@
 # JetBlack
 
-A black-box testing utility for Ruby. Features:
+[![CircleCI](https://circleci.com/gh/odlp/jet_black.svg?style=svg)](https://circleci.com/gh/odlp/jet_black)
+
+A black-box testing utility for command line tools, written in Ruby. Features:
 
 - Each session runs in a temporary directory
-- Captures stdout, stderr and exit status of a command
+- Captures `stdout`, `stderr` and exit status of a command
 - Keeps a history of commands executed
 - Temporarily overriding environment variables for a command
 - Copying fixture files to the temporary directory
 - Appending content to files in the temporary directory
 - Adding a path prefix to include your executable
-- Option to escape the Bundler environment, to "bundle exec" new Gemfiles
+- Option to escape the Bundler environment (allowing `bundle exec` with
+  different Gemfiles)
+- RSpec matchers for `stdout` and `stderr`

data/jet_black.gemspec

@@ -19,7 +19,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "pry"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec_junit_formatter"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "pry"
 end

data/lib/jet_black/executed_command.rb

@@ -8,5 +8,13 @@ module JetBlack
       @stderr = stderr.chomp
       @exit_status = exit_status.to_i
     end
+
+    def success?
+      exit_status.zero?
+    end
+
+    def failure?
+      !success?
+    end
   end
 end

data/lib/jet_black/rspec.rb

@@ -0,0 +1,15 @@
+require "rspec/core"
+require_relative "rspec/matchers"
+
+module JetBlack
+  module RSpec
+  end
+end
+
+RSpec.configure do |config|
+  config.define_derived_metadata(file_path: %r{/spec/black_box/}) do |metadata|
+    metadata[:type] = :black_box
+  end
+
+  config.include JetBlack::RSpec::Matchers, type: :black_box
+end

data/lib/jet_black/rspec/matchers.rb

@@ -0,0 +1,53 @@
+require "rspec/expectations"
+
+module JetBlack
+  module RSpec
+    module Matchers
+      extend ::RSpec::Matchers::DSL
+
+      def have_stdout(expected)
+        HaveStdout.new(expected)
+      end
+
+      def have_stderr(expected)
+        HaveStderr.new(expected)
+      end
+
+      matcher(:have_no_stdout) do
+        match { |result| result.stdout.empty? }
+
+        failure_message do |result|
+          <<~MSG
+            expected command to have no stdout output. Got:
+            ---
+            #{result.stdout}
+          MSG
+        end
+      end
+
+      matcher(:have_no_stderr) do
+        match { |result| result.stderr.empty? }
+
+        failure_message do |result|
+          <<~MSG
+            expected command to have no stderr output. Got:
+            ---
+            #{result.stderr}
+          MSG
+        end
+      end
+
+      class HaveStdout < ::RSpec::Matchers::BuiltIn::Match
+        def matches?(actual)
+          super(actual.stdout)
+        end
+      end
+
+      class HaveStderr < ::RSpec::Matchers::BuiltIn::Match
+        def matches?(actual)
+          super(actual.stderr)
+        end
+      end
+    end
+  end
+end

data/lib/jet_black/session.rb

@@ -93,7 +93,7 @@ module JetBlack
 
     def command_context(options)
       if options[:clean_bundler_env]
-        Bundler.with_original_env { yield }
+        Bundler.with_clean_env { yield }
       else
         yield
       end

data/lib/jet_black/version.rb

@@ -1,3 +1,3 @@
 module JetBlack
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jet_black
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Oli Peate
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-26 00:00:00.000000000 Z
+date: 2018-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -25,35 +25,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.16'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -66,15 +66,31 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: 
 email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -88,6 +104,8 @@ files:
 - lib/jet_black/environment.rb
 - lib/jet_black/errors.rb
 - lib/jet_black/executed_command.rb
+- lib/jet_black/rspec.rb
+- lib/jet_black/rspec/matchers.rb
 - lib/jet_black/session.rb
 - lib/jet_black/version.rb
 homepage: https://github.com/odlp/jet_black