aruba 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a03bef8bda8e7603e1f838f59617c33ed241a6c5
-  data.tar.gz: 2400a8a46277213356de308fc2be9bff799de045
+  metadata.gz: c728c7b302f5e46b803fabe9a95ab2769c768b65
+  data.tar.gz: 2a613d641ff60f99b06774b89bd23513a6aa01e1
 SHA512:
-  metadata.gz: dee2acfaddc2865642aacb0d4dd464aa8e9656e9485511e16a78568b7305a60a8fb79c0529c86c493dab163e8f12d9549eda3f2638c589201c04630e6ea11462
-  data.tar.gz: 07adf9438e735fd1d9bc85149b95ae4f51795d193676f793f0e516f9dbff80f99d75380e081cde6bd9eea78c821a4d796016b1e54db693b8d7eb5584fad47cf0
+  metadata.gz: 8ed3b4ac93ed91676ec48e17eb70fae1ab9d456213810880e2cf50c1f84e3df75e5585c708647c6d6da00604c424e54ea907c2cd225779cac6a67cb766d21108
+  data.tar.gz: c3e739cc6c22e3b42bbd19d04b86b40c4c4f7c370b0bfd6fcaf0fae267654dd73b8f5c7e6f244d1ef2e59e16121fd3bcb31a799d47b0a2b9d50b010fb224109e

data/.travis.yml

@@ -39,5 +39,9 @@ notifications:
 env:
   global:
    - secure: l8uznA5K4K9mZ1krmP3lTMD8WcJ32qGxFOR3jubKHcOBSLB4xSzU2aIqjyJdO+rLzebkwamhJc8pGSIWOUDQYvFiX7splK+uEkbBJ5huAhXtLF4Qgl86bCWbEXYzN7rvn0DQfpJAovyFMNRMnfo70XhwqWzFsaYa7Z0YbqYsJE4=
-   # - JRUBY_OPTS='-Xcli.debug=true --debug'
    - JRUBY_OPTS='--dev'
+cache: apt
+addons:
+  apt:
+    packages:
+    - zsh

data/History.md

@@ -1,4 +1,78 @@
-# Latest Release
+#  UNRELEASED
+
+## [v1.0.0](https://github.com/cucumber/aruba/compare/v0.11.0...v1.0.0)
+
+* Support for rubies older than 1.9.3 is discontinued - e.g 1.8.7 and 1.9.2
+* aruba requires "cucumber 2" for the feature steps. The rest of aruba should
+  be usable by whatever testing framework you are using.
+* Overwriting methods for configuration is discontinued. You need to use
+  `aruba.config.<variable>` or `Aruba.configure { |config| config.<variable>`
+  instead.
+* "aruba/reporting" will be removed. Please use `@debug`-tag + `byebug`,
+  `debugger`, `pry` to troubleshoot your feature tests.
+* Set environment variables will have only effect on `#run` and the like +
+  `#with_environment { }`.
+* The process environment will be fully resetted between tests. Sharing state
+  via ENV['VAR'] = 'shared state' between tests will not be possible anymore.
+  Please make that obvious by using explicit steps or use the aruba API for
+  that.
+* There will be a major cleanup for command execution. There will be only
+  `run` and `run_simple` left. `run_interactive` is replaced by `run`.
+* Setting the root directory of aruba via method overwrite or configuration -
+  this should be your project root directory where the test suite is run.
+* The direct use of "InProcess", "DebugProcess" and "SpawnProcess" is not
+  supported anymore. You need to use "Command" instead. But be careful, it has
+  a different API.
+* HOME can be configured via `Aruba.configure {}` and defaults to
+  `File.join(aruba.config.root_directory, aruba.config.working_directory?)`
+  if `aruba/cucumber` or `aruba/rspec` is used.
+* 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
+  ```
+
+# RELEASED
+
+## [v0.13.0](https://github.com/cucumber/aruba/compare/v0.12.0...v0.13.0)
+
+* Add two new hooks for rspec and cucumber to make troubleshooting feature
+  files easier (PR #338):
+  * command_content: Outputs command content - helpful for scripts
+  * command_filesystem_status: Outputs information like group, owner, mode,
+    atime, mtime
+* Add generator to create ad hoc script file (PR #323, @AdrieanKhisbe)
+* Colored announcer output similar to the color of `cucumber` tags: cyan
+* Fixed bug in announcer. It announces infomation several times due to
+  duplicate announce-calls.
+* Refactorings to internal `#simple_table`-method (internal)
+* Refactored Announcer, now it supports blocks for announce as well (internal)
+* Fix circular require warnings (issue #339)
+* Fix use of old instances variable "@io_wait" (issue #341). Now the
+  default value for io_wait_timeout can be set correctly.
+* Make it possible to announce information on command error, using a new option 
+  called `activate_announcer_on_command_failure` (PR #335, @njam)
+* Re-integrate `event-bus`-library into `aruba`-core (PR #342)
 
 ## [v0.12.0](https://github.com/cucumber/aruba/compare/v0.11.2...v0.12.0)
 
@@ -493,57 +567,3 @@
 ## [v0.1.0](https://github.com/cucumber/aruba/compare/ed6a175d23aaff62dbf355706996f276f304ae8b...v0.1.1)
 
 * First release (David Chelimsky and Aslak Hellesøy)
-
-# Upcoming un-released versions
-
-## [v1.0.0](https://github.com/cucumber/aruba/compare/v0.11.0...v1.0.0)
-
-* Support for rubies older than 1.9.3 is discontinued - e.g 1.8.7 and 1.9.2
-* aruba requires "cucumber 2" for the feature steps. The rest of aruba should
-  be usable by whatever testing framework you are using.
-* Overwriting methods for configuration is discontinued. You need to use
-  `aruba.config.<variable>` or `Aruba.configure { |config| config.<variable>`
-  instead.
-* "aruba/reporting" will be removed. Please use `@debug`-tag + `byebug`,
-  `debugger`, `pry` to troubleshoot your feature tests.
-* Set environment variables will have only effect on `#run` and the like +
-  `#with_environment { }`.
-* The process environment will be fully resetted between tests. Sharing state
-  via ENV['VAR'] = 'shared state' between tests will not be possible anymore.
-  Please make that obvious by using explicit steps or use the aruba API for
-  that.
-* There will be a major cleanup for command execution. There will be only
-  `run` and `run_simple` left. `run_interactive` is replaced by `run`.
-* Setting the root directory of aruba via method overwrite or configuration -
-  this should be your project root directory where the test suite is run.
-* The direct use of "InProcess", "DebugProcess" and "SpawnProcess" is not
-  supported anymore. You need to use "Command" instead. But be careful, it has
-  a different API.
-* HOME can be configured via `Aruba.configure {}` and defaults to
-  `File.join(aruba.config.root_directory, aruba.config.working_directory?)`
-  if `aruba/cucumber` or `aruba/rspec` is used.
-* 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/Rakefile

@@ -19,7 +19,7 @@ end
 require 'rspec/core/rake_task'
 desc "Run RSpec"
 RSpec::Core::RakeTask.new do |spec|
-  spec.rspec_opts = ['--color', '--format documentation']
+  spec.rspec_opts = ['--color', '--format documentation', '--warnings']
 end
 
 namespace :travis do

data/aruba.gemspec

@@ -19,7 +19,6 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'rspec-expectations', '>= 2.99'
   s.add_runtime_dependency 'contracts', '~> 0.9'
   s.add_runtime_dependency 'thor', '~> 0.19'
-  s.add_runtime_dependency 'event-bus', '~> 0.2'
 
   s.add_development_dependency 'bundler', '~> 1.11'
 

data/features/api/command/run_simple.feature

@@ -8,7 +8,7 @@ Feature: Run command
     Given this option is `true`, `aruba` fails if the `command` fails to run - exit code <> 0.
 
     For all other options see [run.feature](run.feature).
-    
+
   Background:
     Given I use a fixture named "cli-app"
 
@@ -107,7 +107,7 @@ Feature: Run command
     Given an executable named "bin/cli" with:
     """bash
     #!/usr/bin/env bash
- 
+
     function initialize_script {
       sleep 2
     }
@@ -205,3 +205,38 @@ Feature: Run command
     """
     When I run `rspec`
     Then the specs should all pass
+
+  Scenario: Activate announcer channels on failure
+
+    Given an executable named "bin/cli" with:
+    """bash
+    #!/bin/bash
+    echo "Hello, I'm STDOUT"
+    echo "Hello, I'm STDERR" 1>&2
+    exit 1
+    """
+    And a file named "spec/run_spec.rb" with:
+    """ruby
+    require 'spec_helper'
+
+    Aruba.configure do |config|
+      config.activate_announcer_on_command_failure = [:stdout, :stderr]
+    end
+
+    RSpec.describe 'Run command', :type => :aruba do
+      it { expect { run_simple('cli', :fail_on_error => true) }.to_not raise_error }
+    end
+    """
+    When I run `rspec`
+    Then the specs should not pass
+    And the output should contain:
+    """
+    <<-STDOUT
+    Hello, I'm STDOUT
+
+    STDOUT
+    <<-STDERR
+    Hello, I'm STDERR
+
+    STDERR
+    """

data/features/api/command/stderr.feature

@@ -0,0 +1,46 @@
+Feature: Access STDERR of command
+
+  You may need to `#stop_all_commands` before accessing `#stderr` of a single
+  command - e.g. `#last_command_started`.
+
+  Background:
+    Given I use a fixture named "cli-app"
+    And the default aruba io wait timeout is 1 seconds
+
+  Scenario: Existing executable
+    Given an executable named "bin/cli" with:
+    """bash
+    #!/bin/bash
+    echo 'Hello, Aruba!' >&2
+    """
+    And a file named "spec/run_spec.rb" with:
+    """ruby
+    require 'spec_helper'
+
+    RSpec.describe 'Run command', :type => :aruba do
+      before(:each) { run('cli') }
+      before(:each) { stop_all_commands }
+      it { expect(last_command_started.stderr).to start_with  'Hello' }
+    end
+    """
+    When I run `rspec`
+    Then the specs should all pass
+
+  Scenario: Waiting for output to "appear" after 2 seconds
+    Given an executable named "bin/cli" with:
+    """bash
+    #!/bin/bash
+    sleep 1
+    echo 'Hello, Aruba' >&2
+    """
+    And a file named "spec/run_spec.rb" with:
+    """ruby
+    require 'spec_helper'
+
+    RSpec.describe 'Run command', :type => :aruba, :io_wait_timeout => 2 do
+      before(:each) { run('cli') }
+      it { expect(last_command_started.stderr).to start_with 'Hello' }
+    end
+    """
+    When I run `rspec`
+    Then the specs should all pass

data/features/api/command/stdout.feature

@@ -0,0 +1,46 @@
+Feature: Access STDOUT of command
+
+  You may need to `#stop_all_commands` before accessing `#stdout` of a single
+  command - e.g. `#last_command_started`.
+
+  Background:
+    Given I use a fixture named "cli-app"
+    And the default aruba io wait timeout is 1 seconds
+
+  Scenario: Existing executable
+    Given an executable named "bin/cli" with:
+    """bash
+    #!/bin/bash
+    echo 'Hello, Aruba!'
+    """
+    And a file named "spec/run_spec.rb" with:
+    """ruby
+    require 'spec_helper'
+
+    RSpec.describe 'Run command', :type => :aruba do
+      before(:each) { run('cli') }
+      before(:each) { stop_all_commands }
+      it { expect(last_command_started.stdout).to start_with  'Hello' }
+    end
+    """
+    When I run `rspec`
+    Then the specs should all pass
+
+  Scenario: Waiting for output to "appear" after 2 seconds
+    Given an executable named "bin/cli" with:
+    """bash
+    #!/bin/bash
+    sleep 1
+    echo 'Hello, Aruba'
+    """
+    And a file named "spec/run_spec.rb" with:
+    """ruby
+    require 'spec_helper'
+
+    RSpec.describe 'Run command', :type => :aruba, :io_wait_timeout => 2 do
+      before(:each) { run('cli') }
+      it { expect(last_command_started.stdout).to start_with 'Hello' }
+    end
+    """
+    When I run `rspec`
+    Then the specs should all pass

data/features/configuration/activate_announcer_on_command_failure.feature

@@ -0,0 +1,38 @@
+Feature: Configure announcer activation on command failure
+
+  As a developer
+  I want to configure which announcers should get activated on command failure
+  In order to understand what caused a command to fail
+
+  Background:
+    Given I use the fixture "cli-app"
+
+  Scenario: Default value
+    Given a file named "features/support/aruba.rb" with:
+    """ruby
+    Aruba.configure do |config|
+      puts %(The default value is "#{config.activate_announcer_on_command_failure.inspect}")
+    end
+    """
+    When I successfully run `cucumber`
+    Then the output should contain:
+    """ruby
+    The default value is "[]"
+    """
+
+  Scenario: Modify value
+    Given a file named "features/support/aruba.rb" with:
+    """ruby
+    Aruba.configure do |config|
+      config.activate_announcer_on_command_failure = [:foo, :bar]
+    end
+
+    Aruba.configure do |config|
+      puts %(The value is "#{config.activate_announcer_on_command_failure.inspect}")
+    end
+    """
+    Then I successfully run `cucumber`
+    Then the output should contain:
+    """
+    The value is "[:foo, :bar]"
+    """

data/features/steps/command/run.feature

@@ -20,3 +20,31 @@ Feature: Run commands
     When I run `cucumber`
     Then the features should all pass
 
+  Scenario: Activate desired announcers when running command fails
+    Given an executable named "bin/cli" with:
+    """
+    #!/bin/bash
+    echo "Hello, I'm STDOUT"
+    exit 1
+    """
+    And a file named "features/run.feature" with:
+    """
+    Feature: Run it
+      Scenario: Run command
+        When I successfully run `cli`
+    """
+    And I append to "features/support/env.rb" with:
+    """
+    Before do
+      aruba.config.activate_announcer_on_command_failure = [:stdout]
+    end
+    """
+    When I run `cucumber`
+    Then the features should not pass
+    And the output should contain:
+    """
+    <<-STDOUT
+    Hello, I'm STDOUT
+
+    STDOUT
+    """

data/features/steps/command/shell.feature

@@ -0,0 +1,155 @@
+Feature: Running shell commands
+
+  You can run an *ad hoc* script with the following steps:
+  - `When I run the following script:`
+
+  Or you can run shell commands with:
+  - `I run the following (bash|zsh|...shell)? commands`
+  - `I run the following (bash|zsh|...shell)? commands (in|with) \`interpreter\``
+  - `I run the following (bash|zsh|...shell)? commands (in|with) \`/path/to/interpreter\``
+
+  Background:
+    Given I use a fixture named "cli-app"
+
+  Scenario: Creating and running scripts
+    Given a file named "features/shell.feature" with:
+    """
+    Feature: Running scripts
+      Scenario: Running ruby script
+        When I run the following script:
+        \"\"\"bash
+        #!/usr/bin/env ruby
+
+        puts "Hello"
+        \"\"\"
+        Then the output should contain exactly "Hello"
+
+      Scenario: Running python script
+        When I run the following script:
+        \"\"\"bash
+        #!/usr/bin/env python
+
+        print("Hello")
+        \"\"\"
+        Then the output should contain exactly "Hello"
+    """
+    When I run `cucumber`
+    Then the features should all pass
+
+  Scenario: Running shell commands
+    Given a file named "features/shell.feature" with:
+    """
+    Feature: Running scripts
+      Scenario: Running shell commands
+        When I run the following commands:
+        \"\"\"bash
+        echo "Hello shell"
+        \"\"\"
+        Then the output should contain exactly "Hello shell"
+    """
+    When I run `cucumber`
+    Then the features should all pass
+
+  Scenario: Running bash commands
+    Given a file named "features/shell.feature" with:
+    """
+    Feature: Running scripts
+      Scenario: Running bash commands
+        When I run the following commands with `bash`:
+        \"\"\"bash
+        echo -n "Hello "
+        echo `echo bash` # subshell
+        \"\"\"
+        Then the output should contain exactly "Hello bash"
+    """
+    When I run `cucumber`
+    Then the features should all pass
+
+  Scenario: Running zsh commands
+    Given a file named "features/shell.feature" with:
+    """
+    Feature: Running zsh scripts
+      Scenario: Running zsh commands
+        When I run the following commands with `zsh`:
+        \"\"\"bash
+        echo "Hello \c"
+        echo $((2 + 2))
+        \"\"\"
+        Then the output should contain exactly "Hello 4"
+    """
+    When I run `cucumber`
+    Then the features should all pass
+
+  Scenario: Running ruby commands
+    Given a file named "features/shell.feature" with:
+    """
+    Feature: Running scripts
+      Scenario: Running ruby commands
+        When I run the following commands with `ruby`:
+        \"\"\"ruby
+        puts "Hello, Aruba!"
+        \"\"\"
+        Then the output should contain exactly "Hello, Aruba!"
+    """
+    When I run `cucumber`
+    Then the features should all pass
+
+  Scenario: Running python commands
+    Given a file named "features/shell.feature" with:
+    """
+    Feature: Running scripts
+      Scenario: Running ruby commands
+        When I run the following commands with `python`:
+        \"\"\"ruby
+        print("Hello, Aruba!")
+        \"\"\"
+        Then the output should contain exactly "Hello, Aruba!"
+    """
+    When I run `cucumber`
+    Then the features should all pass
+
+  Scenario: Running commands if full path to interpreter is given
+    Given a file named "features/shell.feature" with:
+    """
+    Feature: Running full path zsh
+      Scenario: Running zsh commands #1
+        When I run the following commands with `/bin/zsh`:
+        \"\"\"bash
+        echo "Hello \c"
+        echo $((6 - 2))
+        \"\"\"
+        Then the output should contain exactly "Hello 4"
+
+      Scenario: Running zsh commands #1
+        When I run the following commands in `/bin/zsh`:
+        \"\"\"bash
+        echo "Hello \c"
+        echo $((6 - 2))
+        \"\"\"
+        Then the output should contain exactly "Hello 4"
+    """
+    When I run `cucumber`
+    Then the features should all pass
+
+  Scenario: Running commands if only the name of interpreter is given
+    Given a file named "features/shell.feature" with:
+    """
+    Feature: Running full path zsh
+      Scenario: Running zsh commands #1
+        When I run the following commands with `zsh`:
+        \"\"\"bash
+        echo "Hello \c"
+        echo $((6 - 2))
+        \"\"\"
+        Then the output should contain exactly "Hello 4"
+
+      Scenario: Running zsh commands #2
+        When I run the following commands in `zsh`:
+        \"\"\"bash
+        echo "Hello \c"
+        echo $((6 - 2))
+        \"\"\"
+        Then the output should contain exactly "Hello 4"
+    """
+    When I run `cucumber`
+    Then the features should all pass