rspec-launchbox 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c00ce31529ca3732c0fc6e5b930185fac4be632
-  data.tar.gz: ea7c107c0a5688911f48e2feaaa1ce1ea50eb984
+  metadata.gz: 0317ed423bdb78223cf5eb3678021c69c7470d96
+  data.tar.gz: b0fc8a904edfae7244cda86a3d9c02328615edb5
 SHA512:
-  metadata.gz: d4e73a5fbf734687c39a20ead035f863526c561237a60d612fea8a9f3db37da1a80fc856bb79dd1800bd7f0b4a691b17988a1752d0252d910a6125b5e05b6b58
-  data.tar.gz: 701a8acfd4ff108e2cdfee8d86061a1f71a22652b3598804ed8b46aacd0413701bfecfcca5e70c5c1dcd0afcd7a951524f5f7649b487ab946415ad42c949ef7a
+  metadata.gz: 3d34ae9818ab4e61b2249e394a3cddd6d332e4b5d0b1e78125111d54dfe298861288597d82da2c7aa8b8515e28a8ac25a2258283d749b629c04cf35a0d8da9e1
+  data.tar.gz: 915e466f46865992e1f347218f879cf2b5dedd95d95f3eb11160699007743e20cda055e0823b0dfd4e7d7ada3da3a9e21e813612427d2e02f814b5e28332fb85

data/lib/rspec/launchbox.rb

@@ -5,3 +5,9 @@ require 'rspec/its'
 require 'rspec/launchbox/timeout_matchers.rb'
 require 'rspec/launchbox/in_presence_of.rb'
 require 'rspec/launchbox/describe_executable.rb'
+
+include RSpec::DescribeExecutable
+RSpec.configure do |c|
+  c.extend RSpec::InPresenceOf
+  c.include RSpec::Matchers::Timeout
+end

data/lib/rspec/launchbox/describe_executable.rb

@@ -1,32 +1,118 @@
 module RSpec
+  # #describe_executable method and some
+  # pretty expectations regarding streams.
   module DescribeExecutable
+    # Expectations regarding streams,
+    # i.e. stderr, stdout.
+    # Meant to be extended in #describe_stderr and
+    # #describe_stdout
+    module Stream
+      # Expects lines in the specified stream
+      # to include each of the specified lines
+      # @param [Array] lines
+      # @example
+      #     describe_stderr do
+      #       it_is_expected_to_have_line 'cannot load shared library'
+      #     end
+      def it_is_expected_to_have_line(*lines)
+        it "is expected to have line(s) matching '#{lines}'" do
+          expect(_watch_stream.lines.map(&:chomp)).to include *lines
+        end
+      end
+
+      alias_method :it_is_expected_to_have_lines, :it_is_expected_to_have_line
+      alias_method :has_line, :it_is_expected_to_have_lines
+      alias_method :has_lines, :it_is_expected_to_have_line
+
+      # Expects some lines in the specified stream
+      # to match specified pattern
+      # @param [Regex, String] lines
+      # @see #it_is_expected_to_have_line
+      def it_is_expected_to_have_lines_matching(pat)
+        it "is expected to have line(s) matching pattern '#{pat}'" do
+          __grep = _watch_stream.lines.grep(pat)
+          expect(__grep.size).to be > 0
+        end
+      end
+
+      alias_method :has_line_matching, :it_is_expected_to_have_lines_matching
+
+      # Expects lines in the specified stream
+      # *not* to include each of the specified lines
+      # @param [Regex, String] lines
+      # @see #it_is_expected_to_have_line
+      def it_is_expected_not_to_have_line(*lines)
+        it "is expected not to have line(s) matching '#{lines}'" do
+          expect(_watch_stream.lines.map(&:chomp)).not_to include *lines
+        end
+      end
+
+      alias_method :it_is_expected_not_to_have_lines, :it_is_expected_not_to_have_line
+      alias_method :has_no_line, :it_is_expected_not_to_have_line
+
+      # Expects *none of* the lines in the specified stream
+      # to match specified pattern
+      # @param [Regex, String] lines
+      # @see #it_is_expected_to_have_line
+      def it_is_expected_not_to_have_lines_matching(pat)
+        it "is expected not to have line(s) matching pattern '#{pat}'" do
+          __grep = _watch_stream.lines.grep(pat)
+          expect(__grep.size).to be 0
+        end
+      end
+
+      alias_method :has_no_line_matching, :it_is_expected_not_to_have_lines_matching
+    end
+
     # Outmost describe block.
     # @param [String] cmd executable name
     # @yields block like ordinary #describe
     # @example
     #     describe_executable 'ls' do
-    #       its_stdout do
+    #       describe_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
+        $_command_line = cmd
+        $_flags = []
+        $_process_stdout = ''
+        $_process_stderr = ''
+
         before(:each) do
+          $_command_line = cmd
+          $_process_stdout = ''
+          $_process_pid = nil
+          $_piper_o, $_pipew_o = IO.pipe
+          $_piper_e, $_pipew_e = IO.pipe
+          $_process_pid = fork do
+            $_piper_o.close
+            $_piper_e.close
+            $stdout.reopen $_pipew_o
+            $stderr.reopen $_pipew_e
+            exec($_command_line + ' ' + $_flags.join(' '))
+          end
+          $_pipew_o.close
+          $_pipew_e.close
           Thread.abort_on_exception = true
           Thread.new do
-            IO.popen($_command_line) do |io|
-              $_process_stdout << io.read(256) until io.eof?
+            maybe_read = [$_piper_o, $_piper_e]
+            can_read = []
+            loop do
+              can_read = select([$_piper_o, $_piper_e]).first.map!(&:fileno)
+              $_process_stdout << ($_piper_o.read(16) || '') if can_read.include? $_piper_o.fileno
+              $_process_stderr << ($_piper_e.read(16) || '') if can_read.include? $_piper_e.fileno
+              maybe_read.delete_if { |io| io.eof? }
+              break if maybe_read.empty?
             end
-          end
-          sleep 1
+          end.join
         end
 
         after(:each) do
-          `killall -INT #{$_command_line.split(/\W/)[0]} &>/dev/null`
+          `kill -INT #{$_process_pid} &>/dev/null`
           sleep 0.1
-          `killall -KILL #{$_command_line.split(/\W/)[0]} &>/dev/null`
+          `kill -KILL #{$_process_pid} &>/dev/null`
         end
 
         class_eval &block
@@ -37,14 +123,30 @@ module RSpec
     # sets it's subject to process stdout
     # @yields block like ordinary describe
     # @see #describe_executable for an example
-    def its_stdout(&block)
+    def describe_stdout(&block)
       describe "it's stdout" do
+        let(:_watch_stream) { $_process_stdout.dup }
+        extend Stream
+
         subject { $_process_stdout }
 
         class_eval &block
       end
     end
 
+    # Same as #describe_stdout
+    # for stderr
+    def describe_stderr(&block)
+      describe "it's stderr" do
+        let(:_watch_stream) { $_process_stderr.dup }
+        extend Stream
+
+        subject { $_process_stderr }
+
+        class_eval &block
+      end
+    end
+
     # Opens new 'context',
     # where options are appended to
     # command line before execution.
@@ -53,19 +155,54 @@ module RSpec
     # @example
     #     describe_executable 'ls' do
     #       given_option '-a' do
-    #         its_stdout do
+    #         describe_stdout do
     #           #you need rspec-its gem for `its`
     #           its(:lines) { is_expected.to include ".\n" }
+    #           # much prettier:
+    #           has_line '.'
     #         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(' ')
+    def given_option(flag, &block)
+      context "given option #{flag}" do
+        before(:context) do
+          $_flags << flag
+        end
+
+        after(:context) do
+          $_flags.pop
+        end
+
+        class_eval &block
+      end
+    end
+
+    # Waits for `timeout` seconds, then
+    # sends signal to the process.
+    # @param [Integer] timeout
+    # @param [Hash] options
+    # @option options [Symbol | String] signal
+    # @example
+    #     describe_executable 'some_long_running_executable' do
+    #       running_for(10, signal: :INT) do
+    #         describe_stdout do
+    #           #...
+    #         end
+    #       end
+    #     end
+    def running_for(timeout, options = {}, &block)
+      $_signal = options[:signal] && options[:signal].to_s.upcase.prepend('-')
+      context "when sent #{$_signal} after #{timeout} seconds" do
+        before(:each) do
+          Thread.new do
+            sleep timeout
+            `kill #{$_signal} #{$_process_pid} &>/dev/null`
+          end.join
+        end
 
         class_eval &block
       end
     end
   end
+
 end

data/lib/rspec/launchbox/version.rb

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

data/spec/describe_executable_spec.rb

@@ -1,14 +1,46 @@
 describe_executable 'ls' do
-  its_stdout do
+  describe_stdout do
     it { is_expected.to be_a String }
     it { is_expected.not_to be_empty }
+    it_is_expected_to_have_line 'spec'
+    it_is_expected_to_have_line 'spec', 'lib'
+    it_is_expected_not_to_have_line 'blaargs'
+    it_is_expected_to_have_lines_matching /spec/
+    it_is_expected_not_to_have_lines_matching /blaargh/
   end
 
   given_option '-a' do
-    its_stdout do
+    describe_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
+
+  given_option '-h' do
+    describe_stdout do
+      it 'command line should be cleaned up after each example' do
+        expect($_command_line).not_to include '-a'
+      end
+      its(:lines) { is_expected.not_to include ".\n" }
+    end
+
+    given_option '-a' do
+      describe_stdout do
+        its(:lines) { is_expected.to include ".\n" }
+      end
+    end
+  end
+
+  given_option '1>&2' do
+    describe_stderr do
+      its(:lines) { is_expected.to include "spec\n" }
+    end
+  end
+
+  running_for(2, signal: :INT) do
+    describe_stdout do
+      it { is_expected.to be_a String }
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -7,8 +7,4 @@ RSpec.configure do |config|
   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

@@ -1,15 +1,23 @@
 describe '#persist' do
   context 'with jush value passed' do
     it 'raises exceptions' do
-      expect(5).to persist 5
+      begin
+        expect(5).to persist 5
+      rescue RuntimeError => e
+        raise e unless e.message.include? 'Block expected'
+      end
     end
   end
   context 'with block passed' do
     context 'with no boundary' do
       it 'd' do
-        expect do
-          'string'
-        end.to persist
+        begin
+          expect do
+            'string'
+          end.to persist
+        rescue RuntimeError => e
+          raise e unless e.message.include? 'Expected'
+        end
       end
     end
 
@@ -29,10 +37,14 @@ describe '#persist' do
 
   context 'with block which raises exception' do
     it 'rethrows' do
-      expect do
-        'string'
-        fail 'Exception in subject block'
-      end.to persist
+      begin
+        expect do
+          'string'
+          fail 'Exception in subject block'
+        end.to persist.at_most(1)
+      rescue RuntimeError => e
+        raise e unless e.message.include? 'Exception in subject block'
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-launchbox
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - d-theus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-06 00:00:00.000000000 Z
+date: 2015-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -118,4 +118,3 @@ test_files:
 - spec/in-presence-of_spec.rb
 - spec/spec_helper.rb
 - spec/timeouts_spec.rb
-has_rdoc: