aruba 0.10.2 → 0.11.0.pre

data/features/steps/overview.feature

@@ -0,0 +1,60 @@
+Feature: Overview of steps
+
+  Given you're a system administrator
+  Who would like to use `aruba`
+  But didn't know which steps are available
+
+  Background:
+    Given I use a fixture named "cli-app"
+
+  Scenario: Use information found in repository
+    Given an executable named "bin/cli" with:
+    """
+    #!/bin/bash
+    git clone https://github.com/cucumber/aruba.git
+    cd aruba
+    grep -E "When|Given|Then" lib/aruba/cucumber/*.rb | awk -F ":" '{ $1 = ""; print $0}' |sort
+    """
+    And a file named "features/run.feature" with:
+    """
+    Feature: Run it
+      Scenario: Run command
+        When I run `cli`
+        Then the output should contain:
+        \"\"\"
+        Cloning into 'aruba'...
+        \"\"\"
+        And the output should contain:
+        \"\"\"
+        Given(/^
+        \"\"\"
+        And the output should contain:
+        \"\"\"
+        When(/^
+        \"\"\"
+        And the output should contain:
+        \"\"\"
+        Then(/^
+        \"\"\"
+    """
+    When I run `cucumber`
+    Then the features should all pass
+
+  Scenario: Use cucumber output formatter
+    Given a file named "features/run.feature" with:
+    """
+    Feature: Run it
+      Scenario: Run command
+        Given a directory named "features"
+        And a file named "features/support/env.rb" with:
+        \"\"\"
+        require 'aruba/cucumber'
+        \"\"\"
+        When I run `cucumber --format stepdefs`
+        Then the output should contain:
+        \"\"\"
+        NOT MATCHED BY ANY STEPS
+        \"\"\"
+    """
+    When I run `cucumber`
+    Then the features should all pass

data/lib/aruba/announcer.rb

@@ -84,6 +84,8 @@ module Aruba
       output_format :modified_environment, proc { |n, v| format('$ export %s=%s', n, Shellwords.escape(v)) }
       output_format :full_environment, proc { |h| Aruba.platform.simple_table(h) }
       output_format :timeout, '# %s-timeout: %s seconds'
+      output_format :wait_time, '# %s: %s seconds'
+      output_format :stop_signal, proc { |p, s| format('Command will be stopped with `kill -%s %s`', s, p) }
       output_format :stderr, "<<-STDERR\n%s\nSTDERR"
       output_format :stdout, "<<-STDOUT\n%s\nSTDOUT"
 

data/lib/aruba/api/command.rb

@@ -122,22 +122,37 @@ module Aruba
       # @param [Integer] timeout
       #   If the timeout is reached the command will be killed
       #
+      # @param [String] stop_signal
+      #   Use signal to stop command (Private)
+      #
       # @yield [SpawnProcess]
       #   Run block with process
       #
       # rubocop:disable Metrics/MethodLength
-      def run(cmd, exit_timeout = nil, io_wait_timeout = nil)
+      # rubocop:disable Metrics/CyclomaticComplexity
+      def run(cmd, exit_timeout = nil, io_wait_timeout = nil, stop_signal = nil, startup_wait_time = nil)
         exit_timeout ||= aruba.config.exit_timeout
         io_wait_timeout ||= aruba.config.io_wait_timeout
+        stop_signal ||= aruba.config.stop_signal
+        startup_wait_time ||= aruba.config.startup_wait_time
+
+        cmd = replace_variables(cmd)
 
         @commands ||= []
         @commands << cmd
 
+        environment       = aruba.environment.to_h
+        working_directory = expand_path('.')
+
+        announcer.announce(:full_environment, environment)
+        announcer.announce(:timeout, 'exit', exit_timeout)
+        announcer.announce(:timeout, 'io wait', io_wait_timeout)
+        announcer.announce(:wait_time, 'startup wait time', startup_wait_time)
+
+        announcer.announce(:directory, working_directory)
         announcer.announce(:command, cmd)
 
         cmd               = Aruba.platform.detect_ruby(cmd)
-        environment       = aruba.environment.to_h
-        working_directory = expand_path('.')
 
         mode = if Aruba.process
                  # rubocop:disable Metrics/LineLength
@@ -157,11 +172,6 @@ module Aruba
                        aruba.config.main_class
                      end
 
-        announcer.announce(:directory, working_directory)
-        announcer.announce(:timeout, 'exit', exit_timeout)
-        announcer.announce(:timeout, 'io wait', io_wait_timeout)
-        announcer.announce(:full_environment, environment)
-
         command = Command.new(
           cmd,
           :mode              => mode,
@@ -169,7 +179,9 @@ module Aruba
           :io_wait_timeout   => io_wait_timeout,
           :working_directory => working_directory,
           :environment       => environment,
-          :main_class        => main_class
+          :main_class        => main_class,
+          :stop_signal       => stop_signal,
+          :startup_wait_time => startup_wait_time
         )
 
         if aruba.config.before? :cmd
@@ -184,10 +196,13 @@ module Aruba
         process_monitor.register_process(cmd, command)
         command.start
 
+        announcer.announce(:stop_signal, command.pid, stop_signal) if stop_signal
+
         aruba.config.after(:command, self, command)
 
         block_given? ? yield(command) : command
       end
+      # rubocop:enable Metrics/CyclomaticComplexity
       # rubocop:enable Metrics/MethodLength
 
       # Run a command with aruba

data/lib/aruba/api/text.rb

@@ -36,6 +36,15 @@ module Aruba
 
         text.chomp
       end
+
+      # @experimental
+      #
+      # Replace variables in command string
+      def replace_variables(text)
+        text = text.gsub(/<pid-last-command-started>/, last_command_started.pid.to_s)
+
+        text
+      end
     end
   end
 end

data/lib/aruba/command.rb

@@ -8,6 +8,7 @@ module Aruba
       launchers = []
       launchers << Processes::DebugProcess
       launchers << Processes::InProcess
+      launchers << Processes::NullProcess
       launchers << Processes::SpawnProcess
 
       launcher = launchers.find { |l| l.match? opts[:mode] }
@@ -18,7 +19,9 @@ module Aruba
         opts.fetch(:io_wait_timeout),
         opts.fetch(:working_directory),
         opts.fetch(:environment),
-        opts.fetch(:main_class)
+        opts.fetch(:main_class),
+        opts.fetch(:stop_signal),
+        opts.fetch(:startup_wait_time)
       )
     rescue KeyError => e
       raise ArgumentError, e.message

data/lib/aruba/config.rb

@@ -29,7 +29,9 @@ module Aruba
     end
 
     option_accessor :exit_timeout, :contract => { Num => Num }, :default => 15
+    option_accessor :stop_signal, :contract => { Maybe[String] => Maybe[String] }, :default => nil
     option_accessor :io_wait_timeout, :contract => { Num => Num }, :default => 0.1
+    option_accessor :startup_wait_time, :contract => { Num => Num }, :default => 0
     option_accessor :fixtures_directories, :contract => { Array => ArrayOf[String] }, :default => %w(features/fixtures spec/fixtures test/fixtures fixtures)
     option_accessor :command_runtime_environment, :contract => { Hash => Hash }, :default => ENV.to_hash.dup
     # rubocop:disable Metrics/LineLength

data/lib/aruba/cucumber/command.rb

@@ -1,3 +1,7 @@
+if Aruba::VERSION < '1.0.0'
+  require 'aruba/cucumber/core'
+end
+
 When(/^I run "(.*)"$/)do |cmd|
   warn(%{\e[35m    The /^I run "(.*)"$/ step definition is deprecated. Please use the `backticks` version\e[0m})
 
@@ -35,6 +39,11 @@ When(/^I run `([^`]*)` interactively$/)do |cmd|
   @interactive = run(cmd)
 end
 
+# Merge interactive and background after refactoring with event queue
+When(/^I run `([^`]*)` in background$/)do |cmd|
+  run(sanitize_text(cmd))
+end
+
 When(/^I type "([^"]*)"$/) do |input|
   type(unescape_text(input))
 end
@@ -49,6 +58,29 @@ When(/^I pipe in (?:a|the) file(?: named)? "([^"]*)"$/) do |file|
   close_input
 end
 
+When(/^I (terminate|stop) the command (?:"([^"]*)"|(?:started last))$/) do |signal, command|
+  if command
+    cmd = all_commands.find { |c| c.commandline == command }
+    fail ArgumentError, %(No command "#{command}" found) if cmd.nil?
+
+    if signal == 'terminate'
+      # last_command_started.terminate
+      process_monitor.terminate_process!(process_monitor.get_process(command))
+    else
+      # last_command_started.stop
+      process_monitor.stop_process(process_monitor.get_process(command))
+    end
+  else
+    if signal == 'terminate'
+      # last_command_started.terminate
+      process_monitor.terminate_process!(last_command_started)
+    else
+      # last_command_started.stop
+      process_monitor.stop_process(last_command_started)
+    end
+  end
+end
+
 When(/^I stop the command(?: started last)? if (output|stdout|stderr) contains:$/) do |channel, expected|
   fail %(Invalid output channel "#{channel}" chosen. Please choose one of "output, stdout or stderr") unless %w(output stdout stderr).include? channel
 
@@ -332,3 +364,46 @@ Then(/^(?:the )?(output|stdout|stderr) should( not)? contain all of these lines:
     end
   end
 end
+
+Given(/the default aruba timeout is (\d+) seconds/) do |seconds|
+  # rubocop:disable Metrics/LineLength
+  Aruba.platform.deprecated(%{The /^the default aruba timeout is (\d+) seconds/ step definition is deprecated. Please use /^the default aruba exit timeout is (\d+) seconds/ step definition is deprecated.})
+  # rubocop:enable Metrics/LineLength
+
+  aruba.config.exit_timeout = seconds.to_i
+end
+
+Given(/The default aruba timeout is (\d+) seconds/) do |seconds|
+  # rubocop:disable Metrics/LineLength
+  Aruba.platform.deprecated(%{The /^The default aruba timeout is (\d+) seconds/ step definition is deprecated. Please use /^the default aruba exit timeout is (\d+) seconds/ step definition is deprecated.})
+  # rubocop:enable Metrics/LineLength
+
+  aruba.config.exit_timeout = seconds.to_i
+end
+
+Given(/^the (?:default )?aruba io wait timeout is (\d+) seconds?$/) do |seconds|
+  aruba.config.io_wait_timeout = seconds.to_i
+end
+
+Given(/^the (?:default )?aruba exit timeout is (\d+) seconds?$/) do |seconds|
+  aruba.config.exit_timeout = seconds.to_i
+end
+
+Given(/^the (?:default )?aruba stop signal is "([^"]*)"$/) do |signal|
+  aruba.config.stop_signal = signal
+end
+
+Given(/^I wait (\d+) seconds? for (?:a|the) command to start up$/) do |seconds|
+  aruba.config.startup_wait_time = seconds.to_i
+end
+
+When(/^I send the signal "([^"]*)" to the command (?:"([^"]*)"|(?:started last))$/) do |signal, command|
+  if command
+    cmd = all_commands.find { |c| c.commandline == command }
+    fail ArgumentError, %(No command "#{command}" found) if cmd.nil?
+
+    cmd.send_signal signal
+  else
+    last_command_started.send_signal signal
+  end
+end

data/lib/aruba/cucumber/core.rb

@@ -3,27 +3,3 @@ if Aruba::VERSION >= '1.0.0'
     config.working_directory = 'tmp/cucumber'
   end
 end
-
-Given(/the default aruba timeout is (\d+) seconds/) do |seconds|
-  # rubocop:disable Metrics/LineLength
-  Aruba.platform.deprecated(%{The /^the default aruba timeout is (\d+) seconds/ step definition is deprecated. Please use /^the default aruba exit timeout is (\d+) seconds/ step definition is deprecated.})
-  # rubocop:enable Metrics/LineLength
-
-  aruba.config.exit_timeout = seconds.to_i
-end
-
-Given(/The default aruba timeout is (\d+) seconds/) do |seconds|
-  # rubocop:disable Metrics/LineLength
-  Aruba.platform.deprecated(%{The /^The default aruba timeout is (\d+) seconds/ step definition is deprecated. Please use /^the default aruba exit timeout is (\d+) seconds/ step definition is deprecated.})
-  # rubocop:enable Metrics/LineLength
-
-  aruba.config.exit_timeout = seconds.to_i
-end
-
-Given(/the default aruba io wait timeout is (\d+) seconds/) do |seconds|
-  aruba.config.io_wait_timeout = seconds.to_i
-end
-
-Given(/the default aruba exit timeout is (\d+) seconds/) do |seconds|
-  aruba.config.exit_timeout = seconds.to_i
-end

data/lib/aruba/cucumber/hooks.rb

@@ -65,6 +65,10 @@ Before('@announce-directory') do
   announcer.activate :directory
 end
 
+Before('@announce-stop-signal') do
+  announcer.activate :stop_signal
+end
+
 Before('@announce-env') do
   Aruba.platform.deprecated 'The use of "@announce-env"-hook is deprecated. Please use "@announce-modified-environment"'
 
@@ -89,6 +93,10 @@ Before('@announce-timeout') do
   announcer.activate :timeout
 end
 
+Before('@announce-wait-time') do
+  announcer.activate :wait_time
+end
+
 Before('@announce') do
   announcer.activate :command
   announcer.activate :stdout
@@ -98,6 +106,8 @@ Before('@announce') do
   announcer.activate :full_environment
   announcer.activate :environment
   announcer.activate :timeout
+  announcer.activate :wait_time
+  announcer.activate :stop_signal
 end
 
 Before('@debug') do

data/lib/aruba/errors.rb

@@ -10,4 +10,7 @@ module Aruba
 
   # Raised if one tries to use an unknown configuration option
   class UnknownOptionError < ArgumentError; end
+
+  # Rais if command already died
+  class CommandAlreadyStoppedError < Error; end
 end

data/lib/aruba/matchers/command/have_output.rb

@@ -28,7 +28,7 @@ RSpec::Matchers.define :have_output do |expected|
       :env    => @announce_env
     )
 
-    @old_actual.stop(@announcer) unless @old_actual.stopped?
+    @old_actual.stop(@announcer)
 
     @actual = sanitize_text(actual.output)
 

data/lib/aruba/process_monitor.rb

@@ -1,3 +1,5 @@
+require 'aruba/processes/null_process'
+
 module Aruba
   class ProcessMonitor
     private
@@ -21,6 +23,16 @@ module Aruba
 
     def last_command_stopped
       return @last_command_stopped if @last_command_stopped
+      return Command.new('false',
+                         :mode              => :null,
+                         :exit_timeout      => 0,
+                         :io_wait_timeout   => 0,
+                         :working_directory => '/tmp',
+                         :environment       => {},
+                         :main_class        => nil,
+                         :stop_signal       => nil,
+                         :startup_wait_time => nil
+                        ) if all_commands.empty?
 
       all_commands.each { |c| stop_process(c) }
 
@@ -28,6 +40,17 @@ module Aruba
     end
 
     def last_command_started
+      return Command.new('false',
+                         :mode              => :null,
+                         :exit_timeout      => 0,
+                         :io_wait_timeout   => 0,
+                         :working_directory => '/tmp',
+                         :environment       => {},
+                         :main_class        => nil,
+                         :stop_signal       => nil,
+                         :startup_wait_time => nil
+                        ) unless processes.last.is_a? Array
+
       processes.last[1]
     end
 
@@ -37,7 +60,8 @@ module Aruba
     end
 
     def terminate_process!(process)
-      process.terminate
+      @last_command_stopped = process
+      @last_exit_status     = process.terminate
     end
 
     def stop_processes!

data/lib/aruba/processes/basic_process.rb

@@ -3,15 +3,22 @@ require 'shellwords'
 
 module Aruba
   module Processes
+    # Basic Process
+    #
+    # `BasicProcess` is not meant for direct use - `BasicProcess.new` - by users.
+    #
+    # @private
     class BasicProcess
-      attr_reader :exit_status, :environment
+      attr_reader :exit_status, :environment, :startup_wait_time
 
-      def initialize(cmd, exit_timeout, io_wait, working_directory, environment = ENV.to_hash.dup, main_class = nil)
+      def initialize(cmd, exit_timeout, io_wait, working_directory, environment = ENV.to_hash.dup, main_class = nil, stop_signal = nil, startup_wait_time = 0)
         @cmd               = cmd
         @working_directory = working_directory
         @environment       = environment
         @main_class        = main_class
         @exit_status       = nil
+        @stop_signal       = stop_signal
+        @startup_wait_time = startup_wait_time
 
         @exit_timeout = exit_timeout
         @io_wait      = io_wait
@@ -22,6 +29,11 @@ module Aruba
         @cmd
       end
 
+      # Output pid of process
+      def pid
+        'No implemented'
+      end
+
       # Output stderr and stdout
       def output(opts = {})
         stdout(opts) + stderr(opts)
@@ -47,6 +59,14 @@ module Aruba
         NotImplementedError
       end
 
+      def send_signal(*)
+        NotImplementedError
+      end
+
+      def wait
+        NotImplementedError
+      end
+
       # Was process already stopped
       def stopped?
         @stopped == true