bwrap 1.0.0.pre.alpha5 → 1.0.0

data/lib/bwrap/execution/execution.rb

@@ -1,8 +1,152 @@
 # frozen_string_literal: true
 
 require "bwrap/version"
+require "bwrap/output"
+require_relative "exceptions"
+require_relative "execute"
+require_relative "path"
 
-# Generic execution functionality.
+# Provides methods to execute commands and handle its output.
+#
+# Output can be controlled by using log levels of Output module.
+#
+# @example Executing a command
+#   class MyClass
+#     include Bwrap::Execution
+#
+#     def my_method
+#       execute %w{ ls /dev/null }
 module Bwrap::Execution
-  # Nyan.
-end
+  include Bwrap::Output
+  include Bwrap::Execution::Path
+
+  # Actual implementation of execution command. Can be used when static method is needed.
+  #
+  # @note When an array is given as a command, empty strings are passed as empty arguments.
+  #
+  #   This means that `[ "foo", "bar" ]` passes one argument to "foo" command, when
+  #   `[ "foo", "", "bar" ]` passes two arguments.
+  #
+  #   This may or may not be what is assumed, so it can’t be fixed here. It is up to the
+  #   command to decide how to handle empty arguments.
+  #
+  # Returns pid of executed command if wait is false.
+  # Returns command output if wait is true.
+  #
+  # fail == If true, an error is raised in case the command returns failure code.
+  #
+  # @param error if :show, warn()s output of the command is shown if execution failed.
+  #
+  # @see #execute
+  def self.do_execute command,
+                      fail: true,
+                      wait: true,
+                      log: true,
+                      direct_output: false,
+                      env: {},
+                      clear_env: false,
+                      error: nil,
+                      log_callback: 2,
+                      rootcmd: nil
+    command = Execute.format_command command, rootcmd: rootcmd
+    Execute.handle_logging command, log_callback: log_callback, log: log, dry_run: @dry_run
+    return if @dry_run || Bwrap::Execution::Execute.dry_run
+
+    Execute.open_pipes direct_output
+
+    # If command is an array, there can’t be arrays inside the array.
+    # For convenience, the array is flattened here, so callers can construct commands more easily.
+    if command.respond_to? :flatten!
+      command.flatten!
+    end
+
+    # If command is string, splat operator (the *) does not do anything. If array, it expand the arguments.
+    # This causes spawning work correctly, as that’s how spawn() expects to have the argu
+    pid = spawn(env, *command, err: [ :child, :out ], out: Execute.w, unsetenv_others: clear_env)
+    output = Execute.finish_execution(log: log, wait: wait, direct_output: direct_output)
+    return pid unless wait
+
+    # This is instant return, but allows us to have $?/$CHILD_STATUS set.
+    Process.wait pid
+    @last_status = $CHILD_STATUS
+
+    output = Execute.process_output output: output
+    Execute.handle_execution_fail fail: fail, error: error, output: output
+    output
+  ensure
+    Execute.clean_variables
+  end
+
+  # Returns Process::Status instance of last execution.
+  #
+  # @note This only is able to return the status if wait is true, as otherwise caller is assumed to
+  # handle execution flow.
+  def self.last_status
+    @last_status
+  end
+
+  # Execute a command.
+  #
+  # This method can be used by including Execution module in a class that should be able to
+  # execute commands.
+  #
+  # @see .do_execute .do_execute for documentation of argument syntax
+  private def execute *args, **kwargs
+    # Mangle proper location to error message.
+    if kwargs.is_a? Hash
+      kwargs[:log_callback] = 3
+    else
+      kwargs = { log_callback: 3 }
+    end
+    Bwrap::Execution.do_execute(*args, **kwargs)
+  end
+
+  # Same as ::execute, but uses log: false to avoid unnecessary output when we’re just getting a
+  # value for internal needs.
+  #
+  # Defaults to fail: false, since when one just wants to get the value, there is not that much
+  # need to unconditionally die if getting bad exit code.
+  private def execvalue *args, fail: false, log: false, **kwargs
+    # This logging handling is a bit of duplication from execute(), but to be extra safe, it is duplicated.
+    # The debug message contents will always be evaluated, so can just do it like this.
+    log_command = args[0].respond_to?(:join) && args[0].join(" ") || args[0]
+    log_command =
+        if log_command.frozen?
+          log_command.dup.force_encoding("UTF-8")
+        else
+          log_command.force_encoding("UTF-8")
+        end
+    if @dry_run
+      puts "Would execvalue “#{log_command}” at #{caller_locations(1, 1)[0]}"
+      return
+    end
+    trace "Execvaluing “#{log_command}” at #{caller_locations(1, 1)[0]}"
+    execute(*args, fail: fail, log: log, **kwargs)
+  end
+
+  private def exec_success?
+    $CHILD_STATUS.success?
+  end
+
+  private def exec_failure?
+    !exec_success?
+  end
+
+  # When running through bundler, don’t use whatever it defines as we’re running inside chroot.
+  private def clean_execute
+    if (Bundler&.bundler_major_version) >= 2
+      Bundler.with_unbundled_env do
+        yield 2
+      end
+    elsif Bundler&.bundler_major_version == 1
+      Bundler.with_clean_env do
+        yield 1
+      end
+    else
+      yield nil
+    end
+  rescue NameError
+    # If NameError is thrown, no Bundler is available.
+    yield nil
+  end
+end

data/lib/bwrap/execution/labels.rb

@@ -1,7 +1,14 @@
 # frozen_string_literal: true
 
 require "bwrap/version"
-require_relative "execution"
+
+# Just declaring the module here so full Execution module
+# doesn’t need to be required just to have labels.
+#
+# Most users probably should just require bwrap/execution directly
+# instead of this file, but bwrap/output.rb benefits from this.
+module Bwrap::Execution
+end
 
 # Exit codes for exit status handling.
 #

data/lib/bwrap/execution/path.rb

@@ -1,15 +1,29 @@
 # frozen_string_literal: true
 
 require "bwrap/output"
+require_relative "exceptions"
 
 # Path checking methods.
 module Bwrap::Execution::Path
-  # @api internal
+  # Utilities to handle environment path operations.
+  #
+  # @api private
   class Environment
-    def self.each_env_path command
+    # Loop through each path in global PATH environment variable to
+    # perform an operation in each path, for example to resolve
+    # absolute path to a command.
+    #
+    # NOTE: This has nothing to do with {Bwrap::Config#env_paths}, as the
+    # env paths looped are what the system has defined, in ENV["PATH"].
+    #
+    # Should be cross-platform.
+    #
+    # @yield Command appended to each path in PATH environment variable
+    # @yieldparam path [String] Full path to executable
+    def self.each_env_path command, env_path_var: ENV["PATH"]
       exts = ENV["PATHEXT"] ? ENV["PATHEXT"].split(";") : [ "" ]
 
-      ENV["PATH"].split(File::PATH_SEPARATOR).each do |env_path|
+      env_path_var.split(File::PATH_SEPARATOR).each do |env_path|
         exts.each do |ext|
           exe = File.join(env_path, "#{command}#{ext}")
           yield exe
@@ -20,8 +34,12 @@ module Bwrap::Execution::Path
 
   # Check if requested program can be found.
   #
-  # Should work cross-platform and in restricted environents pretty well.
-  private def command_available? command
+  # Should work cross-platform and in restricted environments pretty well.
+  #
+  # @param command [String] executable to be resolved
+  # @param env_path_var [String] PATH environment variable as string.
+  #   Defaults to `ENV["PATH"]`
+  private def command_available? command, env_path_var: ENV["PATH"]
     # Special handling for absolute paths.
     path = Pathname.new command
     if path.absolute?
@@ -32,7 +50,7 @@ module Bwrap::Execution::Path
       return false
     end
 
-    Bwrap::Execution::Path::Environment.each_env_path command do |exe|
+    Bwrap::Execution::Path::Environment.each_env_path command, env_path_var: env_path_var do |exe|
       return true if File.executable?(exe) && !File.directory?(exe)
     end
 
@@ -40,7 +58,9 @@ module Bwrap::Execution::Path
   end
 
   # Returns path to given executable.
-  private def which command, fail: true
+  #
+  # @param (see #command_available?)
+  private def which command, fail: true, env_path_var: ENV["PATH"]
     # Special handling for absolute paths.
     path = Pathname.new command
     if path.absolute?
@@ -48,17 +68,17 @@ module Bwrap::Execution::Path
         return command
       end
 
-      raise CommandNotFound.new command: command if fail
+      raise Bwrap::Execution::CommandNotFound.new command: command if fail
 
       return nil
     end
 
-    Bwrap::Execution::Path::Environment.each_env_path command do |exe|
+    Bwrap::Execution::Path::Environment.each_env_path command, env_path_var: env_path_var do |exe|
       return exe if File.executable?(exe) && !File.directory?(exe)
     end
 
     return nil unless fail
 
-    raise CommandNotFound.new command: command
+    raise Bwrap::Execution::CommandNotFound.new command: command
   end
 end

data/lib/bwrap/execution.rb

@@ -1,165 +1,11 @@
 # frozen_string_literal: true
 
-require "bwrap/version"
-require "bwrap/output"
-require_relative "execution/execute"
-require_relative "execution/path"
+require_relative "bwrap_module"
 
-# @abstract Module to be included in a class that needs to execute commands.
-#
-# Methods to execute processes.
+# Declare Execution module here so Bwrap::Execution module is
+# already declared for Execution module classes, to avoid
+# a circular dependency.
 module Bwrap::Execution
-  include Bwrap::Output
-  include Bwrap::Execution::Path
-
-  # Unspecified execution related error.
-  class CommandError < StandardError
-  end
-
-  # Signifies that command execution has failed.
-  class ExecutionFailed < CommandError
-  end
-
-  # Thrown if given command was not found.
-  class CommandNotFound < CommandError
-    # Command that was looked at.
-    attr_reader :command
-
-    def initialize command:
-      @command = command
-      msg = "Failed to find #{command} from PATH."
-
-      super msg
-    end
-  end
-
-  # Actual implementation of execution command. Can be used when static method is needed.
-  #
-  # @note When an array is given as a command, empty strings are passed as empty arguments.
-  #
-  #   This means that `[ "foo", "bar" ]` passes one argument to "foo" command, when
-  #   `[ "foo", "", "bar" ]` passes two arguments.
-  #
-  #   This may or may not be what is assumed, so it can’t be fixed here. It is up to the
-  #   command to decide how to handle empty arguments.
-  #
-  # Returns pid of executed command if wait is false.
-  # Returns command output if wait is true.
-  #
-  # fail == If true, an error is raised in case the command returns failure code.
-  #
-  # @param error if :show, warn()s output of the command is shown if execution failed.
-  #
-  # @see #execute
-  def self.do_execute command,
-                      fail: true,
-                      wait: true,
-                      log: true,
-                      direct_output: false,
-                      env: {},
-                      clear_env: false,
-                      error: nil,
-                      log_callback: 2,
-                      rootcmd: nil
-    command = Execute.format_command command, rootcmd: rootcmd
-    Execute.handle_logging command, log_callback: log_callback, log: log, dry_run: @dry_run
-    return if @dry_run || Bwrap::Execution::Execute.dry_run
-
-    Execute.open_pipes direct_output
-
-    # If command is an array, there can’t be arrays inside the array.
-    # For convenience, the array is flattened here, so callers can construct commands more easily.
-    if command.respond_to? :flatten!
-      command.flatten!
-    end
-
-    # If command is string, splat operator (the *) does not do anything. If array, it expand the arguments.
-    # This causes spawning work correctly, as that’s how spawn() expects to have the argu
-    pid = spawn(env, *command, err: [ :child, :out ], out: Execute.w, unsetenv_others: clear_env)
-    output = Execute.finish_execution(log: log, wait: wait, direct_output: direct_output)
-    return pid unless wait
-
-    # This is instant return, but allows us to have $?/$CHILD_STATUS set.
-    Process.wait pid
-    @last_status = $CHILD_STATUS
-
-    output = Execute.process_output output: output
-    Execute.handle_execution_fail fail: fail, error: error, output: output
-    output
-  ensure
-    Execute.clean_variables
-  end
-
-  # Returns Process::Status instance of last execution.
-  #
-  # @note This only is able to return the status if wait is true, as otherwise caller is assumed to
-  # handle execution flow.
-  def self.last_status
-    @last_status
-  end
-
-  # Execute a command.
-  #
-  # This method can be used by including Execution module in a class that should be able to
-  # execute commands.
-  #
-  # @see .do_execute .do_execute for documentation of argument syntax
-  private def execute *args
-    # Mangle proper location to error message.
-    if args.last.is_a? Hash
-      args.last[:log_callback] = 3
-    else
-      args << { log_callback: 3 }
-    end
-    Bwrap::Execution.do_execute(*args)
-  end
-
-  # Same as ::execute, but uses log: false to avoid unnecessary output when we’re just getting a
-  # value for internal needs.
-  #
-  # Defaults to fail: false, since when one just wants to get the value, there is not that much
-  # need to unconditionally die if getting bad exit code.
-  private def execvalue *args, fail: false, rootcmd: nil, env: {}
-    # This logging handling is a bit of duplication from execute(), but to be extra safe, it is duplicated.
-    # The debug message contents will always be evaluated, so can just do it like this.
-    log_command = args[0].respond_to?(:join) && args[0].join(" ") || args[0]
-    log_command =
-        if log_command.frozen?
-          log_command.dup.force_encoding("UTF-8")
-        else
-          log_command.force_encoding("UTF-8")
-        end
-    if @dry_run
-      puts "Would execvalue “#{log_command}” at #{caller_locations(1, 1)[0]}"
-      return
-    end
-    trace "Execvaluing “#{log_command}” at #{caller_locations(1, 1)[0]}"
-    execute(*args, fail: fail, log: false, rootcmd: rootcmd, env: env)
-  end
-
-  private def exec_success?
-    $CHILD_STATUS.success?
-  end
-
-  private def exec_failure?
-    !exec_success?
-  end
-
-  # When running through bundler, don’t use whatever it defines as we’re running inside chroot.
-  private def clean_execute
-    if (Bundler&.bundler_major_version) >= 2
-      Bundler.with_unbundled_env do
-        yield 2
-      end
-    elsif Bundler&.bundler_major_version == 1
-      Bundler.with_clean_env do
-        yield 1
-      end
-    else
-      yield nil
-    end
-  rescue NameError
-    # If NameError is thrown, no Bundler is available.
-    yield nil
-  end
 end
+
+require_relative "execution/execution"

data/lib/bwrap/output/colors.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "output"
-
 # Methods to color CLI output.
 module Bwrap::Output::Colors
   # Outputs ANSI true color sequence.

data/lib/bwrap/output/log.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
-# force_encoding modifies string, so can’t freeze strings.
-
-require_relative "output"
-
 # Logging methods.
+#
+# @note One should require "bwrap/output" instead of this file directly, even
+#   if using only methods from this class.
+#
+#   This is because Bwrap::Output module would be missing, or there could be
+#   a circular dependency, which is always bad, even if Ruby would break it for you.
 class Bwrap::Output::Log
   @@log_file = nil
 
@@ -15,11 +17,17 @@ class Bwrap::Output::Log
 
   # Writes given string to log.
   def self.write_to_log str
+    # Guard against invalid input.
+    return unless str.respond_to? :force_encoding
+
     @@log_file&.write str.dup.force_encoding("UTF-8")
   end
 
   # Writes given string to log.
   def self.puts_to_log str
+    # Guard against invalid input.
+    return unless str.respond_to? :force_encoding
+
     @@log_file&.puts str.dup.force_encoding("UTF-8")
   end
 
@@ -31,6 +39,10 @@ class Bwrap::Output::Log
 
   # Starts logging to given file.
   def self.log_to_file log_path
+    unless File.writable? log_path
+      warn "Given log file #{log_path} is not writable by current user."
+      return
+    end
     log_file = File.open log_path, "w"
 
     # In default mode, log messages disappears as Ruby’s own buffer gets full.
@@ -40,7 +52,7 @@ class Bwrap::Output::Log
     @@log_file = log_file
 
     at_exit do
-      ::Bwrap::Output::Log.close_log_file
+      Bwrap::Output::Log.close_log_file
     end
   end
 end

data/lib/bwrap/output/output_impl.rb

@@ -0,0 +1,182 @@
+# frozen_string_literal: true
+
+# Have variables like $CHILD_STATUS which is alias of $?.
+require "English"
+
+require "bwrap/bwrap_module"
+require "bwrap/execution/labels"
+
+require_relative "levels"
+require_relative "log"
+
+# Methods useful for output handling.
+#
+# There is four different log levels:
+#
+# @!description_list
+#   @term error
+#   @description
+#     Causes execution to halt either to exit with requested code or,
+#     if requested, raises an exception.
+#   @term warning
+#   @description Outputs given text to STDERR.
+#   @term verbose
+#   @description Outputs given text if verbose, debug or trace flag is set.
+#   @term debug
+#   @description Outputs given text if debug or trace flag is set.
+#   @term trace
+#   @description Outputs given text if trace flag is set.
+#
+# Output levels can be enabled with {.handle_output_options}.
+#
+# When using {Bwrap::Bwrap}, {Bwrap::Bwrap#parse_command_line_arguments}
+# causes output levels to be set if relevant CLI arguments have been
+# given. TODO: Add documentation about CLI args somewhere. Maybe README?
+module Bwrap::Output
+  # @see #verbose?
+  def self.verbose?
+    Bwrap::Output::Levels.verbose?
+  end
+
+  # @see #debug?
+  def self.debug?
+    Bwrap::Output::Levels.debug?
+  end
+
+  # @see #trace?
+  def self.trace?
+    Bwrap::Output::Levels.trace?
+  end
+
+  # Takes hash of options received from Optimist and checks output related flags.
+  def self.handle_output_options options
+    Bwrap::Output::Levels.handle_output_options options
+  end
+
+  # Handler used by #trace to output given string.
+  def self.trace_output str, raw: false, log_callback: 1
+    return unless trace?
+
+    if raw
+      print str
+    else
+      out = Bwrap::Output::Levels.trace_print_formatted str, log_callback: (log_callback + 1)
+    end
+    Bwrap::Output::Log.puts_to_log out || str
+  end
+
+  # Handler used by #debug to output given string.
+  def self.debug_output str, raw: false, log_callback: 1
+    return unless debug?
+
+    if raw
+      print str
+    else
+      out = Bwrap::Output::Levels.debug_print_formatted str, log_callback: (log_callback + 1)
+    end
+    Bwrap::Output::Log.puts_to_log out || str
+  end
+
+  # Handler used by #verb to output given string.
+  def self.verb_output str, raw: false, log_callback: 1
+    return unless verbose?
+
+    if raw
+      print str
+    else
+      out = Bwrap::Output::Levels.verbose_print_formatted str, log_callback: (log_callback + 1)
+    end
+    Bwrap::Output::Log.puts_to_log out || str
+  end
+
+  # Handler used by #warn to output given string.
+  def self.warn_output str, raw: false, log_callback: 1
+    if raw
+      print str
+    else
+      out = Bwrap::Output::Levels.warning_print_formatted str, log_callback: (log_callback + 1)
+    end
+    Bwrap::Output::Log.puts_to_log out || str
+  end
+
+  # Aborts current process.
+  #
+  # Use this instead of Ruby’s #exit in order to filter out dummy #exit calls from the code.
+  def self.error_output str = nil, label: :unspecified, log_callback: 1, raise_exception: false
+    unless str.nil?
+      out = Bwrap::Output::Levels.error_print_formatted str, log_callback: (log_callback + 1)
+      Bwrap::Output::Log.puts_to_log out
+    end
+
+    exit_code = Bwrap::Execution::Labels.resolve_exit_code(label)
+    raise str if raise_exception
+
+    exit exit_code
+  end
+
+  # @return true if --verbose, --debug or --trace has been passed, false if not.
+  private def verbose?
+    Bwrap::Output::Levels.verbose?
+  end
+
+  # @return true if --debug or --trace has been passed, false if not.
+  private def debug?
+    Bwrap::Output::Levels.debug?
+  end
+
+  # @return true if --trace has been passed, false if not.
+  private def trace?
+    Bwrap::Output::Levels.trace?
+  end
+
+  # @!group Outputters
+
+  # Outputs given string if trace flag has been set.
+  #
+  # Output flags can be set with {.handle_output_options}.
+  #
+  # @param str String to be outputted
+  # @param raw [Boolean] If true, disables output formatting
+  private def trace str, raw: false
+    Bwrap::Output.trace_output(str, raw: raw, log_callback: 2)
+  end
+
+  # Outputs given string if debug flag has been set.
+  #
+  # Output flags can be set with {.handle_output_options}.
+  #
+  # @param str String to be outputted
+  # @param raw [Boolean] If true, disables output formatting
+  private def debug str, raw: false
+    Bwrap::Output.debug_output(str, raw: raw, log_callback: 2)
+  end
+
+  # Outputs given string if verbose flag has been set.
+  #
+  # Output flags can be set with {.handle_output_options}.
+  #
+  # @param str String to be outputted
+  # @param raw [Boolean] If true, disables output formatting
+  private def verb str, raw: false
+    Bwrap::Output.verb_output(str, raw: raw, log_callback: 2)
+  end
+
+  # Outputs given string to `$stderr`.
+  #
+  # @param str String to be outputted
+  # @param raw [Boolean] If true, disables output formatting
+  private def warn str, raw: false
+    Bwrap::Output.warn_output(str, raw: raw, log_callback: 2)
+  end
+
+  # Outputs given string to `$stderr` and halts execution.
+  #
+  # @param str String to be outputted
+  # @param label [Symbol] Exit label accepted by {Bwrap::Execution.resolve_exit_code}
+  # @param raise_exception [Boolean] if true, an exception is raised instead of just existing with exit code.
+  private def error str = nil, label: :unspecified, raise_exception: false
+    Bwrap::Output.error_output(str, label: label, log_callback: 2, raise_exception: raise_exception)
+  end
+
+  # @!endgroup
+end