bash-session 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 94112c5160f83b5173687f7233a8891ad4bea404
-  data.tar.gz: c02ca274af118e6ae761a581c22fea56e31082df
+  metadata.gz: fa2364a00285d79e09083b0f1dac3ff31bb2d195
+  data.tar.gz: fa13408e14f1c502792884de0a6b2b8711f0fc27
 SHA512:
-  metadata.gz: 2c5203f8578c42c5eef1afdeec16244213ef85fa4033faaf648a85181211c7fe03ba96e48353bf412f10f5ec1f4e8bb9b6e1676c134809bbf4f3a5991169a15a
-  data.tar.gz: bf36bb9de2287b23a4cc8bec4a40e6a5e6298efbe14f3b4356cd02b0b0858beb96914f8c59267f03f4c46041511a826deb71d6c8bab5ff47608f227a563b7fac
+  metadata.gz: 0d9639235772066fb33d0ea237f56df7a174a177d448cff9393b2f5a215b38f03e4c64cb02920df9b05a27c5f33d373f58dcf061bd04ca512d47d9f2784047fa
+  data.tar.gz: 6030eb8fce3b6e47785866ad0be353aefc9cbd83b172a20cb965f8b3d454e7920bde43cd19ea4ab1eef61e4e9610487d4427ef97554f91eaf6c7230fbc767b3f

data/.gitignore

@@ -1,6 +1,5 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/

data/.ruby-gemset

@@ -0,0 +1 @@
+bash-session

data/.ruby-version

@@ -0,0 +1 @@
+2.2.4

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    bash-session (0.0.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.10.1)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bash-session!
+  bundler
+  minitest
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.13.7

data/README.md

@@ -31,3 +31,5 @@ TODO: Write usage instructions here
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+To report an issue, [please contact the Snap.ci support team.](https://snap-ci.com/contact-us)

data/Rakefile

@@ -1,2 +1,8 @@
 require "bundler/gem_tasks"
+require "rake/testtask"
 
+Rake::TestTask.new do |t|
+  t.pattern = "test/*_test.rb"
+end
+
+task :default => [:test]

data/bash-session.gemspec

@@ -6,8 +6,8 @@ require 'bash/session/version'
 Gem::Specification.new do |spec|
   spec.name          = "bash-session"
   spec.version       = Bash::Session::VERSION
-  spec.authors       = ["Akshay Karle"]
-  spec.email         = ["akshay.a.karle@gmail.com"]
+  spec.authors       = ["Snap CI"]
+  spec.email         = ["support@snap-ci.com"]
   spec.summary       = %q{A minimalistic gem for a persistent bash session.}
   spec.description   = ""
   spec.homepage      = ""
@@ -18,8 +18,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = '~> 2.2'
+
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 10.0"
 
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "minitest"
 end

data/lib/bash/session.rb

@@ -6,6 +6,8 @@ module Bash
   class Session
     class TimeoutError < StandardError; end
 
+    attr_reader :default_timeout
+
     def initialize(default_timeout=nil)
       start_session
       @default_timeout = default_timeout

data/lib/bash/session/version.rb

@@ -1,5 +1,5 @@
 module Bash
   class Session
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/test/session_test.rb

@@ -0,0 +1,125 @@
+require_relative 'test_helper'
+
+class BashSessionTest < Minitest::Test
+  parallelize_me! unless ENV["SNAP_CI"]
+
+  def setup
+    @session = Bash::Session.new
+  end
+
+  def teardown
+    @session.close
+  end
+
+  def test_run_commands_and_show_out_put_when_it_does_not_end_in_a_new_line
+    @session.execute("echo -n hello") { |output| assert_equal "hello", output }
+  end
+
+  def test_return_the_exit_status_of_the_command
+    exit_status = @session.execute("true")
+    assert_equal 0, exit_status
+
+    exit_status = @session.execute("false")
+    assert_equal 1, exit_status
+  end
+
+  def test_run_commands_ending_with_comments
+    exit_status = @session.execute("true # this is a comment") { |output| assert_equal "", output }
+    assert_equal 0, exit_status
+  end
+
+  def test_uses_same_session_and_preserves_state_through_sequential_commands
+    assert_success_with_output("cd #{Dir.pwd}/test")
+    assert_success_with_output("pwd") { |output| assert_match("#{Dir.pwd}/test", output) }
+    assert_success_with_output("cd ~")
+    assert_success_with_output("pwd") { |output| assert_match(Dir.home, output) }
+    assert_success_with_output("echo $FOO") { |output| refute_match("bar", output) }
+    assert_success_with_output("export FOO=bar")
+    assert_success_with_output("echo $FOO") { |output| assert_match("bar", output) }
+  end
+
+  def test_run_multiple_commands_separated_by_a_newline
+    reader, writer = IO.pipe(Encoding::ASCII_8BIT)
+    @session.execute("echo hi\necho bye", out: writer)
+    writer.close
+    assert_equal "hi\nbye\n", reader.read
+  end
+
+  def test_wait_for_long_running_commands_to_complete_and_then_exit
+    reader, writer = IO.pipe(Encoding::ASCII_8BIT)
+    exit_status = @session.execute("for i in {1..5}; do echo -n 'hello world '; sleep 1; done", out: writer)
+    assert_equal 0, exit_status
+    writer.close
+    assert_equal "hello world "*5, reader.read
+  end
+
+  def test_raise_error_when_command_does_not_generate_any_output_within_a_default_timeout_period
+    @session = Bash::Session.new(3)
+    reader, writer = IO.pipe(Encoding::ASCII_8BIT)
+
+    begin_time = Time.now
+    e = assert_raises(Bash::Session::TimeoutError) do
+      @session.execute("echo hi; sleep 300; echo bye", out: writer)
+    end
+    end_time = Time.now
+
+    writer.close
+
+    assert_in_delta(3, end_time - begin_time, 2.0)
+    assert_equal 'No output received for the last 3 seconds. Timing out...', e.message
+    assert_equal "hi\n", reader.read
+  end
+
+  def test_raise_error_when_command_does_not_generate_any_output_command_specific_timeout_period
+    @session = Bash::Session.new(1)
+    reader, writer = IO.pipe(Encoding::ASCII_8BIT)
+
+    begin_time = Time.now
+    e = assert_raises(Bash::Session::TimeoutError) do
+      @session.execute("echo hi; sleep 300; echo bye", out: writer, timeout: 3)
+    end
+    end_time = Time.now
+
+    writer.close
+
+    assert_in_delta(3, end_time - begin_time, 2.0)
+    assert_equal 'No output received for the last 3 seconds. Timing out...', e.message
+    assert_equal "hi\n", reader.read
+  end
+
+  def test_not_raise_error_when_long_running_command_is_constantly_generating_output_with_default_timeout
+    @session = Bash::Session.new(3)
+    reader, writer = IO.pipe(Encoding::ASCII_8BIT)
+
+    exit_status = @session.execute("echo -n hi; for i in {1..6}; do sleep 1; echo -n .; done; echo bye", out: writer)
+    writer.close
+
+    assert_equal 0, exit_status
+    assert_equal "hi......bye\n", reader.read
+  end
+
+  def test_not_raise_error_when_long_running_command_is_constantly_generating_output_with_a_command_specific_timeout
+    @session = Bash::Session.new(3)
+    reader, writer = IO.pipe(Encoding::ASCII_8BIT)
+
+    exit_status = @session.execute("echo -n hi; for i in {1..6}; do sleep 4; echo -n .; done; echo bye", out: writer, timeout: 5)
+    writer.close
+
+    assert_equal "hi......bye\n", reader.read
+  end
+
+  def test_start_a_non_interactive_login_shell_session
+    exit_status = @session.execute("[[ $- != *i* ]]")
+    assert_equal 0, exit_status
+
+    exit_status = @session.execute("shopt -q login_shell")
+    assert_equal 0, exit_status
+  end
+
+  def assert_success_with_output(command, &block)
+    output = ""
+    status = @session.execute(command) { |out| output = out }
+    assert_equal 0, status, "command #{command} failed with status #{status}"
+    yield output if block_given?
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+$: << "lib"
+
+require "minitest/autorun"
+require "minitest/hell"
+require "bash/session"

metadata

@@ -1,74 +1,77 @@
 --- !ruby/object:Gem::Specification
 name: bash-session
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
-- Akshay Karle
+- Snap CI
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-10 00:00:00.000000000 Z
+date: 2017-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   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'
 - !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
+  name: minitest
   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:
-- akshay.a.karle@gmail.com
+- support@snap-ci.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bash-session.gemspec
 - lib/bash/session.rb
 - lib/bash/session/version.rb
-- spec/session_spec.rb
-- spec/spec_helper.rb
+- test/session_test.rb
+- test/test_helper.rb
 homepage: ''
 licenses:
 - MIT
@@ -79,20 +82,20 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: A minimalistic gem for a persistent bash session.
 test_files:
-- spec/session_spec.rb
-- spec/spec_helper.rb
+- test/session_test.rb
+- test/test_helper.rb

data/spec/session_spec.rb

@@ -1,113 +0,0 @@
-require 'spec_helper'
-
-describe Bash::Session do
-  before(:each) do
-    @session = Bash::Session.new
-  end
-
-  after(:each) do
-    @session.close
-  end
-
-  it 'should run commands and show out put when it does not end in a new line' do
-    @session.execute("echo -n hello") { |output| expect(output).to eq("hello") }
-  end
-
-  it 'should return the exit status of the command' do
-    exit_status = @session.execute("true")
-    expect(exit_status).to eq(0)
-
-    exit_status = @session.execute("false")
-    expect(exit_status).to eq(1)
-  end
-
-  it 'should run commands ending with comments' do
-    exit_status = @session.execute("true # this is a comment") { |output| expect(output).to eq("") }
-    expect(exit_status).to eq(0)
-  end
-
-  it 'should preserve the state of bash internal commands' do
-    @session.execute("cd #{Dir.pwd}/spec")
-    @session.execute("pwd") { |output| expect(output).to include("#{Dir.pwd}/spec") }
-    @session.execute("cd ~")
-    @session.execute("pwd") { |output| expect(output).to include(Dir.home) }
-    @session.execute("echo $FOO") { |output| expect(output).to_not include("bar") }
-    @session.execute("export FOO=bar")
-    @session.execute("echo $FOO") { |output| expect(output).to include("bar") }
-  end
-
-  it 'should run multiple commands separated by a newline' do
-    reader, writer = IO.pipe
-    @session.execute("echo hi\necho bye", out: writer)
-    writer.close
-    expect(reader.read).to eq("hi\nbye\n")
-  end
-
-  it 'should wait for long running commands to complete and then exit' do
-    reader, writer = IO.pipe
-    exit_status = @session.execute("for i in {1..5}; do echo -n 'hello world '; sleep 1; done", out: writer)
-    expect(exit_status).to eq(0)
-    writer.close
-    expect(reader.read).to eq("hello world "*5)
-  end
-
-  it 'should raise error when command does not generate any output within a default timeout period' do
-    @session = Bash::Session.new(3)
-    reader, writer = IO.pipe
-
-    begin_time = Time.now
-    expect do
-      exit_status = @session.execute("echo hi; sleep 300; echo bye", out: writer)
-    end.to raise_error(Bash::Session::TimeoutError, 'No output received for the last 3 seconds. Timing out...')
-    writer.close
-    end_time = Time.now
-
-    expect(end_time - begin_time).to be_within(0.1).of(3)
-    expect(reader.read_nonblock(1000)).to eq("hi\n")
-  end
-
-  it 'should raise error when command does not generate any output command specific timeout period' do
-    @session = Bash::Session.new(1)
-    reader, writer = IO.pipe
-
-    begin_time = Time.now
-
-    expect do
-      exit_status = @session.execute("echo hi; sleep 300; echo bye", out: writer, timeout: 3)
-    end.to raise_error(Bash::Session::TimeoutError, 'No output received for the last 3 seconds. Timing out...')
-    end_time = Time.now
-
-    writer.close
-
-    expect(end_time - begin_time).to be_within(0.1).of(3)
-    expect(reader.read_nonblock(1000)).to eq("hi\n")
-  end
-
-  it 'should not raise error when long running command is constantly generating output with default timeout' do
-    @session = Bash::Session.new(3)
-    reader, writer = IO.pipe
-
-    exit_status = @session.execute("echo -n hi; for i in {1..6}; do sleep 1; echo -n .; done; echo bye", out: writer)
-    writer.close
-
-    expect(reader.read_nonblock(1000)).to eq("hi......bye\n")
-  end
-
-  it 'should not raise error when long running command is constantly generating output with a command specific timeout' do
-    @session = Bash::Session.new(3)
-    reader, writer = IO.pipe
-
-    exit_status = @session.execute("echo -n hi; for i in {1..6}; do sleep 4; echo -n .; done; echo bye", out: writer, timeout: 5)
-    writer.close
-
-    expect(reader.read_nonblock(1000)).to eq("hi......bye\n")
-  end
-
-  it 'should start a non-interactive login shell session' do
-    exit_status = @session.execute("[[ $- != *i* ]]")
-    expect(exit_status).to eq(0)
-
-    exit_status = @session.execute("shopt -q login_shell")
-    expect(exit_status).to eq(0)
-  end
-end

data/spec/spec_helper.rb

@@ -1,90 +0,0 @@
-require 'bash/session'
-# This file was generated by the `rspec --init` command. Conventionally, all
-# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
-# The generated `.rspec` file contains `--require spec_helper` which will cause this
-# file to always be loaded, without a need to explicitly require it in any files.
-#
-# Given that it is always loaded, you are encouraged to keep this file as
-# light-weight as possible. Requiring heavyweight dependencies from this file
-# will add to the boot time of your test suite on EVERY test run, even for an
-# individual file that may not need all of that loaded. Instead, consider making
-# a separate helper file that requires the additional dependencies and performs
-# the additional setup, and require it from the spec files that actually need it.
-#
-# The `.rspec` file also contains a few flags that are not defaults but that
-# users commonly want.
-#
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
-RSpec.configure do |config|
-  # rspec-expectations config goes here. You can use an alternate
-  # assertion/expectation library such as wrong or the stdlib/minitest
-  # assertions if you prefer.
-  config.expect_with :rspec do |expectations|
-    # This option will default to `true` in RSpec 4. It makes the `description`
-    # and `failure_message` of custom matchers include text for helper methods
-    # defined using `chain`, e.g.:
-    # be_bigger_than(2).and_smaller_than(4).description
-    #   # => "be bigger than 2 and smaller than 4"
-    # ...rather than:
-    #   # => "be bigger than 2"
-    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
-  end
-
-  # rspec-mocks config goes here. You can use an alternate test double
-  # library (such as bogus or mocha) by changing the `mock_with` option here.
-  config.mock_with :rspec do |mocks|
-    # Prevents you from mocking or stubbing a method that does not exist on
-    # a real object. This is generally recommended, and will default to
-    # `true` in RSpec 4.
-    mocks.verify_partial_doubles = true
-  end
-
-# The settings below are suggested to provide a good initial experience
-# with RSpec, but feel free to customize to your heart's content.
-=begin
-  # These two settings work together to allow you to limit a spec run
-  # to individual examples or groups you care about by tagging them with
-  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
-  # get run.
-  config.filter_run :focus
-  config.run_all_when_everything_filtered = true
-
-  # Limits the available syntax to the non-monkey patched syntax that is recommended.
-  # For more details, see:
-  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
-  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
-  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
-  config.disable_monkey_patching!
-
-  # This setting enables warnings. It's recommended, but in some cases may
-  # be too noisy due to issues in dependencies.
-  config.warnings = true
-
-  # Many RSpec users commonly either run the entire suite or an individual
-  # file, and it's useful to allow more verbose output when running an
-  # individual spec file.
-  if config.files_to_run.one?
-    # Use the documentation formatter for detailed output,
-    # unless a formatter has already been configured
-    # (e.g. via a command-line flag).
-    config.default_formatter = 'doc'
-  end
-
-  # Print the 10 slowest examples and example groups at the
-  # end of the spec run, to help surface which specs are running
-  # particularly slow.
-  config.profile_examples = 10
-
-  # Run specs in random order to surface order dependencies. If you find an
-  # order dependency and want to debug it, you can fix the order by providing
-  # the seed, which is printed after each run.
-  #     --seed 1234
-  config.order = :random
-
-  # Seed global randomization in this process using the `--seed` CLI option.
-  # Setting this allows you to use `--seed` to deterministically reproduce
-  # test failures related to randomization by passing the same `--seed` value
-  # as the one that triggered the failure.
-  Kernel.srand config.seed
-=end
-end