aruba 0.14.9 → 1.0.0

data/lib/aruba/platforms/announcer.rb

@@ -1,7 +1,7 @@
 require 'shellwords'
 require 'aruba/colorizer'
 
-Aruba::AnsiColor.coloring = false if !STDOUT.tty? && !ENV.key?("AUTOTEST")
+Aruba::Colorizer.coloring = false if !STDOUT.tty? && !ENV.key?('AUTOTEST')
 
 # Aruba
 module Aruba
@@ -27,25 +27,32 @@ module Aruba
     #   Aruba.announcer.announce(:my_channel, 'my message')
     #
     class Announcer
+      # Base Announcer class
+      class BaseAnnouncer
+        def mode?(m)
+          mode == m
+        end
+      end
+
       # Announcer using Kernel.puts
-      class KernelPutsAnnouncer
+      class KernelPutsAnnouncer < BaseAnnouncer
         def announce(message)
           Kernel.puts message
         end
 
-        def mode?(m)
-          :kernel_puts == m
+        def mode
+          :kernel_puts
         end
       end
 
       # Announcer using Main#puts
-      class PutsAnnouncer
+      class PutsAnnouncer < BaseAnnouncer
         def announce(message)
           puts message
         end
 
-        def mode?(m)
-          :puts == m
+        def mode
+          :puts
         end
       end
 
@@ -55,7 +62,7 @@ module Aruba
 
       public
 
-      def initialize(*args)
+      def initialize
         @announcers = []
         @announcers << PutsAnnouncer.new
         @announcers << KernelPutsAnnouncer.new
@@ -66,14 +73,11 @@ module Aruba
         @channels          = {}
         @output_formats    = {}
 
-        @options           = args[1] || {}
-
         after_init
       end
 
       private
 
-      # rubocop:disable Metrics/MethodLength
       def after_init
         output_format :changed_configuration, proc { |n, v| format('# %s = %s', n, v) }
         output_format :changed_environment, proc { |n, v| format('$ export %s=%s', n, Shellwords.escape(v)) }
@@ -88,34 +92,12 @@ module Aruba
         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]
-          warn('The use of "@announce_stdout-instance" variable and "options[:stdout] = true" for Announcer.new is deprecated. Please use "announcer.activate(:stdout)" instead.')
-          activate :stdout
-        end
-        if @options[:stderr]
-          warn('The use of "@announce_stderr-instance" variable and "options[:stderr] = true" for Announcer.new is deprecated. Please use "announcer.activate(:stderr)" instead.')
-          activate :stderr
-        end
-        if @options[:dir]
-          warn('The use of "@announce_dir-instance" variable and "options[:dir] = true" for Announcer.new is deprecated. Please use "announcer.activate(:directory)" instead.')
-          activate :directory
-        end
-        if @options[:cmd]
-          warn('The use of "@announce_cmd-instance" variable and "options[:cmd] = true" for Announcer.new is deprecated. Please use "announcer.activate(:command)" instead.')
-          activate :command
-        end
-        if @options[:env]
-          warn('The use of "@announce_env-instance" variable and "options[:env] = true" for Announcer.new is deprecated. Please use "announcer.activate(:modified_environment)" instead.')
-          activate :modified_enviroment
-        end
-        # rubocop:enable 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))
+                      }
       end
-      # rubocop:enable Metrics/MethodLength
 
       def output_format(channel, string = '%s', &block)
         output_formats[channel.to_sym] = if block_given?
@@ -139,11 +121,18 @@ module Aruba
       # @param [Symbol] m
       #   The mode to set
       def mode=(m)
-        @announcer = @announcers.find { |a| f.mode? m.to_sym }
+        @announcer = @announcers.find { |a| a.mode? m.to_sym }
 
         self
       end
 
+      # Fecth mode of announcer
+      #
+      # @return [Symbol] The current announcer mode
+      def mode
+        @announcer.mode
+      end
+
       # Check if channel is activated
       #
       # @param [Symbol] channel
@@ -154,7 +143,7 @@ module Aruba
 
       # Activate a channel
       #
-      # @param [Symbol] channel
+      # @param [Symbol] chns
       #   The name of the channel to activate
       def activate(*chns)
         chns.flatten.each { |c| channels[c.to_sym] = true }
@@ -173,7 +162,7 @@ module Aruba
       # @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)
+      def announce(channel, *args)
         channel = channel.to_sym
 
         the_output_format = if output_formats.key? channel
@@ -184,49 +173,23 @@ module Aruba
 
         return unless activated?(channel)
 
-        message = if block_given?
-                    the_output_format.call(yield)
-                  else
-                    the_output_format.call(*args)
-                  end
-        message += "\n"
-        message = colorizer.cyan(message)
+        begin
+          if block_given?
+            value = yield
+            args << value
+          end
+
+          message = the_output_format.call(*args)
+          message += "\n"
+          message = colorizer.cyan(message)
+        rescue NotImplementedError => e
+          message = "Error fetching announced value for #{channel}: #{e.message}"
+        end
 
         announcer.announce(message)
 
         nil
       end
-
-      # @deprecated
-      def stdout(content)
-        warn('The announcer now has a new api to activate channels. Please use this one: announce(:stdout, message)')
-        announce :stdout, content
-      end
-
-      # @deprecated
-      def stderr(content)
-        warn('The announcer now has a new api to activate channels. Please use this one: announce(:stderr, message)')
-        announce :stderr, content
-      end
-
-      # @deprecated
-      def dir(dir)
-        warn('The announcer now has a new api to activate channels. Please use this one announce(:directory, message)')
-        announce :directory, dir
-      end
-
-      # @deprecated
-      def cmd(cmd)
-        warn('The announcer now has a new api to activate channels. Please use this one announce(:command, message)')
-        announce :command, cmd
-      end
-
-      # @deprecated
-      def env(name, value)
-        warn('The announcer now has a new api to activate channels. Please use this one: announce(:changed_environment, key, value)')
-
-        announce :changed_environment, name, value
-      end
     end
   end
 end

data/lib/aruba/platforms/aruba_file_creator.rb

@@ -15,18 +15,14 @@ module Aruba
       # @param [Object] content
       #   The content of the file
       #
-      # @param [TrueClass, FalseClass] check_presence (false)
+      # @param [Boolean] check_presence (false)
       #   Check if file exist
       def call(path, content, check_presence = false)
         fail "Expected #{path} to be present" if check_presence && !Aruba.platform.file?(path)
 
         Aruba.platform.mkdir(File.dirname(path))
 
-        if RUBY_VERSION < '1.9.3'
-          File.open(path, 'w') { |f| f << content }
-        else
-          File.write(path, content)
-        end
+        File.write(path, content)
 
         self
       end

data/lib/aruba/platforms/aruba_fixed_size_file_creator.rb

@@ -19,14 +19,14 @@ module Aruba
       # @param [Numeric] size
       #   The size of the file
       #
-      # @param [TrueClass, FalseClass] check_presence (false)
+      # @param [Boolean] check_presence (false)
       #   Check if file exist
       def call(path, size, check_presence)
         fail "Expected #{path} to be present" if check_presence && !Aruba.platform.file?(path)
 
         Aruba.platform.mkdir(File.dirname(path))
 
-        File.open(path, "wb"){ |f| f.seek(size - 1); f.write("\0") }
+        File.open(path, 'wb') { |f| f.seek(size - 1); f.write("\0") }
 
         self
       end

data/lib/aruba/platforms/aruba_logger.rb

@@ -10,19 +10,35 @@ module Aruba
 
     # Create logger
     #
-    # @param [Logger] logger (::Logger.new( $stderr ))
-    #   The logger with should be used to output data
+    # @param [Hash] opts
+    #   Options
+    #
+    # @option opts [Symbol] :default_mode Log level
     def initialize(opts = {})
       @mode = opts.fetch(:default_mode, :info)
     end
 
+    # @!method fatal(msg)
+    # Log a fatal level log message
+
+    # @!method warn(msg)
+    # Log a warn level log message
+
+    # @!method debug(msg)
+    # Log a debug level log message
+
+    # @!method info(msg)
+    # Log an info level log message
+
+    # @!method error(msg)
+    # Log an error level log message
+
+    # @!method unknown(msg)
+    # Log an unknown level log message
+
     [:fatal, :warn, :debug, :info, :error, :unknown].each do |m|
       define_method m do |msg|
-        if RUBY_VERSION < '1.9'
-          logger.send m, msg
-        else
-          logger.public_send m, msg
-        end
+        logger.public_send m, msg
       end
     end
 

data/lib/aruba/platforms/command_monitor.rb

@@ -22,6 +22,10 @@ module Aruba
       def method_missing(*)
         fail NoCommandHasBeenStoppedError, 'No last command stopped available'
       end
+
+      def respond_to_missing?(*)
+        true
+      end
     end
 
     class DefaultLastCommandStarted
@@ -32,6 +36,10 @@ module Aruba
       def method_missing(*)
         fail NoCommandHasBeenStartedError, 'No last command started available'
       end
+
+      def respond_to_missing?(*)
+        true
+      end
     end
 
     def initialize(opts = {})
@@ -40,23 +48,11 @@ module Aruba
 
       @last_command_stopped = DefaultLastCommandStopped.new
       @last_command_started = DefaultLastCommandStarted.new
-
     rescue KeyError => e
       raise ArgumentError, e.message
     end
 
-    if Aruba::VERSION < '1'
-      # Return the last command stopped
-      def last_command_stopped
-        return @last_command_stopped unless @last_command_stopped.nil?
-
-        registered_commands.each(&:stop)
-
-        @last_command_stopped
-      end
-    else
-      attr_reader :last_command_stopped
-    end
+    attr_reader :last_command_stopped
 
     # Set last command started
     #
@@ -66,7 +62,7 @@ module Aruba
       @last_command_started = find(cmd)
     end
 
-    # Set last command started
+    # Set last command stopped
     #
     # @param [String] cmd
     #   The commandline of the command
@@ -95,37 +91,6 @@ module Aruba
       self
     end
 
-    # @deprecated
-    # Fetch output (stdout, stderr) from command
-    #
-    # @param [String] cmd
-    #   The command
-    def output_from(cmd)
-      cmd = Utils.detect_ruby(cmd)
-      find(cmd).output
-    end
-
-    # @deprecated
-    # Fetch stdout from command
-    #
-    # @param [String] cmd
-    #   The command
-    def stdout_from(cmd)
-      cmd = Utils.detect_ruby(cmd)
-      find(cmd).stdout
-    end
-
-    # @deprecated
-    # Fetch stderr from command
-    #
-    # @param [String] cmd
-    #   The command
-    def stderr_from(cmd)
-      cmd = Utils.detect_ruby(cmd)
-      find(cmd).stderr
-    end
-
-    # @deprecated
     # Get stdout of all commands
     #
     # @return [String]
@@ -133,14 +98,9 @@ module Aruba
     def all_stdout
       registered_commands.each(&:stop)
 
-      if RUBY_VERSION < '1.9.3'
-        registered_commands.inject("") { |a, e| a << e.stdout; a }
-      else
-        registered_commands.each_with_object("") { |e, a| a << e.stdout }
-      end
+      registered_commands.each_with_object('') { |e, a| a << e.stdout }
     end
 
-    # @deprecated
     # Get stderr of all commands
     #
     # @return [String]
@@ -148,14 +108,9 @@ module Aruba
     def all_stderr
       registered_commands.each(&:stop)
 
-      if RUBY_VERSION < '1.9.3'
-        registered_commands.inject("") { |a, e| a << e.stderr; a }
-      else
-        registered_commands.each_with_object("") { |e, a| a << e.stderr }
-      end
+      registered_commands.each_with_object('') { |e, a| a << e.stderr }
     end
 
-    # @deprecated
     # Get stderr and stdout of all commands
     #
     # @return [String]
@@ -164,56 +119,6 @@ module Aruba
       all_stdout << all_stderr
     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')
-
-      return @last_exit_status if @last_exit_status
-      registered_commands.each(&:stop)
-      @last_exit_status
-    end
-
-    # @deprecated
-    def stop_process(process)
-      @last_command_stopped = process
-      @last_exit_status     = process.stop(announcer)
-    end
-
-    # @deprecated
-    def terminate_process!(process)
-      process.terminate
-    end
-
-    # @deprecated
-    def stop_processes!
-      Aruba.platform.deprecated('The use of "#stop_processes!" is deprecated.')
-
-      registered_commands.each(&:stop)
-    end
-
-    # @deprecated
-    # Terminate all running processes
-    def terminate_processes
-      Aruba.platform.deprecated('The use of "#terminate_processes" is deprecated.')
-
-      registered_commands.each(&:terminate)
-    end
-
-    # @deprecated
-    def only_processes
-      Aruba.platform.deprecated('The use of "#only_processes" is deprecated.')
-
-      registered_commands
-    end
-
-    # @deprecated
-    def get_process(wanted)
-      command = find(wanted)
-      raise ArgumentError.new("No process named '#{wanted}' has been started") unless command
-
-      command
-    end
-
     # Register command to monitor
     def register_command(cmd)
       registered_commands << cmd

data/lib/aruba/platforms/determine_disk_usage.rb

@@ -1,28 +1,70 @@
-require 'aruba/platforms/disk_usage_calculator'
+require 'aruba/file_size'
 
-# Aruba
 module Aruba
-  # Platforms
   module Platforms
     # Determinate disk usage
     #
     # @private
     class DetermineDiskUsage
-      def call(*args)
-        args = args.flatten
-
-        physical_block_size = args.pop
-        paths = args
-
-        size = paths.flatten.map do |p|
-          DiskUsageCalculator.new.call(
-            p.blocks,
-            physical_block_size
-          )
+      def call(paths)
+        size = paths.flatten.map do |path|
+          minimum_disk_space_used path
         end.inject(0, &:+)
 
         FileSize.new(size)
       end
+
+      private
+
+      # TODO: Aruba.config.physical_block_size could be allowed to be nil
+      # (So the unit size can be autodetected)
+
+      # Report minimum disk space used
+      #
+      # This estimates the minimum bytes allocated by the path.
+      #
+      # E.g. a 1-byte text file on a typical EXT-3 filesystem takes up 4096 bytes
+      # (could be more if it was truncated or less for sparse files).
+      #
+      # Both `File::Stat` and the `stat()` system call will report 8 `blocks`
+      # (each "usually" represents 512 bytes). So 8 * 512 is exactly 4096 bytes.
+      #
+      # (The "magic" 512 bye implied makes the value of "blocks" so confusing).
+      #
+      # Currently Aruba allows you to set what's called the `physical_block_size`,
+      # which is a bit misleading - it's the "512" value. So if you somehow have a
+      # "filesystem unit size" of 8192 (instead of a typical 4KB), set the
+      # `physical_block_size` to 1024 (yes, divide by 8: 8192/8 = 1024).
+      #
+      # Ideally, Aruba should provide e.g. `Aruba.config.fs_allocation_unit`
+      # (with 4096 as the default), so you wouldn't have to "divide by 8".
+      #
+      # (typical_fs_unit / typical_dev_bsize = 4096 / 512 = 8)
+      #
+      #
+      # @return [Integer]
+      #   Total bytes allocate
+      #
+      # TODO: this is recommended over the above "blocks"
+      def minimum_disk_space_used(path)
+        # TODO: replace Aruba.config.physical_block_size
+        # with something like Aruba.config.fs_allocation_unit
+        dev_bsize = Aruba.config.physical_block_size
+
+        stat = File::Stat.new(path.to_s)
+
+        blocks = stat.blocks
+        return (blocks * dev_bsize) if blocks
+
+        typical_fs_unit = 4096
+        typical_dev_bsize = 512 # google dev_bsize for more info
+
+        block_multiplier = typical_fs_unit / typical_dev_bsize
+        fs_unit_size = dev_bsize * block_multiplier
+        fs_units = (stat.size + fs_unit_size - 1) / fs_unit_size
+        fs_units = 1 if fs_units.zero?
+        fs_units * fs_unit_size
+      end
     end
   end
 end

data/lib/aruba/platforms/filesystem_status.rb

@@ -22,11 +22,7 @@ module Aruba
 
       public
 
-      if RUBY_VERSION >= '1.9.3'
-        def_delegators :@status, *METHODS
-      else
-        def_delegators :@status, :executable?, :ctime, :atime, :mtime, :size
-      end
+      def_delegators :@status, *METHODS
 
       def initialize(path)
         @status = File::Stat.new(path)
@@ -34,7 +30,7 @@ module Aruba
 
       # Return permissions
       def mode
-        format("%o", status.mode)[-4,4].gsub(/^0*/, '')
+        format('%o', status.mode)[-4, 4].gsub(/^0*/, '')
       end
 
       # Return owner
@@ -53,14 +49,14 @@ module Aruba
       #   A hash of values
       def to_h
         {
-          :owner      => owner,
-          :group      => group,
-          :mode       => mode,
-          :executable => executable?,
-          :ctime      => ctime,
-          :atime      => atime,
-          :mtime      => mtime,
-          :size       => size
+          owner: owner,
+          group: group,
+          mode: mode,
+          executable: executable?,
+          ctime: ctime,
+          atime: atime,
+          mtime: mtime,
+          size: size
         }
       end
     end

data/lib/aruba/platforms/local_environment.rb

@@ -13,8 +13,8 @@ module Aruba
       #
       # @yield
       #   The block of code which should with local ENV
-      def call(env, &block)
-        old_env = ENV.to_hash.dup
+      def call(env)
+        old_env = Aruba.platform.environment_variables.hash_from_env
 
         ENV.clear
         ENV.update env

data/lib/aruba/platforms/simple_table.rb

@@ -17,7 +17,7 @@ module Aruba
       def initialize(hash, opts)
         @hash = hash
         @opts = {
-          :sort => true
+          sort: true
         }.merge opts
       end
 
@@ -31,16 +31,8 @@ module Aruba
 
         name_size = longest_key.length
 
-        if RUBY_VERSION < '2'
-          rows = []
-
-          hash.each do |k,v|
-            rows << format("# %-#{name_size}s => %s", k, v)
-          end
-        else
-          rows = hash.each_with_object([]) do |(k,v), a|
-            a << format("# %-#{name_size}s => %s", k, v)
-          end
+        rows = hash.each_with_object([]) do |(k, v), a|
+          a << format("# %-#{name_size}s => %s", k, v)
         end
 
         if opts[:sort] == true

data/lib/aruba/platforms/unix_command_string.rb

@@ -6,21 +6,17 @@ module Aruba
   # Platforms
   module Platforms
     # This is a command which should be run
-    class UnixCommandString < SimpleDelegator
-      def initialize(cmd)
-        __setobj__ cmd
+    #
+    # @private
+    class UnixCommandString
+      def initialize(command, *arguments)
+        @command = command
+        @arguments = arguments
       end
 
       # Convert to array
       def to_a
-        [__getobj__]
-      end
-
-      if RUBY_VERSION < '1.9'
-        def to_s
-          __getobj__.to_s
-        end
-        alias inspect to_s
+        [@command, *@arguments]
       end
     end
   end