rspec-launchbox 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5c00ce31529ca3732c0fc6e5b930185fac4be632
+  data.tar.gz: ea7c107c0a5688911f48e2feaaa1ce1ea50eb984
+SHA512:
+  metadata.gz: d4e73a5fbf734687c39a20ead035f863526c561237a60d612fea8a9f3db37da1a80fc856bb79dd1800bd7f0b4a691b17988a1752d0252d910a6125b5e05b6b58
+  data.tar.gz: 701a8acfd4ff108e2cdfee8d86061a1f71a22652b3598804ed8b46aacd0413701bfecfcca5e70c5c1dcd0afcd7a951524f5f7649b487ab946415ad42c949ef7a

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+-f doc

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 d-theus
+
+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,80 @@
+# Rspec::Launchbox
+
+Bundle of RSpec DSL helpers, providing
+timeout matchers, service runners. Work in progress.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec-launchbox'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec-launchbox
+
+## Usage
+
+### in_presence_of
+
+```ruby
+#spec/spec_helper.rb
+
+require 'rspec/launchbox'
+
+RSpec.configure do |config|
+#...
+  config.extend RSpec::InPresenceOf
+  config.include RSpec::Matchers::Timeout
+end
+include RSpec::DescribeExecutable
+```
+
+Then in spec file:
+
+```ruby
+describe MyClass do
+  in_presence_of 'external_program' do
+    it 'should listen on port' do
+      #here goes expectation
+    end
+  end
+end
+```
+
+### describe_executable
+
+```ruby
+describe_executable 'ls' do
+  its_stdout do
+    it { is_expected.to be_a String }
+  end
+end
+```
+
+### expect { }.to persist
+
+```ruby
+expect do
+  #routine
+end.to persist.at_least(3) # or 3.seconds if you use ActiveSupport
+```
+
+This snippet runs binary called external_program (should be in path, or pass absolute path),
+ and makes sure process started by that command is dead.
+
+ _TODO:_ One day there  will be optional parameters e.g. signal to send to process.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/rspec-launchbox/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/launchbox.rb

@@ -0,0 +1,7 @@
+require "rspec/launchbox/version"
+require 'timeout'
+require 'rspec/its'
+
+require 'rspec/launchbox/timeout_matchers.rb'
+require 'rspec/launchbox/in_presence_of.rb'
+require 'rspec/launchbox/describe_executable.rb'

data/lib/rspec/launchbox/describe_executable.rb

@@ -0,0 +1,71 @@
+module RSpec
+  module DescribeExecutable
+    # Outmost describe block.
+    # @param [String] cmd executable name
+    # @yields block like ordinary #describe
+    # @example
+    #     describe_executable 'ls' do
+    #       its_stdout do
+    #         it { is_expected.to be_a String }
+    #       end
+    #     end
+    def describe_executable(cmd, &block)
+      $_command_line = cmd
+      $_process_stdout = ''
+      RSpec.describe "#{$_command_line} executable" do
+        before(:each) do
+          Thread.abort_on_exception = true
+          Thread.new do
+            IO.popen($_command_line) do |io|
+              $_process_stdout << io.read(256) until io.eof?
+            end
+          end
+          sleep 1
+        end
+
+        after(:each) do
+          `killall -INT #{$_command_line.split(/\W/)[0]} &>/dev/null`
+          sleep 0.1
+          `killall -KILL #{$_command_line.split(/\W/)[0]} &>/dev/null`
+        end
+
+        class_eval &block
+      end
+    end
+
+    # Opens new 'describe',
+    # sets it's subject to process stdout
+    # @yields block like ordinary describe
+    # @see #describe_executable for an example
+    def its_stdout(&block)
+      describe "it's stdout" do
+        subject { $_process_stdout }
+
+        class_eval &block
+      end
+    end
+
+    # Opens new 'context',
+    # where options are appended to
+    # command line before execution.
+    # @param [String] flag e.g. `-f`
+    # @param [String] parameter
+    # @example
+    #     describe_executable 'ls' do
+    #       given_option '-a' do
+    #         its_stdout do
+    #           #you need rspec-its gem for `its`
+    #           its(:lines) { is_expected.to include ".\n" }
+    #         end
+    #       end
+    #     end
+    def given_option(flag, parameter = nil, &block)
+      context "given option #{flag}#{parameter ? parameter + ' ' : nil}" do
+        $_command_line__old = $_command_line.dup
+        $_command_line << ' ' << [flag, parameter].join(' ')
+
+        class_eval &block
+      end
+    end
+  end
+end

data/lib/rspec/launchbox/in_presence_of.rb

@@ -0,0 +1,36 @@
+module RSpec
+  module InPresenceOf
+    def self.extended(*args)
+      # Launches particular service
+      # and makes sure it's dead afterwards.
+      # @param [String] service
+      # @yields block as `describe` does
+      # @example
+      #     describe MyClass do
+      #       in_presence_of 'some_service' do
+      #         # `some_service` executable is running
+      #         it 'can establish connection' do
+      #           #assert connecton presence
+      #         end
+      #         # and now it's being killed
+      #       end
+      #     end
+      def in_presence_of(service, &block)
+        before do
+          @_service_pid = fork do
+            $stdout.reopen '/dev/null'
+            $stderr.reopen '/dev/null'
+            exec service
+          end
+          fail "Failed to execute #{service}" unless @_service_pid
+        end
+
+        after do
+          Process.kill(:INT, @_service_pid) if @_service_pid
+        end
+
+        context("in presence of #{service} service", &block)
+      end
+    end
+  end
+end

data/lib/rspec/launchbox/timeout_matchers.rb

@@ -0,0 +1,39 @@
+module RSpec
+  module Matchers
+    # #persist matcher defined here
+    # @example
+    #     expect do
+    #       #routine
+    #     end.to persist.at_least(3) # or 3.seconds if you use ActiveSupport
+    module Timeout
+      def self.included(*args)
+        RSpec::Matchers.define :persist do
+          supports_block_expectations
+          @should_complete_block = nil
+
+          chain :at_least do |time|
+            @time = time
+            @should_complete_block = false
+          end
+
+          chain :at_most do |time|
+            @time = time
+            @should_complete_block = true
+          end
+
+          match do |actual|
+            fail "Block expected, got #{actual.class}" unless actual.respond_to? :call 
+            fail "Expected 'persist.at_least(<seconds>)' or 'persist.at_most(<seconds>)'" if @should_complete_block.nil?
+            begin
+              ::Timeout.timeout(@time, &actual)
+              @block_complete = true
+            rescue ::Timeout::Error
+              @block_complete = false
+            end
+            @block_complete == @should_complete_block
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rspec/launchbox/version.rb

@@ -0,0 +1,5 @@
+module Rspec
+  module Launchbox
+    VERSION = "0.0.1"
+  end
+end

data/rspec-launchbox.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec/launchbox/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-launchbox"
+  spec.version       = Rspec::Launchbox::VERSION
+  spec.authors       = ["d-theus"]
+  spec.email         = ["slma0x02@gmail.com"]
+  spec.summary       = %q{RSpec DSL extension for effortless process control}
+  spec.description   = %q{Launchbox makes it easy to start or stop external service, manage timeouts.}
+  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", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency 'rspec'
+  spec.add_dependency 'rspec-its'
+end

data/spec/describe_executable_spec.rb

@@ -0,0 +1,14 @@
+describe_executable 'ls' do
+  its_stdout do
+    it { is_expected.to be_a String }
+    it { is_expected.not_to be_empty }
+  end
+
+  given_option '-a' do
+    its_stdout do
+      it { is_expected.to be_a String }
+      its(:lines) { is_expected.to include ".\n" }
+      its(:lines) { is_expected.not_to include "ohwowwhatisit\n" }
+    end
+  end
+end

data/spec/in-presence-of_spec.rb

@@ -0,0 +1,8 @@
+describe 'Presence command' do
+  cmd = 'cat'
+  in_presence_of cmd do
+    it 'ps shows presence of command' do
+      expect(`ps -A | grep #{cmd}`.lines.any?).to be_truthy
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'rspec/launchbox'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+  config.extend RSpec::InPresenceOf
+  config.include RSpec::Matchers::Timeout
+end
+
+include RSpec::DescribeExecutable

data/spec/timeouts_spec.rb

@@ -0,0 +1,38 @@
+describe '#persist' do
+  context 'with jush value passed' do
+    it 'raises exceptions' do
+      expect(5).to persist 5
+    end
+  end
+  context 'with block passed' do
+    context 'with no boundary' do
+      it 'd' do
+        expect do
+          'string'
+        end.to persist
+      end
+    end
+
+    context 'with boudary' do
+      it 'succeeds' do
+        expect do
+          'string'
+        end.to persist.at_most 1
+
+        expect do
+          'string'
+          sleep 2
+        end.to persist.at_least 1
+      end
+    end
+  end
+
+  context 'with block which raises exception' do
+    it 'rethrows' do
+      expect do
+        'string'
+        fail 'Exception in subject block'
+      end.to persist
+    end
+  end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: rspec-launchbox
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- d-theus
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Launchbox makes it easy to start or stop external service, manage timeouts.
+email:
+- slma0x02@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rspec/launchbox.rb
+- lib/rspec/launchbox/describe_executable.rb
+- lib/rspec/launchbox/in_presence_of.rb
+- lib/rspec/launchbox/timeout_matchers.rb
+- lib/rspec/launchbox/version.rb
+- rspec-launchbox.gemspec
+- spec/describe_executable_spec.rb
+- spec/in-presence-of_spec.rb
+- spec/spec_helper.rb
+- spec/timeouts_spec.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: RSpec DSL extension for effortless process control
+test_files:
+- spec/describe_executable_spec.rb
+- spec/in-presence-of_spec.rb
+- spec/spec_helper.rb
+- spec/timeouts_spec.rb
+has_rdoc: