aruba 0.2.8 → 0.3.0

data/History.txt

@@ -1,4 +1,15 @@
-== In Git
+== 0.3.0
+
+=== Bugfixes
+* Remove latency introduced in the 0.2.8 release (#42 Mike Sassak)
+
+=== New Features
+* New stepdef Then /^the stdout should contain:$/ do |partial_output| (Aslak Hellesøy)
+
+=== Changed Features
+* Quotes (") and newline (\n) in step arguments no longer need to be backslash-escaped. (Aslak Hellesøy)
+
+== 0.2.8
 
 === New Features
 * Replaced background_process with childprocess, a cross-platform process control library. This will allow Aruba to run on Windows and JRuby in addition to *nix MRI. (#16, #27, #31 Mike Sassak, Jari Bakken, Matt Wynne, Arve Knudsen)

data/README.rdoc

@@ -26,7 +26,7 @@ Aruba has several tags you can use to get more information. You can put these ta
 * <tt>@announce-env</tt> - See environment variables set by Aruba
 * <tt>@announce</tt> - Does all of the above
 
-== Configuring the working directory
+== Runtime Configuration
 
 Per default Aruba will create a directory <tt>tmp/aruba</tt> where it performs it's file operations.
 If you want to change this behaviour put this into your <tt>features/support/env.rb</tt>:
@@ -35,6 +35,22 @@ If you want to change this behaviour put this into your <tt>features/support/env
     @dirs = ["somewhere/else"]
   end
 
+Set <tt>@aruba_timeout_seconds</tt> to control the amount of time Aruba will wait for a process to 
+finish running before terminating it: 
+
+  Before do
+    @aruba_timeout_seconds = 5
+  end
+
+Running processes interactively can result in race conditions when Aruba executes an IO-related step
+but the interactive process has not yet flushed or read some content. To help prevent this Aruba waits
+before reading or writing to the process if it is still running. You can control the wait by setting
+<tt>@aruba_io_wait_seconds</tt> to an appropriate value. This is particularly useful with tags:
+
+  Before('@slow_process') do
+    @aruba_io_wait_seconds = 5
+  end
+
 == Note on Patches/Pull Requests
  
 * Fork the project.

data/aruba.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'aruba'
-  s.version     = '0.2.8'
+  s.version     = '0.3.0'
   s.authors     = ["Aslak Hellesøy", "David Chelimsky", "Mike Sassak"]
   s.description = 'CLI Steps for Cucumber, hand-crafted for you in Aruba'
   s.summary     = "aruba-#{s.version}"

data/features/output.feature

@@ -42,7 +42,7 @@ Feature: Output
     Then the output should contain exactly "hello world\n"
 
   Scenario: Detect exact multiline output
-    When I run "ruby -e 'puts \"hello\\nworld\"'"
+    When I run "ruby -e 'puts "hello\nworld"'"
     Then the output should contain exactly:
       """
       hello
@@ -58,7 +58,7 @@ Feature: Output
 
   @announce
   Scenario: Detect subset of multiline output with regex
-    When I run "ruby -e 'puts \"hello\\nworld\\nextra line1\\nextra line2\\nimportant line\"'"
+    When I run "ruby -e 'puts "hello\nworld\nextra line1\nextra line2\nimportant line"'"
     Then the output should match:
       """
       he..o
@@ -69,14 +69,14 @@ Feature: Output
 
   @announce
   Scenario: Match passing exit status and partial output
-    When I run "ruby -e 'puts \"hello\\nworld\"'"
+    When I run "ruby -e 'puts "hello\nworld"'"
     Then it should pass with:
       """
       hello
       """
 
   Scenario: Match passing exit status and exact output
-    When I run "ruby -e 'puts \"hello\\nworld\"'"
+    When I run "ruby -e 'puts "hello\nworld"'"
     Then it should pass with exactly:
       """
       hello
@@ -93,7 +93,7 @@ Feature: Output
       """
 
   Scenario: Match failing exit status and exact output
-    When I run "ruby -e 'puts \"hello\\nworld\";exit 99'"
+    When I run "ruby -e 'puts "hello\nworld";exit 99'"
     Then it should fail with exactly:
       """
       hello
@@ -115,11 +115,25 @@ Feature: Output
     Then the stdout should contain "hello"
     Then the stderr should not contain "hello"
 
-  @announce-stderr
-  Scenario: Match output in stderr
-    When I run "ruby -e 'STDERR.puts \"hello\\nworld\";exit 99'"
-    Then the stderr should contain "hello"
-    Then the stdout should not contain "hello"
+  @announce
+  Scenario: Match output on several lines
+    When I run "ruby -e 'puts %{GET /}'"
+    Then the stdout should contain:
+      """
+      GET /
+      """
+
+  Scenario: Match output on several lines using quotes
+    When I run "ruby -e 'puts %{GET "/"}'"
+    Then the stdout should contain:
+      """
+      GET "/"
+      """
+
+  Scenario: Match output in stdout
+    When I run "ruby -e 'puts \"hello\\nworld\"'"
+    Then the stdout should contain "hello"
+    Then the stderr should not contain "hello"
 
   Scenario: Detect output from all processes
     When I run "ruby -e 'puts \"hello world!\"'"

data/lib/aruba/api.rb

@@ -98,7 +98,8 @@ module Aruba
     end
 
     def unescape(string)
-      eval(%{"#{string}"})
+      string.gsub('\n', "\n")
+            .gsub('\"', '"')
     end
 
     def regexp(string_or_regexp)
@@ -195,7 +196,7 @@ module Aruba
         announce_or_puts("$ cd #{Dir.pwd}") if @announce_dir
         announce_or_puts("$ #{cmd}") if @announce_cmd
         
-        process = processes[cmd] = Process.new(cmd, timeout)
+        process = processes[cmd] = Process.new(cmd, exit_timeout, io_wait)
         process.run!
 
         block_given? ? yield(process) : process
@@ -204,10 +205,16 @@ module Aruba
 
     DEFAULT_TIMEOUT_SECONDS = 1
 
-    def timeout
+    def exit_timeout
       @aruba_timeout_seconds || DEFAULT_TIMEOUT_SECONDS
     end
 
+    DEFAULT_IO_WAIT_SECONDS = 0.1
+
+    def io_wait
+      @aruba_io_wait_seconds || DEFAULT_IO_WAIT_SECONDS
+    end
+
     def run_simple(cmd, fail_on_error=true)
       @last_exit_status = run(cmd) do |process|
         process.stop

data/lib/aruba/cucumber.rb

@@ -188,6 +188,10 @@ Then /^the stdout should contain "([^"]*)"$/ do |partial_output|
   all_stdout.should include(unescape(partial_output))
 end
 
+Then /^the stdout should contain:$/ do |partial_output|
+  all_stdout.should include(unescape(partial_output))
+end
+
 Then /^the stdout should contain exactly:$/ do |exact_output|
   all_stdout.should == exact_output
 end

data/lib/aruba/process.rb

@@ -6,8 +6,10 @@ module Aruba
   class Process
     include Shellwords
 
-    def initialize(cmd, timeout)
-      @timeout = timeout
+    def initialize(cmd, exit_timeout, io_wait)
+      @exit_timeout = exit_timeout
+      @io_wait = io_wait
+
       @out = Tempfile.new("aruba-out")
       @err = Tempfile.new("aruba-err")
       @process = ChildProcess.build(*shellwords(cmd))
@@ -22,8 +24,9 @@ module Aruba
     end
 
     def stdin
-      sleep 0.1
-      @process.io.stdin
+      wait_for_io do
+        @process.io.stdin
+      end
     end
 
     def output
@@ -31,23 +34,32 @@ module Aruba
     end
 
     def stdout
-      sleep 0.1
-      @out.rewind
-      @out.read
+      wait_for_io do
+        @out.rewind
+        @out.read
+      end
     end
 
     def stderr
-      sleep 0.1
-      @err.rewind
-      @err.read
+      wait_for_io do
+        @err.rewind
+        @err.read
+      end
     end
 
     def stop
       if @process
         stdout && stderr # flush output
-        @process.poll_for_exit(@timeout)
+        @process.poll_for_exit(@exit_timeout)
         @process.exit_code
       end
     end
+
+    private
+
+    def wait_for_io(&block)
+      sleep @io_wait if @process.alive?
+      yield
+    end
   end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 8
-  version: 0.2.8
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - "Aslak Helles\xC3\xB8y"
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-26 00:00:00 -06:00
+date: 2010-12-28 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -112,7 +112,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -4095997037921119441
+      hash: -686975627344897443
       segments: 
       - 0
       version: "0"
@@ -121,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -4095997037921119441
+      hash: -686975627344897443
       segments: 
       - 0
       version: "0"
@@ -131,7 +131,7 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: aruba-0.2.8
+summary: aruba-0.3.0
 test_files: 
 - features/exit_statuses.feature
 - features/file_system_commands.feature