aruba 0.9.0.pre → 0.9.0.pre2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 71f21475524ff2255d0cba069a187f55eab76a63
-  data.tar.gz: 6b76f7d95d15526e86d3ef939cb317a98dabc5ac
+  metadata.gz: f92ba90eaed6ac6f97ad8b43f5913fde2fb0f3a1
+  data.tar.gz: 1ab9079d180953f236b8529749303059a142cc85
 SHA512:
-  metadata.gz: 03123d44f1928b357d180dfe202d35b2c9e3c6f33a613ee8a60c52744d2a5fd6170e184f76abf826745ca0c98aefab602eafa9fdbf63fa274db88e862013eee1
-  data.tar.gz: dbc946f90ee79b79fde4acfa617010bcffc9d7813ad83bf2b966cb1a4f1d6e14ca317e137e14a26a77ad7edc9a4af52c0a25bbfb2cce557cdf2dea1e1bc859c3
+  metadata.gz: 8ab6deff05d7a0366724279a055ce42296b7549b50cf8acd71b655823ad471d19ff3313001e1913da4ea2246f9bf06ff58284d1460dd5b535b947f457536c674
+  data.tar.gz: f234b29f5ae59ebc4ed1cc9939d4d358d3bd4d0ac3212c1a56f0151b4bc4743fe4cd623750e044dfba2417e46a79b1124c1b06e05a301a10ceda89989d000849

data/Gemfile

@@ -5,14 +5,12 @@ gemspec
 
 # Debug aruba
 group :debug do
-  gem 'pry', '~> 0.10.1'
-
   if RUBY_VERSION >= '2' && !RUBY_PLATFORM.include?('java')
     gem 'byebug', '~> 4.0.5'
     gem 'pry-byebug', '~> 3.1.0'
   end
 
-  if RUBY_VERSION < '2' && !RUBY_PLATFORM.include?('java')
+  if RUBY_VERSION < '2' && RUBY_VERSION > '1.9' && !RUBY_PLATFORM.include?('java')
     gem 'debugger', '~> 1.6.8'
     gem 'pry-debugger', '~> 0.2.3'
   end
@@ -25,6 +23,13 @@ group :debug do
 end
 
 group :development, :test do
+  # we use this to demonstrate interactive debugging within our feature tests
+  if RUBY_VERSION >= '2'
+    gem 'pry', '~> 0.10.1'
+  else
+    gem 'pry', '~>0.9.12'
+  end
+
   # Run development tasks
   gem 'rake', '~> 10.4.2'
 

data/History.md

@@ -1,5 +1,25 @@
 # Latest Release
 
+## [v0.9.0.pre](https://github.com/cucumber/aruba/compare/v0.8.1...v0.9.0.pre)
+
+* Improve documentation for filesystem api and move it to feature tests
+* Add logger to aruba. Its output can be captured by rspec.
+* Fix incorrect deprecation message for check_file_presence (issue #292)
+* Fix for Gemfile excludes windows for many gems (issue #282)
+* Make feature tests compatible with ruby 1.9.2
+* Gather disk usage for file(s) (issue #294)
+* Replace keep_ansi-config option by remove_ansi_escape_sequences-option
+* Split up `#unescape` into `#extract_text` and `#unescape_text`
+* Use `UnixPlatform` and `WindowsPlatform` to make code for different platforms maintainable
+* Work around `ENV`-bug in `Jruby` buy using `#dup` on `ENV.to_h` (issue jruby/jruby#3162)
+* Speed up test on `JRuby` by using `--dev`-flag
+* Work around problems when copying files with `cp` on MRI-ruby 1.9.2
+* Add cmd.exe /c for SpawnProcess on Windows (issue #302)
+* Split up `#which` for Windows and Unix/Linux (issue #304)
+* Add `aruba console`-command to play around with aruba (issue 305)
+
+# Old releases
+
 ## [v0.8.1](https://github.com/cucumber/aruba/compare/v0.8.0...v0.8.1)
 
 * Fix problem if working directory of aruba does not exist (issue #286)
@@ -11,8 +31,6 @@
 * Use prepend_environment_variable to modify PATH for rspec integration
 * Add VERSION-constant to aruba and use it for code which should be activated on >= 1.0.0
 
-# Old releases
-
 ## [v0.8.0](https://github.com/cucumber/aruba/compare/v0.8.0.pre3...v0.8.0)
 * Build with cucumber 1.3.x on ruby 1.8.7, with cucumber 2.x on all other platforms
 * Fixed bugs in aruba's cucumber steps
@@ -350,23 +368,25 @@
 
 # Upcoming un-released versions
 
-## [v0.9.0](https://github.com/cucumber/aruba/compare/v0.8.1...v0.9.0)
-
-* Improve documentation for filesystem api and move it to feature tests
-* Add logger to aruba. Its output can be captured by rspec.
-* Fix incorrect deprecation message for check_file_presence (issue #292)
-* Fix for Gemfile excludes windows for many gems (issue #282)
-* Make feature tests compatible with ruby 1.9.2
-* Gather disk usage for file(s) (issue #294)
-* Replace keep_ansi-config option by remove_ansi_escape_sequences-option
-* Split up `#unescape` into `#extract_text` and `#unescape_text`
-* Use `UnixPlatform` and `WindowsPlatform` to make code for different platforms maintainable
-* Work around `ENV`-bug in `Jruby` buy using `#dup` on `ENV.to_h` (issue jruby/jruby#3162)
-* Speed up test on `JRuby` by using `--dev`-flag
-* Work around problems when copying files with `cp` on MRI-ruby 1.9.2
-* Add cmd.exe /c for SpawnProcess on Windows (issue #302)
-* Split up `#which` for Windows and Unix/Linux (issue #304)
-* Add `aruba console`-command to play around with aruba (issue 305)
+## [v0.9.0.pre2](https://github.com/cucumber/aruba/compare/v0.9.0.pre...v0.9.0.pre2)
+
+* Redefine #to_s and #inspect for BasicProcess to reduce the sheer amount of
+  information, if a command produces a lot of output
+* Added new matcher `#all_objects` to check if an object is included + a error message for
+  failures which is similar to the `#all`-matcher of `RSpec`
+* Add `have_output`-, `have_output_on_stderr`, `have_output_on_stdout`-matchers
+* Replace all `assert_*` and `check_*`-methods through expectations
+* Add hook `@announce-output` to output both, stderr and stdout
+* Add a lot of documentation (issue #260)
+* Replace `#last_command` through `#last_command_started` and
+  `#last_command_stopped` to make it more explicit
+* Improve syntax highlighting in cucumber feature tests by adding programming
+  language to `"""`-blocks
+* Rename tags `@ignore-*` to `@unsupported-on-*`
+* Introduce our own `BaseMatcher`-class to remove the dependency to `RSpec`'s
+  private matcher APIs
+* Now we make the process started via `SpawnProcess` the leader of the group to
+  kill all sub-processes more reliably
 
 ## [v1.0.0](https://github.com/cucumber/aruba/compare/v0.11.0...v1.0.0)
 
@@ -397,3 +417,25 @@
 * Use different working directories based on test suite - RSpec, Cucumber.
   It's `tmp/rspec` and `tmp/cucumber` now to make sure they do not overwrite
   the test results from each other.
+* The use of `@interactive` is discontinued. You need to use
+  `#last_command_started`-method to get access to the interactively started
+  command.
+* If multiple commands have been started, each output has to be check
+  separately
+
+  ```cucumber
+  Scenario: Detect stdout from all processes
+    When I run `printf "hello world!\n"`
+    And I run `cat` interactively
+    And I type "hola"
+    And I type ""
+    Then the stdout should contain:
+      """
+      hello world!
+      """
+    And the stdout should contain:
+      """
+      hola
+      """
+    And the stderr should not contain anything
+  ```

data/README.md

@@ -115,15 +115,19 @@ can test those commands as though the gem were already installed.
 
 If you need other directories to be added to the `PATH`, you can put the following in `features/support/env.rb`:
 
-    ENV['PATH'] = "/my/special/bin/path#{File::PATH_SEPARATOR}#{ENV['PATH']}"
+```ruby
+Aruba.configure do |config|
+  config.command_search_paths = config.command_search_paths << '/my/special/bin/path'
+end
+```
 
 ### Increasing timeouts
 
-A process sometimes takes longer than expected to terminate, and Aruba will kill them off (and fail your scenario) if it is still alive after 3 seconds. If you need more time you can modify the timeout by assigning a different value to `@aruba_timeout_seconds` in a `Before` block:
+A process sometimes takes longer than expected to terminate, and Aruba will kill them off (and fail your scenario) if it is still alive after 3 seconds. If you need more time you can modify the timeout by assigning a different value to `#exit_timeout` in a `Aruba.configure` block:
 
 ```ruby
-Before do
-  @aruba_timeout_seconds = 5
+Aruba.configure do |config|
+  config.exit_timeout = 5
 end
 ```
 
@@ -132,11 +136,11 @@ 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
-`@aruba_io_wait_seconds` to an appropriate value. This is particularly useful with tags:
+`aruba.config.io_wait_timeout` to an appropriate value. This is particularly useful with tags:
 
 ```ruby
 Before('@slow_process') do
-  @aruba_io_wait_seconds = 5
+  aruba.config.io_wait_timeout = 5
 end
 ```
 

data/TODO.md

@@ -1,3 +1,8 @@
-
 * Replace check filesystem permissons through a better rspec matcher
 * Improve documentation for matchers in file
+* Cleanup stdout/stderr in spawn process:
+    It should be enough to use 'open(@process.io.stdout).read' and 'open(@process.io.stderr).read'. There's no need to rewind them.
+* Ensure that all processes are kill after cucumber is finished
+* Add variation of check and stop of command if output contains
+    Add something like `(?: of last command)?`. If this is true, just check the last command.
+* Use aruba.config.exit_timeout everywhere

data/cucumber.yml

@@ -2,16 +2,20 @@
 require 'ffi'
 java_version = (RUBY_DESCRIPTION.match(/.*?on.*?(1\.[\d]\..*? )/))[1] if defined?(JRUBY_VERSION)
 
-std_opts          = "--color --exclude features/fixtures --require features"
+std_opts          = "--color --exclude features/fixtures --require features --tags ~@unsupported-on"
 java_default_opts = "--tags ~@wip-jruby-java-1.6" if defined?(JRUBY_VERSION) && (java_version < '1.7.0')
 java_wip_opts     = "--tags @wip-jruby-java-1.6:3" if defined?(JRUBY_VERSION) && (java_version < '1.7.0')
 
 ignore_opts = []
-ignore_opts <<  "--tags ~@ignore-platform-java"    if RUBY_PLATFORM.include? 'java'
-ignore_opts <<  "--tags ~@ignore-platform-mri"     if !RUBY_PLATFORM.include? 'java'
-ignore_opts <<  "--tags ~@ignore-platform-windows" if FFI::Platform.windows?
-ignore_opts <<  "--tags ~@ignore-platform-unix"    if FFI::Platform.unix?
-ignore_opts <<  "--tags ~@ignore-platform-mac"    if FFI::Platform.mac?
+ignore_opts <<  '--tags ~@ignore'
+ignore_opts <<  '--tags ~@unsupported-on-platform-java'    if RUBY_PLATFORM.include? 'java'
+ignore_opts <<  '--tags ~@unsupported-on-platform-mri'     if !RUBY_PLATFORM.include? 'java'
+ignore_opts <<  '--tags ~@unsupported-on-platform-windows' if FFI::Platform.windows?
+ignore_opts <<  '--tags ~@unsupported-on-platform-unix'    if FFI::Platform.unix?
+ignore_opts <<  '--tags ~@unsupported-on-platform-mac'     if FFI::Platform.mac?
+ignore_opts <<  '--tags ~@unsupported-on-ruby-older-2'     if RUBY_VERSION < '2'
+ignore_opts <<  '--tags ~@unsupported-on-ruby-older-193'   if RUBY_VERSION < '1.9.3'
+ignore_opts <<  '--tags ~@unsupported-on-ruby-older-19'    if RUBY_VERSION < '1.9'
 ignore_opts = ignore_opts.join(' ')
 %>
 default: <%= std_opts %> --tags ~@wip <%= java_default_opts %> <%= ignore_opts %>

data/features/.nav

@@ -0,0 +1,72 @@
+- README.md
+- getting_started (Getting Started):
+    - install.feature (Install Aruba)
+    - supported_programming_languages.feature (Supportet Programming Languages)
+- ruby_api (Ruby API):
+    - expand_path.feature (#expand_path)
+    - cleanup_aruba_directory.feature (#setup_aruba)
+    - run.feature (#run)
+    - which.feature (#which)
+    - append_environment_variable.feature (#append_environment_variable)
+    - prepend_environment_variable.feature (#prepend_environment_variable)
+    - set_environment_variable.feature (#set_environment_variable)
+    - cd.feature (#cd)
+    - create_directory.feature (#create_directory)
+    - disk_usage.feature (#disk_usage)
+    - does_exist.feature (#exist?)
+    - is_absolute.feature (#absolute?)
+    - filesystem/is_directory.feature (#directory?)
+    - is_file.feature (#file?)
+    - is_relative.feature(#relative?)
+    - move.feature (#move)
+    - file_system_commands.feature
+    - command.feature (Before Hook)
+    - command.feature (After Hook)
+- cucumber (Cucumber):
+    - debug_command.feature (Debug Commmands)
+    - environment_variables.feature (Environment Variables)
+    - flushing.feature (Flush Output)
+    - interactive.feature (Interactive Commands)
+    - all_output.feature (Command Output)
+    - stdout.feature (STDOUT)
+- configuration (Configuration):
+    - exit_timeout.feature (Exit Timeout)
+    - fixtures_directories.feature (Fixtures Directories)
+    - fixtures_path_prefix.feature (Fixture Path Prefix)
+    - home_directory.feature (Home Directory)
+    - io_timeout.feature (IO Wait Timeout)
+    - keep_ansi.feature (Keep ANSI output)
+    - log_level.feature (Log Level)
+    - physical_block_size.feature (Physical Block Size)
+    - root_directory.feature (Root Directory)
+    - working_directory.feature (Working Directory)
+- rspec (RSpec):
+    - getting_started.feature (Integration)
+    - include_an_object.feature (Matcher: Include an Object)
+    - have_sub_directory.feature (Matcher: Have Sub Directory)
+    - be_existing_file.feature (Matcher: Be Existing File)
+    - have_file_content.feature (Matcher: Have File Content)
+    - have_file_size.feature (Matcher: Have File Size)
+    - be_an_absolute_path.feature (Matcher: Be Absolute Path)
+    - be_an_existing_path.feature (Matcher: Be Existing Path)
+    - have_permissions.feature (Matcher: Have Permissions)
+    - timeouts.feature (Matcher: Timeouts)
+- cucumber (Cucumber):
+    - announce.feature (Announce Information to User)
+    - exit_statuses.feature (Exit Status of Commands)
+    - in_process.feature (Start Commands in Process)
+    - run.feature (Run Commands)
+    - home_variable.feature (Modify HOME-Variable)
+    - set_environment_variable.feature (Set Environment variables)
+    - copy.feature (Copy files/directories)
+    - create_directory.feature (Create Directories)
+    - create_file.feature (Create Files)
+    - file_content.feature (Use File Content)
+    - move.feature (Move files/directories)
+    - overwrite_file.feature (Overwrite Files)
+    - use_fixture.feature (Use Fixtures)
+    - output.feature (Output)
+    - utf-8.feature (Support for UTF-8-strings)
+- development (Development):
+    - build.feature (Build Aruba)
+    - test.feature (Test Aruba)

data/features/announce.feature

@@ -0,0 +1,203 @@
+Feature: Announce output during test run
+
+  In order to specify expected output
+  As a developer using Cucumber
+  I want to use the "the output should contain" step
+
+  Background:
+    Given I use a fixture named "cli-app"
+
+  Scenario: Announce change of directory (deprecated)
+    Given a file named "features/exit_status.feature" with:
+    """cucumber
+    Feature: Announce
+      @announce-dir
+      Scenario: Run command
+        Given a directory named "dir.d"
+        When I cd to "dir.d"
+    """
+    When I run `cucumber`
+    Then the features should all pass
+    And the output should contain:
+    """
+    $ cd /
+    """
+    And the output should contain:
+    """
+    tmp/aruba/dir.d
+    """
+
+  Scenario: Announce change of directory
+    Given a file named "features/exit_status.feature" with:
+    """cucumber
+    Feature: Announce
+      @announce-directory
+      Scenario: Run command
+        Given a directory named "dir.d"
+        When I cd to "dir.d"
+    """
+    When I run `cucumber`
+    Then the features should all pass
+    And the output should contain:
+    """
+    $ cd /
+    """
+    And the output should contain:
+    """
+    tmp/aruba/dir.d
+    """
+
+  Scenario: Announce stdout
+    Given an executable named "bin/cli" with:
+    """bash
+    #!/usr/bin/env bash
+
+    echo 'Hello World'
+    """
+    And a file named "features/exit_status.feature" with:
+    """cucumber
+    Feature: Announce
+      @announce-stdout
+      Scenario: Run command
+        When I run `cli`
+        Then the exit status should be 0
+    """
+    When I run `cucumber`
+    Then the features should all pass
+    And the output should contain:
+    """
+    <<-STDOUT
+    Hello World
+
+    STDOUT
+    """
+
+  Scenario: Announce stderr
+    Given an executable named "bin/cli" with:
+    """bash
+    #!/usr/bin/env bash
+
+    echo 'Hello World' >&2
+    """
+    And a file named "features/exit_status.feature" with:
+    """cucumber
+    Feature: Announce
+      @announce-stderr
+      Scenario: Run command
+        When I run `cli`
+        Then the exit status should be 0
+    """
+    When I run `cucumber`
+    Then the features should all pass
+    And the output should contain:
+    """
+    <<-STDERR
+    Hello World
+
+    STDERR
+    """
+
+  Scenario: Announce both stderr and stdout
+    Given an executable named "bin/cli" with:
+    """bash
+    #!/usr/bin/env bash
+
+    echo 'Hello' >&2
+    echo 'World'
+    """
+    And a file named "features/exit_status.feature" with:
+    """cucumber
+    Feature: Announce
+      @announce-output
+      Scenario: Run command
+        When I run `cli`
+        Then the exit status should be 0
+    """
+    When I run `cucumber`
+    Then the features should all pass
+    And the output should contain:
+    """
+    <<-STDERR
+    Hello
+
+    STDERR
+    """
+    And the output should contain:
+    """
+    <<-STDOUT
+    World
+
+    STDOUT
+    """
+
+  Scenario: Announce command
+    Given an executable named "bin/cli" with:
+    """bash
+    #!/usr/bin/env bash
+
+    echo 'Hello World'
+    """
+    And a file named "features/exit_status.feature" with:
+    """cucumber
+    Feature: Announce
+      @announce-cmd
+      Scenario: Run command
+        When I run `cli`
+        Then the exit status should be 0
+    """
+    When I run `cucumber`
+    Then the features should all pass
+    And the output should contain:
+    """
+    $ cli
+    """
+
+  Scenario: Announce change of environment variable
+    Given an executable named "bin/cli" with:
+    """bash
+    #!/usr/bin/env bash
+
+    echo 'Hello World'
+    """
+    And a file named "features/exit_status.feature" with:
+    """cucumber
+    Feature: Announce
+      @announce-env
+      Scenario: Run command
+        When I set the environment variables to:
+          | variable | value    |
+          | MY_VAR   | my_value |
+        And I run `cli`
+        Then the exit status should be 0
+    """
+    When I run `cucumber`
+    Then the features should all pass
+    And the output should contain:
+    """
+    $ export MY_VAR=my_value
+    """
+
+  Scenario: Announce change of environment variable which contains special characters
+    Given an executable named "bin/cli" with:
+    """bash
+    #!/usr/bin/env bash
+
+    echo 'Hello World'
+    """
+    And a file named "features/exit_status.feature" with:
+    """cucumber
+    Feature: Announce
+      @announce-env
+      Scenario: Run command
+        When I set the environment variables to:
+          | variable | value      |
+          | MY_VAR   | my value ! |
+        And I run `cli`
+        Then the exit status should be 0
+    """
+    When I run `cucumber`
+    Then the features should all pass
+    And the output should contain:
+    """
+    $ export MY_VAR=my\ value\ \
+    """