jet_black 0.3.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 492919b04c06523b9dca80a4d30939272ae1d435ea83c183f94cae6ab7d11501
-  data.tar.gz: c5157a559982f91bfe2560a6283b96229dade980b35fd52f9e446c4e339772e5
+  metadata.gz: c389c6caddb4fe0d3b8874f96a50f9c0e4217c3e1af903b6ca9f19bca24065c5
+  data.tar.gz: 5c1775b10ac55262d4291a9748858776a618400dfb4fa4561357147802822ce3
 SHA512:
-  metadata.gz: d2e3877e059b410b276486990e042722d134abb2c9a4111183a9fcfdd3f902bcd742ff426003fb4c44966e4f0d70ba651709f3833f1cc44048fd3ccddee6e764
-  data.tar.gz: ed0f71a6940b5cde28e0c61bcdcbcd76db183a0808a0d7d97d56ba476aab4f885954ab24386f2329c167972430a04d0591105273a93ee4e63a005647ad38df17
+  metadata.gz: 9ddb6513193a3395baef52fab1bf86b3cf1de9f5d04091b82f52cd35e8bc97c2a3e21ca7549855e7d9db7947cb1af3b5f7263ce1b9929382dd7743ceb05d7d91
+  data.tar.gz: eac5b131ecce2f9b5aff51b1220d3276f320972bbf712f2e1efc7794265972c72f1e6fa5197f3c69548d574ac0f1bbae5193cf16961c9daa2b382c7a652d88b6

data/.circleci/config.yml

@@ -1,43 +1,81 @@
+---
 version: 2
-jobs:
-  build:
-    docker:
-      - image: circleci/ruby:2.5
-    environment:
-      ENABLE_COVERAGE: 1
 
-    working_directory: ~/repo
+#-------------------------------------------------------------------------------
 
-    steps:
-      - checkout
+base_job: &base_job
+  working_directory: ~/repo
+  steps:
+    - checkout
 
-      - restore_cache:
-          keys:
+    - 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 \
+    - run:
+        name: install dependencies
+        command: |
+          gem install bundler
+          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
+    # collect reports
+    - store_test_results:
+        path: /tmp/test-results
+    - store_artifacts:
+        path: /tmp/test-results
+        destination: test-results
+
+#-------------------------------------------------------------------------------
+
+jobs:
+  ruby-2.4:
+    <<: *base_job
+    docker:
+      - image: circleci/ruby:2.4
+  ruby-2.5:
+    <<: *base_job
+    docker:
+      - image: circleci/ruby:2.5
+  ruby-2.6:
+    <<: *base_job
+    docker:
+      - image: circleci/ruby:2.6
+  ruby-2.7:
+    <<: *base_job
+    docker:
+      - image: circleci/ruby:2.7
+    environment:
+      ENABLE_COVERAGE: 1
+  ruby-3.0:
+    <<: *base_job
+    docker:
+      - image: circleci/ruby:3.0
+
+#-------------------------------------------------------------------------------
+
+# TODO: Migrate to CircleCI matrix
+
+workflows:
+  version: 2
+  multiple-rubies:
+    jobs:
+      - ruby-2.4
+      - ruby-2.5
+      - ruby-2.6
+      - ruby-2.7
+      - ruby-3.0

data/.gitignore

@@ -9,3 +9,5 @@
 
 # rspec failure tracking
 .rspec_status
+
+.ruby-version

data/CHANGELOG.md

@@ -1,5 +1,30 @@
 # Changelog
 
+## v0.7.0
+
+- Adds `run_interactive` to allow pseudo-terminal interaction
+
+## v0.6.0
+
+- Freeze string literals
+- Fix deprecation warning: `Bundler.with_clean_env` has been deprecated in
+  favor of `Bundler.with_unbundled_env`
+
+## v0.5.1
+
+- Fix missing `bundler` require - thanks @lpender via [#6][pr-6]
+
+[pr-6]: https://github.com/odlp/jet_black/pull/6
+
+## v0.5.0
+
+- `stdout` and `stderr` now keep any trailing newlines at the end of the string.
+
+## v0.4.0
+
+- Scrub ANSI escape sequences in `stdout` and `stderr`
+- Allow environment variables to be unset
+
 ## v0.3.0
 
 - Allows `stdin` data to be provided when running commands

data/Dockerfile

@@ -0,0 +1,10 @@
+FROM ruby:2.7
+
+WORKDIR /app
+
+COPY Gemfile* jet_black.gemspec /app/
+COPY lib/jet_black/version.rb /app/lib/jet_black/version.rb
+
+RUN bundle install --jobs=4 --retry=3
+
+COPY . /app

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 # Specify your gem's dependencies in jet_black.gemspec

data/Gemfile.lock

@@ -1,69 +1,63 @@
 PATH
   remote: .
   specs:
-    jet_black (0.3.0)
+    jet_black (0.7.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     coderay (1.1.2)
-    coveralls (0.7.2)
-      multi_json (~> 1.3)
-      rest-client (= 1.6.7)
-      simplecov (>= 0.7)
-      term-ansicolor (= 1.2.2)
-      thor (= 0.18.1)
+    coveralls (0.8.22)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.4)
+      tins (~> 1.6)
     diff-lcs (1.3)
-    docile (1.3.0)
-    json (2.1.0)
+    docile (1.3.1)
+    json (2.3.1)
     method_source (0.9.0)
-    mime-types (3.1)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2016.0521)
-    multi_json (1.13.1)
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    rake (10.5.0)
-    rest-client (1.6.7)
-      mime-types (>= 1.16)
-    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)
+    rake (13.0.1)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
-    rspec_junit_formatter (0.3.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rspec_junit_formatter (0.4.1)
       rspec-core (>= 2, < 4, != 2.12.0)
     simplecov (0.16.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    term-ansicolor (1.2.2)
-      tins (~> 0.8)
-    thor (0.18.1)
-    tins (0.13.2)
+    term-ansicolor (1.6.0)
+      tins (~> 1.0)
+    thor (0.19.4)
+    tins (1.16.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16)
+  bundler (>= 1.16, < 3)
   coveralls
   jet_black!
   pry
-  rake (~> 10.0)
+  rake (>= 12.0)
   rspec (~> 3.0)
   rspec_junit_formatter
   simplecov
 
 BUNDLED WITH
-   1.16.1
+   2.1.4

data/README.md

@@ -1,6 +1,6 @@
 # JetBlack
 
-[![CircleCI](https://circleci.com/gh/odlp/jet_black.svg?style=svg)](https://circleci.com/gh/odlp/jet_black) [![Coverage Status](https://coveralls.io/repos/github/odlp/jet_black/badge.svg?branch=master)](https://coveralls.io/github/odlp/jet_black?branch=master)
+[![Gem Version](https://badge.fury.io/rb/jet_black.svg)](https://rubygems.org/gems/jet_black) [![CircleCI](https://circleci.com/gh/odlp/jet_black.svg?style=shield)](https://circleci.com/gh/odlp/jet_black) [![Coverage Status](https://coveralls.io/repos/github/odlp/jet_black/badge.svg?branch=master)](https://coveralls.io/github/odlp/jet_black?branch=master)
 
 A black-box testing utility for command line tools and gems. Written in Ruby,
 with [RSpec] in mind. Features:
@@ -8,22 +8,23 @@ with [RSpec] in mind. Features:
 [RSpec]: http://rspec.info/
 
 - Each session takes place within a unique temporary directory, outside the project
-- Synchronously [run commands](#running-commands) then write assertions on the:
-  - `stdout` / `stderr` content
-  - exit status of the process
-- Conveniently manipulate files in the temporary directory:
+- Synchronously [run commands](#running-commands) then write assertions on:
+  - The `stdout` / `stderr` content
+  - The exit status of the process
+- Exercise [interactive command line interfaces](#running-interactive-commands)
+- Manipulate files in the temporary directory:
   - [Create files](#file-manipulation)
   - [Create executable files](#file-manipulation)
   - [Append content to files](#file-manipulation)
   - [Copy fixture files](#copying-fixture-files) from your project
-- Modify the environment without modifying the parent test process:
+- Modify the environment without changing the parent test process:
   - [Override environment variables](#environment-variable-overrides)
   - [Escape the current Bundler context](#clean-bundler-environment)
   - [Adjust `$PATH`](#path-prefix) to include your executable / Subject Under Test
 - [RSpec matchers](#rspec-matchers) (optional)
 
-The temporary directory is discarded after each spec. This means you can write
-& modify files and run commands (like `git init`) without worrying about tidying
+The temporary directory is discarded after each spec. This means you can write &
+modify files and run commands (like `git init`) without worrying about tidying
 up after or impacting your actual project.
 
 ## Setup
@@ -48,6 +49,8 @@ require "jet_black/rspec"
 Any specs you write in the `spec/black_box` folder will then have an inferred
 `:black_box` meta type, and the matchers will be available in those examples.
 
+#### Manual RSpec setup
+
 Alternatively you can manually include the matchers:
 
 ```ruby
@@ -71,7 +74,7 @@ require "jet_black"
 session = JetBlack::Session.new
 result = session.run("echo foo")
 
-result.stdout # => "foo"
+result.stdout # => "foo\n"
 result.stderr # => ""
 result.exit_status # => 0
 ```
@@ -83,6 +86,38 @@ session = JetBlack::Session.new
 session.run("./hello-world", stdin: "Alice")
 ```
 
+### Running interactive commands
+
+```ruby
+session = JetBlack::Session.new
+
+result = session.run_interactive("./hello-world") do |terminal|
+  terminal.expect("What's your name?", reply: "Alice")
+  terminal.expect("What's your location?", reply: "Wonderland")
+end
+
+expect(result.exit_status).to eq 0
+expect(result.stdout).to eq <<~TXT
+  What's your name?
+  Alice
+  What's your location?
+  Wonderland
+  Hello Alice in Wonderland
+TXT
+```
+
+If you don't want to wait for a process to finish, you can end the interactive
+session early:
+
+```ruby
+session = JetBlack::Session.new
+
+result = session.run_interactive("./long-cli-flow") do |terminal|
+  terminal.expect("Question 1", reply: "Y")
+  terminal.end_session(signal: "INT")
+end
+```
+
 ### File manipulation
 
 ```ruby
@@ -114,40 +149,42 @@ TXT
 ### Copying fixture files
 
 It's ideal to create pertinent files inline within a spec, to provide context
-for the reader, but sometimes a large or non-readable file is best copied
-across.
+for the reader, but sometimes it's better to copy across a large or
+non-human-readable file.
 
-First create a fixture directory in your project, such as
-`spec/fixtures/black_box`. Then configure the fixture path in
-`spec/support/jet_black.rb`:
+1.    Create a fixture directory in your project, such as `spec/fixtures/black_box`.
 
-```ruby
-require "jet_black"
+2.    Configure the fixture path in `spec/support/jet_black.rb`:
 
-JetBlack.configure do |config|
-  config.fixture_directory = File.expand_path("../fixtures/black_box", __dir__)
-end
-```
+      ```ruby
+      require "jet_black"
 
-Now you can copy fixtures across into a session's temporary directory:
+      JetBlack.configure do |config|
+        config.fixture_directory = File.expand_path("../fixtures/black_box", __dir__)
+      end
+      ```
 
-```ruby
-session = JetBlack::Session.new
-session.copy_fixture("src-config.json", "config.json")
+3.    Copy fixtures across into a session's temporary directory:
 
-# Destination subdirectories are created for you:
-session.copy_fixture("src-config.json", "config/config.json")
-```
+      ```ruby
+      session = JetBlack::Session.new
+      session.copy_fixture("src-config.json", "config.json")
+
+      # Destination subdirectories are created for you:
+      session.copy_fixture("src-config.json", "config/config.json")
+      ```
 
 ### Environment variable overrides
 
 ```ruby
 session = JetBlack::Session.new
-result = subject.run("echo $FOO", env: { FOO: "bar" })
+result = session.run("printf $FOO", env: { FOO: "bar" })
 
 result.stdout # => "bar"
 ```
 
+Provide a `nil` value to unset an environment variable.
+
 ### Clean Bundler environment
 
 If your project's test suite is invoked with Bundler (e.g. `bundle exec rspec`)
@@ -155,15 +192,19 @@ but you want to run commands like `bundle install` and `bundle exec` with a
 different Gemfile in a given spec, you can configure the session or individual
 commands to run with a clean Bundler environment.
 
+Per command:
+
 ```ruby
-# Per command
 session = JetBlack::Session.new
-subject.run("bundle install", options: { clean_bundler_env: true })
+session.run("bundle install", options: { clean_bundler_env: true })
+```
 
-# Per session
+Per session:
+
+```ruby
 session = JetBlack::Session.new(options: { clean_bundler_env: true })
-subject.run("bundle install")
-subject.run("bundle exec rake")
+session.run("bundle install")
+session.run("bundle exec rake")
 ```
 
 ### `$PATH` prefix
@@ -179,7 +220,7 @@ Configure the `path_prefix` to the directory containing with your executable(s):
 require "jet_black"
 
 JetBlack.configure do |config|
-  config.path_prefix = File.expand("../../bin", __dir__)
+  config.path_prefix = File.expand_path("../../bin", __dir__)
 end
 ```
 
@@ -246,3 +287,10 @@ RSpec.describe "my command line tool" do
   end
 end
 ```
+
+## More examples
+
+- JetBlack's own [higher-level tests](https://github.com/odlp/jet_black/tree/master/spec/features)
+- A more complex scenario testing a [gem in a fresh Rails app](https://github.com/thoughtbot/capybara_discoball/blob/master/spec/black_box/rails_app_spec.rb#L8-L39). Shows how to:
+  - Include the [gem-under-test via the Rails app's Gemfile](https://github.com/thoughtbot/capybara_discoball/blob/4e89bfe5531eea1bf6dac42c46c26d0c687d6ddf/spec/black_box/rails_app_spec.rb#L99-L104)
+  - Use a [clean Bundler environment](https://github.com/thoughtbot/capybara_discoball/blob/4e89bfe5531eea1bf6dac42c46c26d0c687d6ddf/spec/black_box/rails_app_spec.rb#L5) to use the Gemfile of the new Rails app (instead of the Bundler context of the gem's test suite)

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 

data/bin/docker_test

@@ -0,0 +1,6 @@
+#!/bin/sh
+
+set -euo pipefail
+
+docker build -t odlp/jet_black .
+docker run odlp/jet_black bundle exec rspec --tty

data/bin/jet_black_bin_example

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

data/jet_black.gemspec

@@ -18,10 +18,10 @@ Gem::Specification.new do |spec|
   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 "bundler", ">= 1.16", "< 3"
   spec.add_development_dependency "coveralls"
   spec.add_development_dependency "pry"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", ">= 12.0"
   spec.add_development_dependency "rspec_junit_formatter"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "simplecov"

data/lib/jet_black.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "jet_black/configuration"
 require "jet_black/session"
 require "jet_black/version"

data/lib/jet_black/ansi_scrubber.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module JetBlack
+  class AnsiScrubber
+    ESCAPE_SEQUENCE = /
+      \x1B # ESC char - start of the sequence
+      (
+        [\x20-\x2F]*
+        [\x40-\x5A\x5C-\x7E]
+        |
+        \[           # Start CSI sequence
+        [\x30-\x3F]+ # CSI Parameter bytes
+        [\x20-\x2F]* # CSI Intermediate bytes
+        [\x40-\x7E]  # CSI Finishing byte
+      )
+    /x
+
+    def self.call(string)
+      string.gsub(ESCAPE_SEQUENCE, "")
+    end
+  end
+end

data/lib/jet_black/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JetBlack
   class Configuration
     attr_accessor :fixture_directory, :path_prefix

data/lib/jet_black/environment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JetBlack
   class Environment
     def initialize(raw_env)
@@ -14,7 +16,7 @@ module JetBlack
 
     def stringify_env(env)
       env.map do |key, value|
-        [key.to_s, value.to_s]
+        [key.to_s, value&.to_s]
       end.to_h
     end
 

data/lib/jet_black/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JetBlack
   class Error < ::StandardError
   end
@@ -31,4 +33,17 @@ module JetBlack
       MSG
     end
   end
+
+  class TerminalSessionTimeoutError < Error
+    attr_reader :terminal
+
+    def initialize(terminal, expected_value, timeout)
+      @terminal = terminal
+
+      super <<~MSG
+        Interactive terminal session timed out after #{timeout} second(s).
+        Waiting for: '#{expected_value}'
+      MSG
+    end
+  end
 end

data/lib/jet_black/executed_command.rb

@@ -1,11 +1,18 @@
+# frozen_string_literal: true
+
+require_relative "ansi_scrubber"
+
 module JetBlack
   class ExecutedCommand
-    attr_reader :raw_command, :stdout, :stderr, :exit_status
+    attr_reader :raw_command, :raw_stdout, :raw_stderr,
+                :stdout, :stderr, :exit_status
 
     def initialize(raw_command:, stdout:, stderr:, exit_status:)
       @raw_command = raw_command
-      @stdout = stdout.chomp
-      @stderr = stderr.chomp
+      @raw_stdout = stdout
+      @raw_stderr = stderr
+      @stdout = scrub(stdout)
+      @stderr = scrub(stderr)
       @exit_status = exit_status.to_i
     end
 
@@ -16,5 +23,11 @@ module JetBlack
     def failure?
       !success?
     end
+
+    private
+
+    def scrub(output_string)
+      AnsiScrubber.call(output_string.to_s)
+    end
   end
 end

data/lib/jet_black/file_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "fileutils"
 require_relative "errors"
 

data/lib/jet_black/interactive_command.rb

@@ -0,0 +1,24 @@
+require_relative "environment"
+require_relative "terminal_session"
+
+module JetBlack
+  class InteractiveCommand
+    def call(raw_command:, raw_env:, directory:, block:)
+      env = Environment.new(raw_env).to_h
+      terminal = TerminalSession.new(raw_command, env: env, directory: directory)
+
+      unless block.nil?
+        block.call(terminal)
+      end
+
+      terminal.wait_for_finish
+
+      ExecutedCommand.new(
+        raw_command: raw_command,
+        stdout: terminal.stdout,
+        stderr: terminal.stderr,
+        exit_status: terminal.exit_status,
+      )
+    end
+  end
+end

data/lib/jet_black/non_interactive_command.rb

@@ -0,0 +1,21 @@
+require "open3"
+require_relative "environment"
+
+module JetBlack
+  class NonInteractiveCommand
+    def call(raw_command:, stdin:, raw_env:, directory:)
+      env = Environment.new(raw_env).to_h
+
+      stdout, stderr, exit_status = Open3.capture3(
+        env, raw_command, chdir: directory, stdin_data: stdin
+      )
+
+      ExecutedCommand.new(
+        raw_command: raw_command,
+        stdout: stdout,
+        stderr: stderr,
+        exit_status: exit_status,
+      )
+    end
+  end
+end

data/lib/jet_black/rspec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "rspec/core"
 require_relative "rspec/matchers"
 

data/lib/jet_black/rspec/matchers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "rspec/expectations"
 
 module JetBlack

data/lib/jet_black/session.rb

@@ -1,13 +1,14 @@
 # frozen_string_literal: true
 
+require "bundler"
 require "fileutils"
 require "forwardable"
-require "open3"
 require "tmpdir"
-require_relative "environment"
 require_relative "errors"
 require_relative "executed_command"
 require_relative "file_helper"
+require_relative "non_interactive_command"
+require_relative "interactive_command"
 
 module JetBlack
   class Session
@@ -26,38 +27,52 @@ module JetBlack
     end
 
     def run(command, stdin: nil, env: {}, options: {})
-      combined_options = session_options.merge(options)
-      executed_command = exec_command(command, stdin, env, combined_options)
-      commands << executed_command
-      executed_command
+      exec_non_interactive(raw_command: command, stdin: stdin, raw_env: env, options: options).tap do |executed_command|
+        commands << executed_command
+      end
+    end
+
+    def run_interactive(command, env: {}, options: {}, &block)
+      exec_interactive(raw_command: command, raw_env: env, options: options, block: block).tap do |executed_command|
+        commands << executed_command
+      end
     end
 
     private
 
     attr_reader :session_options, :file_helper
 
-    def exec_command(raw_command, stdin, raw_env, options)
-      env = Environment.new(raw_env).to_h
+    def exec_non_interactive(raw_command:, stdin:, raw_env:, options:)
+      combined_options = session_options.merge(options)
+
+      execution_context(combined_options) do
+        NonInteractiveCommand.new.call(raw_command: raw_command, stdin: stdin, raw_env: raw_env, directory: directory)
+      end
+    end
 
-      command_context(options) do
-        stdout, stderr, exit_status =
-          Open3.capture3(env, raw_command, chdir: directory, stdin_data: stdin)
+    def exec_interactive(raw_command:, raw_env:, options:, block:)
+      combined_options = session_options.merge(options)
 
-        ExecutedCommand.new(
-          raw_command: raw_command,
-          stdout: stdout,
-          stderr: stderr,
-          exit_status: exit_status,
-        )
+      execution_context(combined_options) do
+        InteractiveCommand.new.call(raw_command: raw_command, raw_env: raw_env, directory: directory, block: block)
       end
     end
 
-    def command_context(options)
+    def execution_context(options)
       if options[:clean_bundler_env]
-        Bundler.with_clean_env { yield }
+        Bundler.public_send(bundler_clean_environment_method) { yield }
       else
         yield
       end
     end
+
+    def bundler_clean_environment_method
+      # Bundler 2.x
+      if Bundler.respond_to?(:with_unbundled_env)
+        :with_unbundled_env
+      else
+        :with_clean_env
+      end
+    end
   end
 end

data/lib/jet_black/terminal_session.rb

@@ -0,0 +1,91 @@
+require "pty"
+require "expect"
+require_relative "errors"
+
+module JetBlack
+  class TerminalSession
+    DEFAULT_TIMEOUT = 10
+
+    attr_reader :exit_status
+
+    def initialize(raw_command, env:, directory:)
+      @stderr_reader, @stderr_writer = IO.pipe
+      @output, @input, @pid = PTY.spawn(env, raw_command, chdir: directory, err: stderr_writer.fileno)
+      self.raw_stdout = []
+    end
+
+    def expect(expected_value, reply: nil, timeout: DEFAULT_TIMEOUT, signal_on_timeout: "KILL")
+      output_matches = output.expect(expected_value, timeout)
+
+      if output_matches.nil?
+        end_session(signal: signal_on_timeout)
+        raise TerminalSessionTimeoutError.new(self, expected_value, timeout)
+      end
+
+      raw_stdout.concat(output_matches)
+
+      if reply != nil
+        input.puts(reply)
+      end
+    end
+
+    def stdout
+      raw_stdout.join.gsub("\r", "")
+    end
+
+    def stderr
+      raw_std_err
+    end
+
+    def wait_for_finish
+      return if finished?
+
+      finalize_io
+
+      self.exit_status = wait_for_exit_status
+    end
+
+    def end_session(signal: "INT")
+      Process.kill(signal, pid)
+      finalize_io
+
+      self.exit_status = wait_for_exit_status
+    end
+
+    def finished?
+      !exit_status.nil?
+    end
+
+    private
+
+    attr_accessor :raw_stdout, :raw_std_err
+    attr_reader :input, :output, :pid, :stderr_reader, :stderr_writer
+    attr_writer :exit_status
+
+    def finalize_io
+      drain_stdout
+      drain_stderr
+    end
+
+    def wait_for_exit_status
+      _, pty_status = Process.waitpid2(pid)
+      pty_status.exitstatus || pty_status.termsig
+    end
+
+    def drain_stdout
+      until output.eof? do
+        raw_stdout << output.readline
+      end
+
+      input.close
+      output.close
+    rescue Errno::EIO => e # https://github.com/ruby/ruby/blob/57fb2199059cb55b632d093c2e64c8a3c60acfbb/ext/pty/pty.c#L521
+      warn("Rescued #{e.message}") if ENV.key?("DEBUG")
+    end
+
+    def drain_stderr
+      stderr_writer.close
+      self.raw_std_err = stderr_reader.read
+    end
+  end
+end

data/lib/jet_black/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JetBlack
-  VERSION = "0.3.0"
+  VERSION = "0.7.0"
 end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: jet_black
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Oli Peate
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-06-06 00:00:00.000000000 Z
+date: 2021-02-12 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'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.16'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -56,16 +62,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
@@ -108,8 +114,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
-email: 
+description:
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -118,29 +124,35 @@ files:
 - ".gitignore"
 - ".rspec"
 - CHANGELOG.md
+- Dockerfile
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/docker_test
 - bin/jet_black_bin_example
 - bin/setup
 - jet_black.gemspec
 - lib/jet_black.rb
+- lib/jet_black/ansi_scrubber.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/file_helper.rb
+- lib/jet_black/interactive_command.rb
+- lib/jet_black/non_interactive_command.rb
 - lib/jet_black/rspec.rb
 - lib/jet_black/rspec/matchers.rb
 - lib/jet_black/session.rb
+- lib/jet_black/terminal_session.rb
 - lib/jet_black/version.rb
 homepage: https://github.com/odlp/jet_black
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -155,9 +167,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Black box testing
 test_files: []