jet_black 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9d0380fc2fc0e5a1a92c769bd696b8b6ed50ff314299f41dee11b9a1637ba7af
+  data.tar.gz: 2e5d5cef1ba46569904b89cd4af6893cad9b7041bcba910fe987ba885441cd32
+SHA512:
+  metadata.gz: 586f355aa9142484c739bde06cd412e8096932b7557e28fed5c93c98f850263517226139592308cf0063447da12d457494a859a852e660ac9f2585f1aaa0b81c
+  data.tar.gz: aac1249839146336bb8a414b01073bbfb70ff457a27b3160094c868b61a92b798c578f38e2ae73d5ca126a14ae5b9d42fa71aafa4cfcd612a1d5ab4dcb6a0f57

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.3
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in jet_black.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    jet_black (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  jet_black!
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Oli Peate
+
+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/README.md

@@ -0,0 +1,12 @@
+# JetBlack
+
+A black-box testing utility for Ruby. Features:
+
+- Each session runs in a temporary directory
+- 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

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/jet_black_bin_example

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+echo "Hello from example bin"

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/jet_black.gemspec

@@ -0,0 +1,25 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "jet_black/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "jet_black"
+  spec.version       = JetBlack::VERSION
+  spec.authors       = ["Oli Peate"]
+
+  spec.summary       = "Black box testing"
+  spec.homepage      = "https://github.com/odlp/jet_black"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+end

data/lib/jet_black.rb

@@ -0,0 +1,17 @@
+require "jet_black/configuration"
+require "jet_black/session"
+require "jet_black/version"
+
+module JetBlack
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield configuration if block_given?
+  end
+
+  def self.reset!
+    @configuration = Configuration.new
+  end
+end

data/lib/jet_black/configuration.rb

@@ -0,0 +1,5 @@
+module JetBlack
+  class Configuration
+    attr_accessor :fixture_directory, :path_prefix
+  end
+end

data/lib/jet_black/environment.rb

@@ -0,0 +1,34 @@
+module JetBlack
+  class Environment
+    def initialize(raw_env)
+      @raw_env = raw_env.dup
+    end
+
+    def to_h
+      apply_path_prefix(stringify_env(raw_env))
+    end
+
+    private
+
+    attr_reader :raw_env
+
+    def stringify_env(env)
+      env.map do |key, value|
+        [key.to_s, value.to_s]
+      end.to_h
+    end
+
+    def apply_path_prefix(env)
+      if path_prefix&.empty?
+        env
+      else
+        env["PATH"] = [path_prefix, ENV["PATH"]].join(File::PATH_SEPARATOR)
+        env
+      end
+    end
+
+    def path_prefix
+      JetBlack.configuration.path_prefix
+    end
+  end
+end

data/lib/jet_black/errors.rb

@@ -0,0 +1,34 @@
+module JetBlack
+  class Error < ::StandardError
+  end
+
+  class InvalidPathError < Error
+    attr_reader :raw_path, :expanded_path
+
+    def initialize(raw_path, expanded_path)
+      @raw_path = raw_path
+      @expanded_path = expanded_path
+
+      super <<~MSG
+        Please specify a relative path within the temp dir.
+        Raw path: '#{raw_path}'
+        Expanded path: '#{expanded_path}'
+      MSG
+    end
+  end
+
+  class NonExistentFileError < Error
+    attr_reader :raw_path, :expanded_path
+
+    def initialize(raw_path, expanded_path)
+      @raw_path = raw_path
+      @expanded_path = expanded_path
+
+      super <<~MSG
+        Please create the file before trying to append content.
+        Raw path: '#{raw_path}'
+        Expanded path: '#{expanded_path}'
+      MSG
+    end
+  end
+end

data/lib/jet_black/executed_command.rb

@@ -0,0 +1,12 @@
+module JetBlack
+  class ExecutedCommand
+    attr_reader :raw_command, :stdout, :stderr, :exit_status
+
+    def initialize(raw_command:, stdout:, stderr:, exit_status:)
+      @raw_command = raw_command
+      @stdout = stdout.chomp
+      @stderr = stderr.chomp
+      @exit_status = exit_status.to_i
+    end
+  end
+end

data/lib/jet_black/session.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require "fileutils"
+require "open3"
+require "tmpdir"
+require_relative "environment"
+require_relative "errors"
+require_relative "executed_command"
+
+module JetBlack
+  class Session
+    attr_reader :commands
+
+    def initialize(options: {})
+      @commands = []
+      @session_options = options
+    end
+
+    def run(command, env: {}, options: {})
+      combined_options = session_options.merge(options)
+      executed_command = exec_command(command, env, combined_options)
+      commands << executed_command
+      executed_command
+    end
+
+    def directory
+      @_directory ||= File.realpath(Dir.mktmpdir("jet_black"))
+    end
+
+    def create_file(file_path, file_content)
+      expanded_file_path = File.expand_path(file_path, directory)
+      expanded_dir = File.dirname(expanded_file_path)
+
+      unless expanded_file_path.start_with?(directory)
+        raise JetBlack::InvalidPathError.new(file_path, expanded_file_path)
+      end
+
+      FileUtils.mkdir_p(expanded_dir)
+      File.write(expanded_file_path, file_content)
+    end
+
+    def append_to_file(file_path, append_content)
+      expanded_file_path = File.expand_path(file_path, directory)
+
+      unless File.exist?(expanded_file_path)
+        raise JetBlack::NonExistentFileError.new(file_path, expanded_file_path)
+      end
+
+      File.open(expanded_file_path, "a") do |file|
+        file.write(append_content)
+      end
+    end
+
+    def copy_fixture(source_path, destination_path)
+      src_fixture_dir = JetBlack.configuration.fixture_directory
+      expanded_source_path = File.expand_path(source_path, src_fixture_dir)
+      expanded_destination_path = File.expand_path(destination_path, directory)
+      expanded_destination_dir = File.dirname(expanded_destination_path)
+
+      if src_fixture_dir.nil?
+        raise Error.new("Please configure the fixture_directory")
+      end
+
+      unless expanded_destination_path.start_with?(directory)
+        raise JetBlack::InvalidPathError.new(
+          destination_path, expanded_destination_path
+        )
+      end
+
+      FileUtils.mkdir_p(expanded_destination_dir)
+      FileUtils.cp(expanded_source_path, expanded_destination_path)
+    end
+
+    private
+
+    attr_reader :session_options
+
+    def exec_command(raw_command, raw_env, options)
+      env = Environment.new(raw_env).to_h
+
+      command_context(options) do
+        stdout, stderr, exit_status =
+          Open3.capture3(env, raw_command, chdir: directory)
+
+        ExecutedCommand.new(
+          raw_command: raw_command,
+          stdout: stdout,
+          stderr: stderr,
+          exit_status: exit_status,
+        )
+      end
+    end
+
+    def command_context(options)
+      if options[:clean_bundler_env]
+        Bundler.with_original_env { yield }
+      else
+        yield
+      end
+    end
+  end
+end

data/lib/jet_black/version.rb

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

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: jet_black
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Oli Peate
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/jet_black_bin_example
+- bin/setup
+- jet_black.gemspec
+- lib/jet_black.rb
+- lib/jet_black/configuration.rb
+- lib/jet_black/environment.rb
+- lib/jet_black/errors.rb
+- lib/jet_black/executed_command.rb
+- lib/jet_black/session.rb
+- lib/jet_black/version.rb
+homepage: https://github.com/odlp/jet_black
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Black box testing
+test_files: []