aruba 0.10.2 → 0.11.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ce4f4fe54f79eca8c6cfc08194256c53dd705c0b
-  data.tar.gz: 051de04325eb5ea8d638c23f8ea72740ede9ff72
+  metadata.gz: d0d970f3502a082de16bb266924f0c7900377b76
+  data.tar.gz: 011f90e024a29624795ad9883d29b8547c3fdeda
 SHA512:
-  metadata.gz: bc5656959786aaf00ad27c1215309176bfbf3dd07693ccd23c96305eb34fb185d663a933645d04907d3722d022b186f0f9356c427be612d75825f1bd3dfc113c
-  data.tar.gz: 9d0a45ca8b640fcd8fed7df60d3480304f65069bc7b4c978834c1f448977aa11df024f6e00413f02f8a81cb44e9764c505c76caee8ab741639d4d014f062fb2d
+  metadata.gz: e769fd6414236a83911ef5e5c3a068ea88f8795d2de079ae140b834b452fc0a89167ff2e7466fed1a88c920105cd884652d791d5d246d20361da5fbe763f3faa
+  data.tar.gz: e2415039514fa5fa15ebf0649e13aaafaf339f77348c5a1167b792f08ea7c7c31ba37eb9af6cf1dae1f54cdb40634d90cc8a0dbc97479fd84a43b668a2e5f0ec

data/.travis.yml

@@ -3,8 +3,8 @@ language: ruby
 script: script/test
 install: script/bootstrap --without development debug
 rvm:
-- 2.2.2
-- 2.1.6
+- 2.2.3
+- 2.1.7
 - 2.0.0
 - 1.9.2
 - 1.9.3
@@ -24,9 +24,10 @@ matrix:
   - rvm: jruby-9.0.0.0-21mode
 notifications:
   email:
-  - cukes-devs@googlegroups.com
-  irc:
-  - irc.freenode.org#cucumber
+    - cukes-devs@googlegroups.com
+  webhooks:
+    urls:
+      - https://webhooks.gitter.im/e/d4d9080e2a8c4910f609
 env:
   global:
    - secure: l8uznA5K4K9mZ1krmP3lTMD8WcJ32qGxFOR3jubKHcOBSLB4xSzU2aIqjyJdO+rLzebkwamhJc8pGSIWOUDQYvFiX7splK+uEkbBJ5huAhXtLF4Qgl86bCWbEXYzN7rvn0DQfpJAovyFMNRMnfo70XhwqWzFsaYa7Z0YbqYsJE4=

data/Gemfile

@@ -15,10 +15,6 @@ group :debug do
     gem 'pry-debugger', '~> 0.2.3'
   end
 
-  if RUBY_VERSION >= '1.9.3' && !RUBY_PLATFORM.include?('java')
-    gem 'pry-stack_explorer', '~> 0.4.9'
-  end
-
   gem 'pry-doc', '~> 0.8.0'
 end
 

data/History.md

@@ -1,14 +1,30 @@
 # Latest Release
 
+## [v0.11.0.pre](https://github.com/cucumber/aruba/compare/v0.10.2...v0.11.0.pre)
+
+* Set stop signal which should be used to stop a process after a timeout or
+  used to terminate a process. This can be used to stop processes running
+  docker + "systemd". If you send a systemd-enable container SIGINT it will be
+  stopped.
+* Added a configurable amount of time after a command was started -
+  startup_wait_time. Otherwise you get problems when a process takes to long to
+  startup when you run in background and want to sent it a signal.
+* Replace `<variable>` in commandline, e.g. `<pid-last-command-started>`
+  [experimental]
+* Added announce formatter for time spans, e.g. `startup_wait_time`
+* All `*Process`-classes e.g. `BasicProcess`, `SpawnProcess` etc. are marked as
+  private. Users should use `#run('cmd')` and don't use the classes directly.
+
 ## [v0.10.2](https://github.com/cucumber/aruba/compare/v0.10.1...v0.10.2)
 
 * Fixed problem in regex after merge of step definitions
 
+# Old releases
+
 ## [v0.10.1](https://github.com/cucumber/aruba/compare/v0.10.0...v0.10.1)
 
 * Merged remove steps for file and directory from 4 into 2 step definitions
 
-# Old releases
 
 ## [v0.10.0](https://github.com/cucumber/aruba/compare/v0.10.0.pre2...v0.10.0)
 

data/features/api/command/run.feature

@@ -1,6 +1,24 @@
 Feature: Run command
 
-  To run a command use the `#run`-method.
+  To run a command use the `#run`-method. There are some configuration options
+  which are relevant here:
+
+  - `startup_wait_time`:
+
+    Given this option `aruba` waits n seconds after it started the command.
+    This is most useful when using `#run()` and not really makes sense for
+    `#run_simple()`.
+
+    You can use `#run()` + `startup_wait_time` to start background jobs.
+
+  - `exit_timeout`:
+
+    The exit timeout is used, when `aruba` waits for a command to finished.
+
+  - `io_wait_timeout`:
+
+    The io wait timeout is used, when you access `stdout` or `stderr` of a
+    command.
 
   Background:
     Given I use a fixture named "cli-app"
@@ -53,3 +71,85 @@ Feature: Run command
     """
     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"
+    }
+
+    function recurring_work {
+      echo "Hello, Aruba here"
+    }
+
+    function stop_script {
+      exit 0
+    }
+
+    trap recurring_work HUP
+    trap stop_script TERM
+
+    initialize_script
+    do_some_work
+
+    while [ true ]; do sleep 1; done
+    """
+    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('cli') }
+      before(:each) { last_command_started.send_signal 'HUP' }
+
+      it { expect(last_command_started).to be_successfully_executed }
+      it { expect(last_command_started).to have_output /Hello, Aruba is working/ }
+      it { expect(last_command_started).to have_output /Hello, Aruba here/ }
+
+    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('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

data/features/api/command/send_signal.feature

@@ -0,0 +1,53 @@
+Feature: Send running command a signal
+
+  You can send a running command a signal using
+  `last_command_started#send_signal`. This is only supported with
+  `aruba.config.command_launcher = :spawn` (default).
+
+  Background:
+    Given I use a fixture named "cli-app"
+
+  Scenario: Existing executable
+    Given an executable named "bin/cli" with:
+    """ruby
+    #!/usr/bin/env bash
+
+    function hup {
+      echo 'Exit...' >&2
+      exit 0
+    }
+
+    trap hup HUP
+
+    while [ true ]; do sleep 1; done
+    """
+    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 => 5 do
+      before(:each) { run('cli') }
+      before(:each) { last_command_started.send_signal 'HUP' }
+      it { expect(last_command_started).to have_output /Exit/ }
+    end
+    """
+    When I run `rspec`
+    Then the specs should all pass
+
+  Scenario: Dying command
+    Given an executable named "bin/cli" with:
+    """ruby
+    #!/usr/bin/env bash
+    exit 1
+    """
+    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 => 5 do
+      before(:each) { run('cli') }
+      it { expect { last_command_started.send_signal 'HUP' }.to raise_error Aruba::CommandAlreadyStoppedError, /Command "cli" with PID/ }
+    end
+    """
+    When I run `rspec`
+    Then the specs should all pass

data/features/api/command/stop.feature

@@ -0,0 +1,79 @@
+Feature: Stop command
+
+  To stop commands via API you can do the following:
+
+  - `last_command_started.stop`
+  - `stop_all_commands`
+
+  Background:
+    Given I use a fixture named "cli-app"
+
+  Scenario: Stop successful command with configured signal
+    Given an executable named "bin/cli" with:
+    """bash
+    #!/bin/bash
+    function hup {
+      echo "Exit..."
+      exit 0
+    }
+
+    function term {
+      echo "No! No exit here. Try HUP. I stop the command with exit 1."
+      exit 1
+    }
+
+    trap hup HUP
+    trap term TERM
+    while [ true ]; do sleep 1; done
+    """
+    And a file named "spec/run_spec.rb" with:
+    """ruby
+    require 'spec_helper'
+
+    Aruba.configure do |config|
+      config.stop_signal  = 'HUP'
+      config.exit_timeout = 1
+    end
+
+    RSpec.describe 'Run command', :type => :aruba do
+      before(:each) { run('cli') }
+      it { expect(last_command_started).to be_successfully_executed }
+    end
+    """
+    When I run `rspec`
+    Then the specs should all pass
+
+  Scenario: Stop unsuccessful command with configured signal
+    Given an executable named "bin/cli" with:
+    """bash
+    #!/bin/bash
+    function hup {
+      echo "Exit..."
+      exit 2
+    }
+
+    function term {
+      echo "No! No exit here. Try HUP. I stop the command with exit 1."
+      exit 1
+    }
+
+    trap hup HUP
+    trap term TERM
+    while [ true ]; do sleep 1; done
+    """
+    And a file named "spec/run_spec.rb" with:
+    """ruby
+    require 'spec_helper'
+
+    Aruba.configure do |config|
+      config.stop_signal  = 'HUP'
+      config.exit_timeout = 1
+    end
+
+    RSpec.describe 'Run command', :type => :aruba do
+      before(:each) { run('cli') }
+      it { expect(last_command_started).to have_exit_status 2 }
+    end
+    """
+    When I run `rspec`
+    Then the specs should all pass

data/features/api/text/replace_variables.feature

@@ -0,0 +1,45 @@
+@experimental
+Feature: Replace variables
+
+  There are use cases where you need access to some information from aruba in
+  your command line. The `#replace_variables`-method makes this information
+  available.
+
+  Please note, this feature is experimental for now. The implementation of this
+  feature and the name of variables may change without further notice.
+
+  Background:
+    Given I use a fixture named "cli-app"
+
+  Scenario: PID of last command started
+    Given an executable named "bin/cli" with:
+    """
+    #!/bin/bash
+    exit 0
+    """
+    And a file named "spec/replace_spec.rb" with:
+    """
+    require 'spec_helper'
+
+    RSpec.describe 'Run command', :type => :aruba do
+      before(:each) { run('cli') }
+      before(:each) { stop_all_commands }
+ 
+      it { expect(replace_variables('<pid-last-command-started>')).to eq last_command_started.pid.to_s }
+    end
+    """
+    When I run `rspec`
+    Then the specs should all pass
+
+  Scenario: No last command started
+    Given a file named "spec/replace_spec.rb" with:
+    """
+    require 'spec_helper'
+
+    RSpec.describe 'Run command', :type => :aruba do
+      it { expect(replace_variables('<pid-last-command-started>')).to eq '0' }
+    end
+    """
+    When I run `rspec`
+    Then the specs should all pass
+

data/features/configuration/startup_wait_time.feature

@@ -0,0 +1,48 @@
+Feature: Set time to wait after spawning command
+
+  As a developer
+  I want to configure a time span to wait after the command was spawned
+  In order to prevent failure of some commands which take a little bit longer
+  to load.
+
+
+  If you setup a ruby script, this may load bundler. This makes the script to
+  start up a little bit longer. If you want to run a command in background,
+  starting the command in a background process may take longer then sending it
+  a signal.
+
+  If you experience some brittle tests with background commands, try to set the
+  `#startup_wait_time`.
+
+  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.startup_wait_time}")
+    end
+    """
+    When I successfully run `cucumber`
+    Then the output should contain:
+    """
+    The default value is "0"
+    """
+
+  Scenario: Modify value
+    Given a file named "features/support/aruba.rb" with:
+    """ruby
+    Aruba.configure do |config|
+      config.startup_wait_time = 2
+    end
+
+    Aruba.configure do |config|
+      puts %(The new value is "#{config.startup_wait_time}")
+    end
+    """
+    Then I successfully run `cucumber`
+    Then the output should contain:
+    """
+    The new value is "2"
+    """

data/features/step_definitions/hooks.rb

@@ -1,17 +1,96 @@
 require 'cucumber/platform'
 
-Before '@requires-ruby-version-193' do
-  next unless RUBY_VERSION < '1.9.3'
+Before '@requires-ruby-version-193' do |scenario|
+  next if RUBY_VERSION >= '1.9.3'
 
   if Cucumber::VERSION < '2'
-    pending
+    scenario.skip_invoke!
   else
     skip_this_scenario
   end
 end
 
-Before '@requires-aruba-version-1' do
-  next unless Aruba::VERSION > '1'
+Before '@requires-ruby-version-19' do |scenario|
+  next if RUBY_VERSION >= '1.9'
 
-  skip_this_scenario if Cucumber::VERSION >= '2'
+  if Cucumber::VERSION < '2'
+    scenario.skip_invoke!
+  else
+    skip_this_scenario
+  end
+end
+
+Before '@requires-ruby-version-2' do |scenario|
+  next if RUBY_VERSION >= '2'
+
+  if Cucumber::VERSION < '2'
+    scenario.skip_invoke!
+  else
+    skip_this_scenario
+  end
+end
+
+Before '@requires-aruba-version-1' do |scenario|
+  next if Aruba::VERSION > '1'
+
+  if Cucumber::VERSION < '2'
+    scenario.skip_invoke!
+  else
+    skip_this_scenario
+  end
+end
+
+Before '@requires-ruby-platform-java' do |scenario|
+  # leave if java
+  next if RUBY_PLATFORM.include? 'java'
+
+  if Cucumber::VERSION < '2'
+    scenario.skip_invoke!
+  else
+    skip_this_scenario
+  end
+end
+
+Before '@requires-ruby-platform-mri' do |scenario|
+  # leave if not java
+  next unless RUBY_PLATFORM.include? 'java'
+
+  if Cucumber::VERSION < '2'
+    scenario.skip_invoke!
+  else
+    skip_this_scenario
+  end
+end
+
+Before '@unsupported-on-platform-windows' do |scenario|
+  # leave if not windows
+  next unless FFI::Platform.windows?
+
+  if Cucumber::VERSION < '2'
+    scenario.skip_invoke!
+  else
+    skip_this_scenario
+  end
+end
+
+Before '@unsupported-on-platform-unix' do |scenario|
+  # leave if not windows
+  next unless FFI::Platform.unix?
+
+  if Cucumber::VERSION < '2'
+    scenario.skip_invoke!
+  else
+    skip_this_scenario
+  end
+end
+
+Before '@unsupported-on-platform-mac' do |scenario|
+  # leave if not windows
+  next unless FFI::Platform.mac?
+
+  if Cucumber::VERSION < '2'
+    scenario.skip_invoke!
+  else
+    skip_this_scenario
+  end
 end