bash-session 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4056da143568e57bd5614284b04bae039535297e
+  data.tar.gz: 97ba82055cfb37fa3fdfc2cf6525d0cf30c55a9a
+SHA512:
+  metadata.gz: f489dbb73045762cb9051030cbf81dd9b4053c484f4d5e2a22ff8eb6cfac7c53247872a8b784b28cd334bd7838b69619cd8927685024765add71d5e2c85cb6c5
+  data.tar.gz: a063c08d0c5fea4f68c0609642487abae631ee6e6d7e26d8c6b8a39d50dcec87396575a4144a105cde37727d5efe43d7674828310006a4f614e4be469f30a72c

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Akshay Karle
+
+MIT License
+
+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,33 @@
+[![Build Status](https://snap-ci.com/snap-ci/bash-session/branch/master/build_image)](https://snap-ci.com/snap-ci/bash-session/branch/master)
+
+# Bash::Session
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bash-session'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bash-session
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/bash-session/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bash-session.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+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.summary       = %q{A minimalistic gem for a persistent bash session.}
+  spec.description   = ""
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_development_dependency "rspec"
+end

data/lib/bash/session.rb

@@ -0,0 +1,64 @@
+require "bash/session/version"
+require 'securerandom'
+require 'open3'
+
+module Bash
+  class Session
+    class TimeoutError < StandardError; end
+
+    def initialize(default_timeout=nil)
+      start_session
+      @default_timeout = default_timeout
+      @separator = SecureRandom.hex
+    end
+
+    def execute(command, options={}, &callback)
+      exit_status = nil
+      out = options[:out]
+      timeout = options[:timeout] || @default_timeout
+
+      cmd = command.dup
+      cmd << ";" if cmd !~ /[;&]$/
+      cmd << "\n" if cmd =~ /#/
+      cmd << %Q{DONTEVERUSETHIS=$?; echo "\n#{@separator} $DONTEVERUSETHIS"; echo "exit $DONTEVERUSETHIS"|sh}
+
+      @stdin.puts(cmd)
+
+      until exit_status do
+        begin
+          data = @outstr.read_nonblock(160000)
+          if data.strip =~ /^#{@separator} (\d+)\s*/
+            exit_status = $1
+            data.gsub!(/\n^#{@separator} (\d+)\s*$/, '')
+          end
+          callback.call(data) if callback
+          out.write data if out
+        rescue IO::WaitReadable
+          ready = IO.select([@outstr], nil, nil, timeout)
+          unless ready
+            raise TimeoutError.new("No output received for the last #{timeout} seconds. Timing out...")
+          else
+            retry
+          end
+        end
+      end
+
+      exit_status.to_i
+    end
+
+    def close
+      return unless @wait_thr.alive?
+      return if (Process.kill('TERM', @wait_thr.pid) rescue nil)
+      return unless @wait_thr.alive?
+      return if (Process.kill('KILL', @wait_thr.pid) rescue nil)
+      return unless @wait_thr.alive?
+      raise "Could not kill process(PID #{@wait_thr.pid})"
+    end
+
+    private
+
+    def start_session
+      @stdin, @outstr, @wait_thr = Open3.popen2e("bash")
+    end
+  end
+end

data/lib/bash/session/version.rb

@@ -0,0 +1,5 @@
+module Bash
+  class Session
+    VERSION = "0.0.1"
+  end
+end

data/spec/session_spec.rb

@@ -0,0 +1,105 @@
+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
+end

data/spec/spec_helper.rb

@@ -0,0 +1,90 @@
+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

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: bash-session
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Akshay Karle
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-24 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
+  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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- 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
+homepage: ''
+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.0.14
+signing_key: 
+specification_version: 4
+summary: A minimalistic gem for a persistent bash session.
+test_files:
+- spec/session_spec.rb
+- spec/spec_helper.rb