aruba 0.10.2 → 0.11.0.pre

data/lib/aruba/processes/debug_process.rb

@@ -2,7 +2,13 @@ require 'aruba/processes/spawn_process'
 
 module Aruba
   module Processes
-    # Debug Process
+    # Run your command in `systemd()` to make debugging it easier
+    #
+    # `DebugProcess` is not meant for direct use - `InProcess.new` - by
+    # users. Only it's public methods are part of the public API of aruba, e.g.
+    # `#stdin`, `#stdout`.
+    #
+    # @private
     class DebugProcess < BasicProcess
       # Use only if mode is :debug
       def self.match?(mode)

data/lib/aruba/processes/in_process.rb

@@ -5,6 +5,13 @@ require 'aruba/platform'
 
 module Aruba
   module Processes
+    # Run command in your ruby process
+    #
+    # `InProcess` is not meant for direct use - `InProcess.new` - by
+    # users. Only it's public methods are part of the public API of aruba, e.g.
+    # `#stdin`, `#stdout`.
+    #
+    # @private
     class InProcess < BasicProcess
       # Use only if mode is in_process
       def self.match?(mode)
@@ -33,7 +40,7 @@ module Aruba
       # @private
       attr_reader :main_class
 
-      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
         @argv              = arguments
         @stdin             = StringIO.new
@@ -90,6 +97,13 @@ module Aruba
       def terminate
         stop
       end
+
+      # Output pid of process
+      #
+      # This is the PID of the ruby process! So be careful
+      def pid
+        $PROCESS_ID
+      end
     end
   end
 end

data/lib/aruba/processes/null_process.rb

@@ -0,0 +1,26 @@
+require 'aruba/processes/basic_process'
+
+module Aruba
+  module Processes
+    # Null Process
+    #
+    # `NullProcess` is not meant for direct use - `BasicProcess.new` - by users.
+    #
+    # @private
+    class NullProcess < BasicProcess
+      def self.match?(mode)
+        mode == :null
+      end
+
+      # Pid
+      def pid
+        0
+      end
+
+      # String representation
+      def to_s
+        ''
+      end
+    end
+  end
+end

data/lib/aruba/processes/spawn_process.rb

@@ -8,6 +8,13 @@ require 'aruba/platform'
 
 module Aruba
   module Processes
+    # Spawn a process for command
+    #
+    # `SpawnProcess` is not meant for direct use - `SpawnProcess.new` - by
+    # users. Only it's public methods are part of the public API of aruba, e.g.
+    # `#stdin`, `#stdout`.
+    #
+    # @private
     class SpawnProcess < BasicProcess
       # Use as default launcher
       def self.match?(mode)
@@ -27,12 +34,12 @@ module Aruba
       #
       # @params [String] working_directory
       #   The directory where the command will be executed
-      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)
         super
 
         @process      = nil
-        @stdout_cache       = nil
-        @stderr_cache       = nil
+        @stdout_cache = nil
+        @stderr_cache = nil
       end
 
       # Run the command
@@ -53,8 +60,8 @@ module Aruba
         cmd = Aruba.platform.command_string.new(cmd)
 
         @process   = ChildProcess.build(*[cmd.to_a, arguments].flatten)
-        @stdout_file = Tempfile.new("aruba-stdout-")
-        @stderr_file = Tempfile.new("aruba-stderr-")
+        @stdout_file = Tempfile.new('aruba-stdout-')
+        @stderr_file = Tempfile.new('aruba-stderr-')
 
         @stdout_file.sync = true
         @stderr_file.sync = true
@@ -75,6 +82,7 @@ module Aruba
         begin
           Aruba.platform.with_environment(environment) do
             @process.start
+            sleep startup_wait_time
           end
         rescue ChildProcess::LaunchError => e
           raise LaunchError, "It tried to start #{cmd}. " + e.message
@@ -89,7 +97,7 @@ module Aruba
 
       # Access to stdout of process
       def stdin
-        return if @process.nil?
+        return if @process.exited?
 
         @process.io.stdin
       end
@@ -105,11 +113,9 @@ module Aruba
       # @return [String]
       #   The content of stdout
       def stdout(opts = {})
-        return @stdout_cache if @process.nil?
+        return @stdout_cache if stopped?
 
-        wait_for_io = opts.fetch(:wait_for_io, @io_wait)
-
-        wait_for_io wait_for_io do
+        wait_for_io opts.fetch(:wait_for_io, @io_wait) do
           @process.io.stdout.flush
           open(@stdout_file.path).read
         end
@@ -126,11 +132,9 @@ module Aruba
       # @return [String]
       #   The content of stderr
       def stderr(opts = {})
-        return @stderr_cache if @process.nil?
-
-        wait_for_io = opts.fetch(:wait_for_io, @io_wait)
+        return @stderr_cache if stopped?
 
-        wait_for_io wait_for_io do
+        wait_for_io opts.fetch(:wait_for_io, @io_wait) do
           @process.io.stderr.flush
           open(@stderr_file.path).read
         end
@@ -145,7 +149,7 @@ module Aruba
       end
 
       def write(input)
-        return if @process.nil?
+        return if stopped?
 
         @process.io.stdin.write(input)
         @process.io.stdin.flush
@@ -154,7 +158,7 @@ module Aruba
       end
 
       def close_io(name)
-        return if @process.nil?
+        return if stopped?
 
         if RUBY_VERSION < '1.9'
           @process.io.send(name.to_sym).close
@@ -163,64 +167,93 @@ module Aruba
         end
       end
 
+      # rubocop:disable Metrics/MethodLength
       def stop(reader)
-        @stopped = true
-
-        return @exit_status unless @process
+        return @exit_status if stopped?
 
         begin
-          @process.poll_for_exit(@exit_timeout) unless @process.exited?
+          @process.poll_for_exit(@exit_timeout)
         rescue ChildProcess::TimeoutError
           @timed_out = true
-          @process.stop
         end
 
-        @exit_status = @process.exit_code
-        @process   = nil
-
-        close_and_cache_out
-        close_and_cache_err
+        terminate
 
         if reader
-          reader.announce :stdout, stdout
-          reader.announce :stderr, stderr
+          reader.announce :stdout, @stdout_cache
+          reader.announce :stderr, @stderr_cache
         end
 
         @exit_status
       end
+      # rubocop:enable Metrics/MethodLength
 
+      # Wait for command to finish
+      def wait
+        @process.wait
+      end
+
+      # Terminate command
       def terminate
-        return unless @process
+        return @exit_status if stopped?
+
+        unless @process.exited?
+          if @stop_signal
+            # send stop signal ...
+            send_signal @stop_signal
+            # ... and set the exit status
+            wait
+          else
+            @process.stop
+          end
+        end
 
-        @process.stop
-        stop nil
-      end
+        @exit_status  = @process.exit_code
 
-      private
+        @stdout_cache = read_temporary_output_file @stdout_file
+        @stderr_cache = read_temporary_output_file @stderr_file
 
-      def wait_for_io(time_to_wait, &block)
-        return if @process.nil?
+        # @stdout_file = nil
+        # @stderr_file = nil
 
-        sleep time_to_wait
+        @stopped      = true
 
-        yield
+        @exit_status
       end
 
-      def read(io)
-        io.rewind
-        io.read
+      # Output pid of process
+      #
+      # This is the PID of the spawned process.
+      def pid
+        @process.pid
       end
 
-      def close_and_cache_out
-        @stdout_cache = read @stdout_file
-        @stdout_file.close
-        @stdout_file = nil
+      # Send command a signal
+      #
+      # @param [String] signal
+      #   The signal, i.e. 'TERM'
+      def send_signal(signal)
+        fail CommandAlreadyStoppedError, %(Command "#{commandline}" with PID "#{pid}" has already stopped.) if @process.exited?
+
+        Process.kill signal, pid
+      rescue Errno::ESRCH
+        raise CommandAlreadyStoppedError, %(Command "#{commandline}" with PID "#{pid}" has already stopped.)
       end
 
-      def close_and_cache_err
-        @stderr_cache = read @stderr_file
-        @stderr_file.close
-        @stderr_file = nil
+      private
+
+      def wait_for_io(time_to_wait, &block)
+        sleep time_to_wait.to_i
+        block.call
+      end
+
+      def read_temporary_output_file(file)
+        file.flush
+        file.rewind
+        data = file.read
+        file.close
+
+        data
       end
     end
   end

data/lib/aruba/rspec.rb

@@ -53,6 +53,9 @@ RSpec.configure do |config|
     announcer.activate(:directory)            if example.metadata[:announce_directory]
     announcer.activate(:stdout)               if example.metadata[:announce_stdout]
     announcer.activate(:stderr)               if example.metadata[:announce_stderr]
+    announcer.activate(:timeout)              if example.metadata[:announce_timeout]
+    announcer.activate(:wait_time)            if example.metadata[:announce_wait_time]
+    announcer.activate(:stop_signal)          if example.metadata[:announce_stop_signal]
 
     if example.metadata[:announce_output]
       announcer.activate(:stderr)
@@ -67,6 +70,9 @@ RSpec.configure do |config|
       announcer.activate(:full_environment)
       announcer.activate(:command)
       announcer.activate(:directory)
+      announcer.activate(:stop_signal)
+      announcer.activate(:timeout)
+      announcer.activate(:wait_time)
     end
   end
 

data/lib/aruba/version.rb

@@ -1,3 +1,3 @@
 module Aruba
-  VERSION = '0.10.2'
+  VERSION = '0.11.0.pre'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aruba
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: 0.11.0.pre
 platform: ruby
 authors:
 - Aslak Hellesøy
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-09 00:00:00.000000000 Z
+date: 2015-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -144,6 +144,8 @@ files:
 - features/.nav
 - features/announce.feature
 - features/api/command/run.feature
+- features/api/command/send_signal.feature
+- features/api/command/stop.feature
 - features/api/command/stop_all_commands.feature
 - features/api/command/terminate_all_commands.feature
 - features/api/command/which.feature
@@ -162,6 +164,7 @@ files:
 - features/api/filesystem/is_relative.feature
 - features/api/filesystem/move.feature
 - features/api/text/extract_text.feature
+- features/api/text/replace_variables.feature
 - features/api/text/sanitize_text.feature
 - features/api/text/unescape_text.feature
 - features/cli/console.feature
@@ -183,6 +186,7 @@ files:
 - features/configuration/physical_block_size.feature
 - features/configuration/remove_ansi_escape_sequences.feature
 - features/configuration/root_directory.feature
+- features/configuration/startup_wait_time.feature
 - features/configuration/usage.feature
 - features/configuration/working_directory.feature
 - features/core/cleanup_aruba_directory.feature
@@ -206,9 +210,11 @@ files:
 - features/output.feature
 - features/step_definitions/aruba_dev_steps.rb
 - features/step_definitions/hooks.rb
-- features/steps/commands/exit_statuses.feature
-- features/steps/commands/in_process.feature
-- features/steps/commands/run.feature
+- features/steps/command/exit_statuses.feature
+- features/steps/command/in_process.feature
+- features/steps/command/run.feature
+- features/steps/command/send_signal.feature
+- features/steps/command/stop.feature
 - features/steps/environment/home_variable.feature
 - features/steps/environment/set_environment_variable.feature
 - features/steps/filesystem/copy.feature
@@ -218,6 +224,7 @@ files:
 - features/steps/filesystem/move.feature
 - features/steps/filesystem/overwrite_file.feature
 - features/steps/filesystem/use_fixture.feature
+- features/steps/overview.feature
 - features/support/aruba.rb
 - features/support/env.rb
 - features/support/jruby.rb
@@ -345,6 +352,7 @@ files:
 - lib/aruba/processes/basic_process.rb
 - lib/aruba/processes/debug_process.rb
 - lib/aruba/processes/in_process.rb
+- lib/aruba/processes/null_process.rb
 - lib/aruba/processes/spawn_process.rb
 - lib/aruba/reporting.rb
 - lib/aruba/rspec.rb
@@ -424,18 +432,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
-summary: aruba-0.10.2
+summary: aruba-0.11.0.pre
 test_files:
 - features/announce.feature
 - features/api/command/run.feature
+- features/api/command/send_signal.feature
+- features/api/command/stop.feature
 - features/api/command/stop_all_commands.feature
 - features/api/command/terminate_all_commands.feature
 - features/api/command/which.feature
@@ -454,6 +464,7 @@ test_files:
 - features/api/filesystem/is_relative.feature
 - features/api/filesystem/move.feature
 - features/api/text/extract_text.feature
+- features/api/text/replace_variables.feature
 - features/api/text/sanitize_text.feature
 - features/api/text/unescape_text.feature
 - features/cli/console.feature
@@ -475,6 +486,7 @@ test_files:
 - features/configuration/physical_block_size.feature
 - features/configuration/remove_ansi_escape_sequences.feature
 - features/configuration/root_directory.feature
+- features/configuration/startup_wait_time.feature
 - features/configuration/usage.feature
 - features/configuration/working_directory.feature
 - features/core/cleanup_aruba_directory.feature
@@ -498,9 +510,11 @@ test_files:
 - features/output.feature
 - features/step_definitions/aruba_dev_steps.rb
 - features/step_definitions/hooks.rb
-- features/steps/commands/exit_statuses.feature
-- features/steps/commands/in_process.feature
-- features/steps/commands/run.feature
+- features/steps/command/exit_statuses.feature
+- features/steps/command/in_process.feature
+- features/steps/command/run.feature
+- features/steps/command/send_signal.feature
+- features/steps/command/stop.feature
 - features/steps/environment/home_variable.feature
 - features/steps/environment/set_environment_variable.feature
 - features/steps/filesystem/copy.feature
@@ -510,6 +524,7 @@ test_files:
 - features/steps/filesystem/move.feature
 - features/steps/filesystem/overwrite_file.feature
 - features/steps/filesystem/use_fixture.feature
+- features/steps/overview.feature
 - features/support/aruba.rb
 - features/support/env.rb
 - features/support/jruby.rb