aruba 0.9.0.pre → 0.9.0.pre2

data/lib/aruba/processes/debug_process.rb

@@ -11,50 +11,52 @@ module Aruba
 
       # rubocop:disable Metrics/MethodLength
       # rubocop:disable Metrics/CyclomaticComplexity
-      def run!
-        # rubocop:disable  Metrics/LineLength
-        fail LaunchError, %(Command "#{command}" not found in PATH-variable "#{environment['PATH']}".) unless which(command)
-        # rubocop:enable  Metrics/LineLength
-
-        if RUBY_VERSION < '1.9'
-          begin
-            old_env = ENV.to_hash.dup
-            ENV.update environment
-
-            Dir.chdir @working_directory do
-              @exit_status = system(@cmd) ? 0 : 1
-            end
-          ensure
-            ENV.clear
-            ENV.update old_env
+      def start
+        Dir.chdir @working_directory do
+          Aruba.platform.with_environment(environment) do
+            @exit_status = system(command, *arguments) ? 0 : 1
           end
-        elsif RUBY_VERSION < '2'
-          Dir.chdir @working_directory do
-            @exit_status = system(environment, @cmd) ? 0 : 1
-          end
-        else
-          @exit_status = system(environment, @cmd, :chdir => @working_directory) ? 0 : 1
         end
       end
       # rubocop:enable Metrics/CyclomaticComplexity
       # rubocop:enable Metrics/MethodLength
 
+      # Return stdin
+      #
+      # @return [NilClass]
+      #   Nothing
       def stdin(*); end
 
+      # Return stdout
+      #
+      # @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.'
       end
 
+      # Return stderr
+      #
+      # @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.'
       end
 
-      def stop(_reader)
+      # Write to nothing
+      def write(*); end
+
+      # Close nothing
+      def close_io(*); end
+
+      # Stop process
+      def stop(*)
         @stopped = true
 
         @exit_status
       end
 
+      # Terminate process
       def terminate(*)
         stop
       end

data/lib/aruba/processes/in_process.rb

@@ -1,6 +1,7 @@
 require 'shellwords'
 require 'stringio'
 require 'aruba/processes/basic_process'
+require 'aruba/platform'
 
 module Aruba
   module Processes
@@ -29,6 +30,7 @@ module Aruba
         attr_accessor :main_class
       end
 
+      # @private
       attr_reader :main_class
 
       def initialize(cmd, exit_timeout, io_wait, working_directory, environment = ENV.to_hash.dup, main_class = nil)
@@ -42,13 +44,13 @@ module Aruba
         super
       end
 
-      def run!
+      def start
         fail "You need to call aruba.config.main_class = YourMainClass" unless main_class
 
         Dir.chdir @working_directory do
           before_run
 
-          in_environment 'PWD' => @working_directory do
+          Aruba.platform.with_environment environment.merge('PWD' => @working_directory) do
             main_class.new(@argv, @stdin, @stdout, @stderr, @kernel).execute!
           end
 
@@ -58,7 +60,7 @@ module Aruba
         end
       end
 
-      def stop(reader)
+      def stop(*)
         @stopped     = true
         @exit_status = @kernel.exitstatus
       end
@@ -67,11 +69,11 @@ module Aruba
         @stdin.string
       end
 
-      def stdout
+      def stdout(*)
         @stdout.string
       end
 
-      def stderr
+      def stderr(*)
         @stderr.string
       end
 
@@ -88,23 +90,6 @@ module Aruba
       def terminate
         stop
       end
-
-      private
-
-      def in_environment(env = {}, &block)
-        if RUBY_VERSION <= '1.9.3'
-          old_env = ENV.to_hash
-        else
-          old_env = ENV.to_h
-        end
-
-        ENV.update(environment).update(env)
-
-        block.call if block_given?
-      ensure
-        ENV.clear
-        ENV.update old_env
-      end
     end
   end
 end

data/lib/aruba/processes/spawn_process.rb

@@ -30,11 +30,9 @@ module Aruba
       def initialize(cmd, exit_timeout, io_wait, working_directory, environment = ENV.to_hash.dup, main_class = nil)
         super
 
-        @exit_timeout = exit_timeout
-        @io_wait      = io_wait
         @process      = nil
-        @output_cache = nil
-        @error_cache  = nil
+        @stdout_cache       = nil
+        @stderr_cache       = nil
       end
 
       # Run the command
@@ -44,9 +42,10 @@ module Aruba
       #
       # rubocop:disable Metrics/MethodLength
       # rubocop:disable Metrics/CyclomaticComplexity
-      def run!
+      def start
         # gather fully qualified path
-        cmd = which(command)
+        cmd = Aruba.platform.which(command, environment['PATH'])
+
         # rubocop:disable  Metrics/LineLength
         fail LaunchError, %(Command "#{command}" not found in PATH-variable "#{environment['PATH']}".) if cmd.nil?
         # rubocop:enable  Metrics/LineLength
@@ -54,22 +53,25 @@ module Aruba
         cmd = Aruba.platform.command_string.new(cmd)
 
         @process   = ChildProcess.build(*[cmd.to_a, arguments].flatten)
-        @out       = Tempfile.new("aruba-out")
-        @err       = Tempfile.new("aruba-err")
+        @stdout_file = Tempfile.new("aruba-stdout")
+        @stderr_file = Tempfile.new("aruba-stderr")
         @exit_status = nil
-        @duplex    = true
+        @duplex      = true
 
         before_run
 
-        @process.io.stdout = @out
-        @process.io.stderr = @err
+        @process.leader    = true
+        @process.io.stdout = @stdout_file
+        @process.io.stderr = @stderr_file
         @process.duplex    = @duplex
         @process.cwd       = @working_directory
 
         @process.environment.update(environment)
 
         begin
-          @process.start
+          Aruba.platform.with_environment(environment) do
+            @process.start
+          end
         rescue ChildProcess::LaunchError => e
           raise LaunchError, "It tried to start #{cmd}. " + e.message
         end
@@ -81,35 +83,75 @@ module Aruba
       # rubocop:enable Metrics/MethodLength
       # rubocop:enable Metrics/CyclomaticComplexity
 
+      # Access to stdout of process
       def stdin
+        return if @process.nil?
+
         @process.io.stdin
       end
 
-      def stdout
-        wait_for_io do
+      # Access to stdout of process
+      #
+      # @param [Hash] opts
+      #   Options
+      #
+      # @option [Integer] wait_for_io
+      #   Wait for IO to be finished
+      #
+      # @return [String]
+      #   The content of stdout
+      def stdout(opts = {})
+        return @stdout_cache if @process.nil?
+
+        wait_for_io = opts.fetch(:wait_for_io, @io_wait)
+
+        wait_for_io wait_for_io do
           @process.io.stdout.flush
-          read(@out)
-        end || @output_cache
+          open(@stdout_file.path).read
+        end
       end
 
-      def stderr
-        wait_for_io do
+      # Access to stderr of process
+      #
+      # @param [Hash] opts
+      #   Options
+      #
+      # @option [Integer] wait_for_io
+      #   Wait for IO to be finished
+      #
+      # @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)
+
+        wait_for_io wait_for_io do
           @process.io.stderr.flush
-          read(@err)
-        end || @error_cache
+          open(@stderr_file.path).read
+        end
       end
 
       def read_stdout
-        warn('The use of "#read_stdout" is deprecated. Use "#stdout" instead.')
-        stdout
+        # rubocop:disable Metrics/LineLength
+        Aruba.platform.deprecated('The use of "#read_stdout" is deprecated. Use "#stdout" instead. To reduce the time to wait for io, pass `:wait_for_io => 0` or some suitable for your use case')
+        # rubocop:enable Metrics/LineLength
+
+        stdout(:wait_for_io => 0)
       end
 
       def write(input)
+        return if @process.nil?
+
         @process.io.stdin.write(input)
         @process.io.stdin.flush
+
+        self
       end
 
       def close_io(name)
+        return if @process.nil?
+
         if RUBY_VERSION < '1.9'
           @process.io.send(name.to_sym).close
         else
@@ -152,10 +194,11 @@ module Aruba
 
       private
 
-      def wait_for_io(&block)
-        return unless @process
+      def wait_for_io(time_to_wait, &block)
+        return if @process.nil?
+
+        sleep time_to_wait
 
-        sleep @io_wait
         yield
       end
 
@@ -165,15 +208,15 @@ module Aruba
       end
 
       def close_and_cache_out
-        @output_cache = read @out
-        @out.close
-        @out = nil
+        @stdout_cache = read @stdout_file
+        @stdout_file.close
+        @stdout_file = nil
       end
 
       def close_and_cache_err
-        @error_cache = read @err
-        @err.close
-        @err = nil
+        @stderr_cache = read @stderr_file
+        @stderr_file.close
+        @stderr_file = nil
       end
     end
   end

data/lib/aruba/rspec.rb

@@ -25,17 +25,12 @@ RSpec.configure do |config|
 
   if Aruba::VERSION >= '1.0.0'
     config.around :each do |example|
-      begin
-        old_env = ENV.to_hash.dup
+      Aruba.platform.with_environment do
         example.run
-      ensure
-        ENV.clear
-        ENV.update old_env
       end
     end
   end
 
-  # Use rspec metadata as option for aruba
   config.before :each do |example|
     next unless self.class.include? Aruba::Api
 

data/lib/aruba/version.rb

@@ -1,3 +1,3 @@
 module Aruba
-  VERSION = '0.9.0.pre'
+  VERSION = '0.9.0.pre2'
 end

data/script/console

@@ -5,7 +5,6 @@ $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'pry'
 
 require 'aruba/api'
-require 'aruba/reporting'
 
 module Aruba
   class MyConsole

data/spec/aruba/api/environment/restore_env_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+RSpec.describe 'Command Environment' do
+  include_context 'uses aruba API'
+
+  around do |example|
+    Aruba.platform.with_environment do
+      example.run
+    end
+  end
+
+  describe '#restore_env' do
+    context 'when non-existing variable' do
+      before :each do
+        ENV.delete 'LONG_LONG_ENV_VARIABLE'
+      end
+
+      context 'when set single' do
+        before :each do
+          @aruba.set_env 'LONG_LONG_ENV_VARIABLE', '1'
+          @aruba.restore_env
+        end
+
+        it { expect(ENV).not_to be_key 'LONG_LONG_ENV_VARIABLE' }
+      end
+
+      context 'when set multiple times' do
+        before :each do
+          @aruba.set_env 'LONG_LONG_ENV_VARIABLE', '1'
+          @aruba.set_env 'LONG_LONG_ENV_VARIABLE', '2'
+          @aruba.set_env 'LONG_LONG_ENV_VARIABLE', '3'
+          @aruba.restore_env
+        end
+
+        it { expect(ENV).not_to be_key 'LONG_LONG_ENV_VARIABLE' }
+      end
+    end
+
+    context 'when existing variable from outer context' do
+      before :each do
+        ENV['LONG_LONG_ENV_VARIABLE'] = '0'
+      end
+
+      context 'when set single time' do
+        before :each do
+          @aruba.set_env 'LONG_LONG_ENV_VARIABLE', '1'
+          @aruba.restore_env
+        end
+
+        it { expect(ENV['LONG_LONG_ENV_VARIABLE']).to eq '0' }
+      end
+
+      context 'when set multiple times' do
+        before :each do
+          @aruba.set_env 'LONG_LONG_ENV_VARIABLE', '1'
+          @aruba.set_env 'LONG_LONG_ENV_VARIABLE', '2'
+          @aruba.set_env 'LONG_LONG_ENV_VARIABLE', '3'
+          @aruba.restore_env
+        end
+
+        it { expect(ENV['LONG_LONG_ENV_VARIABLE']).to eq '0' }
+      end
+    end
+  end
+end

data/spec/aruba/api/environment/set_env_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+RSpec.describe 'Command Environment' do
+  include_context 'uses aruba API'
+
+  around do |example|
+    Aruba.platform.with_environment do
+      example.run
+    end
+  end
+
+  describe '#set_env' do
+    context 'when non-existing variable' do
+      before :each do
+        ENV.delete('LONG_LONG_ENV_VARIABLE')
+      end
+
+      context 'when string' do
+        before :each do
+          @aruba.set_env 'LONG_LONG_ENV_VARIABLE', '1'
+        end
+
+        it { expect(ENV['LONG_LONG_ENV_VARIABLE']).to eq '1' }
+      end
+    end
+
+    context 'when existing variable set by aruba' do
+      before :each do
+        @aruba.set_env 'LONG_LONG_ENV_VARIABLE', '1'
+        @aruba.set_env 'LONG_LONG_ENV_VARIABLE', '2'
+      end
+
+      it { expect(ENV['LONG_LONG_ENV_VARIABLE']).to eq '2' }
+    end
+
+    context 'when existing variable by outer context' do
+      before :each do
+        ENV['LONG_LONG_ENV_VARIABLE'] = '1'
+      end
+    end
+  end
+end