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) ⇒ BuildError

Returns a new instance of BuildError.



445
446
447
448
449
450
451
452
# File 'exceptions.rb', line 445

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

Instance Attribute Details

#argsObject (readonly)

Returns the value of attribute args.



442
443
444
# File 'exceptions.rb', line 442

def args
  @args
end

#cmdObject (readonly)

Returns the value of attribute cmd.



442
443
444
# File 'exceptions.rb', line 442

def cmd
  @cmd
end

#envObject (readonly)

Returns the value of attribute env.



442
443
444
# File 'exceptions.rb', line 442

def env
  @env
end

#formulaObject

Returns the value of attribute formula.



443
444
445
# File 'exceptions.rb', line 443

def formula
  @formula
end

#optionsObject

Returns the value of attribute options.



443
444
445
# File 'exceptions.rb', line 443

def options
  @options
end

Instance Method Details

#dump(verbose: false) ⇒ Object



465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
# File 'exceptions.rb', line 465

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_issuesObject



458
459
460
461
462
463
# File 'exceptions.rb', line 458

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

#issuesObject



454
455
456
# File 'exceptions.rb', line 454

def issues
  @issues ||= fetch_issues
end