aruba 0.11.0.pre → 0.11.0.pre2

data/lib/aruba/platforms/unix_which.rb

@@ -1,8 +1,12 @@
 require 'aruba/platform'
 
+# Aruba
 module Aruba
+  # Platforms
   module Platforms
     # Implement `which(command)` for UNIX/Linux
+    #
+    # @private
     class UnixWhich
       # Bail out because this should never be reached
       class DefaultWhich
@@ -22,7 +26,7 @@ module Aruba
         end
 
         def call(program, path)
-          return File.expand_path(program) if Aruba.platform.executable_file?(program)
+          return File.expand_path(program) if Aruba.platform.executable?(program)
 
           nil
         end
@@ -43,7 +47,7 @@ module Aruba
             next unless Aruba.platform.exist?(dir) # In case of bogus second argument
 
             found = Dir[File.join(dir, program)].first
-            return found if found && Aruba.platform.executable_file?(found)
+            return found if found && Aruba.platform.executable?(found)
           end
 
           nil

data/lib/aruba/platforms/windows_command_string.rb

@@ -1,13 +1,20 @@
 require 'delegate'
 
+# 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 < SimpleDelegator
       def initialize(cmd)
         __setobj__ format('%s /c "%s"', Aruba.platform.which('cmd.exe'), cmd)
       end
 
+      # Convert to array
       def to_a
         Shellwords.split __getobj__
       end

data/lib/aruba/platforms/windows_environment_variables.rb

@@ -1,6 +1,8 @@
 require 'aruba/platforms/unix_environment_variables'
 
+# Aruba
 module Aruba
+  # Platforms
   module Platforms
     # Windows is case-insensitive when it accesses its environment variables.
     # That means that at the Windows command line:

data/lib/aruba/platforms/windows_platform.rb

@@ -5,6 +5,7 @@ require 'aruba/platforms/windows_command_string'
 require 'aruba/platforms/windows_environment_variables'
 require 'aruba/platforms/windows_which'
 
+# Aruba
 module Aruba
   # This abstracts OS-specific things
   module Platforms
@@ -15,6 +16,8 @@ module Aruba
     # any further notice.
     #
     # This includes all methods for the Windows platform
+    #
+    # @private
     class WindowsPlatform < UnixPlatform
       def self.match?
         FFI::Platform.windows?

data/lib/aruba/platforms/windows_which.rb

@@ -1,8 +1,12 @@
 require 'aruba/platform'
 
+# Aruba
 module Aruba
+  # Platforms
   module Platforms
     # Implement `which(command)` for windows
+    #
+    # @private
     class WindowsWhich
       # Bail out because this should never be reached
       class DefaultWhich
@@ -25,7 +29,7 @@ module Aruba
           # Expand `#path_exts`
           found = Dir[program].first
 
-          return File.expand_path(found) if found && Aruba.platform.executable_file?(found)
+          return File.expand_path(found) if found && Aruba.platform.executable?(found)
           nil
         end
       end
@@ -53,7 +57,7 @@ module Aruba
             found = Dir[file].first
 
             # Convert all forward slashes to backslashes if supported
-            if found && Aruba.platform.executable_file?(found)
+            if found && Aruba.platform.executable?(found)
               found.tr!(File::SEPARATOR, File::ALT_SEPARATOR)
               return found
             end

data/lib/aruba/processes/basic_process.rb

@@ -1,7 +1,9 @@
 require 'aruba/platform'
 require 'shellwords'
 
+# Aruba
 module Aruba
+  # Processes
   module Processes
     # Basic Process
     #
@@ -9,9 +11,9 @@ module Aruba
     #
     # @private
     class BasicProcess
-      attr_reader :exit_status, :environment, :startup_wait_time
+      attr_reader :exit_status, :environment, :working_directory, :main_class, :io_wait_timeout, :exit_timeout, :startup_wait_time
 
-      def initialize(cmd, exit_timeout, io_wait, working_directory, environment = ENV.to_hash.dup, main_class = nil, stop_signal = nil, startup_wait_time = 0)
+      def initialize(cmd, exit_timeout, io_wait_timeout, 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
@@ -20,8 +22,10 @@ module Aruba
         @stop_signal       = stop_signal
         @startup_wait_time = startup_wait_time
 
-        @exit_timeout = exit_timeout
-        @io_wait      = io_wait
+        @exit_timeout    = exit_timeout
+        @io_wait_timeout = io_wait_timeout
+
+        @started         = false
       end
 
       # Return command line
@@ -67,9 +71,20 @@ module Aruba
         NotImplementedError
       end
 
+      # Restart a command
+      def restart
+        stop
+        start
+      end
+
       # Was process already stopped
       def stopped?
-        @stopped == true
+        @started == false
+      end
+
+      # Was process already started
+      def started?
+        @started == true
       end
 
       # Does the process failed to stop in time

data/lib/aruba/processes/debug_process.rb

@@ -1,6 +1,8 @@
 require 'aruba/processes/spawn_process'
 
+# Aruba
 module Aruba
+  # Processes
   module Processes
     # Run your command in `systemd()` to make debugging it easier
     #
@@ -57,7 +59,7 @@ module Aruba
 
       # Stop process
       def stop(*)
-        @stopped = true
+        @started = false
 
         @exit_status
       end

data/lib/aruba/processes/in_process.rb

@@ -3,7 +3,9 @@ require 'stringio'
 require 'aruba/processes/basic_process'
 require 'aruba/platform'
 
+# Aruba
 module Aruba
+  # Platforms
   module Processes
     # Run command in your ruby process
     #
@@ -20,6 +22,9 @@ module Aruba
 
       attr_reader :exit_status
 
+      # Fake Kernel module of ruby
+      #
+      # @private
       class FakeKernel
         attr_reader :exitstatus
 
@@ -40,7 +45,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, stop_signal = nil, startup_wait_time = 0)
+      def initialize(cmd, exit_timeout, io_wait_timeout, working_directory, environment = ENV.to_hash.dup, main_class = nil, stop_signal = nil, startup_wait_time = 0)
         @cmd               = cmd
         @argv              = arguments
         @stdin             = StringIO.new
@@ -51,6 +56,7 @@ module Aruba
         super
       end
 
+      # Start command
       def start
         fail "You need to call aruba.config.main_class = YourMainClass" unless main_class
 
@@ -67,33 +73,43 @@ module Aruba
         end
       end
 
+      # Stop command
       def stop(*)
-        @stopped     = true
+        @started     = false
         @exit_status = @kernel.exitstatus
       end
 
+      # Access stdin
       def stdin
         @stdin.string
       end
 
+      # Access stdout
       def stdout(*)
         @stdout.string
       end
 
+      # Access stderr
       def stderr(*)
         @stderr.string
       end
 
+      # Write strint to stdin
+      #
+      # @param [String] input
+      #   Write string to stdin in
       def write(input)
         @stdin.write input
       end
 
+      # Close io
       def close_io(name)
         fail ArgumentError, 'Only stdin stdout and stderr are allowed to close' unless [:stdin, :stdout, :stderr].include? name
 
         get_instance_variable(name.to_sym).close
       end
 
+      # Terminate program
       def terminate
         stop
       end

data/lib/aruba/processes/spawn_process.rb

@@ -6,7 +6,9 @@ require 'aruba/errors'
 require 'aruba/processes/basic_process'
 require 'aruba/platform'
 
+# Aruba
 module Aruba
+  # Platforms
   module Processes
     # Spawn a process for command
     #
@@ -29,12 +31,12 @@ module Aruba
       # @params [Integer] exit_timeout
       #   The timeout until we expect the command to be finished
       #
-      # @params [Integer] io_wait
+      # @params [Integer] io_wait_timeout
       #   The timeout until we expect the io to be finished
       #
       # @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, stop_signal = nil, startup_wait_time = 0)
+      def initialize(cmd, exit_timeout, io_wait_timeout, working_directory, environment = ENV.to_hash.dup, main_class = nil, stop_signal = nil, startup_wait_time = 0)
         super
 
         @process      = nil
@@ -50,6 +52,12 @@ module Aruba
       # rubocop:disable Metrics/MethodLength
       # rubocop:disable Metrics/CyclomaticComplexity
       def start
+        # rubocop:disable Metrics/LineLength
+        fail CommandAlreadyStartedError, %(Command "#{commandline}" has already been started. Please `#stop` the command first and `#start` it again. Alternatively use `#restart`.\n#{caller.join("\n")}) if started?
+        # rubocop:enable Metrics/LineLength
+
+        @started = true
+
         # gather fully qualified path
         cmd = Aruba.platform.which(command, environment['PATH'])
 
@@ -157,6 +165,7 @@ module Aruba
         self
       end
 
+      # Close io
       def close_io(name)
         return if stopped?
 
@@ -167,8 +176,8 @@ module Aruba
         end
       end
 
-      # rubocop:disable Metrics/MethodLength
-      def stop(reader)
+      # Stop command
+      def stop(*)
         return @exit_status if stopped?
 
         begin
@@ -178,15 +187,7 @@ module Aruba
         end
 
         terminate
-
-        if reader
-          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
@@ -216,7 +217,7 @@ module Aruba
         # @stdout_file = nil
         # @stderr_file = nil
 
-        @stopped      = true
+        @started = false
 
         @exit_status
       end

data/lib/aruba/rspec.rb

@@ -21,6 +21,9 @@ RSpec.configure do |config|
     end
 
     example.run
+
+    next unless self.class.include? Aruba::Api
+    stop_all_commands
   end
 
   if Aruba::VERSION >= '1.0.0'
@@ -42,37 +45,45 @@ RSpec.configure do |config|
     next unless self.class.include?(Aruba::Api)
 
     if example.metadata[:announce_environment]
-      Aruba.platform.deprecated 'announce_environment is deprecated. Use announce_modified_environment instead'
+      Aruba.platform.deprecated 'announce_environment is deprecated. Use announce_changed_environment instead'
+
+      aruba.announcer.activate(:changed_environment)
+    end
+
+    aruba.announcer.activate(:full_environment)     if example.metadata[:announce_full_environment]
+    aruba.announcer.activate(:changed_environment)  if example.metadata[:announce_changed_environment]
+
+    if example.metadata[:announce_modified_environment]
+      Aruba.platform.deprecated 'announce_modified_environment is deprecated. Use announce_changed_environment instead'
 
-      announcer.activate(:modified_environment)
+      aruba.announcer.activate(:changed_environment)
     end
 
-    announcer.activate(:full_environment)     if example.metadata[:announce_full_environment]
-    announcer.activate(:modified_environment) if example.metadata[:announce_modified_environment]
-    announcer.activate(:command)              if example.metadata[:announce_command]
-    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]
+    aruba.announcer.activate(:command)              if example.metadata[:announce_command]
+    aruba.announcer.activate(:directory)            if example.metadata[:announce_directory]
+    aruba.announcer.activate(:full_environment)     if example.metadata[:announce_full_environment]
+    aruba.announcer.activate(:stderr)               if example.metadata[:announce_stderr]
+    aruba.announcer.activate(:stdout)               if example.metadata[:announce_stdout]
+    aruba.announcer.activate(:stop_signal)          if example.metadata[:announce_stop_signal]
+    aruba.announcer.activate(:timeout)              if example.metadata[:announce_timeout]
+    aruba.announcer.activate(:wait_time)            if example.metadata[:announce_wait_time]
 
     if example.metadata[:announce_output]
-      announcer.activate(:stderr)
-      announcer.activate(:stdout)
+      aruba.announcer.activate(:stderr)
+      aruba.announcer.activate(:stdout)
     end
 
     if example.metadata[:announce]
-      announcer.activate(:stderr)
-      announcer.activate(:stdout)
-      announcer.activate(:environment)
-      announcer.activate(:modified_environment)
-      announcer.activate(:full_environment)
-      announcer.activate(:command)
-      announcer.activate(:directory)
-      announcer.activate(:stop_signal)
-      announcer.activate(:timeout)
-      announcer.activate(:wait_time)
+      aruba.announcer.activate(:changed_environment)
+      aruba.announcer.activate(:command)
+      aruba.announcer.activate(:directory)
+      aruba.announcer.activate(:environment)
+      aruba.announcer.activate(:full_environment)
+      aruba.announcer.activate(:stderr)
+      aruba.announcer.activate(:stdout)
+      aruba.announcer.activate(:stop_signal)
+      aruba.announcer.activate(:timeout)
+      aruba.announcer.activate(:wait_time)
     end
   end
 

data/lib/aruba/runtime.rb

@@ -1,18 +1,77 @@
 require 'aruba/config'
-require 'aruba/aruba_logger'
+require 'aruba/aruba_path'
+require 'aruba/config_wrapper'
+require 'aruba/events'
+require 'event/bus'
 
 module Aruba
+  # Runtime of aruba
+  #
+  # Most methods are considered private. Please look for `(private)` in the
+  # attribute descriptions. Only a few like `#current_directory`,
+  # '#root_directory` and `#config` are considered to be part of the public
+  # API.
   class Runtime
-    attr_reader :config, :current_directory, :environment, :root_directory, :logger
+    # @!attribute [r] current_directory
+    #   Returns the current working directory
+    #
+    # @!attribute [r] root_directory
+    #   Returns the root directory of aruba
+    attr_reader :current_directory, :root_directory
+
+    # @!attribute [r] config
+    #   Access configuration of aruba
+    #
+    # @!attribute [r] environment
+    #   Access environment of aruba (private)
+    #
+    # @!attribute [r] logger
+    #   Logger of aruba (private)
+    #
+    # @!attribute [r] command_monitor
+    #   Handler started commands (private)
+    #
+    # @!attribute [r] announcer
+    #   Announce information
+    #
+    # @!attribute [r] event_bus
+    #   Handle events (private)
+    #
+    attr_accessor :config, :environment, :logger, :command_monitor, :announcer, :event_bus
+
+    def initialize(opts = {})
+      @environment     = opts.fetch(:environment, Aruba.platform.environment_variables)
+      @event_bus     = ::Event::Bus.new(::Event::NameResolver.new(Aruba::Events))
+      @announcer       = opts.fetch(:announcer, Aruba.platform.announcer.new)
 
-    def initialize
-      @config            = Aruba.config.make_copy
+      @config            = opts.fetch(:config, ConfigWrapper.new(Aruba.config.make_copy, @event_bus))
       @current_directory = ArubaPath.new(@config.working_directory)
       @root_directory    = ArubaPath.new(@config.root_directory)
-      @environment       = Aruba.platform.environment_variables
 
-      @logger      = ArubaLogger.new
+      if Aruba::VERSION < '1'
+        @command_monitor = opts.fetch(:command_monitor, Aruba.platform.command_monitor.new(:announcer => @announcer))
+      else
+        @command_monitor = opts.fetch(:command_monitor, Aruba.platform.command_monitor.new)
+      end
+
+      @logger = opts.fetch(:logger, Aruba.platform.logger.new)
       @logger.mode = @config.log_level
+
+      @setup_done = false
+    end
+
+    # @private
+    #
+    # Setup of aruba is finshed. Should be used only internally.
+    def setup_done
+      @setup_done = true
+    end
+
+    # @private
+    #
+    # Has aruba already been setup. Should be used only internally.
+    def setup_already_done?
+      @setup_done == true
     end
 
     # The path to the directory which contains fixtures