aruba 0.9.0 → 0.10.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f2e3003b3ecea3cf45cddaf06835c8ffe7268c6f
-  data.tar.gz: 8c01fda685c1a9900410307d833c22f2c8974000
+  metadata.gz: f28f6c27992873436132f1a1026bf1fefca105da
+  data.tar.gz: a84562c8730d436682f1e297e9a1f93e5875cc54
 SHA512:
-  metadata.gz: 5d36c1041b9b3e9133534c12e97e988bdfa790da359819a545f5081250e5c165a4c99f2731de036e387ad5a1cb48224df31f4959f4b58ca8f3f1eda936efc906
-  data.tar.gz: abc7f2b9dd945b80debf37586c7ac4f20632d8e01fdd87c3fc80e4c810b71b18cd830acd039ab3b8250af9fcf42bee18a168f3beb17eca2e94ae9154d8f89631
+  metadata.gz: 3cef82f178232a44414a87e5e4b8f1b7582974b4e1e1517defd7154343a5c21a59778951ef71116dae59ea76870924f9945d35f2e69894c637c4f36448a6a424
+  data.tar.gz: 8cdd376cb0f7f4d2d70e508135e6b679ec288a5cbd55c55ebbe7d58972da4261a9ccec084017ee1fe5f1cc736f9cc434f2357169fdabd7c2f212ed04a5a31646

data/.travis.yml

@@ -13,9 +13,15 @@ rvm:
 - jruby-21mode
 - jruby
 - rbx
+- jruby-9.0.0.0
+- jruby-9.0.0.0-20mode
+- jruby-9.0.0.0-21mode
 matrix:
   allow_failures:
   - rvm: rbx
+  - rvm: jrbuby-9.0.0.0
+  - rvm: jrbuby-9.0.0.0-20mode
+  - rvm: jrbuby-9.0.0.0-21mode
 notifications:
   email:
   - cukes-devs@googlegroups.com

data/Gemfile

@@ -75,6 +75,8 @@ group :development, :test do
     # Upload documentation
     gem 'relish', '~> 0.7.1'
   end
+
+  gem 'minitest', '~> 5.8.0'
 end
 
 platforms :rbx do

data/History.md

@@ -1,5 +1,28 @@
 # Latest Release
 
+## [v0.10.0.pre](https://github.com/cucumber/aruba/compare/v0.9.0...v0.10.0)
+
+* Add some new steps to make writing documentation easier using "cucumber",
+  "rspec", "minitest" together with "aruba" - see [Feature](features/getting_started/supported_testing_frameworks.feature)
+  for some examples
+* Write output of commands directly to disk if SpawnProcess is used (see https://github.com/cucumber/aruba/commit/85d74fcca4fff4e753776925d8b003cddaa8041d)
+* Refactored API of cucumber steps to reduce the need for more methods and make
+  it easier for users to write their own steps (issue #306)
+* Added `aruba init` to the cli command to setup environment for aruba (issue
+  #308)
+* Added new method `delete_environment_variable` to remove environment variable
+* Added work around because of method name conflict between Capybara and RSpec
+  (https://github.com/cucumber/aruba/commit/1939c4049d5195ffdd967485f50119bdd86e98a0)
+
+# Old releases
+
+## [v0.9.0](https://github.com/cucumber/aruba/compare/v0.9.0.pre2...v0.9.0)
+
+* Fix feature test
+* Fix ordering in console
+* Fix bug in console handling SIGINT
+* Deprecated Aruba/Reporting before we remove it
+
 ## [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
@@ -20,7 +43,6 @@
 * Now we make the process started via `SpawnProcess` the leader of the group to
   kill all sub-processes more reliably
 
-# Old releases
 
 ## [v0.9.0.pre](https://github.com/cucumber/aruba/compare/v0.8.1...v0.9.0.pre)
 

data/README.md

@@ -9,11 +9,11 @@ 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)
 
-`aruba` is an extension for popular TDD and BDD frameworks like "Cucumber" and "RSpec" to make testing of commandline applications meaningful, easy and fun.
+`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.
 
 Features at a glance:
 
-* Test any command line application, implemented in any programming language - e.g. Bash, Python, Ruby, Java
+* Test any command line application, implemented in any [programming language](features/getting_started/supported_programming_languages.feature) - e.g. Bash, Python, Ruby, Java, ...
 * Manipulate the file system and the process environment
 * Automatically reset state of file system and process environment between tests
 

data/aruba.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.name        = 'aruba'
   s.version     = Aruba::VERSION
   s.authors     = ["Aslak Hellesøy", "David Chelimsky", "Mike Sassak", "Matt Wynne", "Jarl Friis", "Dennis Günnewig"]
-  s.description = 'Extension for popular TDD and BDD frameworks like "Cucumber" and "RSpec" to make testing commandline applications meaningful, easy and fun.'
+  s.description = 'Extension for popular TDD and BDD frameworks like "Cucumber", "RSpec" and "Minitest" to make testing commandline applications meaningful, easy and fun.'
   s.summary     = "aruba-#{s.version}"
   s.license     = 'MIT'
   s.email       = 'cukes@googlegroups.com'

data/cucumber.yml

@@ -1,5 +1,8 @@
 <%
+$LOAD_PATH << ::File.expand_path('../lib', __FILE__)
+require 'aruba/version'
 require 'ffi'
+
 java_version = (RUBY_DESCRIPTION.match(/.*?on.*?(1\.[\d]\..*? )/))[1] if defined?(JRUBY_VERSION)
 
 std_opts          = "--color --exclude features/fixtures --require features --tags ~@unsupported-on"
@@ -16,6 +19,7 @@ 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 <<  '--tags ~@requires-aruba-version-1'        if Aruba::VERSION < '1'
 ignore_opts = ignore_opts.join(' ')
 %>
 default: <%= std_opts %> --tags ~@wip <%= java_default_opts %> <%= ignore_opts %>

data/features/api/command/run.feature

@@ -23,6 +23,24 @@ Feature: Run command
     When I run `rspec`
     Then the specs should all pass
 
+  Scenario: Relative path to executable
+    Given an executable named "bin/cli" with:
+    """bash
+    #!/bin/bash
+    exit 0
+    """
+    And a file named "spec/run_spec.rb" with:
+    """ruby
+    require 'spec_helper'
+
+    RSpec.describe 'Run command', :type => :aruba do
+      before(:each) { run('bin/cli') }
+      it { expect(last_command_started).to be_successfully_executed }
+    end
+    """
+    When I run `rspec`
+    Then the specs should all pass
+
   Scenario: Non-existing executable
     Given a file named "bin/cli" does not exist
     And a file named "spec/run_spec.rb" with:

data/features/api/environment/remove_environment_variable.feature

@@ -0,0 +1,63 @@
+Feature: Remove existing environment variable via API-method
+
+  It is quite handy to modify the environment of a process. To make this
+  possible, `aruba` provides several methods. One of these is
+  `#delete_environment_variable`. Using this remove an existing variable.
+
+  Background:
+    Given I use the fixture "cli-app"
+
+  Scenario: Non-existing variable
+    Given a file named "spec/environment_spec.rb" with:
+    """ruby
+    require 'spec_helper'
+
+    RSpec.describe 'Long running command', :type => :aruba do
+      before(:each) { delete_environment_variable 'LONG_LONG_VARIABLE' }
+
+      before(:each) { run('env') }
+      before(:each) { stop_all_commands }
+
+      it { expect(last_command_started.output).not_to include 'LONG_LONG_VARIABLE=1' }
+    end
+    """
+    When I run `rspec`
+    Then the specs should all pass
+
+  Scenario: Existing variable set from within the test
+    Given a file named "spec/environment_spec.rb" with:
+    """ruby
+    require 'spec_helper'
+
+    RSpec.describe 'Long running command', :type => :aruba do
+      before(:each) { set_environment_variable 'LONG_LONG_VARIABLE', '1' }
+      before(:each) { delete_environment_variable 'LONG_LONG_VARIABLE' }
+
+      before(:each) { run('env') }
+      before(:each) { stop_all_commands }
+
+      it { expect(last_command_started.output).not_to include 'LONG_LONG_VARIABLE' }
+    end
+    """
+    When I run `rspec`
+    Then the specs should all pass
+
+  Scenario: Existing variable set by some outer parent process
+
+    Given a file named "spec/environment_spec.rb" with:
+    """ruby
+    require 'spec_helper'
+
+    ENV['REALLY_LONG_LONG_VARIABLE'] = '1'
+
+    RSpec.describe 'Environment command', :type => :aruba do
+      before(:each) { delete_environment_variable 'REALLY_LONG_LONG_VARIABLE' }
+
+      before(:each) { run('env') }
+      before(:each) { stop_all_commands }
+
+      it { expect(last_command_started.output).not_to include 'REALLY_LONG_LONG_VARIABLE' }
+    end
+    """
+    When I run `rspec`
+    Then the specs should all pass

data/features/api/environment/set_environment_variable.feature

@@ -2,7 +2,7 @@ Feature: Set environment variable via API-method
 
   It is quite handy to modify the environment of a process. To make this
   possible, `aruba` provides several methods. One of these is
-  `#set_environment_variable`. Using this variable sets the value of a
+  `#set_environment_variable`. Using this sets the value of a
   non-existing variable and overwrites an existing value. Each variable name
   and each value is converted to a string. Otherwise `ruby` would complain
   about an invalid argument. To make use of a variable you can either use `#run`
@@ -17,7 +17,7 @@ Feature: Set environment variable via API-method
     """ruby
     require 'spec_helper'
 
-    RSpec.describe 'Long running command', :type => :aruba do
+    RSpec.describe 'Environment command', :type => :aruba do
       before(:each) { set_environment_variable 'LONG_LONG_VARIABLE', '1' }
 
       before(:each) { run('env') }
@@ -34,7 +34,7 @@ Feature: Set environment variable via API-method
     """ruby
     require 'spec_helper'
 
-    RSpec.describe 'Long running command', :type => :aruba do
+    RSpec.describe 'Environment command', :type => :aruba do
       before(:each) { set_environment_variable 'LONG_LONG_VARIABLE', '1' }
       before(:each) { set_environment_variable 'LONG_LONG_VARIABLE', '2' }
 
@@ -56,7 +56,7 @@ Feature: Set environment variable via API-method
 
     ENV['REALLY_LONG_LONG_VARIABLE'] = '1'
 
-    RSpec.describe 'Long running command', :type => :aruba do
+    RSpec.describe 'Environment command', :type => :aruba do
       before(:each) { set_environment_variable 'REALLY_LONG_LONG_VARIABLE', '2' }
 
       before(:each) { run('env') }
@@ -80,7 +80,7 @@ Feature: Set environment variable via API-method
 
     ENV['REALLY_LONG_LONG_VARIABLE'] = '1'
 
-    RSpec.describe 'Long running command', :type => :aruba do
+    RSpec.describe 'Environment command', :type => :aruba do
       before(:each) { set_environment_variable 'REALLY_LONG_LONG_VARIABLE', '2' }
 
       before(:each) { run('env') }
@@ -110,7 +110,7 @@ Feature: Set environment variable via API-method
 
     ENV['REALLY_LONG_LONG_VARIABLE'] = '1'
 
-    RSpec.describe 'Long running command', :type => :aruba do
+    RSpec.describe 'Environment command', :type => :aruba do
       before(:each) { set_environment_variable 'REALLY_LONG_LONG_VARIABLE', '2' }
 
       before(:each) { run('env') }
@@ -137,7 +137,7 @@ Feature: Set environment variable via API-method
     """ruby
     require 'spec_helper'
 
-    RSpec.describe 'Long running command', :type => :aruba do
+    RSpec.describe 'Environment command', :type => :aruba do
       before(:each) { set_environment_variable 'LONG_LONG_VARIABLE', '1' }
 
       describe 'Method XX' do
@@ -167,7 +167,7 @@ Feature: Set environment variable via API-method
 
     ENV['REALLY_LONG_LONG_VARIABLE'] = '1'
 
-    RSpec.describe 'Long running command', :type => :aruba do
+    RSpec.describe 'Environment command', :type => :aruba do
       before(:each) { set_environment_variable 'REALLY_LONG_LONG_VARIABLE', '2' }
 
       before(:each) { run('env') }
@@ -203,7 +203,7 @@ Feature: Set environment variable via API-method
     ENV['LONG_LONG_VARIABLE'] = '1'
     ENV['REALLY_LONG_LONG_VARIABLE'] = '1'
 
-    RSpec.describe 'Long running command', :type => :aruba do
+    RSpec.describe 'Environment command', :type => :aruba do
       it do
         with_environment 'REALLY_LONG_LONG_VARIABLE' => 2 do
           with_environment 'LONG_LONG_VARIABLE' => 3 do
@@ -230,7 +230,7 @@ Feature: Set environment variable via API-method
     """ruby
     require 'spec_helper'
 
-    RSpec.describe 'Long running command', :type => :aruba do
+    RSpec.describe 'Environment command', :type => :aruba do
       # Please mind :context. This is run BEFORE the `around`-hook
       before(:context) { set_environment_variable 'REALLY_LONG_LONG_VARIABLE', '1' }
 
@@ -267,3 +267,40 @@ Feature: Set environment variable via API-method
     """
     When I run `rspec`
     Then the specs should all pass
+
+  @unsupported-on-platform-windows
+  Scenario: Mixed-Case variable
+    Given a file named "spec/environment_spec.rb" with:
+    """ruby
+    require 'spec_helper'
+
+    RSpec.describe 'Environment command', :type => :aruba do
+      before(:each) { set_environment_variable 'long_LONG_VARIABLE', '1' }
+
+      before(:each) { run('env') }
+      before(:each) { stop_all_commands }
+
+      it { expect(last_command_started.output).to include 'long_LONG_VARIABLE=1' }
+    end
+    """
+    When I run `rspec`
+    Then the specs should all pass
+
+  @unsupported-on-platform-unix
+  @unsupported-on-platform-mac
+  Scenario: Mixed-Case variable
+    Given a file named "spec/environment_spec.rb" with:
+    """ruby
+    require 'spec_helper'
+
+    RSpec.describe 'Environment command', :type => :aruba do
+      before(:each) { set_environment_variable 'long_LONG_VARIABLE', '1' }
+
+      before(:each) { run('env') }
+      before(:each) { stop_all_commands }
+
+      it { expect(last_command_started.output).to include 'LONG_LONG_VARIABLE=1' }
+    end
+    """
+    When I run `rspec`
+    Then the specs should all pass

data/features/api/{command → text}/extract_text.feature

@@ -12,7 +12,7 @@ Feature: Extract text from output
     #!/bin/bash
     echo -n "\e[31mText"
     """
-    And a file named "spec/which_spec.rb" with:
+    And a file named "spec/extract_text_spec.rb" with:
     """
     require 'spec_helper'
 
@@ -32,7 +32,7 @@ Feature: Extract text from output
     #!/bin/bash
     echo -n "\033[31mText"
     """
-    And a file named "spec/which_spec.rb" with:
+    And a file named "spec/extract_text_spec.rb" with:
     """
     require 'spec_helper'
 
@@ -46,33 +46,13 @@ Feature: Extract text from output
     When I run `rspec`
     Then the specs should all pass
 
-    # Scenario: Output contains ansi escape codes enclosed by \[\]
-    #   Given an executable named "bin/cli" with:
-    #   """
-    #   #!/bin/bash
-    #   echo -n "\[\033[31m\]Text"
-    #   """
-    #   And a file named "spec/which_spec.rb" with:
-    #   """
-    #   require 'spec_helper'
-    # 
-    #   RSpec.describe 'Run command', :type => :aruba do
-    #     before(:each) { run('cli') }
-    #     before(:each) { stop_all_commands }
-    #
-    #     it { expect(extract_text(unescape_text(last_command.output))).to eq "Text" }
-    #   end
-    #   """
-    #   When I run `rspec`
-    #   Then the specs should all pass
-
     # Scenario: Output contains ansi escape code \016
     #   Given an executable named "bin/cli" with:
     #   """
     #   #!/bin/bash
     #   echo -n "\016Text"
     #   """
-    #   And a file named "spec/which_spec.rb" with:
+    #   And a file named "spec/extract_text_spec.rb" with:
     #   """
     #   require 'spec_helper'
     #
@@ -92,7 +72,7 @@ Feature: Extract text from output
     #   #!/bin/bash
     #   echo -n "\017Text"
     #   """
-    #   And a file named "spec/which_spec.rb" with:
+    #   And a file named "spec/extract_text_spec.rb" with:
     #   """
     #   require 'spec_helper'
     #

data/features/api/text/sanitize_text.feature

@@ -0,0 +1,228 @@
+Feature: Sanitize text from output
+
+  If have got some text include \n, \t and the like and need them to become
+  special characters again and also want the text to be stripped down to bare
+  text, you can use the `#sanitize_text`-method for this.
+
+  Background:
+    Given I use a fixture named "cli-app"
+
+  Scenario: Output contains \n
+    Given an executable named "bin/cli" with:
+    """
+    #!/bin/bash
+    echo -n 'text\ntext'
+    """
+    And a file named "spec/sanitize_spec.rb" with:
+    """
+    require 'spec_helper'
+
+    RSpec.describe 'Run command', :type => :aruba do
+      before(:each) { run('cli') }
+      before(:each) { stop_all_commands }
+
+      it { expect(sanitize_text(last_command_started.output)).to eq "text\ntext" }
+    end
+    """
+    When I run `rspec`
+    Then the specs should all pass
+
+  Scenario: Output contains \e
+    Given an executable named "bin/cli" with:
+    """
+    #!/bin/bash
+    echo -n 'text\etext'
+    """
+    And a file named "spec/sanitize_spec.rb" with:
+    """
+    require 'spec_helper'
+
+    RSpec.describe 'Run command', :type => :aruba do
+      before(:each) { run('cli') }
+      before(:each) { stop_all_commands }
+
+      it { expect(sanitize_text(last_command_started.output)).to eq "texttext" }
+    end
+    """
+    When I run `rspec`
+    Then the specs should all pass
+
+  Scenario: Output contains \"
+    Given an executable named "bin/cli" with:
+    """
+    #!/bin/bash
+    echo -n 'text\"text'
+    """
+    And a file named "spec/sanitize_spec.rb" with:
+    """
+    require 'spec_helper'
+
+    RSpec.describe 'Run command', :type => :aruba do
+      before(:each) { run('cli') }
+      before(:each) { stop_all_commands }
+
+      it { expect(sanitize_text(last_command_started.output)).to eq "text\"text" }
+    end
+    """
+    When I run `rspec`
+    Then the specs should all pass
+
+  Scenario: Output contains \033
+    Given an executable named "bin/cli" with:
+    """
+    #!/bin/bash
+    echo -n 'text\033text'
+    """
+    And a file named "spec/sanitize_spec.rb" with:
+    """
+    require 'spec_helper'
+
+    RSpec.describe 'Run command', :type => :aruba do
+      before(:each) { run('cli') }
+      before(:each) { stop_all_commands }
+
+      it { expect(sanitize_text(last_command_started.output)).to eq "texttext" }
+    end
+    """
+    When I run `rspec`
+    Then the specs should all pass
+
+  Scenario: Output contains \017
+    Given an executable named "bin/cli" with:
+    """
+    #!/bin/bash
+    echo -n 'text\017text'
+    """
+    And a file named "spec/sanitize_spec.rb" with:
+    """
+    require 'spec_helper'
+
+    RSpec.describe 'Run command', :type => :aruba do
+      before(:each) { run('cli') }
+      before(:each) { stop_all_commands }
+
+      it { expect(sanitize_text(last_command_started.output)).to eq "texttext" }
+    end
+    """
+    When I run `rspec`
+    Then the specs should all pass
+
+  Scenario: Output contains \016
+    Given an executable named "bin/cli" with:
+    """
+    #!/bin/bash
+    echo -n 'text\016text'
+    """
+    And a file named "spec/sanitize_spec.rb" with:
+    """
+    require 'spec_helper'
+
+    RSpec.describe 'Run command', :type => :aruba do
+      before(:each) { run('cli') }
+      before(:each) { stop_all_commands }
+
+      it { expect(sanitize_text(last_command_started.output)).to eq "texttext" }
+    end
+    """
+    When I run `rspec`
+    Then the specs should all pass
+
+  Scenario: Output contains ansi escape codes prefixed by \e
+    Given an executable named "bin/cli" with:
+    """
+    #!/bin/bash
+    echo -n "\e[31mText"
+    """
+    And a file named "spec/sanitize_spec.rb" with:
+    """
+    require 'spec_helper'
+
+    RSpec.describe 'Run command', :type => :aruba do
+      before(:each) { run('cli') }
+      before(:each) { stop_all_commands }
+
+      it { expect(sanitize_text(last_command_started.output)).to eq "Text" }
+    end
+    """
+    When I run `rspec`
+    Then the specs should all pass
+
+  Scenario: Output contains ansi escape codes prefixed by \033
+    Given an executable named "bin/cli" with:
+    """
+    #!/bin/bash
+    echo -n "\033[31mText"
+    """
+    And a file named "spec/sanitize_spec.rb" with:
+    """
+    require 'spec_helper'
+
+    RSpec.describe 'Run command', :type => :aruba do
+      before(:each) { run('cli') }
+      before(:each) { stop_all_commands }
+
+      it { expect(sanitize_text(last_command_started.output)).to eq "Text" }
+    end
+    """
+    When I run `rspec`
+    Then the specs should all pass
+
+  Scenario: Output contains ansi escape codes prefixed by \e, but removable is disabled by configuration
+    Given an executable named "bin/cli" with:
+    """
+    #!/bin/bash
+    echo -n "\e[31mText"
+    """
+    And a file named "spec/sanitize_spec.rb" with:
+    """
+    require 'spec_helper'
+
+    RSpec.describe 'Run command', :type => :aruba, :remove_ansi_escape_sequences => false, :keep_ansi => true do
+      before(:each) { run('cli') }
+      before(:each) { stop_all_commands }
+
+      it { expect(sanitize_text(last_command_started.output)).to eq "\e[31mText" }
+    end
+    """
+    When I run `rspec`
+    Then the specs should all pass
+
+    # Scenario: Output contains ansi escape code \016
+    #   Given an executable named "bin/cli" with:
+    #   """
+    #   #!/bin/bash
+    #   echo -n "\016Text"
+    #   """
+    #   And a file named "spec/sanitize_spec.rb" with:
+    #   """
+    #   require 'spec_helper'
+    #
+    #   RSpec.describe 'Run command', :type => :aruba do
+    #     before(:each) { run('cli') }
+    #     before(:each) { stop_all_commands }
+    #
+    #     it { expect(sanitize_text(last_command_started.output)).to eq "Text" }
+    #   end
+    #   """
+    #   When I run `rspec`
+    #   Then the specs should all pass
+
+    # Scenario: Output contains ansi escape code \017
+    #   Given an executable named "bin/cli" with:
+    #   """
+    #   #!/bin/bash
+    #   echo -n "\017Text"
+    #   """
+    #   And a file named "spec/sanitize_spec.rb" with:
+    #   """
+    #   require 'spec_helper'
+    #
+    #   RSpec.describe 'Run command', :type => :aruba do
+    #     before(:each) { run('cli') }
+    #     before(:each) { stop_all_commands }
+    #
+    #     it { expect(sanitize_text(last_command_started.output)).to eq "Text" }
+    #   end
+    #   """
+    #   When I run `rspec`
+    #   Then the specs should all pass