Exception: BuildError

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

Overview

Raised when an error occurs during a formula build.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(formula, cmd, args, env) ⇒ void

Parameters:



482
483
484
485
486
487
488
489
# File 'exceptions.rb', line 482

def initialize(formula, cmd, args, env)
  @formula = formula
  @cmd = cmd
  @args = args
  @env = env
  pretty_args = Array(args).map { |arg| arg.to_s.gsub(/[\\ ]/, "\\\\\\0") }.join(" ")
  super "Failed executing: #{cmd} #{pretty_args}".strip
end

Instance Attribute Details

#argsObject (readonly)

Returns the value of attribute args.



471
472
473
# File 'exceptions.rb', line 471

def args
  @args
end

#cmdObject (readonly)

Returns the value of attribute cmd.



471
472
473
# File 'exceptions.rb', line 471

def cmd
  @cmd
end

#envObject (readonly)

Returns the value of attribute env.



471
472
473
# File 'exceptions.rb', line 471

def env
  @env
end

#formulaObject

Returns the value of attribute formula.



472
473
474
# File 'exceptions.rb', line 472

def formula
  @formula
end

#optionsObject

Returns the value of attribute options.



472
473
474
# File 'exceptions.rb', line 472

def options
  @options
end

Instance Method Details

#dump(verbose: false) ⇒ void

This method returns an undefined value.

Parameters:

  • verbose (Boolean) (defaults to: false)


505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
# File 'exceptions.rb', line 505

def dump(verbose: false)
  puts

  if verbose
    require "system_config"
    require "build_environment"

    ohai "Formula"
    puts "Tap: #{formula.tap}" if formula.tap?
    puts "Path: #{formula.path}"
    ohai "Configuration"
    SystemConfig.dump_verbose_config
    ohai "ENV"
    BuildEnvironment.dump env
    puts
    onoe "#{formula.full_name} #{formula.version} did not build"
    unless (logs = Dir["#{formula.logs}/*"]).empty?
      puts "Logs:"
      puts logs.map { |fn| "     #{fn}" }.join("\n")
    end
  end

  if formula.tap && defined?(OS::ISSUES_URL)
    if formula.tap.official?
      puts Formatter.error(Formatter.url(OS::ISSUES_URL), label: "READ THIS")
    elsif (issues_url = formula.tap.issues_url)
      puts <<~EOS
        If reporting this issue please do so at (not Homebrew/brew or Homebrew/core):
          #{Formatter.url(issues_url)}
      EOS
    else
      puts <<~EOS
        If reporting this issue please do so to (not Homebrew/brew or Homebrew/core):
          #{formula.tap}
      EOS
    end
  else
    puts <<~EOS
      Do not report this issue to Homebrew/brew or Homebrew/core!
    EOS
  end

  puts

  if issues.present?
    puts "These open issues may also help:"
    puts issues.map { |i| "#{i["title"]} #{i["html_url"]}" }.join("\n")
  end

  require "diagnostic"
  checks = Homebrew::Diagnostic::Checks.new
  checks.build_error_checks.each do |check|
    out = checks.send(check)
    next if out.nil?

    puts
    ofail out
  end
end

#fetch_issuesArray<T.untyped>

Returns:

  • (Array<T.untyped>)


497
498
499
500
501
502
# File 'exceptions.rb', line 497

def fetch_issues
  GitHub.issues_for_formula(formula.name, tap: formula.tap, state: "open")
rescue GitHub::API::RateLimitExceededError => e
  opoo e.message
  []
end

#issuesArray<T.untyped>

Returns:

  • (Array<T.untyped>)


492
493
494
# File 'exceptions.rb', line 492

def issues
  @issues ||= fetch_issues
end