aruba 0.11.1 → 0.11.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62427bdbd40bcd56afd8712d52200e7ade0a46a3
-  data.tar.gz: 1edaf0abe9e8d71651e9d891fe0f2a9dff81e5e8
+  metadata.gz: 640c6d6d67827e65e671ee40fea3fd3bd8b40138
+  data.tar.gz: a726ab79cf1c258322423cccbcb8ab325a5af0d6
 SHA512:
-  metadata.gz: 1576ea1206c4ab02384f227746e4344fc53a02278772a612e68aa16de5d62ada2f6da4406ff38c785ce84fe0409c8e512e0a20e12c5389fe1cd6ce652cbf7062
-  data.tar.gz: d7fc54d5f31c23b02073e6e1ea8879d2a7c7cca254cefc92504c9aac8835160310f36b3c9939c496b2facb99ebc234e51c62c87a424babfc0a89a2a8d6d8c012
+  metadata.gz: 6c061409af3d9b559ba62ad74c7dba3af505dfd87224b246a0ec4d7f11a1d82631e827ae0755eb93bbec0e0c6c12099ff634d3a90938edabf1029f4a0a572ec4
+  data.tar.gz: e05cb84b2085d874698c2aaf34b6d91f94005d421e5d22cefddfd3b65b9ee366d8ffde4f8315f0fa7232db7d89fba51d31923954776a5ef37ccee0d3afcf9163

data/.travis.yml

@@ -3,25 +3,32 @@ language: ruby
 script: script/test
 install: script/bootstrap --without development debug
 rvm:
-- 1.8.7
-- 1.9.2
-- 1.9.3
-- 2.0.0
-- 2.1.7
-- 2.2.3
-- jruby
-- jruby-20mode
-- jruby-21mode
-- jruby-9.0.0.0
-- jruby-9.0.0.0-20mode
-- jruby-9.0.0.0-21mode
-- rbx
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - 2.1.7
+  - 2.2.3
+  - jruby
+  - jruby-20mode
+  - jruby-21mode
+  - rbx
 matrix:
+  include:
+    - rvm: jruby-9.0.0.0
+      env: JRUBY_OPTS='--dev'
+    - rvm: jruby-9.0.0.0-20mode
+      env: JRUBY_OPTS='--dev'
+    - rvm: jruby-9.0.0.0-21mode
+      env: JRUBY_OPTS='--dev'
   allow_failures:
   - rvm: rbx
   - rvm: jruby-9.0.0.0
+    env: JRUBY_OPTS='--dev'
   - rvm: jruby-9.0.0.0-20mode
+    env: JRUBY_OPTS='--dev'
   - rvm: jruby-9.0.0.0-21mode
+    env: JRUBY_OPTS='--dev'
 notifications:
   email:
     - cukes-devs@googlegroups.com
@@ -31,4 +38,5 @@ notifications:
 env:
   global:
    - secure: l8uznA5K4K9mZ1krmP3lTMD8WcJ32qGxFOR3jubKHcOBSLB4xSzU2aIqjyJdO+rLzebkwamhJc8pGSIWOUDQYvFiX7splK+uEkbBJ5huAhXtLF4Qgl86bCWbEXYzN7rvn0DQfpJAovyFMNRMnfo70XhwqWzFsaYa7Z0YbqYsJE4=
-   - JRUBY_OPTS='--dev -X-C -Xcli.debug=true --debug
+   # - JRUBY_OPTS='-Xcli.debug=true --debug'
+   - JRUBY_OPTS='--dev'

data/History.md

@@ -1,26 +1,30 @@
 # Latest Release
 
-## [v0.11.1](https://github.com/cucumber/aruba/compare/v0.11.pre4...v0.11.1)
+## [v0.11.2](https://github.com/cucumber/aruba/compare/v0.11.1...v0.11.2)
 
-* Use fixed version of event-bus
-* Refactored and improved documentation (feature tests) in PR #309
+* Fixed problem with positional arguments in `#run_simple()` (issue #322)
 
 # Old releases
 
-## [v0.11.0](https://github.com/cucumber/aruba/compare/v0.11.pre4...v0.11.0)
+## [v0.11.1](https://github.com/cucumber/aruba/compare/v0.11.0...v0.11.1)
+
+* Use fixed version of event-bus
+* Refactored and improved documentation (feature tests) in PR #309
+
+## [v0.11.0](https://github.com/cucumber/aruba/compare/v0.11.0.pre4...v0.11.0)
 
 * Accidently pushed to rubygems.org - yanked it afterwards
 
-## [v0.11.0.pre4](https://github.com/cucumber/aruba/compare/v0.11.pre3...v0.11.0.pre4)
+## [v0.11.0.pre4](https://github.com/cucumber/aruba/compare/v0.11.0.pre3...v0.11.0.pre4)
 
 * Fixed syntax for Hash on ruby 1.8.7
 * Reorder rubies in .travis.yml
 
-## [v0.11.0.pre3](https://github.com/cucumber/aruba/compare/v0.11.pre2...v0.11.0.pre3)
+## [v0.11.0.pre3](https://github.com/cucumber/aruba/compare/v0.11.0.pre2...v0.11.0.pre3)
 
 * Fixed syntax for proc on ruby 1.8.7
 
-## [v0.11.0.pre2](https://github.com/cucumber/aruba/compare/v0.11.pre...v0.11.0.pre2)
+## [v0.11.0.pre2](https://github.com/cucumber/aruba/compare/v0.11.0.pre...v0.11.0.pre2)
 
 * Integrate `EventBus` to decouple announcers from starting, stopping commands
   etc. This uses nearly the same implementation like `cucumber`. (PR #309)

data/README.md

@@ -7,7 +7,7 @@ Build status:
 
 Linux / OS X  | Windows
 ------------- | -------------
-[![Build Status](https://travis-ci.org/cucumber/aruba.svg)](http://travis-ci.org/cucumber/aruba) | [![Build status](https://ci.appveyor.com/api/projects/status/jfo2tkqhnrqqcivl?svg=true)](https://ci.appveyor.com/project/cucumberbdd/aruba/branch/master)
+[![Build Status](https://travis-ci.org/cucumber/aruba.svg?branch=master)](https://travis-ci.org/cucumber/aruba) | [![Build status](https://ci.appveyor.com/api/projects/status/jfo2tkqhnrqqcivl?svg=true)](https://ci.appveyor.com/project/cucumberbdd/aruba/branch/master)
 
 `aruba` is an extension for popular TDD and BDD frameworks like "Cucumber", "RSpec" and "Minitest" to make testing of commandline applications meaningful, easy and fun.
 
@@ -43,48 +43,142 @@ For an up to date list of all supported ruby versions, please see our [`.travis.
 
 ## Usage
 
+Please also see this
+[feature test](https://github.com/cucumber/aruba/blob/master/features/getting_started/supported_testing_frameworks.feature)
+for the most up to date documentation.
+
+### Initialize your project with "aruba"
+
+There's an initializer to make it easier for you to getting started. If you
+prefer to setup `aruba` yourself, please move on to the next section.
+
+1. Go to your project's directory
+
+2. Make sure, it's under version control and all changes are committed to your
+   version control repository
+
+3. Run one of the following commands depending on the tools you use to test your project.
+
+   This assumes, that you use either `rspec`, `cucumber-ruby` or `minitest` to
+   write the tests for your project. Besides that, your tool can be implemented
+   in any programming language you like.
+
+   ~~~bash
+   aruba init --test-framework rspec
+   aruba init --test-framework cucumber
+   aruba init --test-framework minitest
+   ~~~
+
 ### Cucumber
 
-To use `aruba` with cucumber, `require` the library in one of your ruby files
-under `features/support` (e.g. `env.rb`)
+1. Create a file named "features/support/env.rb" with:
+
+   ~~~ruby
+   require 'aruba/cucumber'
+   ~~~
 
-```ruby
-require 'aruba/cucumber'
-```
+2. Create a file named "features/use_aruba_with_cucumber.feature" with:
 
-You now have a bunch of step definitions that you can use in your features. Look at [`lib/aruba/cucumber.rb`](lib/aruba/cucumber.rb)
-to see them all. Look at [`features/*.feature`](features/) for examples (which are also testing Aruba
-itself).
+   ~~~ruby
+   Feature: Cucumber
+     Scenario: First Run
+       Given a file named "file.txt" with:
+       """
+       Hello World
+       """
+       Then the file "file.txt" should contain:
+       """
+       Hello World
+       """
+   ~~~
+
+3. Run `cucumber`
 
 ### RSpec
 
-Originally written for `cucumber`, `aruba` can be helpful in other contexts as
-well. One might want to use it together with `rspec`.
+1. Create a file named "spec/support/aruba.rb" with:
+
+   ~~~ruby
+   require 'aruba/rspec'
+   ~~~
+
+2. Create a file named "spec/spec_helper.rb" with:
+
+   ~~~ruby
+   $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+   if RUBY_VERSION < '1.9.3'
+     ::Dir.glob(::File.expand_path('../support/**/*.rb', __FILE__)).each { |f| require File.join(File.dirname(f), File.basename(f, '.rb')) }
+   else
+     ::Dir.glob(::File.expand_path('../support/**/*.rb', __FILE__)).each { |f| require_relative f }
+   end
+   ~~~
 
-1. Create a directory named `spec/support`
-2. Create a file named `spec/support/aruba.rb` with:
+3. Create a file named named "spec/use_aruba_with_rspec_spec.rb" with:
 
-  ```ruby
-  require 'aruba/rspec'
-  ```
+   ~~~ruby
+   require 'spec_helper'
 
-3. Add the following to your `spec/spec_helper.rb`
+   RSpec.describe 'First Run', :type => :aruba do
+     let(:file) { 'file.txt' }
+     let(:content) { 'Hello World' }
 
-  ```ruby
-  Dir.glob(::File.expand_path('../support/*.rb', __FILE__)).each { |f| require_relative f }
-  ```
+     before(:each) { write_file file, content }
 
-4. Add a type to your specs
+     it { expect(read(file)).to eq [content] }
+   end
+   ~~~
 
-  ```ruby
-  RSpec.describe 'My feature', type: :aruba do
-    # [...]
-  end
-  ```
+4. Run `rspec`
 
 ### Minitest
 
-TBD :-)
+1. Add a file named "test/support/aruba.rb" with:
+
+   ~~~ ruby
+   require 'aruba/api'
+   ~~~
+
+2. Add a file named "test/test_helper.rb" with:
+
+   ~~~ruby
+   $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+   if RUBY_VERSION < '1.9.3'
+     ::Dir.glob(::File.expand_path('../support/**/*.rb', __FILE__)).each { |f| require File.join(File.dirname(f), File.basename(f, '.rb')) }
+   else
+     ::Dir.glob(::File.expand_path('../support/**/*.rb', __FILE__)).each { |f| require_relative f }
+   end
+   ~~~
+
+3. Add a file named "test/use_aruba_with_minitest.rb" with:
+
+   ~~~ruby
+   $LOAD_PATH.unshift File.expand_path('../test', __FILE__)
+
+   require 'test_helper'
+   require 'minitest/autorun'
+
+   class FirstRun < Minitest::Test
+     include Aruba::Api
+
+     def setup
+       aruba_setup
+     end
+
+     def getting_started_with_aruba
+       file = 'file.txt'
+       content = 'Hello World' 
+
+       write_file file, content
+       read(file).must_equal [content]
+     end
+   end
+   ~~~
+
+4. Run your tests
+
+   `ruby -Ilib:test test/use_aruba_with_minitest.rb`
 
 ## Documentation
 

data/features/api/command/find_command.feature

@@ -5,7 +5,7 @@ Feature: Find a started command
   Background:
     Given I use a fixture named "cli-app"
 
-  Scenario: Exising command
+  Scenario: Existing command
     Given a file named "spec/run_spec.rb" with:
     """ruby
     require 'spec_helper'
@@ -23,7 +23,7 @@ Feature: Find a started command
     When I run `rspec`
     Then the specs should all pass
 
-  Scenario: Non-Exising command
+  Scenario: Non-Existing command
     Given a file named "spec/run_spec.rb" with:
     """ruby
     require 'spec_helper'

data/features/api/command/run_simple.feature

@@ -0,0 +1,207 @@
+Feature: Run command
+
+  To run a command use the `#run`-method. There are some configuration options
+  which are relevant here:
+
+  - `fail_on_error`:
+
+    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"
+
+  Scenario: Require executable to succeed (by default value)
+    Given an executable named "bin/cli" with:
+    """bash
+    #!/bin/bash
+    exit 1
+    """
+    And a file named "spec/run_spec.rb" with:
+    """ruby
+    require 'spec_helper'
+
+    RSpec.describe 'Run command', :type => :aruba do
+      it { expect { run_simple('cli') }.to raise_error RSpec::Expectations::ExpectationNotMetError }
+    end
+    """
+    When I run `rspec`
+    Then the specs should all pass
+
+  Scenario: Require executable to succeed (set by option)
+    Given an executable named "bin/cli" with:
+    """bash
+    #!/bin/bash
+    exit 1
+    """
+    And a file named "spec/run_spec.rb" with:
+    """ruby
+    require 'spec_helper'
+
+    RSpec.describe 'Run command', :type => :aruba do
+      it { expect { run_simple('cli', :fail_on_error => true) }.to raise_error }
+    end
+    """
+    When I run `rspec`
+    Then the specs should all pass
+
+  Scenario: Require executable to succeed (set by option, deprecated)
+    Given an executable named "bin/cli" with:
+    """bash
+    #!/bin/bash
+    exit 1
+    """
+    And a file named "spec/run_spec.rb" with:
+    """ruby
+    require 'spec_helper'
+
+    RSpec.describe 'Run command', :type => :aruba do
+      it { expect { run_simple('cli', true) }.to raise_error }
+    end
+    """
+    When I run `rspec`
+    Then the specs should all pass
+
+  Scenario: Ignore failure of executable (set by option)
+    Given an executable named "bin/cli" with:
+    """bash
+    #!/bin/bash
+    exit 1
+    """
+    And a file named "spec/run_spec.rb" with:
+    """ruby
+    require 'spec_helper'
+
+    RSpec.describe 'Run command', :type => :aruba do
+      it { expect { run_simple('cli', :fail_on_error => false) }.not_to raise_error }
+    end
+    """
+    When I run `rspec`
+    Then the specs should all pass
+
+  Scenario: Ignore failure of executable (set by option, deprecated)
+    Given an executable named "bin/cli" with:
+    """bash
+    #!/bin/bash
+    exit 1
+    """
+    And a file named "spec/run_spec.rb" with:
+    """ruby
+    require 'spec_helper'
+
+    RSpec.describe 'Run command', :type => :aruba do
+      it { expect { run_simple('cli', false) }.not_to raise_error }
+    end
+    """
+    When I run `rspec`
+    Then the specs should all pass
+
+  Scenario: Command with long startup phase
+
+    If you have got a command with a long startup phase or use `ruby` together
+    with `bundler`, you should consider using the `startup_wait_time`-option.
+    Otherwise methods like `#send_signal` don't work since they require the
+    command to be running and have setup it's signal handler.
+
+    Given an executable named "bin/cli" with:
+    """bash
+    #!/usr/bin/env bash
+ 
+    function initialize_script {
+      sleep 2
+    }
+
+    function do_some_work {
+      echo "Hello, Aruba is working"
+    }
+
+    initialize_script
+    do_some_work
+
+    exit 0
+    """
+    And a file named "spec/run_spec.rb" with:
+    """ruby
+    require 'spec_helper'
+
+    RSpec.describe 'Run command', :type => :aruba, :exit_timeout => 1, :startup_wait_time => 2 do
+      before(:each) { run_simple('cli') }
+
+      it { expect(last_command_started).to be_successfully_executed }
+      it { expect(last_command_started).to have_output /Hello, Aruba is working/ }
+    end
+    """
+    When I run `rspec`
+    Then the specs should all pass
+
+  Scenario: Long running command
+
+    If you have got a "long running" command, you should consider using the
+    `exit_timeout`-option.
+
+    Given an executable named "bin/cli" with:
+    """bash
+    #!/usr/bin/env bash
+
+    function do_some_work {
+      sleep 2
+      echo "Hello, Aruba here"
+    }
+
+    do_some_work
+    """
+    And a file named "spec/run_spec.rb" with:
+    """ruby
+    require 'spec_helper'
+
+    RSpec.describe 'Run command', :type => :aruba, :exit_timeout => 3 do
+      before(:each) { run_simple('cli') }
+
+      it { expect(last_command_started).to be_successfully_executed }
+      it { expect(last_command_started).to have_output /Hello, Aruba here/ }
+    end
+    """
+    When I run `rspec`
+    Then the specs should all pass
+
+  Scenario: Sending signals to commands started with `#run_simple()`
+
+    Sending signals to a command which is started by
+    `#run_simple()` does not make sense. The command is stopped internally when
+    its exit status is checked.
+
+    Given an executable named "bin/cli" with:
+    """bash
+    #!/usr/bin/env bash
+
+    function initialize_script {
+      sleep 1
+    }
+
+    function cleanup_script {
+      sleep 1
+    }
+
+    function do_some_work {
+      echo "Hello, Aruba is working"
+    }
+
+    trap stop_script TERM
+
+    initialize_script
+    do_some_work
+    cleanup_script
+    exit 0
+    """
+    And a file named "spec/run_spec.rb" with:
+    """ruby
+    require 'spec_helper'
+
+    RSpec.describe 'Run command', :type => :aruba, :exit_timeout => 2, :startup_wait_time => 1 do
+      before(:each) { run_simple('cli') }
+      it { expect { last_command_started.send_signal 'HUP' }.to raise_error Aruba::CommandAlreadyStoppedError }
+    end
+    """
+    When I run `rspec`
+    Then the specs should all pass

data/lib/aruba/api/command.rb

@@ -144,19 +144,19 @@ module Aruba
         if args.last.is_a? Hash
           opts = args.pop
 
-          exit_timeout      = opts.fetch(:exit_timeout, aruba.config.exit_timeout)
-          io_wait_timeout   = opts.fetch(:io_wait_timeout, aruba.config.io_wait_timeout)
-          stop_signal       = opts.fetch(:stop_signal, aruba.config.stop_signal)
-          startup_wait_time = opts.fetch(:startup_wait_time, aruba.config.startup_wait_time)
+          exit_timeout      = opts[:exit_timeout].nil? ? aruba.config.exit_timeout : opts[:exit_timeout]
+          io_wait_timeout   = opts[:io_wait_timeout].nil? ? aruba.config.io_wait_timeout : opts[:io_wait_timeout]
+          stop_signal       = opts[:stop_signal].nil? ? aruba.config.stop_signal : opts[:stop_signal]
+          startup_wait_time = opts[:startup_wait_time].nil? ? aruba.config.startup_wait_time : opts[:startup_wait_time]
         else
           if args.size > 1
             Aruba.platform.deprecated("Please pass options to `#run` as named parameters/hash and don\'t use the old style, e.g. `#run('cmd', :exit_timeout => 5)`.")
           end
 
-          exit_timeout      = args[0] || aruba.config.exit_timeout
-          io_wait_timeout   = args[1] || aruba.config.io_wait_timeout
-          stop_signal       = args[2] || aruba.config.stop_signal
-          startup_wait_time = args[3] || aruba.config.startup_wait_time
+          exit_timeout      = args[0].nil? ? aruba.config.exit_timeout : args[0]
+          io_wait_timeout   = args[1].nil? ? aruba.config.io_wait_timeout : args[1]
+          stop_signal       = args[2].nil? ? aruba.config.stop_signal : args[2]
+          startup_wait_time = args[3].nil? ? aruba.config.startup_wait_time : args[3]
         end
 
         cmd = replace_variables(cmd)
@@ -257,10 +257,7 @@ module Aruba
 
         if args.last.is_a? Hash
           opts = args.pop
-
-          fail_on_error   = opts.fetch(:fail_on_error, false) || false
-          exit_timeout    = opts.fetch(:exit_timeout, aruba.config.exit_timeout) || aruba.config.exit_timeout
-          io_wait_timeout = opts.fetch(:io_wait_timeout, aruba.config.io_wait_timeout) || aruba.config.io_wait_timeout
+          fail_on_error = opts.delete(:fail_on_error) == true ? true : false
         else
           if args.size > 1
             # rubocop:disable Metrics/LineLength
@@ -268,12 +265,17 @@ module Aruba
             # rubocop:enable Metrics/LineLength
           end
 
-          fail_on_error     = args[0] || true
-          exit_timeout      = args[1] || aruba.config.exit_timeout
-          io_wait_timeout   = args[2] || aruba.config.io_wait_timeout
+          fail_on_error = args[0] == false ? false : true
+
+          opts = {
+            :exit_timeout      => (args[1] || aruba.config.exit_timeout),
+            :io_wait_timeout   => (args[2] || aruba.config.io_wait_timeout),
+            :stop_signal       => (args[3] || aruba.config.stop_signal),
+            :startup_wait_time => (args[4] || aruba.config.startup_wait_time)
+          }
         end
 
-        command = run(cmd, :exit_timeout => exit_timeout, :io_wait_timeout => io_wait_timeout)
+        command = run(cmd, opts)
         command.stop
 
         if Aruba::VERSION < '1'

data/lib/aruba/version.rb

@@ -1,3 +1,3 @@
 module Aruba
-  VERSION = '0.11.1'
+  VERSION = '0.11.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aruba
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.11.2
 platform: ruby
 authors:
 - Aslak Hellesøy
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-27 00:00:00.000000000 Z
+date: 2015-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -160,6 +160,7 @@ files:
 - features/api/command/last_command_started.feature
 - features/api/command/last_command_stopped.feature
 - features/api/command/run.feature
+- features/api/command/run_simple.feature
 - features/api/command/send_signal.feature
 - features/api/command/stop.feature
 - features/api/command/stop_all_commands.feature
@@ -471,12 +472,13 @@ rubyforge_project:
 rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
-summary: aruba-0.11.1
+summary: aruba-0.11.2
 test_files:
 - features/api/command/find_command.feature
 - features/api/command/last_command_started.feature
 - features/api/command/last_command_stopped.feature
 - features/api/command/run.feature
+- features/api/command/run_simple.feature
 - features/api/command/send_signal.feature
 - features/api/command/stop.feature
 - features/api/command/stop_all_commands.feature