aruba 0.9.0.pre → 0.9.0.pre2

data/lib/aruba/api/core.rb

@@ -53,22 +53,20 @@ module Aruba
             fail ArgumentError, "#{expand_path(dir)} is not a directory or does not exist." unless Aruba.platform.directory? expand_path(dir)
 
             aruba.current_directory << dir
+            announcer.announce :directory, expand_path(dir)
 
             old_dir    = Aruba.platform.getwd
-            old_oldpwd = ENV['OLDPWD']
-            old_pwd    = ENV['PWD']
-
-            ENV['OLDPWD'] = Aruba.platform.getwd
-            ENV['PWD'] = File.join(aruba.root_directory, aruba.current_directory).sub(%r{/$}, '')
 
             Aruba.platform.chdir File.join(aruba.root_directory, aruba.current_directory)
 
-            result = block.call
+            result = Aruba.platform.with_environment(
+              'OLDPWD' => old_dir,
+              'PWD' => File.expand_path(File.join(aruba.root_directory, aruba.current_directory)),
+              &block
+            )
           ensure
             aruba.current_directory.pop
             Aruba.platform.chdir old_dir
-            ENV['OLDPWD'] = old_oldpwd
-            ENV['PWD']    = old_pwd
           end
 
           return result
@@ -77,6 +75,7 @@ module Aruba
         fail ArgumentError, "#{expand_path(dir)} is not a directory or does not exist." unless Aruba.platform.directory? expand_path(dir)
 
         aruba.current_directory << dir
+        announcer.announce :directory, expand_path(dir)
 
         self
       end
@@ -129,22 +128,32 @@ module Aruba
         # rubocop:enable Metrics/LineLength
 
         if RUBY_VERSION < '1.9'
-          prefix = file_name.chars.to_a[0]
-          rest = file_name.chars.to_a[1..-1].join('')
+          prefix = file_name.chars.to_a[0].to_s
+          rest = if file_name.chars.to_a[2..-1].nil?
+                   nil
+                 else
+                   file_name.chars.to_a[2..-1].join
+                 end
         else
           prefix = file_name[0]
-          rest = file_name[1..-1]
+          rest = file_name[2..-1]
         end
 
         if aruba.config.fixtures_path_prefix == prefix
-          File.join aruba.fixtures_directory, rest
+          path = File.join(*[aruba.fixtures_directory, rest].compact)
+
+          # rubocop:disable Metrics/LineLength
+          fail ArgumentError, %(Fixture "#{rest}" does not exist in fixtures directory "#{aruba.fixtures_directory}". This was the one we found first on your system from all possible candidates: #{aruba.config.fixtures_directories.map { |p| format('"%s"', p) }.join(', ')}.) unless Aruba.platform.exist? path
+          # rubocop:enable Metrics/LineLength
+
+          path
         elsif '~' == prefix
           path = with_environment do
             ArubaPath.new(File.expand_path(file_name))
           end
 
-          fail 'Expanding "~/" to "/" is not allowed' if path.to_s == '/'
-          fail %(Expanding "~/" to a relative path "#{path}" is not allowed) unless path.absolute?
+          fail ArgumentError, 'Expanding "~/" to "/" is not allowed' if path.to_s == '/'
+          fail ArgumentError, %(Expanding "~/" to a relative path "#{path}" is not allowed) unless path.absolute?
 
           path.to_s
         else
@@ -163,23 +172,12 @@ module Aruba
       # @yield
       #   The block of code which should be run with the modified environment variables
       def with_environment(env = {}, &block)
-        if RUBY_VERSION <= '1.9.3'
-          old_env = ENV.to_hash.dup
-        else
-          old_env = ENV.to_h.dup
-        end
-
         old_aruba_env = aruba.environment.to_h
 
-        ENV.update aruba.environment.update(env).to_h
-
-        block.call if block_given?
+        Aruba.platform.with_environment aruba.environment.update(env).to_h, &block
       ensure
         aruba.environment.clear
         aruba.environment.update old_aruba_env
-
-        ENV.clear
-        ENV.update old_env
       end
     end
   end

data/lib/aruba/api/deprecated.rb

@@ -75,9 +75,9 @@ module Aruba
 
       # @deprecated
       def _read_interactive
-        Aruba.platform.deprecated('The use of "#_read_interactive" is deprecated. Please use "last_command.stdout" instead')
+        Aruba.platform.deprecated('The use of "#_read_interactive" is deprecated. Please use "last_command_started.stdout" instead')
 
-        last_command.stdout
+        last_command_started.stdout
       end
 
       # @deprecated
@@ -93,9 +93,9 @@ module Aruba
 
       # @deprecated
       def _write_interactive(input)
-        Aruba.platform.deprecated('The use of "#_write_interactive" is deprecated. Please use "#last_command.write()" instead')
+        Aruba.platform.deprecated('The use of "#_write_interactive" is deprecated. Please use "#last_command_started.write()" instead')
 
-        last_command.write(input)
+        last_command_started.write(input)
       end
 
       # @deprecated
@@ -133,7 +133,7 @@ module Aruba
       def mod?(file, perms, &block)
         Aruba.platform.deprecated('The use of "#mod?" is deprecated. Use "expect().to have_permissions()" instead')
 
-        expect(Array(file)).to all have_permissions(perms)
+        expect(Array(file)).to all_objects have_permissions(perms)
       end
 
       # @deprecated
@@ -181,7 +181,7 @@ module Aruba
       def check_file_presence(paths, expect_presence = true)
         Aruba.platform.deprecated('The use of "check_file_presence" is deprecated. Use "expect().to be_an_existing_file" or "expect(all_paths).to all match /pattern/" instead')
 
-        stop_processes!
+        stop_all_commands
 
         Array(paths).each do |path|
           if path.kind_of? Regexp
@@ -216,7 +216,8 @@ module Aruba
       #
       def check_file_size(paths_and_sizes)
         Aruba.platform.deprecated('The use of "#check_file_size" is deprecated. Use "expect(file).to have_file_size(size)", "expect(all_files).to all have_file_size(1)", "expect(all_files).to include a_file_with_size(1)" instead')
-        stop_processes!
+
+        stop_all_commands
 
         paths_and_sizes.each do |path, size|
           expect(path).to have_file_size size
@@ -244,7 +245,7 @@ module Aruba
       def check_binary_file_content(file, reference_file, expect_match = true)
         Aruba.platform.deprecated('The use of "#check_binary_file_content" is deprecated. Use "expect(file).to have_same_file_content_like(file)"')
 
-        stop_processes!
+        stop_all_commands
 
         if expect_match
           expect(file).to have_same_file_content_like reference_file
@@ -264,7 +265,7 @@ module Aruba
       def check_directory_presence(paths, expect_presence)
         Aruba.platform.deprecated('The use of "#check_directory_presence" is deprecated. Use "expect(directory).to be_an_existing_directory"')
 
-        stop_processes!
+        stop_all_commands
 
         paths.each do |path|
           path = expand_path(path)
@@ -281,8 +282,9 @@ module Aruba
       def prep_for_fs_check(&block)
         Aruba.platform.deprecated('The use of "prep_for_fs_check" is deprecated. Use apropriate methods and the new rspec matchers instead')
 
-        process_monitor.stop_processes!
-        cd('.') { block.call }
+        stop_all_commands
+
+        cd('') { block.call }
       end
 
       # @deprecated
@@ -322,7 +324,7 @@ module Aruba
       def check_file_content(file, content, expect_match = true)
         Aruba.platform.deprecated('The use of "#check_file_content" is deprecated. Use "expect(file).to have_file_content(content)" instead. For eq match use string, for partial match use /regex/')
 
-        stop_processes!
+        stop_all_commands
 
         if expect_match
           expect(file).to have_file_content content
@@ -499,6 +501,7 @@ module Aruba
 
         aruba.root_directory
       end
+
       # The path to the directory which contains fixtures
       # You might want to overwrite this method to place your data else where.
       #
@@ -514,6 +517,11 @@ module Aruba
       # rubocop:disable Metrics/CyclomaticComplexity
       # rubocop:disable Metrics/MethodLength
       def check_for_deprecated_variables
+        if defined? @aruba_exit_timeout
+          Aruba.platform.deprecated('The use of "@aruba_exit_timeout" is deprecated. Use "#aruba.config.exit_timeout = <numeric>" instead')
+          aruba.config.exit_timeout = @aruba_exit_timeout
+        end
+
         if defined? @aruba_io_wait_seconds
           Aruba.platform.deprecated('The use of "@aruba_io_wait_seconds" is deprecated. Use "#aruba.config.io_wait_timeout = <numeric>" instead')
           aruba.config.io_wait_timeout = @aruba_io_wait_seconds
@@ -521,16 +529,366 @@ module Aruba
 
         if defined? @keep_ansi
           Aruba.platform.deprecated('The use of "@aruba_keep_ansi" is deprecated. Use "#aruba.config.remove_ansi_escape_sequences = <true|false>" instead. Be aware that it uses an inverted logic')
+
           aruba.config.remove_ansi_escape_sequences = false
         end
 
         if defined? @aruba_root_directory
           Aruba.platform.deprecated('The use of "@aruba_root_directory" is deprecated. Use "#aruba.config.root_directory = <string>" instead')
+
           aruba.config.root_directory = @aruba_root_directory.to_s
         end
       end
       # rubocop:enable Metrics/CyclomaticComplexity
       # rubocop:enable Metrics/MethodLength
+
+      # Last command started
+      def last_command
+        Aruba.platform.deprecated('The use of "#last_command" is deprecated. Use "#last_command_started"')
+
+        process_monitor.last_command_started
+      end
+
+      # @deprecated
+      #
+      # Full compare arg1 and arg2
+      #
+      # @return [TrueClass, FalseClass]
+      #   If arg1 is exactly the same as arg2 return true, otherwise false
+      def assert_exact_output(expected, actual)
+        # rubocop:disable Metrics/LineLength
+        Aruba.platform.deprecated('The use of "#assert_exact_output" is deprecated. Use "expect(command).to have_output \'exact\'" instead. There are also special matchers for "stdout" and "stderr"')
+        # rubocop:enable Metrics/LineLength
+
+        actual.force_encoding(expected.encoding) if RUBY_VERSION >= "1.9"
+        expect(Aruba.platform.unescape(actual, aruba.config.keep_ansi)).to eq Aruba.platform.unescape(expected, aruba.config.keep_ansi)
+      end
+
+      # @deprecated
+      #
+      # Partial compare arg1 and arg2
+      #
+      # @return [TrueClass, FalseClass]
+      #   If arg2 contains arg1 return true, otherwise false
+      def assert_partial_output(expected, actual)
+        # rubocop:disable Metrics/LineLength
+        Aruba.platform.deprecated('The use of "#assert_partial_output" is deprecated. Use "expect(command).to have_output /partial/" instead. There are also special matchers for "stdout" and "stderr"')
+        # rubocop:enable Metrics/LineLength
+
+        actual.force_encoding(expected.encoding) if RUBY_VERSION >= "1.9"
+        expect(Aruba.platform.unescape(actual, aruba.config.keep_ansi)).to include(Aruba.platform.unescape(expected, aruba.config.keep_ansi))
+      end
+
+      # @deprecated
+      #
+      # Regex Compare arg1 and arg2
+      #
+      # @return [TrueClass, FalseClass]
+      #   If arg2 matches arg1 return true, otherwise false
+      def assert_matching_output(expected, actual)
+        # rubocop:disable Metrics/LineLength
+        Aruba.platform.deprecated('The use of "#assert_matching_output" is deprecated. Use "expect(command).to have_output /partial/" instead. There are also special matchers for "stdout" and "stderr"')
+        # rubocop:enable Metrics/LineLength
+
+        actual.force_encoding(expected.encoding) if RUBY_VERSION >= "1.9"
+        expect(Aruba.platform.unescape(actual, aruba.config.keep_ansi)).to match(/#{Aruba.platform.unescape(expected, aruba.config.keep_ansi)}/m)
+      end
+
+      # @deprecated
+      #
+      # Negative regex compare arg1 and arg2
+      #
+      # @return [TrueClass, FalseClass]
+      #   If arg2 does not match arg1 return true, otherwise false
+      def assert_not_matching_output(expected, actual)
+        # rubocop:disable Metrics/LineLength
+        Aruba.platform.deprecated('The use of "#assert_not_matching_output" is deprecated. Use "expect(command).not_to have_output /partial/" instead. There are also special matchers for "stdout" and "stderr"')
+        # rubocop:enable Metrics/LineLength
+
+        actual.force_encoding(expected.encoding) if RUBY_VERSION >= "1.9"
+        expect(Aruba.platform.unescape(actual, aruba.config.keep_ansi)).not_to match(/#{Aruba.platform.unescape(expected, aruba.config.keep_ansi)}/m)
+      end
+
+      # @deprecated
+      #
+      # Negative partial compare arg1 and arg2
+      #
+      # @return [TrueClass, FalseClass]
+      #   If arg2 does not match/include arg1 return true, otherwise false
+      def assert_no_partial_output(unexpected, actual)
+        # rubocop:disable Metrics/LineLength
+        Aruba.platform.deprecated('The use of "#assert_no_partial_output" is deprecated. Use "expect(command).not_to have_output /partial/" instead. There are also special matchers for "stdout" and "stderr"')
+        # rubocop:enable Metrics/LineLength
+
+        actual.force_encoding(unexpected.encoding) if RUBY_VERSION >= "1.9"
+        if Regexp === unexpected
+          expect(Aruba.platform.unescape(actual, aruba.config.keep_ansi)).not_to match unexpected
+        else
+          expect(Aruba.platform.unescape(actual, aruba.config.keep_ansi)).not_to include(unexpected)
+        end
+      end
+
+      # @deprecated
+      #
+      # Partial compare output of interactive command and arg1
+      #
+      # @return [TrueClass, FalseClass]
+      #   If output of interactive command includes arg1 return true, otherwise false
+      def assert_partial_output_interactive(expected)
+        # rubocop:disable Metrics/LineLength
+        Aruba.platform.deprecated('The use of "#assert_partial_output_interactive" is deprecated. Use "expect(last_command_started).to have_output /partial/" instead. There are also special matchers for "stdout" and "stderr"')
+        # rubocop:enable Metrics/LineLength
+
+        Aruba.platform.unescape(last_command_started.stdout, aruba.config.keep_ansi).include?(Aruba.platform.unescape(expected, aruba.config.keep_ansi)) ? true : false
+      end
+
+      # @deprecated
+      #
+      # Check if command succeeded and if arg1 is included in output
+      #
+      # @return [TrueClass, FalseClass]
+      #   If exit status is 0 and arg1 is included in output return true, otherwise false
+      def assert_passing_with(expected)
+        # rubocop:disable Metrics/LineLength
+        Aruba.platform.deprecated('The use of "#assert_passing_with" is deprecated. Use "expect(all_commands).to all(be_successfully_executed).and include_an_object(have_output(/partial/))" or something similar instead. There are also special matchers for "stdout" and "stderr"')
+        # rubocop:enable Metrics/LineLength
+
+        assert_success(true)
+        assert_partial_output(expected, all_output)
+      end
+
+      # @deprecated
+      #
+      # Check if command failed and if arg1 is included in output
+      #
+      # @return [TrueClass, FalseClass]
+      #   If exit status is not equal 0 and arg1 is included in output return true, otherwise false
+      def assert_failing_with(expected)
+        # rubocop:disable Metrics/LineLength
+        Aruba.platform.deprecated('The use of "#assert_passing_with" is deprecated. Use "expect(all_commands).not_to include_an_object(be_successfully_executed).and include_an_object(have_output(/partial/))" or something similar instead. There are also special matchers for "stdout" and "stderr"')
+        # rubocop:enable Metrics/LineLength
+
+        assert_success(false)
+        assert_partial_output(expected, all_output)
+      end
+
+      # @deprecated
+      #
+      # Check exit status of process
+      #
+      # @return [TrueClass, FalseClass]
+      #   If arg1 is true, return true if command was successful
+      #   If arg1 is false, return true if command failed
+      def assert_success(success)
+        # rubocop:disable Metrics/LineLength
+        Aruba.platform.deprecated('The use of "#assert_success" is deprecated. Use "expect(last_command_started).to be_successfully_executed" or with "not_to" or the negative form "have_failed_running" (requires rspec >= 3.1)')
+        # rubocop:enable Metrics/LineLength
+
+        if success
+          expect(last_command_started).to be_successfully_executed
+        else
+          expect(last_command_started).not_to be_successfully_executed
+        end
+      end
+
+      # @deprecated
+      def assert_exit_status(status)
+        # rubocop:disable Metrics/LineLength
+        Aruba.platform.deprecated('The use of "#assert_success" is deprecated. Use "expect(last_command_started).to have_exit_status(status)"')
+        # rubocop:enable Metrics/LineLength
+
+        expect(last_command_started).to have_exit_status(status)
+      end
+
+      # @deprecated
+      def assert_not_exit_status(status)
+        # rubocop:disable Metrics/LineLength
+        Aruba.platform.deprecated('The use of "#assert_success" is deprecated. Use "expect(last_command_started).not_to have_exit_status(status)"')
+        # rubocop:enable Metrics/LineLength
+
+        expect(last_exit_status).not_to eq(status),
+          append_output_to("Exit status was #{last_exit_status} which was not expected.")
+      end
+
+      # @deprecated
+      def append_output_to(message)
+        Aruba.platform.deprecated('The use of "#append_output_to" is deprecated')
+
+        "#{message} Output:\n\n#{all_output}\n"
+      end
+
+      # @deprecated
+      def register_process(*args)
+        # Aruba.platform.deprecated('The use of "#register_process" is deprecated')
+
+        process_monitor.register_process(*args)
+      end
+
+      # @deprecated
+      def get_process(wanted)
+        # Aruba.platform.deprecated('The use of "#get_process" is deprecated')
+
+        process_monitor.get_process(wanted)
+      end
+
+      # @deprecated
+      #
+      # Fetch output (stdout, stderr) from command
+      #
+      # @param [String] cmd
+      #   The command
+      def output_from(cmd)
+        # Aruba.platform.deprecated('The use of "#output_from" is deprecated')
+
+        process_monitor.output_from(cmd)
+      end
+
+      # @deprecated
+      #
+      # Fetch stdout from command
+      #
+      # @param [String] cmd
+      #   The command
+      def stdout_from(cmd)
+        # Aruba.platform.deprecated('The use of "#stdout_from" is deprecated')
+
+        process_monitor.stdout_from(cmd)
+      end
+
+      # @deprecated
+      #
+      # Fetch stderr from command
+      #
+      # @param [String] cmd
+      #   The command
+      def stderr_from(cmd)
+        # Aruba.platform.deprecated('The use of "#stderr_from" is deprecated')
+
+        process_monitor.stderr_from(cmd)
+      end
+
+      # @deprecated
+      #
+      # Get stdout of all processes
+      #
+      # @return [String]
+      #   The stdout of all process which have run before
+      def all_stdout
+        Aruba.platform.deprecated('The use of "#all_stdout" is deprecated. Use `all_commands.map { |c| c.stdout }.join("\n") instead. If you need to check for some output use "expect(all_commands).to have_output_on_stdout /output/" instead')
+
+        process_monitor.all_stdout
+      end
+
+      # @deprecated
+      #
+      # Get stderr of all processes
+      #
+      # @return [String]
+      #   The stderr of all process which have run before
+      def all_stderr
+        Aruba.platform.deprecated('The use of "#all_stderr" is deprecated. Use `all_commands.map { |c| c.stderr }.join("\n") instead. If you need to check for some output use "expect(all_commands).to have_output_on_stderr /output/" instead')
+
+        process_monitor.all_stderr
+      end
+
+      # @deprecated
+      #
+      # Get stderr and stdout of all processes
+      #
+      # @return [String]
+      #   The stderr and stdout of all process which have run before
+      def all_output
+        Aruba.platform.deprecated('The use of "#all_output" is deprecated. Use `all_commands.map { |c| c.output }.join("\n") instead. If you need to check for some output use "expect(all_commands).to have_output /output/" instead')
+
+        process_monitor.all_output
+      end
+
+      # @deprecated
+      #
+      # Default exit timeout for running commands with aruba
+      #
+      # Overwrite this method if you want a different timeout or set
+      # `@aruba_timeout_seconds`.
+      def exit_timeout
+        Aruba.platform.deprecated('The use of "#exit_timeout" is deprecated. Use "aruba.config.exit_timeout" instead.')
+
+        aruba.config.exit_timeout
+      end
+
+      # @deprecated
+      #
+      # Default io wait timeout
+      #
+      # Overwrite this method if you want a different timeout or set
+      # `@aruba_io_wait_seconds
+      def io_wait
+        Aruba.platform.deprecated('The use of "#io_wait" is deprecated. Use "aruba.config.io_wait_timeout" instead')
+
+        aruba.config.io_wait_timeout
+      end
+
+      # @deprecated
+      # Only processes
+      def only_processes
+        Aruba.platform.deprecated('The use of "#only_processes" is deprecated. Use "#all_commands" instead')
+
+        process_monitor.only_processes
+      end
+
+      # @deprecated
+      def last_exit_status
+        Aruba.platform.deprecated('The use of "#last_exit_status" is deprecated. Use "#last_command_(started|stopped).exit_status" instead')
+
+        process_monitor.last_exit_status
+      end
+
+      # @deprecated
+      def stop_process(process)
+        # Aruba.platform.deprecated('The use of "#stop_process" is deprecated. Use "#last_command_(started|stopped).stop" instead')
+
+        @last_exit_status = process_monitor.stop_process(process)
+      end
+
+      # @deprecated
+      def terminate_process(process)
+        # Aruba.platform.deprecated('The use of "#terminate_process" is deprecated. Use "#last_command_(started|stopped).terminate" instead')
+
+        process_monitor.terminate_process(process)
+      end
+
+      # @deprecated
+      def stop_processes!
+        Aruba.platform.deprecated('The use of "#stop_processes!" is deprecated. Use "#stop_all_commands" instead')
+
+        stop_all_commands
+      end
+
+      # @deprecated
+      #
+      # Terminate all running processes
+      def terminate_processes!
+        Aruba.platform.deprecated('The use of "#stop_processes!" is deprecated. Use "all_commands.each(&:terminate)" instead')
+
+        all_commands.each(&:terminate)
+      end
+
+      # @deprecated
+      #
+      # Access to announcer
+      def announcer
+        # Aruba.platform.deprecated('The use of "#announcer" is deprecated. Use "aruba.announcer" instead')
+
+        @announcer ||= Announcer.new(
+          self,
+          :stdout => defined?(@announce_stdout),
+          :stderr => defined?(@announce_stderr),
+          :dir    => defined?(@announce_dir),
+          :cmd    => defined?(@announce_cmd),
+          :env    => defined?(@announce_env)
+        )
+
+        @announcer
+      end
     end
   end
 end