Exception: ErrorDuringExecution Private

Inherits:
RuntimeError
  • Object
show all
Defined in:
exceptions.rb

Overview

This class is part of a private API. This class may only be used in the Homebrew/brew repository. Third parties should avoid using this class if possible, as it may be removed or changed without warning.

Raised by Kernel#safe_system in utils.rb.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(cmd, status:, output: nil, secrets: []) ⇒ ErrorDuringExecution

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns a new instance of ErrorDuringExecution.

Raises:

  • (ArgumentError)


645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
# File 'exceptions.rb', line 645

def initialize(cmd, status:, output: nil, secrets: [])
  @cmd = cmd
  @status = status
  @output = output

  raise ArgumentError, "Status cannot be nil." if status.nil?

  exitstatus = case status
  when Integer
    status
  when Hash
    status["exitstatus"]
  else
    status.exitstatus
  end

  termsig = case status
  when Integer
    nil
  when Hash
    status["termsig"]
  else
    status.termsig
  end

  redacted_cmd = redact_secrets(cmd.shelljoin.gsub('\=', "="), secrets)

  reason = if exitstatus
    "exited with #{exitstatus}"
  elsif termsig
    "was terminated by uncaught signal #{Signal.signame(termsig)}"
  else
    raise ArgumentError, "Status neither has `exitstatus` nor `termsig`."
  end

  s = +"Failure while executing; `#{redacted_cmd}` #{reason}."

  if Array(output).present?
    format_output_line = lambda do |type_line|
      type, line = *type_line
      if type == :stderr
        Formatter.error(line)
      else
        line
      end
    end

    s << " Here's the output:\n"
    s << output.map(&format_output_line).join
    s << "\n" unless s.end_with?("\n")
  end

  super s.freeze
end

Instance Attribute Details

#cmdObject (readonly)

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



643
644
645
# File 'exceptions.rb', line 643

def cmd
  @cmd
end

#outputObject (readonly)

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



643
644
645
# File 'exceptions.rb', line 643

def output
  @output
end

#statusObject (readonly)

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.



643
644
645
# File 'exceptions.rb', line 643

def status
  @status
end

Instance Method Details

#stderrString

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



701
702
703
# File 'exceptions.rb', line 701

def stderr
  Array(output).select { |type,| type == :stderr }.map(&:last).join
end