aruba 0.12.0 → 0.13.0

data/lib/aruba/generators/script_file.rb

@@ -0,0 +1,46 @@
+# Aruba
+module Aruba
+  # Generate script files on command line
+  class ScriptFile
+    private
+
+    attr_reader :path, :content, :interpreter
+
+    public
+
+    def initialize(opts = {})
+      @path        = opts[:path]
+      @content     = opts[:content]
+      @interpreter = opts[:interpreter]
+    end
+
+    def call
+      Aruba.platform.write_file(path, "#{header}#{content}")
+      Aruba.platform.chmod(0755, path, {})
+    end
+
+    private
+
+    def header
+      if script_starts_with_shebang?
+        ''
+      elsif interpreter_is_absolute_path?
+        format("#!%s\n", interpreter)
+      elsif interpreter_is_just_the_name_of_shell?
+        format("#!/usr/bin/env %s\n", interpreter)
+      end
+    end
+
+    def interpreter_is_absolute_path?
+      Aruba.platform.absolute_path? interpreter
+    end
+
+    def interpreter_is_just_the_name_of_shell?
+      interpreter =~ /^[-_a-zA-Z.]+$/
+    end
+
+    def script_starts_with_shebang?
+      content.start_with? '#!'
+    end
+  end
+end

data/lib/aruba/matchers/path/have_permissions.rb

@@ -30,7 +30,7 @@ require 'rspec/expectations/version'
 #     end
 RSpec::Matchers.define :have_permissions do |expected|
   def permissions(file)
-    @actual = format("%o", File::Stat.new(file).mode)[-4,4].gsub(/^0*/, '')
+    @actual = Aruba.platform.filesystem_status.new(file).mode
   end
 
   match do |actual|

data/lib/aruba/platforms/announcer.rb

@@ -1,4 +1,7 @@
 require 'shellwords'
+require 'aruba/colorizer'
+
+Aruba::AnsiColor.coloring = false if !STDOUT.tty? && !ENV.key?("AUTOTEST")
 
 # Aruba
 module Aruba
@@ -24,17 +27,6 @@ module Aruba
     #   Aruba.announcer.announce(:my_channel, 'my message')
     #
     class Announcer
-      # Dev null
-      class NullAnnouncer
-        def announce(*)
-          nil
-        end
-
-        def mode?(*)
-          true
-        end
-      end
-
       # Announcer using Kernel.puts
       class KernelPutsAnnouncer
         def announce(message)
@@ -49,7 +41,7 @@ module Aruba
       # Announcer using Main#puts
       class PutsAnnouncer
         def announce(message)
-          Kernel.puts message
+          puts message
         end
 
         def mode?(m)
@@ -59,7 +51,7 @@ module Aruba
 
       private
 
-      attr_reader :announcers, :default_announcer, :announcer, :channels, :output_formats
+      attr_reader :announcers, :announcer, :channels, :output_formats, :colorizer
 
       public
 
@@ -67,9 +59,9 @@ module Aruba
         @announcers = []
         @announcers << PutsAnnouncer.new
         @announcers << KernelPutsAnnouncer.new
-        @announcers << NullAnnouncer.new
 
-        @default_announcer = @announcers.last
+        @colorizer = Aruba::Colorizer.new
+
         @announcer         = @announcers.first
         @channels          = {}
         @output_formats    = {}
@@ -88,13 +80,17 @@ module Aruba
         output_format :command, '$ %s'
         output_format :directory, '$ cd %s'
         output_format :environment, proc { |n, v| format('$ export %s=%s', n, Shellwords.escape(v)) }
-        output_format :full_environment, proc { |h| Aruba.platform.simple_table(h) }
+        output_format :full_environment, proc { |h| format("<<-ENVIRONMENT\n%s\nENVIRONMENT", Aruba.platform.simple_table(h)) }
         output_format :modified_environment, proc { |n, v| format('$ export %s=%s', n, Shellwords.escape(v)) }
         output_format :stderr, "<<-STDERR\n%s\nSTDERR"
         output_format :stdout, "<<-STDOUT\n%s\nSTDOUT"
+        output_format :command_content, "<<-COMMAND\n%s\nCOMMAND"
         output_format :stop_signal, proc { |p, s| format('Command will be stopped with `kill -%s %s`', s, p) }
         output_format :timeout, '# %s-timeout: %s seconds'
         output_format :wait_time, '# %s: %s seconds'
+        # rubocop:disable Metrics/LineLength
+        output_format :command_filesystem_status, proc { |status| format("<<-COMMAND FILESYSTEM STATUS\n%s\nCOMMAND FILESYSTEM STATUS", Aruba.platform.simple_table(status.to_h, :sort => false)) }
+        # rubocop:enable Metrics/LineLength
 
         # rubocop:disable Metrics/LineLength
         if @options[:stdout]
@@ -135,7 +131,6 @@ module Aruba
 
       # Reset announcer
       def reset
-        @default_announcer = @announcers.last
         @announcer         = @announcers.first
       end
 
@@ -161,8 +156,8 @@ module Aruba
       #
       # @param [Symbol] channel
       #   The name of the channel to activate
-      def activate(channel)
-        channels[channel.to_sym] = true
+      def activate(*chns)
+        chns.flatten.each { |c| channels[c.to_sym] = true }
 
         self
       end
@@ -174,7 +169,11 @@ module Aruba
       #
       # @param [Array] args
       #   Arguments
-      def announce(channel, *args)
+      #
+      # @yield
+      #   If block is given, that one is called and the return value is used as
+      #   message to be announced.
+      def announce(channel, *args, &block)
         channel = channel.to_sym
 
         the_output_format = if output_formats.key? channel
@@ -183,11 +182,19 @@ module Aruba
                               proc { |v| format('%s', v) }
                             end
 
-        message = the_output_format.call(*args)
+        return unless activated?(channel)
+
+        message = if block_given?
+                    the_output_format.call(block.call)
+                  else
+                    the_output_format.call(*args)
+                  end
+        message += "\n"
+        message = colorizer.cyan(message)
 
-        announcer.announce(message) if channels[channel]
+        announcer.announce(message)
 
-        default_announcer.announce message
+        nil
       end
 
       # @deprecated

data/lib/aruba/platforms/filesystem_status.rb

@@ -0,0 +1,68 @@
+require 'forwardable'
+
+module Aruba
+  module Platforms
+    # File System Status object
+    #
+    # This is a wrapper for File::Stat returning only a subset of information.
+    class FilesystemStatus
+      METHODS = [
+        :executable?,
+        :ctime,
+        :atime,
+        :mtime,
+        :size
+      ]
+
+      extend Forwardable
+
+      private
+
+      attr_reader :status
+
+      public
+
+      if RUBY_VERSION >= '1.9.3'
+        def_delegators :@status, *METHODS
+      else
+        def_delegators :@status, :executable?, :ctime, :atime, :mtime, :size
+      end
+
+      def initialize(path)
+        @status = File::Stat.new(path)
+      end
+
+      # Return permissions
+      def mode
+        format("%o", status.mode)[-4,4].gsub(/^0*/, '')
+      end
+
+      # Return owner
+      def owner
+        status.uid
+      end
+
+      # Return owning group
+      def group
+        status.gid
+      end
+
+      # Convert status to hash
+      #
+      # @return [Hash]
+      #   A hash of values
+      def to_h
+        {
+          :owner      => owner,
+          :group      => group,
+          :mode       => mode,
+          :executable => executable?,
+          :ctime      => ctime,
+          :atime      => atime,
+          :mtime      => mtime,
+          :size       => size
+        }
+      end
+    end
+  end
+end

data/lib/aruba/platforms/simple_table.rb

@@ -6,7 +6,7 @@ module Aruba
     class SimpleTable
       private
 
-      attr_reader :hash
+      attr_reader :hash, :opts
 
       public
 
@@ -14,8 +14,11 @@ module Aruba
       #
       # @param [Hash] hash
       #   Input
-      def initialize(hash)
+      def initialize(hash, opts)
         @hash = hash
+        @opts = {
+          :sort => true
+        }.merge opts
       end
 
       # Generate table
@@ -24,7 +27,7 @@ module Aruba
       #   The table
       def to_s
         longest_key = hash.keys.map(&:to_s).max_by(&:length)
-        return [] if longest_key.nil?
+        return '' if longest_key.nil?
 
         name_size  = longest_key.length
 
@@ -34,12 +37,16 @@ module Aruba
           hash.each do |k,v|
             rows << format("# %-#{name_size}s => %s", k, v)
           end
-
-          rows.sort
         else
-          hash.each_with_object([]) do |(k,v), a|
+          rows = hash.each_with_object([]) do |(k,v), a|
             a << format("# %-#{name_size}s => %s", k, v)
-          end.sort
+          end
+        end
+
+        if opts[:sort] == true
+          rows.sort.join("\n")
+        else
+          rows.join("\n")
         end
       end
     end

data/lib/aruba/platforms/unix_platform.rb

@@ -14,6 +14,7 @@ require 'aruba/platforms/local_environment'
 require 'aruba/platforms/aruba_logger'
 require 'aruba/platforms/announcer'
 require 'aruba/platforms/command_monitor'
+require 'aruba/platforms/filesystem_status'
 
 # Aruba
 module Aruba
@@ -41,6 +42,10 @@ module Aruba
         UnixCommandString
       end
 
+      def filesystem_status
+        FilesystemStatus
+      end
+
       def announcer
         Announcer
       end
@@ -73,6 +78,10 @@ module Aruba
         LocalEnvironment.new.call(env, &block)
       end
 
+      def default_shell
+        'bash'
+      end
+
       def detect_ruby(cmd)
         if cmd =~ /^ruby\s/
           cmd.gsub(/^ruby\s/, "#{current_ruby} ")
@@ -245,8 +254,8 @@ module Aruba
       end
 
       # Transform hash to a string table which can be output on stderr/stdout
-      def simple_table(hash)
-        SimpleTable.new(hash).to_s
+      def simple_table(hash, opts = {})
+        SimpleTable.new(hash, opts).to_s
       end
 
       # Resolve path for command using the PATH-environment variable

data/lib/aruba/platforms/unix_which.rb

@@ -1,5 +1,3 @@
-require 'aruba/platform'
-
 # Aruba
 module Aruba
   # Platforms

data/lib/aruba/platforms/windows_which.rb

@@ -1,5 +1,3 @@
-require 'aruba/platform'
-
 # Aruba
 module Aruba
   # Platforms

data/lib/aruba/processes/basic_process.rb

@@ -67,6 +67,14 @@ module Aruba
         NotImplementedError
       end
 
+      def filesystem_status
+        NotImplementedError
+      end
+
+      def content
+        NotImplementedError
+      end
+
       def wait
         NotImplementedError
       end

data/lib/aruba/processes/spawn_process.rb

@@ -58,16 +58,7 @@ module Aruba
 
         @started = true
 
-        # gather fully qualified path
-        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
-
-        cmd = Aruba.platform.command_string.new(cmd)
-
-        @process   = ChildProcess.build(*[cmd.to_a, arguments].flatten)
+        @process   = ChildProcess.build(*[command_string.to_a, arguments].flatten)
         @stdout_file = Tempfile.new('aruba-stdout-')
         @stderr_file = Tempfile.new('aruba-stderr-')
 
@@ -123,7 +114,7 @@ module Aruba
       def stdout(opts = {})
         return @stdout_cache if stopped?
 
-        wait_for_io opts.fetch(:wait_for_io, @io_wait) do
+        wait_for_io opts.fetch(:wait_for_io, io_wait_timeout) do
           @process.io.stdout.flush
           open(@stdout_file.path).read
         end
@@ -142,7 +133,7 @@ module Aruba
       def stderr(opts = {})
         return @stderr_cache if stopped?
 
-        wait_for_io opts.fetch(:wait_for_io, @io_wait) do
+        wait_for_io opts.fetch(:wait_for_io, io_wait_timeout) do
           @process.io.stderr.flush
           open(@stderr_file.path).read
         end
@@ -241,8 +232,36 @@ module Aruba
         raise CommandAlreadyStoppedError, %(Command "#{commandline}" with PID "#{pid}" has already stopped.)
       end
 
+      # Return file system stats for the given command
+      #
+      # @return [Aruba::Platforms::FilesystemStatus]
+      #   This returns a File::Stat-object
+      def filesystem_status
+        Aruba.platform.filesystem_status.new(command_string.to_s)
+      end
+
+      # 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.
+      def content
+        File.read command_string.to_s
+      end
+
       private
 
+      def command_string
+        # gather fully qualified path
+        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
+
+        Aruba.platform.command_string.new(cmd)
+      end
+
       def wait_for_io(time_to_wait, &block)
         sleep time_to_wait.to_i
         block.call

data/lib/aruba/rspec.rb

@@ -59,14 +59,16 @@ RSpec.configure do |config|
       aruba.announcer.activate(:changed_environment)
     end
 
-    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]
+    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]
+    aruba.announcer.activate(:command_content)           if example.metadata[:announce_command_content]
+    aruba.announcer.activate(:command_filesystem_status) if example.metadata[:announce_command_filesystem_status]
 
     if example.metadata[:announce_output]
       aruba.announcer.activate(:stderr)
@@ -84,6 +86,8 @@ RSpec.configure do |config|
       aruba.announcer.activate(:stop_signal)
       aruba.announcer.activate(:timeout)
       aruba.announcer.activate(:wait_time)
+      aruba.announcer.activate(:command_content)
+      aruba.announcer.activate(:command_filesystem_status)
     end
   end