Class: Homebrew::Diagnostic::Checks Private

Inherits:
Object
  • Object
show all
Includes:
OS::Linux::Diagnostic::Checks, OS::Mac::Diagnostic::Checks, SystemCommand::Mixin, Utils::Output::Mixin
Defined in:
diagnostic.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.

Diagnostic checks.

HELPERS collapse

Instance Method Summary collapse

Methods included from Utils::Output::Mixin

#issue_reporting_message, #odebug, #odeprecated, #odie, #odisabled, #ofail, #oh1, #oh1_title, #ohai, #ohai_title, #onoe, #opoo, #opoo_outside_github_actions, #opoo_without_github_actions_annotation, #pretty_deprecated, #pretty_disabled, #pretty_duration, #pretty_install_status, #pretty_installed, #pretty_uninstalled, #pretty_unmarked, #pretty_upgradable, #pretty_warning

Methods included from SystemCommand::Mixin

#system_command, #system_command!

Methods included from OS::Linux::Diagnostic::Checks

#check_for_symlinked_home, #check_gcc_dependent_linkage, #check_glibc_minimum_version, #check_glibc_next_version, #check_glibc_version, #check_kernel_minimum_version, #check_linux_sandbox, #check_linuxbrew_bottle_domain, #check_linuxbrew_core, #check_supported_architecture, #check_tmpdir_executable, #check_umask_not_zero

Methods included from OS::Mac::Diagnostic::Checks

#check_broken_sdks, #check_cask_quarantine_support, #check_clt_minimum_version, #check_clt_up_to_date, #check_filesystem_case_sensitive, #check_for_gettext, #check_for_iconv, #check_for_multiple_volumes, #check_for_non_prefixed_findutils, #check_for_opencore, #check_for_unsupported_macos, #check_if_supported_sdk_available, #check_if_xcode_needs_clt_installed, #check_pkgconf_macos_sdk_mismatch, #check_xcode_license_approved, #check_xcode_minimum_version, #check_xcode_prefix, #check_xcode_prefix_exists, #check_xcode_select_path, #check_xcode_up_to_date

Constructor Details

#initialize(verbose: true) ⇒ void

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.

Parameters:

  • verbose (Boolean) (defaults to: true) 


49
50
51
52
53
54
55
56
 
# File 'diagnostic.rb', line 49

def initialize(verbose: true)
  @verbose = verbose
  @found = T.let([], T::Array[String])
  @seen_prefix_bin = T.let(false, T::Boolean)
  @seen_prefix_sbin = T.let(false, T::Boolean)
  @user_path_1_done = T.let(false, T::Boolean)
  @non_core_taps = T.let([], T.nilable(T::Array[Tap]))
end

Instance Method Details

#__check_linked_brew!(formula) ⇒ Boolean

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.

Parameters:

Returns:

  • (Boolean) 


916
917
918
919
920
921
922
923
924
925
926
927
 
# File 'diagnostic.rb', line 916

def __check_linked_brew!(formula)
  formula.installed_prefixes.each do |prefix|
    prefix.find do |src|
      next if src == prefix

      dst = HOMEBREW_PREFIX + src.relative_path_from(prefix)
      return true if dst.symlink? && src == dst.resolved_path
    end
  end

  false
end

#__check_stray_files(dir, pattern, allow_list, message) ⇒ String?

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.

Parameters:

Returns:



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'diagnostic.rb', line 223

def __check_stray_files(dir, pattern, allow_list, message)
  return unless File.directory?(dir)

  files = Dir.chdir(dir) do
    (Dir.glob(pattern) - Dir.glob(allow_list))
      .select { |f| File.file?(f) && !File.symlink?(f) }
      .map do |f|
        f.sub!(%r{/.*}, "/*") unless @verbose
        File.join(dir, f)
      end
      .sort.uniq
  end
  return if files.empty?

  inject_file_list(files, message)
end

#__tap_git_status(tap, path) ⇒ Finding?

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.

Parameters:

Returns:



1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
 
# File 'diagnostic.rb', line 1044

def __tap_git_status(tap, path)
  return unless path.exist?

  status = path.cd do
    `git status --untracked-files=all --porcelain 2>/dev/null`
  end
  return if status.blank?

  message = <<~EOS
    You have uncommitted modifications to #{tap}.
  EOS
  remediation = Finding::Remediation.new(
    commands: ["git -C \"#{path}\" stash -u && git -C \"#{path}\" clean -d -f"],
    text:     <<~EOS,
      If this is a surprise to you, then you should stash these modifications.
      Stashing returns Homebrew to a pristine state but can be undone
      should you later need to do so for some reason.

        git -C "#{path}" stash -u && git -C "#{path}" clean -d -f
    EOS
  )

  modified = status.split("\n")
  message += inject_file_list modified, <<~EOS
    Uncommitted files:
  EOS

  Finding.new(message, affects: modified, remediation:) if message.present?
end

#add_info(*args) ⇒ void

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.

This method returns an undefined value.

Parameters:

  • args (T.anything) 


91
92
93
 
# File 'diagnostic.rb', line 91

def add_info(*args)
  ohai(*args) if @verbose
end

#all ⇒ Array<String>

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:



1583
1584
1585
 
# File 'diagnostic.rb', line 1583

def all
  methods.map(&:to_s).grep(/^check_/).sort
end

#broken_tap(tap) ⇒ Finding?

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.

Parameters:

Returns:



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'diagnostic.rb', line 182

def broken_tap(tap)
  return unless Utils::Git.available?

  repo = GitRepository.new(HOMEBREW_REPOSITORY)
  return unless repo.git_repository?

  finding = Finding.new(
    "#{tap.full_name} was not tapped properly!",
    remediation: Finding::Remediation.new(
      text:     <<~EOS,
        You can solve this by tapping again:
          rm -rf "#{tap.path}"
          brew tap #{tap.name}
      EOS
      commands: [
        "rm -rf \"#{tap.path}\"",
        "brew tap #{tap.name}",
      ],
    ),
  )

  return finding if tap.remote.blank?

  tap_head = tap.git_head
  return finding if tap_head.blank?
  return if tap_head != repo.head_ref

  finding
end

#build_error_checks ⇒ Array<String>

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:



133
134
135
 
# File 'diagnostic.rb', line 133

def build_error_checks
  supported_configuration_checks + build_from_source_checks
end

#build_from_source_checks ⇒ Array<String>

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:



121
122
123
 
# File 'diagnostic.rb', line 121

def build_from_source_checks
  [].freeze
end

#cask_checks ⇒ Array<String>

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:



1588
1589
1590
 
# File 'diagnostic.rb', line 1588

def cask_checks
  all.grep(/^check_cask_/)
end

#check_access_directories ⇒ Finding?

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:



450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
 
# File 'diagnostic.rb', line 450

def check_access_directories
  not_writable_dirs =
    Keg.must_be_writable_directories.select(&:exist?)
       .reject(&:writable?)
  return if not_writable_dirs.empty?

  Finding.new(
    <<~EOS,
    remediation: Finding::Remediation.new(
      text:     <<~EOS,
        You should change the ownership of these directories to your user.
          sudo chown -R #{current_user} #{not_writable_dirs.join(" ")}

        And make sure that your user has write permission.
          chmod u+w #{not_writable_dirs.join(" ")}
      EOS
      commands: ["sudo chown -R #{current_user} #{not_writable_dirs.join(" ")}",
                 "chmod u+w #{not_writable_dirs.join(" ")}"],
    ),
  )
end

#check_brew_git_origin ⇒ Finding?

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:



709
710
711
712
 
# File 'diagnostic.rb', line 709

def check_brew_git_origin
  repo = GitRepository.new(HOMEBREW_REPOSITORY)
  examine_git_origin(repo, Homebrew::EnvConfig.brew_git_remote)
end

#check_cask_corrupt_dirs ⇒ Finding?

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:



1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
 
# File 'diagnostic.rb', line 1387

def check_cask_corrupt_dirs
  corrupt = Cask::Caskroom.corrupt_cask_dirs
  return if corrupt.empty?

  fixes = corrupt.map { |token| "brew reinstall --cask --force #{token}" }
  Finding.new(
    <<~EOS,
    remediation: Finding::Remediation.new(
      text:     <<~EOS,
        To fix this, run:
          #{fixes.join("\n  ")}
      EOS
      commands: fixes,
    ),
  )
end

#check_cask_deprecated_disabled ⇒ Finding?

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:



1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
 
# File 'diagnostic.rb', line 1009

def check_cask_deprecated_disabled
  deprecated_or_disabled = Cask::Caskroom.casks.select(&:deprecated?)
  deprecated_or_disabled += Cask::Caskroom.casks.select(&:disabled?)
  return if deprecated_or_disabled.empty?

  Finding.new(
    "Some installed casks are deprecated or disabled.",
    affects:     deprecated_or_disabled.map(&:token),
    remediation: <<~EOS,
      You should find replacements for the following casks:
      #{deprecated_or_disabled.sort_by(&:token).uniq * "\n  "}
    EOS
  )
end

#check_cask_environment_variables ⇒ Finding?

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:



1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
 
# File 'diagnostic.rb', line 1443

def check_cask_environment_variables
  environment_variables = %w[
    RUBYLIB
    RUBYOPT
    RUBYPATH
    RBENV_VERSION
    CHRUBY_VERSION
    GEM_HOME
    GEM_PATH
    BUNDLE_PATH
    PATH
    SHELL
    HOMEBREW_CASK_OPTS
  ]

  locale_variables = ENV.keys.grep(/^(?:LC_\S+|LANG|LANGUAGE)\Z/).sort

  cask_environment_variables = (locale_variables + environment_variables).sort.filter_map do |var|
    next unless ENV.key?(var)

    %Q(#{var}="#{Utils::Shell.sh_quote(ENV.fetch(var))}")
  end
  add_info "Cask Environment Variables:", cask_environment_variables

  nil
end

#check_cask_install_location ⇒ Finding?

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:



1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
 
# File 'diagnostic.rb', line 1346

def check_cask_install_location
  locations = Dir.glob(HOMEBREW_CELLAR.join("brew-cask", "*")).reverse
  return if locations.empty?

  Finding.new(
    locations.map do |l|
      "Legacy install at #{l}."
    end.join("\n"),
    remediation: <<~EOS,
      Run `brew uninstall --force brew-cask`.
    EOS
  )
end

#check_cask_load_path ⇒ Finding?

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:



1434
1435
1436
1437
1438
1439
1440
 
# File 'diagnostic.rb', line 1434

def check_cask_load_path
  paths = $LOAD_PATH.map { user_tilde(it) }

  add_info "$LOAD_PATHS", paths.presence || none_string

  Finding.new("$LOAD_PATH is empty") if paths.blank?
end

#check_cask_software_versions ⇒ Finding?

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:



1339
1340
1341
1342
1343
 
# File 'diagnostic.rb', line 1339

def check_cask_software_versions
  add_info "Homebrew Version", HOMEBREW_VERSION

  nil
end

#check_cask_staging_location ⇒ Finding?

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:



1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
 
# File 'diagnostic.rb', line 1361

def check_cask_staging_location
  # Skip this check when running CI since the staging path is not writable for security reasons
  return if GitHub::Actions.env_set?

  path = Cask::Caskroom.path

  add_info "Cask Staging Location", user_tilde(path.to_s)

  return if !path.exist? || path.writable?

  remediation = Finding::Remediation.new(
    text:     <<~EOS,
      To fix, run:
        sudo chown -R #{current_user} #{user_tilde(path.to_s)}
    EOS
    commands: ["sudo chown -R #{current_user} #{user_tilde(path.to_s)}"],
  )
  Finding.new(
    <<~EOS,
      The staging path #{user_tilde(path.to_s)} is not writable by the current user.
    EOS
    remediation:,
  )
end

#check_cask_taps ⇒ Finding?

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:



1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
 
# File 'diagnostic.rb', line 1409

def check_cask_taps
  error_tap_paths = []

  taps = (Tap.to_a + [CoreCaskTap.instance]).uniq

  taps_info = taps.filter_map do |tap|
    cask_count = begin
      tap.cask_files.count
    rescue
      error_tap_paths << tap.path
      0
    end
    next if cask_count.zero?

    "#{tap.path} (#{Utils.pluralize("cask", cask_count, include_count: true)})"
  end
  add_info "Cask Taps:", taps_info

  taps_string = Utils.pluralize("tap", error_tap_paths.count)
  return unless error_tap_paths.present?

  Finding.new("Unable to read from cask #{taps_string}: #{error_tap_paths.to_sentence}")
end

#check_cask_xattr ⇒ Finding?

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:



1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
 
# File 'diagnostic.rb', line 1471

def check_cask_xattr
  # If quarantine is not available, a warning is already shown by check_cask_quarantine_support so just return
  return unless Cask::Quarantine.available?
  return Finding.new("Unable to find `xattr`.") unless File.exist?("/usr/bin/xattr")

  result = system_command "/usr/bin/xattr", args: ["-h"]

  return if result.status.success?

  if result.stderr.include? "ImportError: No module named pkg_resources"
    result = Utils.popen_read "/usr/bin/python", "--version", err: :out

    if result.include? "Python 2.7"
      Finding.new(
        <<~EOS,
        remediation: <<~EOS,
          To fix, reinstall macOS or run:
            sudo /usr/bin/python -m pip install -I setuptools
        EOS
      )
    else
      Finding.new(
        <<~EOS,
        remediation: <<~EOS,
          To fix, run:
            defaults write com.apple.versioner.python Version 2.7
        EOS
      )
    end
  elsif result.stderr.include? "pkg_resources.DistributionNotFound"
    Finding.new("Your Python installation is unable to find `xattr`.")
  else
    Finding.new("unknown xattr error: #{result.stderr.split("\n").last}")
  end
end

#check_casktap_integrity ⇒ Finding?

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:



740
741
742
743
744
745
 
# File 'diagnostic.rb', line 740

def check_casktap_integrity
  core_cask_tap = CoreCaskTap.instance
  return unless core_cask_tap.installed?

  broken_tap(core_cask_tap) || examine_git_origin(core_cask_tap.git_repository, T.must(core_cask_tap.remote))
end

#check_coretap_integrity ⇒ Finding?

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:



728
729
730
731
732
733
734
735
736
737
 
# File 'diagnostic.rb', line 728

def check_coretap_integrity
  core_tap = CoreTap.instance
  unless core_tap.installed?
    return unless EnvConfig.no_install_from_api?

    core_tap.ensure_installed!
  end

  broken_tap(core_tap) || examine_git_origin(core_tap.git_repository, Homebrew::EnvConfig.core_git_remote)
end

#check_deleted_formula ⇒ Finding?

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:



1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
 
# File 'diagnostic.rb', line 1234

def check_deleted_formula
  kegs = Keg.all

  deleted_formulae = kegs.filter_map do |keg|
    tap = keg.tab.tap
    tap_keg_name = tap ? "#{tap}/#{keg.name}" : keg.name

    loadable = [
      Formulary::FromAPILoader,
      Formulary::FromTapLoader,
      Formulary::FromNameLoader,
    ].any? do |loader_class|
      loader = begin
        loader_class.try_new(tap_keg_name, warn: false)
      rescue TapFormulaAmbiguityError => e
        e.loaders.first
      end

      loader.instance_of?(Formulary::FromTapLoader) ? loader.path.exist? : loader.present?
    end

    keg.name unless loadable
  end.uniq

  return if deleted_formulae.blank?

  Finding.new(
    <<~EOS,
    affects:     deleted_formulae,
    remediation: <<~EOS,
      You should find replacements for the following formulae:
        #{deleted_formulae.join("\n  ")}
    EOS
  )
end

#check_deprecated_cask_taps ⇒ Finding?

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:



1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
 
# File 'diagnostic.rb', line 1317

def check_deprecated_cask_taps
  tapped_caskroom_taps = ::Tap.select { |t| t.user == "caskroom" || t.name == "phinze/cask" }
                              .map(&:name)
  return if tapped_caskroom_taps.empty?

  remediation = Finding::Remediation.new(
    text:     <<~EOS,
      Please remove it by running:
       brew untap #{tapped_caskroom_taps.join(" ")}
    EOS
    commands: ["brew untap #{tapped_caskroom_taps.join(" ")}"],
  )
  Finding.new(
    <<~EOS,
      You have the following deprecated Cask taps installed:
        #{tapped_caskroom_taps.join("\n  ")}
    EOS
    remediation:,
  )
end

#check_deprecated_disabled ⇒ Finding?

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:



992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
 
# File 'diagnostic.rb', line 992

def check_deprecated_disabled
  return unless HOMEBREW_CELLAR.exist?

  deprecated_or_disabled = Formula.installed.select { |f| f.deprecated? || f.disabled? }
  return if deprecated_or_disabled.empty?

  Finding.new(
    "Some installed formulae are deprecated or disabled.",
    affects:     deprecated_or_disabled.map(&:full_name),
    remediation: <<~EOS,
      You should find replacements for the following formulae:
          #{deprecated_or_disabled.sort_by(&:full_name).uniq * "\n  "}
    EOS
  )
end

#check_deprecated_official_taps ⇒ Finding?

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:



794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
 
# File 'diagnostic.rb', line 794

def check_deprecated_official_taps
  tapped_deprecated_taps =
    Tap.select(&:official?).map(&:repository) & DEPRECATED_OFFICIAL_TAPS

  # TODO: remove this once it's no longer in the default GitHub Actions image
  tapped_deprecated_taps -= ["bundle"] if GitHub::Actions.env_set?

  return if tapped_deprecated_taps.empty?

  Finding.new(
    <<~EOS,
    remediation: <<~EOS,
      Untap them with `brew untap`.
    EOS
  )
end

#check_exist_directories ⇒ Finding?

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:



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'diagnostic.rb', line 426

def check_exist_directories
  return if HOMEBREW_PREFIX.writable?

  not_exist_dirs = Keg.must_exist_directories.reject(&:exist?)
  return if not_exist_dirs.empty?

  Finding.new(
    <<~EOS,
    remediation: Finding::Remediation.new(
      text:     <<~EOS,
        You should create these directories and change their ownership to your user.
          sudo mkdir -p #{not_exist_dirs.join(" ")}
          sudo chown -R #{current_user} #{not_exist_dirs.join(" ")}
      EOS
      commands: ["sudo mkdir -p #{not_exist_dirs.join(" ")}",
                 "sudo chown -R #{current_user} #{not_exist_dirs.join(" ")}"],
    ),
  )
end

#check_for_broken_symlinks ⇒ Finding?

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:



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'diagnostic.rb', line 380

def check_for_broken_symlinks
  broken_symlinks = []

  Keg.must_exist_subdirectories.each do |d|
    next unless d.directory?

    d.find do |path|
      broken_symlinks << path if path.symlink? && !path.resolved_path_exists?
    end
  end
  return if broken_symlinks.empty?

  Finding.new(
    inject_file_list(broken_symlinks, <<~EOS
      Broken symlinks were found:
    EOS
    ),
    remediation: Finding::Remediation.new(
      text:     <<~EOS,
        Remove them with `brew cleanup`
      EOS
      commands: ["brew cleanup"],
    ),
  )
end

#check_for_duplicate_casks ⇒ Finding?

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:



1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
 
# File 'diagnostic.rb', line 1547

def check_for_duplicate_casks
  return if ENV["HOMEBREW_TEST_BOT"].present?

  core_cask_names = CoreCaskTap.instance.cask_tokens
  shadowed_cask_full_names = non_core_taps.flat_map do |tap|
    tap_cask_names = tap.cask_tokens.map { |s| s.delete_prefix("#{tap.name}/") }
    (core_cask_names & tap_cask_names).map { |f| "#{tap.name}/#{f}" }
  end.compact.sort
  return if shadowed_cask_full_names.empty?

  installed_cask_tap_names = Cask::Caskroom.casks.filter_map(&:tap).uniq.reject(&:official?).map(&:name)
  shadowed_cask_tap_names = shadowed_cask_full_names.filter_map { |s| Utils.tap_from_full_name(s) }.uniq
  unused_shadowed_cask_tap_names = (shadowed_cask_tap_names - installed_cask_tap_names).sort

  remediation = if unused_shadowed_cask_tap_names.empty?
    Finding::Remediation.new(
      text: "Their taps are in use, so you must use these full names throughout Homebrew.",
    )
  else
    Finding::Remediation.new(
      text:     "Some of these can be resolved with:",
      commands: ["brew untap #{unused_shadowed_cask_tap_names.join(" ")}"],
    )
  end

  Finding.new(
    <<~EOS,
      The following casks have the same name as core casks:
        #{shadowed_cask_full_names.join("\n  ")}
    EOS
    affects:     shadowed_cask_full_names,
    remediation:,
  )
end

#check_for_duplicate_formulae ⇒ Finding?

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:



1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
 
# File 'diagnostic.rb', line 1517

def check_for_duplicate_formulae
  return if ENV["HOMEBREW_TEST_BOT"].present?

  core_formula_names = CoreTap.instance.formula_names
  shadowed_formula_full_names = non_core_taps.flat_map do |tap|
    tap_formula_names = tap.formula_names.map { |s| s.delete_prefix("#{tap.name}/") }
    (core_formula_names & tap_formula_names).map { |f| "#{tap.name}/#{f}" }
  end.compact.sort
  return if shadowed_formula_full_names.empty?

  installed_formula_tap_names = Formula.installed.filter_map(&:tap).uniq.reject(&:official?).map(&:name)
  shadowed_formula_tap_names = shadowed_formula_full_names.filter_map { |s| Utils.tap_from_full_name(s) }.uniq
  unused_shadowed_formula_tap_names = (shadowed_formula_tap_names - installed_formula_tap_names).sort

  remediation = if unused_shadowed_formula_tap_names.empty?
    "Their taps are in use, so you must use these full names throughout Homebrew."
  else
    "Some of these can be resolved with:\n  brew untap #{unused_shadowed_formula_tap_names.join(" ")}"
  end

  Finding.new(
    <<~EOS,
      The following formulae have the same name as core formulae:
        #{shadowed_formula_full_names.join("\n  ")}
    EOS
    remediation:,
  )
end

#check_for_external_cmd_name_conflict ⇒ Finding?

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:



1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
 
# File 'diagnostic.rb', line 1164

def check_for_external_cmd_name_conflict
  cmds = Commands.tap_cmd_directories.flat_map { |p| Dir["#{p}/brew-*"] }.uniq
  cmds = cmds.select { |cmd| File.file?(cmd) && File.executable?(cmd) }
  cmd_map = {}
  cmds.each do |cmd|
    cmd_name = File.basename(cmd, ".rb")
    cmd_map[cmd_name] ||= []
    cmd_map[cmd_name] << cmd
  end
  cmd_map.reject! { |_cmd_name, cmd_paths| cmd_paths.size == 1 }
  return if cmd_map.empty?

  if ENV["CI"].present? && cmd_map.keys.length == 1 &&
     cmd_map.keys.first == "brew-test-bot"
    return
  end

  message = "You have external commands with conflicting names.\n"
  cmd_map.each do |cmd_name, cmd_paths|
    message += inject_file_list cmd_paths, <<~EOS
      Found command `#{cmd_name}` in the following places:
    EOS
  end

  Finding.new(message)
end

#check_for_git ⇒ Finding?

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:



633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
 
# File 'diagnostic.rb', line 633

def check_for_git
  return if Utils::Git.available?

  Finding.new(
    <<~EOS,
    remediation: Finding::Remediation.new(
      text:     <<~EOS,
        You may want to install Git:
          brew install git
      EOS
      commands: ["brew install git"],
    ),
  )
end

#check_for_installed_developer_tools ⇒ Finding?

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:



213
214
215
216
217
218
219
220
 
# File 'diagnostic.rb', line 213

def check_for_installed_developer_tools
  return if DevelopmentTools.installed?

  Finding.new(
    "No developer tools installed.\n",
    remediation: DevelopmentTools.installation_instructions,
  )
end

#check_for_nix_homebrew ⇒ Finding?

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:



715
716
717
718
719
720
721
722
723
724
725
 
# File 'diagnostic.rb', line 715

def check_for_nix_homebrew
  return unless OS.nix_managed_homebrew?

  Finding.new(
    <<~EOS,
      Your Homebrew installation is managed by Nix.
      Homebrew does not support Nix-managed installations.
    EOS
    tier: 3,
  )
end

#check_for_non_prefixed_coreutils ⇒ Finding?

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:



1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
 
# File 'diagnostic.rb', line 1075

def check_for_non_prefixed_coreutils
  coreutils = Formula["coreutils"]
  return unless coreutils.any_version_installed?

  gnubin = %W[#{coreutils.opt_libexec}/gnubin #{coreutils.libexec}/gnubin]
  return unless paths.intersect?(gnubin)

  Finding.new(
    <<~EOS,
      Putting non-prefixed coreutils in your path can cause GMP builds to fail.
    EOS
  )
rescue FormulaUnavailableError
  nil
end

#check_for_other_frameworks ⇒ Finding?

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:



930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
 
# File 'diagnostic.rb', line 930

def check_for_other_frameworks
  # Other frameworks that are known to cause problems when present
  frameworks_to_check = %w[
    expat.framework
    libexpat.framework
    libcurl.framework
  ]
  frameworks_found = frameworks_to_check
                     .map { |framework| "/Library/Frameworks/#{framework}" }
                     .select { |framework| File.exist? framework }
  return if frameworks_found.empty?

  Finding.new(
    <<~EOS,
    remediation: <<~EOS,
      To compile CMake, you may wish to move these out of the way:
      #{frameworks_found.join("\n")}
    EOS
  )
end

#check_for_pydistutils_cfg_in_home ⇒ Finding?

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:



1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
 
# File 'diagnostic.rb', line 1092

def check_for_pydistutils_cfg_in_home
  return unless File.exist? "#{Dir.home}/.pydistutils.cfg"

  Finding.new(
    <<~EOS,
      A '.pydistutils.cfg' file was found in $HOME, which may cause Python
      builds to fail. See:
        #{Formatter.url("https://bugs.python.org/issue6138")}
        #{Formatter.url("https://bugs.python.org/issue4655")}
    EOS
    links: [
      "https://bugs.python.org/issue6138",
      "https://bugs.python.org/issue4655",
    ],
  )
end

#check_for_stray_dylibs ⇒ Finding?

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:



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'diagnostic.rb', line 241

def check_for_stray_dylibs
  # Dylibs which are generally OK should be added to this list,
  # with a short description of the software they come with.
  allow_list = [
    "libfuse.2.dylib", # MacFuse
    "libfuse3.*.dylib", # MacFuse
    "libfuse_ino64.2.dylib", # MacFuse
    "libfuse-t*.dylib", # FUSE-T
    "libmacfuse_i32.2.dylib", # OSXFuse MacFuse compatibility layer
    "libmacfuse_i64.2.dylib", # OSXFuse MacFuse compatibility layer
    "libosxfuse_i32.2.dylib", # OSXFuse
    "libosxfuse_i64.2.dylib", # OSXFuse
    "libosxfuse.2.dylib", # OSXFuse
    "libTrAPI.dylib", # TrAPI/Endpoint Security VPN
    "libntfs-3g.*.dylib", # NTFS-3G
    "libntfs.*.dylib", # NTFS-3G
    "libublio.*.dylib", # NTFS-3G
    "libUFSDNTFS.dylib", # Paragon NTFS
    "libUFSDExtFS.dylib", # Paragon ExtFS
    "libecomlodr.dylib", # Symantec Endpoint Protection
    "libsymsea*.dylib", # Symantec Endpoint Protection
    "sentinel.dylib", # SentinelOne
    "sentinel-*.dylib", # SentinelOne
    "libASAF.dylib", # Apple Immersive Audio SDK
  ]

  msg = __check_stray_files "/usr/local/lib", "*.dylib", allow_list, <<~EOS
    Unbrewed dylibs were found in /usr/local/lib.
    If you didn't put them there on purpose they could cause problems when
    building Homebrew formulae and may need to be deleted.

    Unexpected dylibs:
  EOS
  Finding.new(msg) if msg.present?
end

#check_for_stray_headers ⇒ Finding?

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:



357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'diagnostic.rb', line 357

def check_for_stray_headers
  allow_list = [
    "fuse.h", # MacFuse
    "fuse/**/*.h", # MacFuse
    "fuse3/**/*.h", # MacFuse
    "macfuse/**/*.h", # OSXFuse MacFuse compatibility layer
    "osxfuse/**/*.h", # OSXFuse
    "ntfs/**/*.h", # NTFS-3G
    "ntfs-3g/**/*.h", # NTFS-3G
  ]

  msg = __check_stray_files "/usr/local/include", "**/*.h", allow_list, <<~EOS
    Unbrewed header files were found in /usr/local/include.
    If you didn't put them there on purpose they could cause problems when
    building Homebrew formulae and may need to be deleted.

    Unexpected header files:
  EOS

  Finding.new(msg) if msg.present?
end

#check_for_stray_las ⇒ Finding?

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:



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'diagnostic.rb', line 333

def check_for_stray_las
  allow_list = [
    "libfuse.la", # MacFuse
    "libfuse_ino64.la", # MacFuse
    "libosxfuse_i32.la", # OSXFuse
    "libosxfuse_i64.la", # OSXFuse
    "libosxfuse.la", # OSXFuse
    "libntfs-3g.la", # NTFS-3G
    "libntfs.la", # NTFS-3G
    "libublio.la", # NTFS-3G
  ]

  msg = __check_stray_files("/usr/local/lib", "*.la", allow_list, <<~EOS
    Unbrewed '.la' files were found in /usr/local/lib.
    If you didn't put them there on purpose they could cause problems when
    building Homebrew formulae and may need to be deleted.

    Unexpected '.la' files:
  EOS
  )
  Finding.new(msg) if msg.present?
end

#check_for_stray_pcs ⇒ Finding?

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:



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'diagnostic.rb', line 308

def check_for_stray_pcs
  # Package-config files which are generally OK should be added to this list,
  # with a short description of the software they come with.
  allow_list = [
    "fuse.pc", # OSXFuse/MacFuse
    "fuse3.pc", # OSXFuse/MacFuse
    "fuse-t.pc", # FUSE-T
    "macfuse.pc", # OSXFuse MacFuse compatibility layer
    "osxfuse.pc", # OSXFuse
    "libntfs-3g.pc", # NTFS-3G
    "libublio.pc", # NTFS-3G
  ]

  msg = __check_stray_files("/usr/local/lib/pkgconfig", "*.pc", allow_list, <<~EOS
    Unbrewed '.pc' files were found in /usr/local/lib/pkgconfig.
    If you didn't put them there on purpose they could cause problems when
    building Homebrew formulae and may need to be deleted.

    Unexpected '.pc' files:
  EOS
  )
  Finding.new(msg) if msg.present?
end

#check_for_stray_static_libs ⇒ Finding?

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:



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'diagnostic.rb', line 278

def check_for_stray_static_libs
  # Static libs which are generally OK should be added to this list,
  # with a short description of the software they come with.
  allow_list = [
    "libfuse-t*.a", # FUSE-T
    "libfuse3.a", # FUSE-T
    "libntfs-3g.a", # NTFS-3G
    "libntfs.a", # NTFS-3G
    "libublio.a", # NTFS-3G
    "libappfirewall.a", # Symantec Endpoint Protection
    "libautoblock.a", # Symantec Endpoint Protection
    "libautosetup.a", # Symantec Endpoint Protection
    "libconnectionsclient.a", # Symantec Endpoint Protection
    "liblocationawareness.a", # Symantec Endpoint Protection
    "libpersonalfirewall.a", # Symantec Endpoint Protection
    "libtrustedcomponents.a", # Symantec Endpoint Protection
  ]

  msg = __check_stray_files "/usr/local/lib", "*.a", allow_list, <<~EOS
    Unbrewed static libraries were found in /usr/local/lib.
    If you didn't put them there on purpose they could cause problems when
    building Homebrew formulae and may need to be deleted.

    Unexpected static libraries:
  EOS

  Finding.new(msg) if msg.present?
end

#check_for_symlinked_cellar ⇒ Finding?

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:



588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
 
# File 'diagnostic.rb', line 588

def check_for_symlinked_cellar
  return unless HOMEBREW_CELLAR.exist?
  return unless HOMEBREW_CELLAR.symlink?

  Finding.new(
    <<~EOS,
      Symlinked Cellars can cause problems.
      Your Homebrew Cellar is a symlink: #{HOMEBREW_CELLAR}
                      which resolves to: #{HOMEBREW_CELLAR.realpath}

      The recommended Homebrew installations are either:
      (A) Have Cellar be a real directory inside of your `$HOMEBREW_PREFIX`
      (B) Symlink "bin/brew" into your prefix, but don't symlink "Cellar".

      Older installations of Homebrew may have created a symlinked Cellar, but this can
      cause problems when two formulae install to locations that are mapped on top of each
      other during the linking step.
    EOS
  )
end

#check_for_tap_ruby_files_locations ⇒ Finding?

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:



1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
 
# File 'diagnostic.rb', line 1192

def check_for_tap_ruby_files_locations
  bad_tap_files = {}
  Tap.installed.each do |tap|
    unused_formula_dirs = tap.potential_formula_dirs - [tap.formula_dir]
    unused_formula_dirs.each do |dir|
      next unless dir.exist?

      dir.children.each do |path|
        next if path.extname != ".rb"

        bad_tap_files[tap] ||= []
        bad_tap_files[tap] << path
      end
    end
  end
  return if bad_tap_files.empty?

  Finding.new(bad_tap_files.keys.map do |tap|
    <<~EOS
      Found Ruby file outside #{tap} tap formula directory.
      (#{tap.formula_dir}):
        #{bad_tap_files[tap].join("\n  ")}
    EOS
  end.join("\n"))
end

#check_for_unlinked_but_not_keg_only ⇒ Finding?

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:



1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
 
# File 'diagnostic.rb', line 1132

def check_for_unlinked_but_not_keg_only
  unlinked = Formula.racks.reject do |rack|
    next true if (HOMEBREW_LINKED_KEGS/rack.basename).directory?

    begin
      Formulary.from_rack(rack).keg_only?
    rescue Homebrew::UntrustedTapError
      true
    rescue FormulaUnavailableError, TapFormulaAmbiguityError
      false
    end
  end.map(&:basename)
  return if unlinked.empty?

  Finding.new(
    <<~EOS,
    affects:     unlinked.map(&:to_s),
    remediation: Finding::Remediation.new(
      text:     inject_file_list(unlinked, <<~EOS
        Run `brew link` on these:
      EOS
      ),
      commands: unlinked.map { |unlink| "brew link #{unlink}" },
    ),
  )
end

#check_for_unnecessary_cask_tap ⇒ Finding?

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:



1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
 
# File 'diagnostic.rb', line 1295

def check_for_unnecessary_cask_tap
  return if Homebrew::EnvConfig.developer?
  return if Homebrew::EnvConfig.no_install_from_api?
  return if Homebrew::EnvConfig.devcmdrun?

  cask_tap = CoreCaskTap.instance
  return unless cask_tap.installed?

  remediation = Finding::Remediation.new(text: <<~EOS, commands: ["brew untap #{cask_tap.name}"])
    Please remove it by running:
     brew untap #{cask_tap.name}
  EOS
  Finding.new(
    <<~EOS,
      You have an unnecessary local Cask tap.
      This can cause problems installing up-to-date casks.
    EOS
    remediation:,
  )
end

#check_for_unnecessary_core_tap ⇒ Finding?

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:



1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
 
# File 'diagnostic.rb', line 1275

def check_for_unnecessary_core_tap
  return if Homebrew::EnvConfig.developer?
  return if Homebrew::EnvConfig.no_install_from_api?
  return if Homebrew::EnvConfig.devcmdrun?
  return unless CoreTap.instance.installed?

  remediation = Finding::Remediation.new(text: <<~EOS, commands: ["brew untap #{CoreTap.instance.name}"])
    Please remove it by running:
     brew untap #{CoreTap.instance.name}
  EOS
  Finding.new(
    <<~EOS,
      You have an unnecessary local Core tap!
      This can cause problems installing up-to-date formulae.
    EOS
    remediation:,
  )
end

#check_for_unreadable_installed_formula ⇒ Finding?

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:



1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
 
# File 'diagnostic.rb', line 1110

def check_for_unreadable_installed_formula
  formula_unavailable_exceptions = []
  Formula.racks.each do |rack|
    Formulary.from_rack(rack)
  rescue FormulaUnreadableError, FormulaClassUnavailableError,
         TapFormulaUnreadableError, TapFormulaClassUnavailableError => e
    formula_unavailable_exceptions << e
  rescue Homebrew::UntrustedTapError, FormulaUnavailableError, TapFormulaAmbiguityError
    nil
  end
  return if formula_unavailable_exceptions.empty?

  Finding.new(
    <<~EOS,
      Some installed formulae are not readable:
        #{formula_unavailable_exceptions.join("\n\n  ")}
    EOS
    affects: formula_unavailable_exceptions,
  )
end

#check_git_newline_settings ⇒ Finding?

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:



653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
 
# File 'diagnostic.rb', line 653

def check_git_newline_settings
  return unless Utils::Git.available?

  autocrlf = HOMEBREW_REPOSITORY.cd { `git config --get core.autocrlf`.chomp }
  return if autocrlf != "true"

  Finding.new(
    <<~EOS,
    remediation: Finding::Remediation.new(
      text:     <<~EOS,
        If you are not routinely dealing with Windows-based projects,
        consider removing these by running:
          git config --global core.autocrlf input
      EOS
      commands: ["git config --global core.autocrlf input"],
    ),
  )
end

#check_git_status ⇒ Array<Finding>

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:



1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
 
# File 'diagnostic.rb', line 1025

def check_git_status
  return [] unless Utils::Git.available?

  repos = {
    "Homebrew/brew"          => HOMEBREW_REPOSITORY,
    "Homebrew/homebrew-core" => CoreTap.instance.path,
    "Homebrew/homebrew-cask" => CoreCaskTap.instance.path,
  }

  status = []
  repos.each do |name, path|
    finding = __tap_git_status(name, path)
    status << finding if finding.present?
  end

  status
end

#check_git_version ⇒ Finding?

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:



610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
 
# File 'diagnostic.rb', line 610

def check_git_version
  minimum_version = ENV.fetch("HOMEBREW_MINIMUM_GIT_VERSION")
  return unless Utils::Git.available?
  return if Utils::Git.version >= Version.new(minimum_version)

  git = Formula["git"]
  git_upgrade_cmd = git.any_version_installed? ? "upgrade" : "install"
  Finding.new(
    <<~EOS,
    remediation: Finding::Remediation.new(
      text:     <<~EOS,
        Please upgrade:
          brew #{git_upgrade_cmd} git
      EOS
      commands: ["brew #{git_upgrade_cmd} git"],
    ),
  )
end

#check_homebrew_prefix ⇒ Finding?

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:



1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
 
# File 'diagnostic.rb', line 1219

def check_homebrew_prefix
  return if Homebrew.default_prefix?

  Finding.new(
    <<~EOS,
      Your Homebrew's prefix is not #{Homebrew::DEFAULT_PREFIX}.

      Most of Homebrew's bottles (binary packages) can only be used with the default prefix.
    EOS
    tier:        3,
    remediation: "Consider uninstalling Homebrew and reinstalling into the default prefix.",
  )
end

#check_homebrew_repository_git_hooks ⇒ Finding?

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:



678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
 
# File 'diagnostic.rb', line 678

def check_homebrew_repository_git_hooks
  found = T.let([], T::Array[Pathname])

  hooks_dir = HOMEBREW_REPOSITORY/".git/hooks"
  if hooks_dir.directory?
    found += hooks_dir.children.reject { |path| path.basename.to_s.end_with?(".sample") }.sort_by(&:to_s)
  end

  gitconfig = HOMEBREW_REPOSITORY/".gitconfig"
  found << gitconfig if gitconfig.exist?
  return if found.empty?

  Finding.new(
    inject_file_list(found, <<~EOS
      Git hooks or a repository-local `.gitconfig` were found in your Homebrew repository.
      Homebrew does not use these, and they can break Homebrew operations.

      Paths found:
    EOS
    ),
    remediation: Finding::Remediation.new(
      text:     <<~EOS,
        Remove them with:
          rm -rf "#{HOMEBREW_REPOSITORY}/.git/hooks" "#{HOMEBREW_REPOSITORY}/.gitconfig"
      EOS
      commands: ["rm -rf \"#{HOMEBREW_REPOSITORY}/.git/hooks\" \"#{HOMEBREW_REPOSITORY}/.gitconfig\""],
    ),
  )
end

#check_missing_deps ⇒ Finding?

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:



967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
 
# File 'diagnostic.rb', line 967

def check_missing_deps
  return if !HOMEBREW_CELLAR.exist? && !Cask::Caskroom.path.exist?

  missing = Set.new
  Homebrew::Missing.deps(Formula.installed, Cask::Caskroom.casks).each_value do |deps|
    missing.merge(deps)
  end
  return if missing.empty?

  Finding.new(
    <<~EOS,
    remediation: Finding::Remediation.new(
      text:     <<~EOS,
        You should `brew install` the missing dependencies:
          brew install #{missing.sort * " "}
      EOS
      commands: ["brew install #{missing.sort * " "}"],
    ),
  )
end

#check_multiple_cellars ⇒ Finding?

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:



476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
 
# File 'diagnostic.rb', line 476

def check_multiple_cellars
  return if HOMEBREW_PREFIX.to_s == HOMEBREW_REPOSITORY.to_s
  return unless (HOMEBREW_REPOSITORY/"Cellar").exist?
  return unless (HOMEBREW_PREFIX/"Cellar").exist?

  Finding.new(
    <<~EOS,
    remediation: Finding::Remediation.new(
      text:     <<~EOS,
        You should delete #{HOMEBREW_REPOSITORY}/Cellar:
          rm -rf #{HOMEBREW_REPOSITORY}/Cellar
      EOS
      commands: ["rm -rf #{HOMEBREW_REPOSITORY}/Cellar"],
    ),
  )
end

#check_tap_git_branch ⇒ Finding?

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:



748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
 
# File 'diagnostic.rb', line 748

def check_tap_git_branch
  return if ENV["CI"]
  return unless Utils::Git.available?

  deprecated_master = []
  commands = []

  brew_repo = GitRepository.new(HOMEBREW_REPOSITORY)
  deprecated_master << "Homebrew/brew" if brew_repo.branch_name == "master"

  Tap.installed.each do |tap|
    if tap.git_repository.branch_name == "master" && tap.official?
      deprecated_master << tap.name
    elsif !tap.git_repository.default_origin_branch?
      commands << "git -C $(brew --repo #{tap.name}) checkout #{tap.git_repository.origin_branch_name}"
    end
  end

  message = +""

  if deprecated_master.any?
    message << <<~EOS
      The following repositories are on the deprecated "master" branch.
      The "master" branch sync will stop and this warning will become an error
      when Homebrew 5.2.0 is released (no earlier than 2026-06-10).
      Run `brew update` to migrate to "main":
        #{deprecated_master.join("\n  ")}
    EOS
  end

  remediation = nil
  if commands.any?
    message << "\n" if deprecated_master.any?
    message << <<~EOS
      Some taps are not on the default git origin branch and may not receive updates.
    EOS
    remediation = Finding::Remediation.new(text: <<~EOS, commands: commands)
      If this is a surprise to you, check out the default branch with:
        #{commands.join("\n  ")}
    EOS
  end

  Finding.new(message, remediation:) if message.present?
end

#check_tmpdir ⇒ Finding?

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:



955
956
957
958
959
960
961
962
963
964
 
# File 'diagnostic.rb', line 955

def check_tmpdir
  tmpdir = ENV.fetch("TMPDIR", nil)
  return if tmpdir.nil? || File.directory?(tmpdir)

  Finding.new(
    <<~EOS,
      TMPDIR #{tmpdir.inspect} doesn't exist.
    EOS
  )
end

#check_tmpdir_sticky_bit ⇒ Finding?

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:



407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'diagnostic.rb', line 407

def check_tmpdir_sticky_bit
  world_writable = HOMEBREW_TEMP.stat.mode & 0777 == 0777
  return if !world_writable || HOMEBREW_TEMP.sticky?

  Finding.new(
    <<~EOS,
    remediation: Finding::Remediation.new(
      text:     <<~EOS,
        To set it, run the following command:
          sudo chmod +t #{HOMEBREW_TEMP}
      EOS
      commands: ["sudo chmod +t #{HOMEBREW_TEMP}"],
    ),
  )
end

#check_untrusted_taps ⇒ Finding?

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:



815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
 
# File 'diagnostic.rb', line 815

def check_untrusted_taps
  return if Homebrew::EnvConfig.no_require_tap_trust?

  untrusted_taps = Homebrew::Trust.wholly_untrusted_taps
  return if untrusted_taps.empty?

  untrusted_tap_names = untrusted_taps.map(&:name)
  untrusted_tap_name_set = untrusted_tap_names.to_set
  installed_formulae_by_tap = {}
  installed_casks_by_tap = {}
  Formula.racks.each do |rack|
    next unless (keg = Keg.from_rack(rack))
    next unless (tap = keg.tab.tap)
    next unless untrusted_tap_name_set.include?(tap.name)

    installed_formulae = installed_formulae_by_tap[tap.name] ||= []
    installed_formulae << "#{tap.name}/#{rack.basename}"
  rescue
    nil
  end
  installed_formula_message = installed_formulae_by_tap.sort_by(&:first).filter_map do |_tap_name, formulae|
    next if formulae.empty?

    "  brew trust --formula #{formulae.sort.join(" ")}"
  end.join("\n")
  Cask::Caskroom.casks.each do |cask|
    next unless (tap = cask.tab.tap)
    next unless untrusted_tap_name_set.include?(tap.name)

    installed_casks = installed_casks_by_tap[tap.name] ||= []
    installed_casks << "#{tap.name}/#{cask.token}"
  end
  installed_cask_message = installed_casks_by_tap.sort_by(&:first).filter_map do |_tap_name, casks|
    next if casks.empty?

    "  brew trust --cask #{casks.sort.join(" ")}"
  end.join("\n")
  installed_items_from_untrusted_taps = installed_formula_message.present? || installed_cask_message.present?
  untap_message = "Untap them with:\n  brew untap #{untrusted_tap_names.join(" ")}"
  generic_trust_types = []
  generic_trust_commands = []
  if installed_formula_message.blank?
    generic_trust_types << "formulae"
    generic_trust_commands << "  brew trust --formula <user>/<tap>/<formula>"
  end
  if installed_cask_message.blank?
    generic_trust_types << "casks"
    generic_trust_commands << "  brew trust --cask <user>/<tap>/<cask>"
  end
  generic_trust_types << "commands"
  generic_trust_commands << "  brew trust --command <user>/<tap>/<command>"
  generic_trust_prefix = if installed_items_from_untrusted_taps
    "Trust other specific"
  else
    "Trust specific"
  end
  generic_trust_message = "#{generic_trust_prefix} #{generic_trust_types.to_sentence} with:\n" \
                          "#{generic_trust_commands.join("\n")}"
  trust_messages = if installed_items_from_untrusted_taps
    ["Prefer trusting only the specific formulae, casks or commands you need."]
  else
    [untap_message]
  end
  if installed_formula_message.present?
    trust_messages << "Trust installed formulae from these taps with:\n#{installed_formula_message}"
  end
  if installed_cask_message.present?
    trust_messages << "Trust installed casks from these taps with:\n#{installed_cask_message}"
  end
  trust_messages << generic_trust_message
  trust_messages << <<~EOS.chomp
    Whole-tap trust is broader and includes all current and future formulae,
    casks and commands from the listed taps. Trust whole taps with:
      brew trust #{untrusted_tap_names.join(" ")}
  EOS
  trust_messages << untap_message if installed_items_from_untrusted_taps
  unless Homebrew::EnvConfig.no_env_hints?
    trust_messages << <<~EOS.chomp
      To disable trust checks:
        export HOMEBREW_NO_REQUIRE_TAP_TRUST=1
      This is not recommended and will be removed in a later release.
    EOS
  end
  trust_messages << <<~EOS.chomp
    For more information, see:
      #{Formatter.url("https://docs.brew.sh/Tap-Trust")}
  EOS

  Finding.new(
    <<~EOS,
      The following taps are not trusted:
        #{untrusted_tap_names.join("\n  ")}

      Homebrew is currently ignoring formulae, casks and commands from these taps because tap trust is required.
    EOS
    links:       ["https://docs.brew.sh/Tap-Trust"],
    remediation: trust_messages.join("\n"),
  )
end

#check_user_path_1 ⇒ Finding?

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:



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
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
 
# File 'diagnostic.rb', line 496

def check_user_path_1
  @seen_prefix_bin = false
  @seen_prefix_sbin = false

  message = ""
  remediation = T.let(nil, T.nilable(Finding::Remediation))

  paths.each do |p|
    case p
    when "/usr/bin"
      unless @seen_prefix_bin
        # only show the doctor message if there are any conflicts
        # rationale: a default install should not trigger any brew doctor messages
        conflicts = Dir["#{HOMEBREW_PREFIX}/bin/*"]
                    .map { |fn| File.basename fn }
                    .select { |bn| File.exist? "/usr/bin/#{bn}" }

        unless conflicts.empty?
          message = inject_file_list conflicts, <<~EOS
            /usr/bin occurs before #{HOMEBREW_PREFIX}/bin in your PATH.
            This means that system-provided programs will be used instead of those
            provided by Homebrew.

            The following tools exist at both paths:
          EOS
          remediation = Finding::Remediation.new(
            text:     <<~EOS,
              Consider setting your PATH so that
              #{HOMEBREW_PREFIX}/bin occurs before /usr/bin. Here is a one-liner:
                #{Utils::Shell.prepend_path_in_profile("#{HOMEBREW_PREFIX}/bin")}
            EOS
            commands: [T.must(Utils::Shell.prepend_path_in_profile("#{HOMEBREW_PREFIX}/bin"))],
          )
        end
      end
    when "#{HOMEBREW_PREFIX}/bin"
      @seen_prefix_bin = true
    when "#{HOMEBREW_PREFIX}/sbin"
      @seen_prefix_sbin = true
    end
  end

  @user_path_1_done = true
  Finding.new(message, remediation:) if message.present?
end

#check_user_path_2 ⇒ Finding?

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:



543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
 
# File 'diagnostic.rb', line 543

def check_user_path_2
  check_user_path_1 unless @user_path_1_done
  return if @seen_prefix_bin

  Finding.new(
    <<~EOS,
    remediation: Finding::Remediation.new(
      text:     <<~EOS,
        Consider setting your PATH for example like so:
            #{Utils::Shell.prepend_path_in_profile("#{HOMEBREW_PREFIX}/bin")}
      EOS
      commands: [T.must(Utils::Shell.prepend_path_in_profile("#{HOMEBREW_PREFIX}/bin"))],
    ),
  )
end

#check_user_path_3 ⇒ Finding?

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:



562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
 
# File 'diagnostic.rb', line 562

def check_user_path_3
  check_user_path_1 unless @user_path_1_done
  return if @seen_prefix_sbin

  # Don't complain about sbin not being in the path if it doesn't exist
  sbin = HOMEBREW_PREFIX/"sbin"
  return unless sbin.directory?
  return if sbin.children.empty?
  return if sbin.children.one? && sbin.children.first.basename.to_s == ".keepme"

  Finding.new(
    <<~EOS,
    remediation: Finding::Remediation.new(
      text:     <<~EOS,
        Consider setting your PATH for example like so:
          #{Utils::Shell.prepend_path_in_profile("#{HOMEBREW_PREFIX}/sbin")}
      EOS
      commands: [T.must(Utils::Shell.prepend_path_in_profile("#{HOMEBREW_PREFIX}/sbin"))],
    ),
  )
end

#current_user ⇒ String

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:



1593
1594
1595
 
# File 'diagnostic.rb', line 1593

def current_user
  ENV.fetch("USER", "$(whoami)")
end

#examine_git_origin(repository_path, desired_origin) ⇒ Finding?

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.

Parameters:

Returns:



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'diagnostic.rb', line 138

def examine_git_origin(repository_path, desired_origin)
  return if !Utils::Git.available? || !repository_path.git_repository?

  current_origin = repository_path.origin_url

  if current_origin.nil?
    Finding.new(
      <<~EOS,
      remediation: Finding::Remediation.new(
        text:     <<~EOS,
          You can solve this by adding the remote:
            git -C "#{repository_path}" remote add origin #{Formatter.url(desired_origin)}
        EOS
        commands: [
          "git -C \"#{repository_path}\" remote add origin #{desired_origin}",
        ],
      ),
    )
  elsif !current_origin.match?(%r{#{desired_origin}(\.git|/)?$}i)
    Finding.new(
      <<~EOS,
      remediation: Finding::Remediation.new(
        text:     <<~EOS,
          You can solve this by setting the origin remote:
            git -C "#{repository_path}" remote set-url origin #{Formatter.url(desired_origin)}
        EOS
        commands: [
          "git -C \"#{repository_path}\" remote set-url origin #{desired_origin}",
        ],
      ),
    )
  end
end

#fatal_build_from_source_checks ⇒ Array<String>

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:



104
105
106
107
108
 
# File 'diagnostic.rb', line 104

def fatal_build_from_source_checks
  %w[
    check_for_installed_developer_tools
  ].freeze
end

#fatal_preinstall_checks ⇒ Array<String>

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:



97
98
99
100
101
 
# File 'diagnostic.rb', line 97

def fatal_preinstall_checks
  %w[
    check_access_directories
  ].freeze
end

#fatal_setup_build_environment_checks ⇒ Array<String>

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:



111
112
113
 
# File 'diagnostic.rb', line 111

def fatal_setup_build_environment_checks
  [].freeze
end

#find_relative_paths(*relative_paths) ⇒ void

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.

This method returns an undefined value.

Finds files in HOMEBREW_PREFIX and /usr/local. Specify paths relative to a prefix, e.g. "include/foo.h". Sets @found for your convenience.

Parameters:



63
64
65
66
67
 
# File 'diagnostic.rb', line 63

def find_relative_paths(*relative_paths)
  @found = [HOMEBREW_PREFIX, "/usr/local"].uniq.reduce([]) do |found, prefix|
    found + relative_paths.map { |f| File.join(prefix, f) }.select { |f| File.exist? f }
  end
end

#inject_file_list(list, string) ⇒ String

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.

Parameters:

Returns:



70
71
72
73
 
# File 'diagnostic.rb', line 70

def inject_file_list(list, string)
  list.reduce(string.dup) { |acc, elem| acc << "  #{elem}\n" }
      .freeze
end

#non_core_taps ⇒ Array<Tap>

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:



1512
1513
1514
 
# File 'diagnostic.rb', line 1512

def non_core_taps
  @non_core_taps ||= Tap.installed.reject(&:core_tap?).reject(&:core_cask_tap?)
end

#none_string ⇒ String?

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:



86
87
88
 
# File 'diagnostic.rb', line 86

def none_string
  "<NONE>"
end

#preinstall_checks ⇒ Array<String>

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:



126
127
128
129
130
 
# File 'diagnostic.rb', line 126

def preinstall_checks
  %w[
    check_untrusted_taps
  ].freeze
end

#supported_configuration_checks ⇒ Array<String>

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:



116
117
118
 
# File 'diagnostic.rb', line 116

def supported_configuration_checks
  [].freeze
end

#user_tilde(path) ⇒ String

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.

Parameters:

Returns:



76
77
78
79
80
81
82
83
 
# File 'diagnostic.rb', line 76

def user_tilde(path)
  home = Dir.home
  if path == home
    "~"
  else
    path.gsub(%r{^#{home}/}, "~/")
  end
end