rspec-cli 0.2.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OWUxYmRlNWRjOTM1YjY0MDljNWI4ZWY2NWZmOWY0NDcwZTMwMzJhZg==
+  data.tar.gz: !binary |-
+    N2RhZTg3MjNiMGQ3ZWIxMGRmNjMwYzRkYmIxMjI3MTM5MmZhZmQ3OA==
+SHA512:
+  metadata.gz: !binary |-
+    YTQyMzAyMmU0YTU0MjEzNjIxMDJkY2Q2Yjg1YTVlMzY5MDQwNjcyNWY5YWYz
+    MDljNGUxMjE4NmI0NDA4MTFkNWQxZGM1NDhmMzdhZTk2ZGU1ODg4MTUzZDYx
+    MzdjZjE4MWQ2YmRjNjc2Y2QxZTUxMjcwMmI2NTlkYTEwNTU3YTg=
+  data.tar.gz: !binary |-
+    MDRlMGRjN2M1N2JmNjgyYmVlMTlmYTU5ZDVhZDZjYTM5YTU2ZTI2OTg3YjIz
+    NTc0ZWIzYjVlZWNkZjQ3NTQ1MWM2NGEyYWYzNmEwZWM4MDZiNjE5YWFlMDEz
+    NTUxNjQ1MWFmMzY4MjUzMWVmZDA2MDZhMGM1YWNmOGMwNDRjZDQ=

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,6 @@
+guard 'rspec', cmd: 'rspec'do
+
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/rspec/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Sia. S.
+
+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,50 @@
+# RSpec::Cli
+
+This is an extension to rspec to fascilitate cli testing.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec-cli'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec-cli
+
+## Usage
+
+In your rspec config
+
+```ruby
+RSpec.configure do |config|
+  config.include RSpec::Cli, type: :feature
+
+  config.alias_example_group_to :feature, :type => :feature
+  config.alias_example_to :scenario
+end
+```
+or similar.
+
+Now your feature specs will have helper methods
+```new_cli_process(%w[echo hi there :D])``` and ```spawn_cli_process(%w[echo hi there :D])```
+
+The first one returns a CliProcess instance that hasn't spawned your command yet.
+
+The second one returns a CliProcess instance that has spawned your command.
+
+The CliProcess instance has some useful methads like ```#read``` to read from it's stdout, ```#write(string)``` to write to it's stdin and ```#status``` to get the process's status.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/rspec-cli/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/lib/rspec/cli/cli_process.rb

@@ -0,0 +1,109 @@
+require 'pty'
+require 'rspec/cli/i_o_decorator'
+
+module RSpec
+
+  module Cli
+
+    ##
+    # This class spawns your process and provides some
+    # helpers to interact with the process
+    class CliProcess
+
+      TERMINAL_COLOURS = /\e\[(\d+)(;\d+)*m/
+
+      attr_reader :pid
+
+      def initialize(*args)
+        raise ArgumentError, "wrong number of arguments" if args.empty?
+        args.unshift(*args.shift) if Array === args.first
+        @command = args
+      end
+
+      def flush
+        assert_spawned
+        @master.flush
+      end
+
+      def read_all(*args)
+        assert_spawned
+        @master.flush
+        @master.ready_all *args
+      end
+
+      def gets
+        assert_spawned
+        @master.gets
+      end
+
+      def puts(*args)
+        assert_spawned
+        @master.puts args
+        @master.flush
+      end
+
+      def stdout
+        @master
+      end
+
+      def stdin
+        @slave
+      end
+
+      def write(arg)
+        # This method can block if the argument is huge
+        assert_spawned
+        @master.write "#{arg}\n"
+        @master.flush
+      end
+
+      def run!
+        # Create master and slave pseudo terminal devices
+        master_tty, slave_tty = PTY.open
+        @master =  IODecorator.new master_tty
+        @slave = slave_tty
+
+        @pid =  PTY.spawn(*@command, in: @slave, out: @slave, err: @slave)[2]
+
+        @slave.close
+
+        self
+
+      end
+
+      def status
+
+        assert_spawned
+        PTY.check(@pid)
+
+      end
+
+      def alive?
+
+        begin
+          return status.nil?
+        rescue
+          return false
+        end
+
+      end
+
+      def kill!(signal = "TERM")
+
+        assert_spawned
+        @master.close
+        Process.kill(signal, @pid)
+
+      end
+
+      private
+
+      def assert_spawned
+        raise "process hasn't spawned yet" if @pid.nil?
+      end
+
+    end
+
+  end
+
+end

data/lib/rspec/cli/i_o_decorator.rb

@@ -0,0 +1,32 @@
+require 'pty'
+require 'delegate'
+
+module RSpec
+
+  module Cli
+
+    class IODecorator < SimpleDelegator
+
+      def has_data?(timeout = 0)
+        IO.select([self], nil, nil, timeout) ? true : false
+      end
+
+      def ready_all nonblocking = false
+        if nonblocking && !has_data?
+          return nil
+        end
+
+        # Block until data has arrived.
+        data = readpartial 0xFFFF
+        # If there is more data in the buffer, retrieve it nonblocking.
+        while has_data?
+          data << readpartial(0xFFFF)
+        end
+        data
+      end
+
+    end
+
+  end
+
+end

data/lib/rspec/cli/version.rb

@@ -0,0 +1,5 @@
+module RSpec
+  module Cli
+    VERSION = "0.2.1"
+  end
+end

data/lib/rspec/cli.rb

@@ -0,0 +1,18 @@
+require "rspec/cli/version"
+require "rspec/cli/cli_process"
+
+module RSpec
+
+  module Cli
+
+    def spawn_cli_process(*args)
+      new_cli_process(*args).run!
+    end
+
+    def new_cli_process(*args)
+      CliProcess.new(*args)
+    end
+
+  end
+
+end

data/rspec-cli.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec/cli/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-cli"
+  spec.version       = RSpec::Cli::VERSION
+  spec.authors       = ["Sia. S."]
+  spec.email         = ["sia.s.saj@gmail.com"]
+  spec.summary       = "rspec-cli-#{RSpec::Cli::VERSION}"
+  spec.description   = "A set of tools to test programs on the command line"
+  spec.homepage      = "https://github.com/quazimodo/rspec-cli"
+  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", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1"
+
+end

data/spec/cli/cli_process_spec.rb

@@ -0,0 +1,115 @@
+require 'spec_helper'
+require 'rspec/cli/cli_process'
+
+describe RSpec::Cli::CliProcess do
+
+  let(:looper) do
+    RSpec::Cli::CliProcess.new(%w[spec/support/bin/dummy --looper])
+  end
+
+  let(:echo) do
+    RSpec::Cli::CliProcess.new %w[spec/support/bin/dummy --echo "interesting repeat"]
+  end
+
+
+
+  it "initializes with a binary and a set of arguments" do
+    expect{RSpec::Cli::CliProcess.new %w[echo who are you] }.not_to raise_error
+  end
+
+  it "initializes without actually spawning any process" do
+    expect(PTY).not_to receive(:spawn)
+    expect(echo.pid).to eq nil
+  end
+
+  describe "#run!" do
+
+    it "spawns process and sets the pid" do
+      echo.run!
+      expect(echo.pid).not_to eq nil
+    end
+
+    it "assigns the new process's stdout to a tty by default" do
+      allow_any_instance_of(File).to receive(:close)
+      echo.run!
+      expect(echo.stdout).to be_a_tty
+    end
+
+    it "assigns the new process's stdin to a tty by default" do
+      allow_any_instance_of(File).to receive(:close)
+      echo.run!
+      expect(echo.stdin).to be_a_tty
+    end
+
+  end
+
+  describe "#status" do
+
+    it "raises an error if the process hasn't spawned yet" do
+      expect{echo.status}.to raise_error "process hasn't spawned yet"
+    end
+
+    it "returns nil if the process is still alive" do
+      looper.run!
+      expect(looper.status).to eq nil
+    end
+
+    it "returns a Process::Status object if the process has spawned and terminated" do
+      looper.run!
+      looper.kill!
+      sleep 0.1
+      expect(looper.status).to be_a_kind_of Process::Status
+    end
+
+  end
+
+  describe "#write" do
+
+    it "writes to the spawned processes stdin" do
+      looper.run!
+      looper.write "hi there"
+      expect(looper.gets).to include "hi there"
+    end
+
+    it "puts to the spawned process stdin" do
+      looper.run!
+      looper.puts "hi there"
+      expect(looper.gets).to include "hi there"
+    end
+
+    it "raises an error if the process hasn't been spawned" do
+      expect{looper.write "hi"}.to raise_error
+    end
+
+  end
+
+  describe "#kill" do
+
+    it "closes all remaining streams" do
+      looper.run!
+      pty = looper.instance_variable_get(:@master)
+      expect(pty).to receive(:close)
+      looper.kill!
+    end
+
+    it "raises an error if the process hasn't spawned" do
+      expect{looper.read}.to raise_error
+    end
+
+    it "terminates the process using SIGTERM" do
+      looper.run!
+      pid = looper.pid
+      expect(Process).to receive(:kill).with("TERM", pid).and_call_original
+      looper.kill!
+      expect(Process.wait looper.pid).to eq looper.pid
+    end
+
+    it "terminates the process using given signal" do
+      looper.run!
+      pid = looper.pid
+      expect(Process).to receive(:kill).with("KILL", pid).and_call_original
+      looper.kill!("KILL")
+      expect(Process.wait looper.pid).to eq looper.pid
+    end
+  end
+end

data/spec/cli/i_o_decorator_spec.rb

@@ -0,0 +1,94 @@
+require 'spec_helper'
+require 'rspec/cli/i_o_decorator'
+
+describe RSpec::Cli::IODecorator do
+
+
+
+  let(:pipe_arry) { IO.pipe }
+
+  let(:pipe_out) { pipe_arry[0] }
+  let(:pipe_in) { pipe_arry[1] }
+
+  let(:io_out) { RSpec::Cli::IODecorator.new pipe_out }
+  let(:io_in) { RSpec::Cli::IODecorator.new pipe_in }
+
+
+  describe "#has_data?" do
+
+    it "returns true if io has data to read" do
+      io_in.puts "test_data"
+      expect(io_out.has_data?).to be true
+    end
+
+    it "returns false if io has no data to reads" do
+      expect(io_out.has_data?).to be false
+    end
+
+  end
+
+  describe "#read_all" do
+
+    context "with nonblocking reads" do
+
+      it 'returns nil if no data' do
+        expect(io_out.read_all(nonblocking: true)).to be nil
+      end
+
+      it "returns all the data if there is data" do
+        io_in.puts "hi, this"
+        io_in.puts "is test data"
+       expect(io_out.read_all(nonblocking: true)).to include "hi, this\nis test data"
+      end
+
+      it "doesn't fall into a race condition with another process interacting with it" do
+        master_tty, slave_tty = PTY.open
+
+        master = RSpec::Cli::IODecorator.new master_tty
+
+        command = "spec/support/bin/dummy --looper --sleeper 0.1"
+        @pid =  PTY.spawn(command, in: slave_tty, out: slave_tty, err: slave_tty)[2]
+
+        master.write "hi there"
+        expect(master.read_all).to include "hi there"
+      end
+    end
+
+
+    context "with blocking reads" do
+
+     it 'blocks till data arrives' do
+       test = lambda do
+         Timeout::timeout(1) { io_out.read_all }
+       end
+
+       expect(test).to raise_error Timeout::Error
+     end
+
+     it 'reads all the data when available' do
+
+       data = nil
+       huge_string = "BC" * 0xFFFF
+       huge_string << "ends in awesome"
+
+       # declare the block that we will call in our test
+       test = lambda do
+         Timeout::timeout(1) { data = io_out.read_all }
+       end
+
+       # the huge_string might be too big for the buffer and block
+       # while the system waits for the buffer to be read from,
+       # so we do the write in a new thread.
+       Thread.new do
+         io_in.syswrite huge_string
+       end
+
+       expect(test).to change{data}.to huge_string
+
+     end
+
+    end
+
+  end
+
+end

data/spec/cli_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+require 'rspec/cli'
+
+describe RSpec::Cli do
+
+  let(:subject) { Object.new.extend RSpec::Cli }
+
+  describe "::new_cli_process" do
+
+    it "returns a CliProcess object that has not actually spawned the process yet" do
+      p = subject.new_cli_process %w[factor]
+      expect(p.pid).to eq nil
+    end
+
+  end
+
+  describe "::spawn_cli_process" do
+
+    it "returns a CliProcess object with a spawned process" do
+      p = subject.spawn_cli_process %w[factor]
+      expect(p.pid).not_to eq nil
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+Dir.glob(::File.expand_path('../support/*.rb', __FILE__)).each { |f| require_relative f }
+
+RSpec.configure do |config|
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+  config.order = :random
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+end

data/spec/support/bin/dummy

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+require 'optparse'
+
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Dummy executable to help test rspec-cli"
+
+  opts.on("-l", "--looper", "start in read/print loop mode") do
+    options[:looper] = true
+  end
+
+  opts.on("-e str", "--echo str", "echo str arg") do |echo|
+    options[:echo] = echo
+  end
+
+  opts.on("-s seconds", "--sleeper seconds", "echo str arg") do |seconds|
+    options[:sleeper] = seconds
+  end
+end.parse!
+
+puts "Dummy has loaded"
+
+if options[:looper]
+
+  loop do
+    i = gets
+    sleep(options[:sleeper].to_f) unless options[:sleeper].nil?
+    puts i
+  end
+
+elsif options[:echo]
+
+  puts options[:echo]
+
+end
+
+
+exit 0

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: rspec-cli
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Sia. S.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: A set of tools to test programs on the command line
+email:
+- sia.s.saj@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rspec/cli.rb
+- lib/rspec/cli/cli_process.rb
+- lib/rspec/cli/i_o_decorator.rb
+- lib/rspec/cli/version.rb
+- rspec-cli.gemspec
+- spec/cli/cli_process_spec.rb
+- spec/cli/i_o_decorator_spec.rb
+- spec/cli_spec.rb
+- spec/spec_helper.rb
+- spec/support/bin/dummy
+homepage: https://github.com/quazimodo/rspec-cli
+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.3.0
+signing_key: 
+specification_version: 4
+summary: rspec-cli-0.2.1
+test_files:
+- spec/cli/cli_process_spec.rb
+- spec/cli/i_o_decorator_spec.rb
+- spec/cli_spec.rb
+- spec/spec_helper.rb
+- spec/support/bin/dummy
+has_rdoc: