aruba 2.1.0 → 2.3.0

data/lib/aruba/platforms/unix_platform.rb

@@ -1,21 +1,23 @@
-require "rbconfig"
-require "rubygems"
-require "pathname"
-
-require "aruba/aruba_path"
-
-require "aruba/platforms/simple_table"
-require "aruba/platforms/unix_command_string"
-require "aruba/platforms/unix_which"
-require "aruba/platforms/determine_file_size"
-require "aruba/platforms/determine_disk_usage"
-require "aruba/platforms/aruba_file_creator"
-require "aruba/platforms/aruba_fixed_size_file_creator"
-require "aruba/platforms/local_environment"
-require "aruba/platforms/aruba_logger"
-require "aruba/platforms/announcer"
-require "aruba/platforms/command_monitor"
-require "aruba/platforms/filesystem_status"
+# frozen_string_literal: true
+
+require 'rbconfig'
+require 'rubygems'
+require 'pathname'
+
+require 'aruba/aruba_logger'
+require 'aruba/aruba_path'
+require 'aruba/command_monitor'
+
+require 'aruba/platforms/simple_table'
+require 'aruba/platforms/unix_command_string'
+require 'aruba/platforms/unix_which'
+require 'aruba/platforms/determine_file_size'
+require 'aruba/platforms/determine_disk_usage'
+require 'aruba/platforms/aruba_file_creator'
+require 'aruba/platforms/aruba_fixed_size_file_creator'
+require 'aruba/platforms/local_environment'
+require 'aruba/platforms/announcer'
+require 'aruba/platforms/filesystem_status'
 
 # Aruba
 module Aruba
@@ -75,12 +77,12 @@ module Aruba
         ArubaFixedSizeFileCreator.new.call(*args)
       end
 
-      def with_environment(env = {}, &block)
-        LocalEnvironment.new.call(env, &block)
+      def with_replaced_environment(env = {}, &block)
+        LocalEnvironment.new(self).call(env, &block)
       end
 
       def default_shell
-        "bash"
+        'bash'
       end
 
       def detect_ruby(cmd)
@@ -92,15 +94,15 @@ module Aruba
       end
 
       def deprecated(msg)
-        warn(format("%s. Called by %s", msg, caller[1]))
+        warn(format('%s. Called by %s', msg, caller[1]))
       end
 
       def current_ruby
-        ::File.join(RbConfig::CONFIG["bindir"], RbConfig::CONFIG["ruby_install_name"])
+        ::File.join(RbConfig::CONFIG['bindir'], RbConfig::CONFIG['ruby_install_name'])
       end
 
       def require_matching_files(pattern, base)
-        ::Dir.glob(::File.expand_path(pattern, base)).sort.each { |f| require_relative f }
+        ::Dir.glob(::File.expand_path(pattern, base)).each { |f| require_relative f }
       end
 
       # Create directory and subdirectories
@@ -126,7 +128,7 @@ module Aruba
       def chdir(dir_name, &block)
         dir_name = ::File.expand_path(dir_name.to_s)
 
-        with_environment "OLDPWD" => getwd, "PWD" => dir_name do
+        with_replaced_environment 'OLDPWD' => getwd, 'PWD' => dir_name do
           ::Dir.chdir(dir_name, &block)
         end
       end
@@ -234,13 +236,17 @@ module Aruba
       # @param [String] path
       #   The PATH, a string concatenated with ":", e.g. /usr/bin/:/bin on a
       #   UNIX-system
-      def which(program, path = ENV["PATH"])
+      def which(program, path = ENV['PATH'])
         UnixWhich.new.call(program, path)
       end
 
       def builtin_shell_commands
         []
       end
+
+      def term_signal_supported?
+        true
+      end
     end
   end
 end

data/lib/aruba/platforms/unix_which.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Aruba
 module Aruba
   # Platforms
@@ -70,7 +72,7 @@ module Aruba
       #
       # @param [String] path
       #   ENV['PATH']
-      def call(program, path = ENV["PATH"])
+      def call(program, path = ENV['PATH'])
         raise ArgumentError, "ENV['PATH'] cannot be empty" if path.nil? || path.empty?
 
         program = program.to_s

data/lib/aruba/platforms/windows_command_string.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 # Aruba
 module Aruba
   # Platforms
   module Platforms
     # This is a command which should be run
     #
-    # This adds `cmd.exec` in front of commmand
-    #
     # @private
     class WindowsCommandString
       def initialize(command, *arguments)
@@ -15,22 +15,7 @@ module Aruba
 
       # Convert to array
       def to_a
-        [cmd_path, "/c", [escaped_command, *escaped_arguments].join(" ")]
-      end
-
-      private
-
-      def escaped_arguments
-        @arguments.map { |arg| arg.gsub(/"/, '"""') }
-                  .map { |arg| / /.match?(arg) ? "\"#{arg}\"" : arg }
-      end
-
-      def escaped_command
-        @command.gsub(/ /, '""" """')
-      end
-
-      def cmd_path
-        Aruba.platform.which("cmd.exe")
+        [@command, *@arguments]
       end
     end
   end

data/lib/aruba/platforms/windows_environment_variables.rb

@@ -1,4 +1,6 @@
-require "aruba/platforms/unix_environment_variables"
+# frozen_string_literal: true
+
+require 'aruba/platforms/unix_environment_variables'
 
 # Aruba
 module Aruba

data/lib/aruba/platforms/windows_platform.rb

@@ -1,7 +1,9 @@
-require "aruba/platforms/unix_platform"
-require "aruba/platforms/windows_command_string"
-require "aruba/platforms/windows_environment_variables"
-require "aruba/platforms/windows_which"
+# frozen_string_literal: true
+
+require 'aruba/platforms/unix_platform'
+require 'aruba/platforms/windows_command_string'
+require 'aruba/platforms/windows_environment_variables'
+require 'aruba/platforms/windows_which'
 
 # Aruba
 module Aruba
@@ -32,12 +34,16 @@ module Aruba
       end
 
       # @see UnixPlatform#which
-      def which(program, path = ENV["PATH"])
+      def which(program, path = ENV['PATH'])
         WindowsWhich.new.call(program, path)
       end
 
       def builtin_shell_commands
-        %w(cd dir echo exit set type)
+        %w[cd dir echo exit set type]
+      end
+
+      def term_signal_supported?
+        false
       end
     end
   end

data/lib/aruba/platforms/windows_which.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Aruba
 module Aruba
   # Platforms
@@ -49,7 +51,7 @@ module Aruba
             file = File.join(dir, program)
             # Dir[] doesn't handle backslashes properly, so convert them. Also, if
             # the program name doesn't have an extension, try them all.
-            file = file.tr("\\", "/")
+            file = file.tr('\\', '/')
 
             found = Dir[file].first
 
@@ -84,7 +86,7 @@ module Aruba
       #
       # @param [String] path
       #   ENV['PATH']
-      def call(program, path = ENV["PATH"])
+      def call(program, path = ENV['PATH'])
         raise ArgumentError, "ENV['PATH'] cannot be empty" if path.nil? || path.empty?
 
         program = program.to_s
@@ -96,10 +98,10 @@ module Aruba
       private
 
       def windows_executable_extentions
-        if ENV["PATHEXT"]
-          format(".{%s}", ENV["PATHEXT"].tr(";", ",").tr(".", "")).downcase
+        if ENV['PATHEXT']
+          format('.{%s}', ENV['PATHEXT'].tr(';', ',').tr('.', '')).downcase
         else
-          ".{exe,com,bat}"
+          '.{exe,com,bat}'
         end
       end
     end

data/lib/aruba/processes/basic_process.rb

@@ -1,5 +1,7 @@
-require "aruba/platform"
-require "shellwords"
+# frozen_string_literal: true
+
+require 'aruba/platform'
+require 'shellwords'
 
 # Aruba
 module Aruba
@@ -125,7 +127,7 @@ module Aruba
       end
 
       def arguments
-        return Shellwords.split(commandline)[1..-1] if Shellwords.split(commandline).size > 1
+        return Shellwords.split(commandline)[1..] if Shellwords.split(commandline).size > 1
 
         []
       end

data/lib/aruba/processes/debug_process.rb

@@ -1,4 +1,6 @@
-require "aruba/processes/spawn_process"
+# frozen_string_literal: true
+
+require 'aruba/processes/spawn_process'
 
 # Aruba
 module Aruba
@@ -24,7 +26,7 @@ module Aruba
       def start
         @started = true
         Dir.chdir @working_directory do
-          Aruba.platform.with_environment(environment) do
+          Aruba.platform.with_replaced_environment(environment) do
             @exit_status = system(command, *arguments) ? 0 : 1
           end
         end
@@ -41,8 +43,8 @@ module Aruba
       # @return [String]
       #   A predefined string to make users aware they are using the DebugProcess
       def stdout(*)
-        "This is the debug launcher on STDOUT." \
-          " If this output is unexpected, please check your setup."
+        'This is the debug launcher on STDOUT. ' \
+          'If this output is unexpected, please check your setup.'
       end
 
       # Return stderr
@@ -50,8 +52,8 @@ module Aruba
       # @return [String]
       #   A predefined string to make users aware they are using the DebugProcess
       def stderr(*)
-        "This is the debug launcher on STDERR." \
-          " If this output is unexpected, please check your setup."
+        'This is the debug launcher on STDERR. ' \
+          'If this output is unexpected, please check your setup.'
       end
 
       # Write to nothing

data/lib/aruba/processes/in_process.rb

@@ -1,7 +1,9 @@
-require "shellwords"
-require "stringio"
-require "aruba/processes/basic_process"
-require "aruba/platform"
+# frozen_string_literal: true
+
+require 'shellwords'
+require 'stringio'
+require 'aruba/processes/basic_process'
+require 'aruba/platform'
 
 # Aruba
 module Aruba
@@ -61,14 +63,15 @@ module Aruba
 
       # Start command
       def start
-        raise "You need to call aruba.config.main_class = YourMainClass" unless main_class
+        raise 'You need to call aruba.config.main_class = YourMainClass' unless main_class
 
         @started = true
 
         Dir.chdir @working_directory do
           before_run
 
-          Aruba.platform.with_environment environment.merge("PWD" => @working_directory) do
+          new_env = environment.merge('PWD' => @working_directory)
+          Aruba.platform.with_replaced_environment new_env do
             main_class.new(@argv, @stdin, @stdout, @stderr, @kernel).execute!
           end
 
@@ -109,8 +112,8 @@ module Aruba
 
       # Close io
       def close_io(name)
-        unless [:stdin, :stdout, :stderr].include? name
-          raise ArgumentError, "Only stdin stdout and stderr are allowed to close"
+        unless %i[stdin stdout stderr].include? name
+          raise ArgumentError, 'Only stdin stdout and stderr are allowed to close'
         end
 
         get_instance_variable(name.to_sym).close

data/lib/aruba/processes/spawn_process.rb

@@ -1,15 +1,95 @@
-require "childprocess"
-require "tempfile"
-require "shellwords"
+# frozen_string_literal: true
 
-require "aruba/errors"
-require "aruba/processes/basic_process"
-require "aruba/platform"
+require 'tempfile'
+require 'shellwords'
+
+require 'aruba/errors'
+require 'aruba/processes/basic_process'
+require 'aruba/platform'
 
 # Aruba
 module Aruba
   # Platforms
   module Processes
+    # Wrapper around Process.spawn that broadly follows the ChildProcess interface
+    # @private
+    class ProcessRunner
+      def initialize(command_array)
+        @command_array = command_array
+        @exit_status = nil
+      end
+
+      attr_accessor :stdout, :stderr, :cwd, :environment
+      attr_reader :command_array, :pid
+
+      def start
+        @stdin_r, @stdin_w = IO.pipe
+        @pid = Process.spawn(environment, *command_array,
+                             unsetenv_others: true,
+                             in: @stdin_r,
+                             out: stdout.fileno,
+                             err: stderr.fileno,
+                             close_others: true,
+                             chdir: cwd)
+      end
+
+      def stdin
+        @stdin_w
+      end
+
+      def stop
+        return if @exit_status
+
+        if Aruba.platform.term_signal_supported?
+          send_signal 'TERM'
+          return if poll_for_exit(3)
+        end
+
+        send_signal 'KILL'
+        wait
+      end
+
+      def wait
+        _, status = Process.waitpid2 @pid
+        @exit_status = status
+      end
+
+      def exited?
+        return true if @exit_status
+
+        pid, status = Process.waitpid2 @pid, Process::WNOHANG | Process::WUNTRACED
+
+        if pid
+          @exit_status = status
+          return true
+        end
+
+        false
+      end
+
+      def poll_for_exit(exit_timeout)
+        start = Time.now
+        wait_until = start + exit_timeout
+        loop do
+          return true if exited?
+          break if Time.now >= wait_until
+
+          sleep 0.1
+        end
+        false
+      end
+
+      def exit_code
+        @exit_status&.exitstatus
+      end
+
+      private
+
+      def send_signal(signal)
+        Process.kill signal, @pid
+      end
+    end
+
     # Spawn a process for command
     #
     # `SpawnProcess` is not meant for direct use - `SpawnProcess.new` - by
@@ -66,42 +146,39 @@ module Aruba
       def start
         if started?
           error_message =
-            "Command \"#{commandline}\" has already been started." \
-            " Please `#stop` the command first and `#start` it again." \
-            " Alternatively use `#restart`."
+            "Command \"#{commandline}\" has already been started. " \
+            'Please `#stop` the command first and `#start` it again. ' \
+            'Alternatively use `#restart`.'
           raise CommandAlreadyStartedError, error_message
         end
 
         @started = true
 
-        @process = ChildProcess.build(*command_string.to_a)
-        @stdout_file = Tempfile.new("aruba-stdout-")
-        @stderr_file = Tempfile.new("aruba-stderr-")
+        @process = ProcessRunner.new(command_string.to_a)
+
+        @stdout_file = Tempfile.new('aruba-stdout-')
+        @stderr_file = Tempfile.new('aruba-stderr-')
 
         @stdout_file.sync = true
         @stderr_file.sync = true
 
-        @stdout_file.set_encoding("ASCII-8BIT")
-        @stderr_file.set_encoding("ASCII-8BIT")
+        @stdout_file.set_encoding('ASCII-8BIT')
+        @stderr_file.set_encoding('ASCII-8BIT')
 
         @exit_status = nil
-        @duplex      = true
 
         before_run
 
-        @process.io.stdout = @stdout_file
-        @process.io.stderr = @stderr_file
-        @process.duplex    = @duplex
-        @process.cwd       = @working_directory
+        @process.stdout = @stdout_file
+        @process.stderr = @stderr_file
+        @process.cwd    = @working_directory
 
-        @process.environment.update(environment)
+        @process.environment = environment
 
         begin
-          Aruba.platform.with_environment(environment) do
-            @process.start
-            sleep startup_wait_time
-          end
-        rescue ChildProcess::LaunchError => e
+          @process.start
+          sleep startup_wait_time
+        rescue SystemCallError => e
           raise LaunchError, "It tried to start #{commandline}. " + e.message
         end
 
@@ -131,7 +208,7 @@ module Aruba
         return @stdout_cache if stopped?
 
         wait_for_io opts.fetch(:wait_for_io, io_wait_timeout) do
-          @process.io.stdout.flush
+          @process.stdout.flush
           open(@stdout_file.path).read
         end
       end
@@ -150,7 +227,7 @@ module Aruba
         return @stderr_cache if stopped?
 
         wait_for_io opts.fetch(:wait_for_io, io_wait_timeout) do
-          @process.io.stderr.flush
+          @process.stderr.flush
           open(@stderr_file.path).read
         end
       end
@@ -158,8 +235,8 @@ module Aruba
       def write(input)
         return if stopped?
 
-        @process.io.stdin.write(input)
-        @process.io.stdin.flush
+        @process.stdin.write(input)
+        @process.stdin.flush
 
         self
       end
@@ -168,18 +245,14 @@ module Aruba
       def close_io(name)
         return if stopped?
 
-        @process.io.public_send(name.to_sym).close
+        @process.public_send(name.to_sym).close
       end
 
       # Stop command
       def stop(*)
         return @exit_status if stopped?
 
-        begin
-          @process.poll_for_exit(@exit_timeout)
-        rescue ChildProcess::TimeoutError
-          @timed_out = true
-        end
+        @process.poll_for_exit(@exit_timeout) or @timed_out = true
 
         terminate
       end
@@ -275,7 +348,7 @@ module Aruba
           if Aruba.platform.builtin_shell_commands.include?(command)
             command
           else
-            Aruba.platform.which(command, environment["PATH"])
+            Aruba.platform.which(command, environment['PATH'])
           end
       end
 
@@ -290,7 +363,7 @@ module Aruba
         data = file.read
         file.close
 
-        data.force_encoding("UTF-8")
+        data.force_encoding('UTF-8')
       end
     end
   end

data/lib/aruba/rspec.rb

@@ -1,8 +1,10 @@
-require "rspec/core"
+# frozen_string_literal: true
 
-require "aruba"
-require "aruba/api"
-require "aruba/version"
+require 'rspec/core'
+
+require 'aruba'
+require 'aruba/api'
+require 'aruba/version'
 
 RSpec.configure do |config|
   config.include Aruba::Api, type: :aruba
@@ -14,12 +16,12 @@ RSpec.configure do |config|
 
       # Modify PATH to include project/bin
       prepend_environment_variable(
-        "PATH",
+        'PATH',
         aruba.config.command_search_paths.join(File::PATH_SEPARATOR) + File::PATH_SEPARATOR
       )
 
       # Use configured home directory as HOME
-      set_environment_variable "HOME", aruba.config.home_directory
+      set_environment_variable 'HOME', aruba.config.home_directory
     end
 
     example.run

data/lib/aruba/runtime.rb

@@ -1,8 +1,10 @@
-require "aruba/configuration"
-require "aruba/aruba_path"
-require "aruba/config_wrapper"
-require "aruba/events"
-require "aruba/event_bus"
+# frozen_string_literal: true
+
+require 'aruba/configuration'
+require 'aruba/aruba_path'
+require 'aruba/config_wrapper'
+require 'aruba/events'
+require 'aruba/event_bus'
 
 module Aruba
   # Runtime of aruba
@@ -40,7 +42,7 @@ module Aruba
     attr_accessor :config, :environment, :logger, :command_monitor, :announcer, :event_bus
 
     def initialize(opts = {})
-      @event_bus       = EventBus.new(EventBus::NameResolver.new(Aruba::Events))
+      @event_bus       = EventBus.new(Aruba::Events.registry)
       @announcer       = opts.fetch(:announcer, Aruba.platform.announcer.new)
       @config          = opts.fetch(:config,
                                     ConfigWrapper.new(Aruba.config.make_copy, @event_bus))
@@ -84,7 +86,7 @@ module Aruba
         directory = candidates.find { |d| Aruba.platform.directory? d }
 
         unless directory
-          canditates_display = candidates.map { |d| format('"%s"', d) }.join(", ")
+          canditates_display = candidates.map { |d| format('"%s"', d) }.join(', ')
           raise "No existing fixtures directory found in #{canditates_display}."
         end
 

data/lib/aruba/setup.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Aruba
   class Setup
     private
@@ -39,10 +41,10 @@ module Aruba
         :command_started,
         proc do |event|
           runtime.announcer.announce(:command) { event.entity.commandline }
-          runtime.announcer.announce(:timeout, "exit") { event.entity.exit_timeout }
-          runtime.announcer.announce(:timeout, "io wait") { event.entity.io_wait_timeout }
+          runtime.announcer.announce(:timeout, 'exit') { event.entity.exit_timeout }
+          runtime.announcer.announce(:timeout, 'io wait') { event.entity.io_wait_timeout }
           runtime.announcer
-            .announce(:wait_time, "startup wait time") { event.entity.startup_wait_time }
+            .announce(:wait_time, 'startup wait time') { event.entity.startup_wait_time }
           runtime.announcer.announce(:full_environment) { event.entity.environment }
         end
       )
@@ -74,9 +76,9 @@ module Aruba
       )
 
       runtime.event_bus.register(
-        [:changed_environment_variable,
-         :added_environment_variable,
-         :deleted_environment_variable],
+        %i[changed_environment_variable
+           added_environment_variable
+           deleted_environment_variable],
         proc do |event|
           runtime.announcer.announce :changed_environment,
                                      event.entity[:changed][:name],

data/lib/aruba/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Aruba
-  VERSION = "2.1.0".freeze
+  VERSION = '2.3.0'
 end

data/lib/aruba.rb

@@ -1 +1,3 @@
-require "aruba/api"
+# frozen_string_literal: true
+
+require 'aruba/api'