aruba 0.14.7 → 0.14.8

data/features/api/text/unescape_text.feature

@@ -17,7 +17,7 @@ Feature: Unescape special characters in text
     require 'spec_helper'
 
     RSpec.describe 'Run command', :type => :aruba do
-      before(:each) { run('cli') }
+      before(:each) { run_command('cli') }
       before(:each) { stop_all_commands }
 
       it { expect(unescape_text(last_command.output)).to eq "text\ntext" }
@@ -37,7 +37,7 @@ Feature: Unescape special characters in text
     require 'spec_helper'
 
     RSpec.describe 'Run command', :type => :aruba do
-      before(:each) { run('cli') }
+      before(:each) { run_command('cli') }
       before(:each) { stop_all_commands }
 
       it { expect(unescape_text(last_command.output)).to eq "texttext" }
@@ -57,7 +57,7 @@ Feature: Unescape special characters in text
     require 'spec_helper'
 
     RSpec.describe 'Run command', :type => :aruba do
-      before(:each) { run('cli') }
+      before(:each) { run_command('cli') }
       before(:each) { stop_all_commands }
 
       it { expect(unescape_text(last_command.output)).to eq "text\"text" }
@@ -77,7 +77,7 @@ Feature: Unescape special characters in text
     require 'spec_helper'
 
     RSpec.describe 'Run command', :type => :aruba do
-      before(:each) { run('cli') }
+      before(:each) { run_command('cli') }
       before(:each) { stop_all_commands }
 
       it { expect(unescape_text(last_command.output)).to eq "texttext" }
@@ -97,7 +97,7 @@ Feature: Unescape special characters in text
     require 'spec_helper'
 
     RSpec.describe 'Run command', :type => :aruba do
-      before(:each) { run('cli') }
+      before(:each) { run_command('cli') }
       before(:each) { stop_all_commands }
 
       it { expect(unescape_text(last_command.output)).to eq "texttext" }
@@ -117,7 +117,7 @@ Feature: Unescape special characters in text
     require 'spec_helper'
 
     RSpec.describe 'Run command', :type => :aruba do
-      before(:each) { run('cli') }
+      before(:each) { run_command('cli') }
       before(:each) { stop_all_commands }
 
       it { expect(unescape_text(last_command.output)).to eq "texttext" }

data/features/configuration/command_runtime_environment.feature

@@ -27,7 +27,7 @@ Feature: Define default process environment
     end
 
     RSpec.describe 'Environment command', :type => :aruba do
-      before(:each) { run('env') }
+      before(:each) { run_command('env') }
       before(:each) { stop_all_commands }
 
       it { expect(last_command_started.output).to include 'LONG_LONG_VARIABLE=x' }
@@ -50,7 +50,7 @@ Feature: Define default process environment
     RSpec.describe 'Environment command', :type => :aruba do
       before(:each) { set_environment_variable 'LONG_LONG_VARIABLE', 'z' }
 
-      before(:each) { run('env') }
+      before(:each) { run_command('env') }
       before(:each) { stop_all_commands }
 
       it { expect(last_command_started.output).to include 'LONG_LONG_VARIABLE=z' }
@@ -73,7 +73,7 @@ Feature: Define default process environment
     RSpec.describe 'Environment command', :type => :aruba do
       before(:each) { append_environment_variable 'LONG_LONG_VARIABLE', 'z' }
 
-      before(:each) { run('env') }
+      before(:each) { run_command('env') }
       before(:each) { stop_all_commands }
 
       it { expect(last_command_started.output).to include 'LONG_LONG_VARIABLE=xz' }
@@ -96,7 +96,7 @@ Feature: Define default process environment
     RSpec.describe 'Environment command', :type => :aruba do
       before(:each) { prepend_environment_variable 'LONG_LONG_VARIABLE', 'z' }
 
-      before(:each) { run('env') }
+      before(:each) { run_command('env') }
       before(:each) { stop_all_commands }
 
       it { expect(last_command_started.output).to include 'LONG_LONG_VARIABLE=zx' }
@@ -119,7 +119,7 @@ Feature: Define default process environment
     RSpec.describe 'Environment command', :type => :aruba do
       before(:each) { delete_environment_variable 'LONG_LONG_VARIABLE' }
 
-      before(:each) { run('env') }
+      before(:each) { run_command('env') }
       before(:each) { stop_all_commands }
 
       it { expect(last_command_started.output).not_to include 'LONG_LONG_VARIABLE' }

data/features/configuration/usage.feature

@@ -35,12 +35,12 @@ Feature: Usage of configuration
 
     RSpec.describe 'Run command', :type => :aruba do
       context 'when fast command' do
-        before(:each) { run('cli 0') }
+        before(:each) { run_command('cli 0') }
         it { expect(last_command_started).to be_successfully_executed }
       end
 
       context 'when slow command' do
-        before(:each) { run('cli 2') }
+        before(:each) { run_command('cli 2') }
         it { expect(last_command_started).not_to be_successfully_executed }
       end
     end
@@ -78,17 +78,17 @@ Feature: Usage of configuration
 
     RSpec.describe 'Run command', :type => :aruba do
       context 'when fast command' do
-        before(:each) { run('cli 0') }
+        before(:each) { run_command('cli 0') }
         it { expect(last_command_started).to be_successfully_executed }
       end
 
       context 'when slow command and this is known by the developer', :slow_command => true do
-        before(:each) { run('cli 2') }
+        before(:each) { run_command('cli 2') }
         it { expect(last_command_started).to be_successfully_executed }
       end
 
       context 'when slow command, but this might be a failure' do
-        before(:each) { run('cli 2') }
+        before(:each) { run_command('cli 2') }
         it { expect(last_command_started).not_to be_successfully_executed }
       end
     end

data/features/hooks/after/command.feature

@@ -32,7 +32,7 @@ Feature: After command hooks
     require 'spec_helper'
 
     RSpec.describe 'Hooks', :type => :aruba do
-      before(:each) { run_simple 'echo running' }
+      before(:each) { run_command_and_stop 'echo running' }
 
       it { expect(last_command_started.stdout.chomp).to eq 'running' }
     end

data/features/hooks/before/command.feature

@@ -34,7 +34,7 @@ Feature: before_cmd hooks
     require 'spec_helper'
 
     RSpec.describe 'Hooks', :type => :aruba do
-      before(:each) { run_simple 'echo running' }
+      before(:each) { run_command_and_stop 'echo running' }
 
       it { expect(last_command_started.stdout.chomp).to eq 'running' }
     end
@@ -62,7 +62,7 @@ Feature: before_cmd hooks
     require 'spec_helper'
 
     RSpec.describe 'Hooks', :type => :aruba do
-      before(:each) { run_simple 'echo running' }
+      before(:each) { run_command_and_stop 'echo running' }
 
       it { expect(last_command_started.stdout.chomp).to eq 'running' }
     end

data/features/matchers/timeouts.feature

@@ -18,7 +18,7 @@ Feature: Check if a timeout occured during command execution
     RSpec.describe 'Long running command', :type => :aruba do
       before(:each) { aruba.config.exit_timeout = 0 }
 
-      before(:each) { run('cli') }
+      before(:each) { run_command('cli') }
 
       it { expect(last_command_started).to run_too_long }
     end
@@ -39,7 +39,7 @@ Feature: Check if a timeout occured during command execution
     RSpec.describe 'Short running command', :type => :aruba do
       before(:each) { aruba.config.exit_timeout = 5 }
 
-      before(:each) { run('cli') }
+      before(:each) { run_command('cli') }
 
       it { expect(last_command_started).to have_finished_in_time }
     end

data/features/step_definitions/aruba_dev_steps.rb

@@ -51,6 +51,6 @@ Given(/^the default feature-test$/) do
 end
 
 Then(/^aruba should be installed on the local system$/) do
-  run('gem list aruba')
+  run_command('gem list aruba')
   expect(last_command_started).to have_output(/aruba/)
 end

data/lib/aruba/api.rb

@@ -6,7 +6,7 @@ require 'aruba/extensions/string/strip'
 
 require 'aruba/platform'
 require 'aruba/api/core'
-require 'aruba/api/command'
+require 'aruba/api/commands'
 
 if Aruba::VERSION <= '1.0.0'
   require 'aruba/api/deprecated'

data/lib/aruba/api/{command.rb → commands.rb}

@@ -136,8 +136,8 @@ module Aruba
       #
       # rubocop:disable Metrics/MethodLength
       # rubocop:disable Metrics/CyclomaticComplexity
-      def run(*args)
-        fail ArgumentError, 'Please pass at least a command as first argument.' if args.size < 1
+      def run_command(*args)
+        fail ArgumentError, 'Please pass at least a command as first argument.' if args.empty?
 
         cmd = args.shift
 
@@ -149,8 +149,9 @@ module Aruba
           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)`.")
+          if args.size > 0
+            Aruba.platform.deprecated(
+              "Please pass options to `#run_command` as named parameters/hash and don\'t use the old style, e.g. `#run_command('cmd', :exit_timeout => 5)`.")
           end
 
           exit_timeout      = args[0].nil? ? aruba.config.exit_timeout : args[0]
@@ -243,8 +244,8 @@ module Aruba
       #
       # rubocop:disable Metrics/CyclomaticComplexity
       # rubocop:disable Metrics/MethodLength
-      def run_simple(*args)
-        fail ArgumentError, 'Please pass at least a command as first argument.' if args.size < 1
+      def run_command_and_stop(*args)
+        fail ArgumentError, 'Please pass at least a command as first argument.' if args.empty?
 
         cmd = args.shift
 
@@ -252,9 +253,9 @@ module Aruba
           opts = args.pop
           fail_on_error = opts.delete(:fail_on_error) == true ? true : false
         else
-          if args.size > 1
+          if args.size > 0
             # rubocop:disable Metrics/LineLength
-            Aruba.platform.deprecated("Please pass options to `#run_simple` as named parameters/hash and don\'t use the old style with positional parameters, NEW: e.g. `#run_simple('cmd', :exit_timeout => 5)`.")
+            Aruba.platform.deprecated("Please pass options to `#run_command_and_stop` as named parameters/hash and don\'t use the old style with positional parameters, NEW: e.g. `#run_command_and_stop('cmd', :exit_timeout => 5)`.")
             # rubocop:enable Metrics/LineLength
           end
 
@@ -268,7 +269,7 @@ module Aruba
           }
         end
 
-        command = run(cmd, opts)
+        command = run_command(cmd, opts)
         command.stop
 
         if Aruba::VERSION < '1'

data/lib/aruba/api/deprecated.rb

@@ -116,13 +116,75 @@ module Aruba
       #   The command to by run
       #
       # @see #cmd
-      # @deprectated
+      # @deprecated
       def run_interactive(cmd)
-        Aruba.platform.deprecated('The use of "#run_interactive" is deprecated. You can simply use "run" instead')
+        Aruba.platform.deprecated('The use of "#run_interactive" is deprecated. You can simply use "run_command" instead')
+
+        run_command(cmd)
+      end
+
+      # Run given command and stop it if timeout is reached
+      #
+      # @param [String] cmd
+      #   The command which should be executed
+      #
+      # @param [Hash] opts
+      #   Options
+      #
+      # @option [Integer] exit_timeout
+      #   If the timeout is reached the command will be killed
+      #
+      # @option [Integer] io_wait_timeout
+      #   Wait for IO to finish
+      #
+      # @option [Integer] startup_wait_time
+      #   Wait for a command to start
+      #
+      # @option [String] stop_signal
+      #   Use signal to stop command
+      #
+      # @yield [SpawnProcess]
+      #   Run block with process
+      #
+      # @see #run_command
+      # @deprecated
+      def run(*args)
+        Aruba.platform.deprecated(
+          'The use of "#run" is deprecated. Use "run_command" instead')
+
+        run_command(*args)
+      end
 
-        run(cmd)
+      # Run a command with aruba
+      #
+      # Checks for error during command execution and checks the output to detect
+      # an timeout error.
+      #
+      # @param [String] cmd
+      #   The command to be executed
+      #
+      # @param [Hash] options
+      #   Options for aruba
+      #
+      # @option [TrueClass,FalseClass] fail_on_error
+      #   Should aruba fail on error?
+      #
+      # @option [Integer] exit_timeout
+      #   Timeout for execution
+      #
+      # @option [Integer] io_wait_timeout
+      #   Timeout for IO - STDERR, STDOUT
+      #
+      # rubocop:disable Metrics/CyclomaticComplexity
+      # rubocop:disable Metrics/MethodLength
+      def run_simple(*args)
+        Aruba.platform.deprecated(
+          'The use of "#run_simple" is deprecated. Use "run_command_and_stop" instead')
+
+        run_command_and_stop(*args)
       end
 
+
       # @deprecated
       # Create an empty file
       #
@@ -523,8 +585,6 @@ module Aruba
       end
 
       # @deprecated
-      # rubocop:disable Metrics/CyclomaticComplexity
-      # rubocop:disable Metrics/MethodLength
       def check_for_deprecated_variables
         if defined? @aruba_exit_timeout
           Aruba.platform.deprecated('The use of "@aruba_exit_timeout" is deprecated. Use "#aruba.config.exit_timeout = <numeric>" instead')
@@ -548,8 +608,6 @@ module Aruba
           aruba.config.root_directory = @aruba_root_directory.to_s
         end
       end
-      # rubocop:enable Metrics/CyclomaticComplexity
-      # rubocop:enable Metrics/MethodLength
 
       # Last command started
       def last_command

data/lib/aruba/api/rvm.rb

@@ -1,5 +1,5 @@
 require 'aruba/api/environment'
-require 'aruba/api/command'
+require 'aruba/api/commands'
 
 # Aruba
 module Aruba
@@ -16,7 +16,7 @@ module Aruba
       # @param [String] gemset
       #   The name of the gemset to be used
       def use_clean_gemset(gemset)
-        run_simple(%{rvm gemset create "#{gemset}"}, true)
+        run_command_and_stop(%{rvm gemset create "#{gemset}"}, true)
         if all_stdout =~ /'#{gemset}' gemset created \((.*)\)\./
           gem_home = Regexp.last_match[1]
           set_environment_variable('GEM_HOME', gem_home)
@@ -27,7 +27,7 @@ module Aruba
           paths.unshift(File.join(gem_home, 'bin'))
           set_environment_variable('PATH', paths.uniq.join(File::PATH_SEPARATOR))
 
-          run_simple("gem install bundler", true)
+          run_command_and_stop("gem install bundler", true)
         else
           raise "I didn't understand rvm's output: #{all_stdout}"
         end

data/lib/aruba/basic_configuration.rb

@@ -57,7 +57,6 @@ module Aruba
       # @option [Object] default
       #   The default value
       #
-      # rubocop:disable Metrics/CyclomaticComplexity
       def option_accessor(name, opts = {})
         contract = opts[:contract]
         default  = opts[:default]
@@ -75,7 +74,6 @@ module Aruba
         # Add reader
         option_reader name, :contract => { None => contract.values.first }
       end
-      # rubocop:enable Metrics/CyclomaticComplexity
 
       private
 

data/lib/aruba/config.rb

@@ -46,7 +46,6 @@ module Aruba
     option_accessor :command_launcher, :contract => { Aruba::Contracts::Enum[:in_process, :spawn, :debug] => Aruba::Contracts::Enum[:in_process, :spawn, :debug] }, :default => :spawn
     # rubocop:enable Metrics/LineLength
     option_accessor :main_class, :contract => { Class => Maybe[Class] }, :default => nil
-    # rubocop:disable Metrics/LineLength
 
     # rubocop:disable Metrics/LineLength
     if Aruba::VERSION >= '1.0.0'

data/lib/aruba/console.rb

@@ -35,7 +35,6 @@ module Aruba
       IRB.conf[:SAVE_HISTORY] = 1000
       IRB.conf[:HISTORY_FILE] = Aruba.config.console_history_file
 
-      # rubocop:disable Lint/NestedMethodDefinition
       context = Class.new do
         include Aruba::Api
         include Aruba::Console::Help
@@ -48,7 +47,6 @@ module Aruba
           'nil'
         end
       end
-      # rubocop:enable Lint/NestedMethodDefinition
 
       irb = IRB::Irb.new(IRB::WorkSpace.new(context.new))
       IRB.conf[:MAIN_CONTEXT] = irb.context

data/lib/aruba/cucumber/command.rb

@@ -7,26 +7,26 @@ When(/^I run "(.*)"$/)do |cmd|
   warn(%{\e[35m    The /^I run "(.*)"$/ step definition is deprecated. Please use the `backticks` version\e[0m})
 
   cmd = sanitize_text(cmd)
-  run_simple(cmd, false)
+  run_command_and_stop(cmd, false)
 end
 
 When(/^I run `([^`]*)`$/)do |cmd|
   cmd = sanitize_text(cmd)
-  run_simple(cmd, :fail_on_error => false)
+  run_command_and_stop(cmd, :fail_on_error => false)
 end
 
 When(/^I successfully run "(.*)"$/)do |cmd|
   warn(%{\e[35m    The  /^I successfully run "(.*)"$/ step definition is deprecated. Please use the `backticks` version\e[0m})
 
   cmd = sanitize_text(cmd)
-  run_simple(cmd)
+  run_command_and_stop(cmd)
 end
 
 ## I successfully run `echo -n "Hello"`
 ## I successfully run `sleep 29` for up to 30 seconds
 When(/^I successfully run `(.*?)`(?: for up to (\d+) seconds)?$/)do |cmd, secs|
   cmd = sanitize_text(cmd)
-  run_simple(cmd, :fail_on_error => true, :exit_timeout => secs && secs.to_i)
+  run_command_and_stop(cmd, :fail_on_error => true, :exit_timeout => secs && secs.to_i)
 end
 
 When(/^I run the following (?:commands|script)(?: (?:with|in) `([^`]+)`)?:$/) do |shell, commands|
@@ -48,12 +48,12 @@ end
 
 When(/^I run `([^`]*)` interactively$/)do |cmd|
   cmd = sanitize_text(cmd)
-  @interactive = run(cmd)
+  @interactive = run_command(cmd)
 end
 
 # Merge interactive and background after refactoring with event queue
 When(/^I run `([^`]*)` in background$/)do |cmd|
-  run(sanitize_text(cmd))
+  run_command(sanitize_text(cmd))
 end
 
 When(/^I type "([^"]*)"$/) do |input|