aruba 2.4.1 → 3.0.0

data/lib/aruba/cucumber.rb

@@ -8,4 +8,3 @@ require 'aruba/cucumber/parameter_types'
 require 'aruba/cucumber/command'
 require 'aruba/cucumber/environment'
 require 'aruba/cucumber/file'
-require 'aruba/cucumber/testing_frameworks'

data/lib/aruba/events.rb

@@ -6,34 +6,70 @@ require 'cucumber/core/event'
 module Aruba
   # Events
   module Events
-    # Basic event
-    #
-    # This is not meant for direct use - BasicEvent.new - by users. It is
-    # inherited by normal events
-    #
-    # @private
-    class BasicEvent < Cucumber::Core::Event.new(:entity); end
+    # cucumber-core version 19 and up
+    if defined? Cucumber::Core::Event::Base
+      # @private
+      class BasicEvent < Cucumber::Core::Event::Base
+        attr_reader :entity
+
+        def initialize(entity)
+          @entity = entity
+          super()
+        end
+      end
+    else
+      # @private
+      class BasicEvent < Cucumber::Core::Event.new(:entity); end
+    end
 
     # Command was stopped
-    class CommandStopped < BasicEvent; end
+    class CommandStopped < BasicEvent
+      def self.event_id
+        :command_stopped
+      end
+    end
 
     # Command was started
-    class CommandStarted < BasicEvent; end
+    class CommandStarted < BasicEvent
+      def self.event_id
+        :command_started
+      end
+    end
 
     # An environment variable was changed
-    class ChangedEnvironmentVariable < BasicEvent; end
+    class ChangedEnvironmentVariable < BasicEvent
+      def self.event_id
+        :changed_environment_variable
+      end
+    end
 
     # An environment variable was added
-    class AddedEnvironmentVariable < BasicEvent; end
+    class AddedEnvironmentVariable < BasicEvent
+      def self.event_id
+        :added_environment_variable
+      end
+    end
 
     # An environment variable was deleted
-    class DeletedEnvironmentVariable < BasicEvent; end
+    class DeletedEnvironmentVariable < BasicEvent
+      def self.event_id
+        :deleted_environment_variable
+      end
+    end
 
     # The working directory has changed
-    class ChangedWorkingDirectory < BasicEvent; end
+    class ChangedWorkingDirectory < BasicEvent
+      def self.event_id
+        :changed_working_directory
+      end
+    end
 
     # The configuration was changed
-    class ChangedConfiguration < BasicEvent; end
+    class ChangedConfiguration < BasicEvent
+      def self.event_id
+        :changed_configuration
+      end
+    end
 
     def self.registry
       [CommandStarted,

data/lib/aruba/generators/script_file.rb

@@ -10,15 +10,15 @@ module Aruba
 
     public
 
-    def initialize(opts = {})
-      @path        = opts[:path]
-      @content     = opts[:content]
-      @interpreter = opts[:interpreter]
+    def initialize(path: nil, content: nil, interpreter: nil)
+      @path        = path
+      @content     = content
+      @interpreter = interpreter
     end
 
     def call
       Aruba.platform.write_file(path, "#{header}#{content}")
-      Aruba.platform.chmod(0o755, path, {})
+      Aruba.platform.chmod(0o755, path)
     end
 
     private

data/lib/aruba/initializer.rb

@@ -3,7 +3,8 @@
 require 'thor/group'
 require 'thor/actions'
 
-# Aruba
+require 'aruba/version'
+
 module Aruba
   # Initializers
   #
@@ -154,7 +155,11 @@ module Aruba
             include Aruba::Api
 
             def setup
-              setup_aruba
+              aruba.setup
+            end
+
+            def teardown
+              aruba.teardown
             end
 
             def test_dummy

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

@@ -27,7 +27,7 @@ RSpec::Matchers.define :have_output do |expected|
 
     @old_actual.stop
 
-    @actual = sanitize_text(actual.output)
+    @actual = extract_text(actual.output)
 
     values_match?(expected, @actual)
   end

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

@@ -25,7 +25,7 @@ RSpec::Matchers.define :have_output_on_stderr do |expected|
 
     @old_actual.stop
 
-    @actual = sanitize_text(actual.stderr)
+    @actual = extract_text(actual.stderr)
 
     values_match?(expected, @actual)
   end

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

@@ -25,7 +25,7 @@ RSpec::Matchers.define :have_output_on_stdout do |expected|
 
     @old_actual.stop
 
-    @actual = sanitize_text(actual.stdout)
+    @actual = extract_text(actual.stdout)
 
     values_match?(expected, @actual)
   end

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

@@ -1,12 +1,10 @@
 # frozen_string_literal: true
 
-# @!method have_output_size(output)
-#   This matchers checks if output has size.
+# @!method have_output_size
+#   This matcher checks if the process has produced output of a given size.
 #
-#   @param [String,Aruba::Process:BasicProcess] output or process
-#     The content which should be checked, or the process whose output should be checked
-#
-#     Use of this matcher with a string is deprecated.
+#   @param [Aruba::Process:BasicProcess] process
+#     The process whose output should be checked
 #
 #   @return [Boolean] The result
 #
@@ -18,24 +16,13 @@
 #   @example Use matcher
 #
 #     RSpec.describe do
-#       it { expect(file1).to have_output_size(256) }
-#     end
-#
-#     RSpec.describe do
 #       it { expect(last_command_started).to have_output_size(256) }
 #     end
 RSpec::Matchers.define :have_output_size do |expected|
   match do |actual|
-    if actual.respond_to? :size
-      Aruba.platform.deprecated \
-        'Application of the have_output_size matcher to a string is deprecated. ' \
-        'Apply the matcher directly to the process object instead'
-      actual_size = actual.size
-    elsif actual.respond_to? :output
-      actual_size = actual.output.size
-    else
-      raise "Expected #{actual} to respond to #size or #output"
-    end
+    raise "Expected #{actual} to respond to #output" unless actual.respond_to? :output
+
+    actual_size = actual.output.size
 
     values_match? expected, actual_size
   end

data/lib/aruba/matchers/string/match_output_string.rb

@@ -33,5 +33,3 @@ RSpec::Matchers.define :match_output_string do |expected|
 end
 
 RSpec::Matchers.alias_matcher :an_output_string_matching, :match_output_string
-RSpec::Matchers.alias_matcher :a_file_name_matching, :match_output_string
-RSpec::Matchers.alias_matcher :file_content_matching, :match_output_string

data/lib/aruba/platforms/unix_platform.rb

@@ -112,7 +112,7 @@ module Aruba
       end
 
       # Remove file, directory + sub-directories
-      def rm(paths, options = {})
+      def rm(paths, **options)
         paths = Array(paths).map { |p| ::File.expand_path(p) }
 
         FileUtils.rm_r(paths, **options)
@@ -133,7 +133,7 @@ module Aruba
       end
 
       # Touch file, directory
-      def touch(args, options)
+      def touch(args, **options)
         FileUtils.touch(args, **options)
       end
 
@@ -148,7 +148,7 @@ module Aruba
       end
 
       # Change mode of file/directory
-      def chmod(mode, args, options)
+      def chmod(mode, args, **options)
         FileUtils.chmod_R(mode, args, **options)
       end
 

data/lib/aruba/platforms/unix_which.rb

@@ -40,7 +40,7 @@ module Aruba
 
         def call(program, path)
           # Iterate over each path glob the dir + program.
-          path.split(File::PATH_SEPARATOR).each do |dir|
+          path&.split(File::PATH_SEPARATOR)&.each do |dir|
             dir = Aruba.platform.expand_path(dir, Dir.getwd)
             next unless Aruba.platform.exist?(dir) # In case of bogus second argument
 
@@ -65,7 +65,7 @@ module Aruba
         @whiches << DefaultWhich
       end
 
-      # Find fully quallified path for program
+      # Find fully qualified path for program
       #
       # @param [String] program
       #   Name of program
@@ -73,8 +73,6 @@ module Aruba
       # @param [String] 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
 
         whiches.find { |w| w.match? program }.new.call(program, path)

data/lib/aruba/platforms/windows_which.rb

@@ -43,7 +43,7 @@ module Aruba
 
         def call(program, path)
           # Iterate over each path glob the dir + program.
-          path.split(File::PATH_SEPARATOR).each do |dir|
+          path&.split(File::PATH_SEPARATOR)&.each do |dir|
             dir = Aruba.platform.expand_path(dir, Dir.getwd)
 
             next unless Aruba.platform.exist?(dir) # In case of bogus second argument
@@ -79,7 +79,7 @@ module Aruba
         @whiches << DefaultWhich
       end
 
-      # Find fully quallified path for program
+      # Find fully qualified path for program
       #
       # @param [String] program
       #   Name of program
@@ -87,8 +87,6 @@ module Aruba
       # @param [String] 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
         program += windows_executable_extentions if File.extname(program).empty?
 

data/lib/aruba/processes/basic_process.rb

@@ -9,13 +9,13 @@ module Aruba
   module Processes
     # Basic Process
     #
-    # `BasicProcess` is not meant for direct use - `BasicProcess.new` - by users.
+    # Base class for all Aruba process runners.
     #
-    # @private
     class BasicProcess
       attr_reader :exit_status, :environment, :working_directory, :main_class,
                   :io_wait_timeout, :exit_timeout, :startup_wait_time, :stop_signal
 
+      # @private
       def initialize(cmd, exit_timeout, io_wait_timeout, working_directory, # rubocop:disable Metrics/ParameterLists
                      environment = Aruba.platform.environment_variables.hash_from_env,
                      main_class = nil, stop_signal = nil, startup_wait_time = 0)
@@ -45,8 +45,8 @@ module Aruba
       end
 
       # Output stderr and stdout
-      def output(opts = {})
-        stdout(opts) + stderr(opts)
+      def output(**opts)
+        stdout(**opts) + stderr(**opts)
       end
 
       def write(*)

data/lib/aruba/processes/debug_process.rb

@@ -16,9 +16,10 @@ module Aruba
     # users. Only its public methods are part of the public API of aruba, e.g.
     # `#stdin`, `#stdout`.
     #
-    # @private
     class DebugProcess < BasicProcess
       # Use only if mode is :debug
+      #
+      # @private
       def self.match?(mode)
         mode == :debug || (mode.is_a?(Class) && mode <= DebugProcess)
       end

data/lib/aruba/processes/in_process.rb

@@ -15,9 +15,10 @@ module Aruba
     # 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
+      #
+      # @private
       def self.match?(mode)
         mode == :in_process || (mode.is_a?(Class) && mode <= InProcess)
       end
@@ -48,6 +49,7 @@ module Aruba
       # @private
       attr_reader :main_class
 
+      # @private
       def initialize(cmd, exit_timeout, io_wait_timeout, working_directory, # rubocop:disable Metrics/ParameterLists
                      environment = Aruba.platform.environment_variables.hash_from_env,
                      main_class = nil, stop_signal = nil, startup_wait_time = 0)

data/lib/aruba/processes/spawn_process.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'marcel'
 require 'tempfile'
 require 'shellwords'
 
@@ -74,7 +75,7 @@ module Aruba
           return true if exited?
           break if Time.now >= wait_until
 
-          sleep 0.1
+          sleep 0.01
         end
         false
       end
@@ -96,9 +97,9 @@ module Aruba
     # 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
+      # @private
       def self.match?(_mode)
         true
       end
@@ -128,6 +129,8 @@ module Aruba
       #
       # @param [Numeric] startup_wait_time
       #   The amount of seconds to wait after Aruba has started a command.
+      #
+      # @private
       def initialize(cmd, exit_timeout, io_wait_timeout, working_directory, # rubocop:disable Metrics/ParameterLists
                      environment = Aruba.platform.environment_variables.hash_from_env,
                      main_class = nil, stop_signal = nil, startup_wait_time = 0)
@@ -156,8 +159,8 @@ module Aruba
 
         @process = ProcessRunner.new(command_string.to_a)
 
-        @stdout_file = Tempfile.new('aruba-stdout-')
-        @stderr_file = Tempfile.new('aruba-stderr-')
+        @stdout_file = Tempfile.create('aruba-stdout-', anonymous: true)
+        @stderr_file = Tempfile.create('aruba-stderr-', anonymous: true)
 
         @stdout_file.sync = true
         @stderr_file.sync = true
@@ -196,39 +199,35 @@ module Aruba
 
       # Access to stdout of process
       #
-      # @param [Hash] opts
-      #   Options
-      #
-      # @option [Integer] wait_for_io
+      # @param [Integer] wait_for_io
       #   Wait for IO to be finished
       #
       # @return [String]
       #   The content of stdout
-      def stdout(opts = {})
+      def stdout(wait_for_io: io_wait_timeout)
         return @stdout_cache if stopped?
 
-        wait_for_io opts.fetch(:wait_for_io, io_wait_timeout) do
+        wait_for_io wait_for_io do
           @process.stdout.flush
-          File.read(@stdout_file.path)
+          @stdout_file.rewind
+          @stdout_file.read
         end
       end
 
       # Access to stderr of process
       #
-      # @param [Hash] opts
-      #   Options
-      #
-      # @option [Integer] wait_for_io
+      # @param [Integer] wait_for_io
       #   Wait for IO to be finished
       #
       # @return [String]
       #   The content of stderr
-      def stderr(opts = {})
+      def stderr(wait_for_io: io_wait_timeout)
         return @stderr_cache if stopped?
 
-        wait_for_io opts.fetch(:wait_for_io, io_wait_timeout) do
+        wait_for_io wait_for_io do
           @process.stderr.flush
-          File.read(@stderr_file.path)
+          @stderr_file.rewind
+          @stderr_file.read
         end
       end
 
@@ -322,10 +321,16 @@ module Aruba
       # Content of command
       #
       # @return [String]
-      #   The content of the script/command. This might be binary output as
-      #   string if your command is a binary executable.
+      #   The content of the script/command. If your command is a binary
+      #   executable, a human-readable message is returned instead.
       def content
-        File.read command_path
+        return unless command_path
+
+        if binary_file?(command_path)
+          "Binary content of '#{command_path}' not displayed"
+        else
+          File.read command_path
+        end
       end
 
       def interactive?
@@ -352,6 +357,12 @@ module Aruba
           end
       end
 
+      def binary_file?(file_path)
+        mime_type = Marcel::MimeType.for Pathname.new(file_path)
+        magic = Marcel::Magic.new mime_type
+        !magic.text?
+      end
+
       def wait_for_io(time_to_wait)
         sleep time_to_wait
         yield

data/lib/aruba/rspec.rb

@@ -10,47 +10,40 @@ RSpec.configure do |config|
   config.include Aruba::Api, type: :aruba
 
   # Setup environment for aruba
-  config.around :each do |example|
-    if self.class.include? Aruba::Api
-      setup_aruba
+  config.around :each, type: :aruba do |example|
+    aruba.setup
 
-      # Modify PATH to include project/bin
-      prepend_environment_variable(
-        'PATH',
-        aruba.config.command_search_paths.join(File::PATH_SEPARATOR) + File::PATH_SEPARATOR
-      )
+    # Modify PATH to include project/bin
+    prepend_environment_variable(
+      '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
-    end
+    # Use configured home directory as HOME
+    set_environment_variable 'HOME', aruba.home_directory
 
     example.run
 
-    next unless self.class.include? Aruba::Api
-
     stop_all_commands
+    if example.exception
+      warn "Find the Aruba working directory for inspection at #{aruba.home_directory}"
+    else
+      aruba.teardown
+    end
   end
 
-  config.around :each do |example|
-    if self.class.include? Aruba::Api
-      with_environment do
-        example.run
-      end
-    else
+  config.around :each, type: :aruba do |example|
+    with_environment do
       example.run
     end
   end
 
-  config.before :each do |example|
-    next unless self.class.include? Aruba::Api
-
+  config.before :each, type: :aruba do |example|
     example.metadata.each { |k, v| aruba.config.set_if_option(k, v) }
   end
 
   # Activate announcers based on rspec metadata
-  config.before :each do |example|
-    next unless self.class.include?(Aruba::Api)
-
+  config.before :each, type: :aruba do |example|
     if example.metadata[:announce_full_environment]
       aruba.announcer.activate(:full_environment)
     end

data/lib/aruba/runtime.rb

@@ -17,9 +17,15 @@ module Aruba
     # @!attribute [r] current_directory
     #   Returns the current working directory
     #
+    # @!attribute [r] working_directory
+    #   Returns the working directory
+    #
     # @!attribute [r] root_directory
     #   Returns the root directory of aruba
-    attr_reader :current_directory, :root_directory
+    #
+    # @!attribute [r] home_directory
+    #   Returns the home directory used to mock HOME by aruba
+    attr_reader :current_directory, :working_directory, :root_directory, :home_directory
 
     # @!attribute [r] config
     #   Access configuration of aruba
@@ -39,40 +45,46 @@ module Aruba
     # @!attribute [r] event_bus
     #   Handle events (private)
     #
-    attr_accessor :config, :environment, :logger, :command_monitor, :announcer, :event_bus
+    attr_reader :config, :environment, :logger, :command_monitor, :announcer, :event_bus
 
-    def initialize(opts = {})
+    def initialize(config: Aruba.config)
       @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))
-      @environment     = opts.fetch(:environment, Aruba.platform.environment_variables.new)
-      @current_directory = ArubaPath.new(@config.working_directory)
-      @root_directory    = ArubaPath.new(@config.root_directory)
+      @announcer       = Aruba.platform.announcer.new
+      @config          = ConfigWrapper.new(config.make_copy, @event_bus)
+      @environment     = Aruba.platform.environment_variables.new
+
+      @root_directory = ArubaPath.new(@config.root_directory)
 
       @environment.update(@config.command_runtime_environment)
 
-      @command_monitor = opts.fetch(:command_monitor,
-                                    Aruba.platform.command_monitor.new(announcer: @announcer))
+      @command_monitor = Aruba.platform.command_monitor.new(announcer: @announcer)
 
-      @logger = opts.fetch(:logger, Aruba.platform.logger.new)
+      @logger = Aruba.platform.logger.new
       @logger.mode = @config.log_level
 
+      @setup = Aruba::Setup.new(self)
       @setup_done = false
     end
 
-    # @private
-    #
-    # Setup of aruba is finshed. Should be used only internally.
-    def setup_done
+    # Set up Aruba's workspace and event bus. Cleans out the workspace as well.
+    def setup
+      return if @setup_done
+
+      @setup.setup
+
+      @home_directory = @setup.workspace_directory
+      @working_directory = Pathname.new(@home_directory)
+                                   .relative_path_from(@config.root_directory).to_s
+      @current_directory = ArubaPath.new(@working_directory)
+
       @setup_done = true
     end
 
-    # @private
-    #
-    # Has aruba already been setup. Should be used only internally.
-    def setup_already_done?
-      @setup_done == true
+    def teardown
+      return unless @setup_done
+
+      @setup.teardown
+      @setup_done = false
     end
 
     # The path to the directory which contains fixtures
@@ -99,5 +111,11 @@ module Aruba
 
       ArubaPath.new(@fixtures_directory)
     end
+
+    private
+
+    def setup_already_done?
+      @setup_done == true
+    end
   end
 end