Module: Homebrew::Upgrade Private
- Extended by:
- Utils::Output::Mixin
- Defined in:
- upgrade.rb
Overview
This module is part of a private API. This module may only be used in the Homebrew/brew repository. Third parties should avoid using this module if possible, as it may be removed or changed without warning.
Helper functions for upgrading formulae.
Defined Under Namespace
Classes: Dependents, self
Class Method Summary collapse
- .dependants(formulae, flags:, dry_run: false, ask: false, installed_on_request: false, force_bottle: false, build_from_source_formulae: [], interactive: false, keep_tmp: false, debug_symbols: false, force: false, debug: false, quiet: false, verbose: false) ⇒ Dependents private
- .dependent_formula_installers(deps, formulae, flags:, force_bottle: false, build_from_source_formulae: [], interactive: false, keep_tmp: false, debug_symbols: false, force: false, debug: false, quiet: false, verbose: false) ⇒ Array<FormulaInstaller> private
- .filter_dependent_formula_installers(formula_installers) ⇒ Array<FormulaInstaller> private
- .format_upgrade_summary(upgrades) ⇒ Array<String> private
- .formula_installers(formulae_to_install, flags:, dry_run: false, force_bottle: false, build_from_source_formulae: [], dependents: false, interactive: false, keep_tmp: false, debug_symbols: false, force: false, overwrite: false, debug: false, quiet: false, verbose: false) ⇒ Array<FormulaInstaller> private
- .outdated_kegs(formula) ⇒ Array<Keg> private
- .print_upgrade_message(formula, fi_options) ⇒ void private
- .upgrade_dependents(deps, formulae, flags:, dry_run: false, installed_on_request: false, force_bottle: false, build_from_source_formulae: [], interactive: false, keep_tmp: false, debug_symbols: false, force: false, debug: false, quiet: false, verbose: false, skip_formula_names: [], cleanup: true, prefetched_formula_installers: nil) ⇒ Array<Formula> private
- .upgrade_formula(formula_installer, dry_run: false, verbose: false, skip_formula_names: []) ⇒ Boolean private
- .upgrade_formulae(formula_installers, dry_run: false, verbose: false, fetch: true, cleanup: true, skip_formula_names: []) ⇒ Array<FormulaInstaller> private
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
Class Method Details
.dependants(formulae, flags:, dry_run: false, ask: false, installed_on_request: false, force_bottle: false, build_from_source_formulae: [], interactive: false, keep_tmp: false, debug_symbols: false, force: false, debug: false, quiet: false, verbose: false) ⇒ Dependents
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.
274 275 276 277 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 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 |
# File 'upgrade.rb', line 274 def dependants( formulae, flags:, dry_run: false, ask: false, installed_on_request: false, force_bottle: false, build_from_source_formulae: [], interactive: false, keep_tmp: false, debug_symbols: false, force: false, debug: false, quiet: false, verbose: false ) no_dependents = Dependents.new(upgradeable: [], pinned: [], skipped: []) if Homebrew::EnvConfig.no_installed_dependents_check? unless Homebrew::EnvConfig.no_env_hints? opoo <<~EOS `$HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK` is set: not checking for outdated dependents or dependents with broken linkage! EOS end return no_dependents end formulae_to_install = formulae.reject { |f| f.core_formula? && f.versioned_formula? } return no_dependents if formulae_to_install.empty? # TODO: this should be refactored to use FormulaInstaller new logic outdated = formulae_to_install.flat_map(&:runtime_installed_formula_dependents) .uniq .select(&:outdated?) # Ensure we never attempt a source build for outdated dependents of upgraded formulae. outdated, skipped = outdated.partition do |dependent| dependent.bottled? && dependent.deps.map(&:to_formula).all?(&:bottled?) end return no_dependents if outdated.blank? outdated -= formulae_to_install if dry_run upgradeable = outdated.reject(&:pinned?) .sort { |a, b| depends_on(a, b) } pinned = outdated.select(&:pinned?) .sort { |a, b| depends_on(a, b) } Dependents.new(upgradeable:, pinned:, skipped:) end |
.dependent_formula_installers(deps, formulae, flags:, force_bottle: false, build_from_source_formulae: [], interactive: false, keep_tmp: false, debug_symbols: false, force: false, debug: false, quiet: false, verbose: false) ⇒ Array<FormulaInstaller>
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.
188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 |
# File 'upgrade.rb', line 188 def dependent_formula_installers( deps, formulae, flags:, force_bottle: false, build_from_source_formulae: [], interactive: false, keep_tmp: false, debug_symbols: false, force: false, debug: false, quiet: false, verbose: false ) formula_names = formulae.map(&:full_name) formula_installers( deps.upgradeable.reject { |formula| formula_names.include?(formula.full_name) }, flags:, force_bottle:, build_from_source_formulae:, dependents: true, interactive:, keep_tmp:, debug_symbols:, force:, debug:, quiet:, verbose:, ) end |
.filter_dependent_formula_installers(formula_installers) ⇒ Array<FormulaInstaller>
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.
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 |
# File 'upgrade.rb', line 163 def filter_dependent_formula_installers(formula_installers) formula_installers.reject do |fi| all_runtime_deps_installed = fi.bottle_tab_runtime_dependencies.presence&.all? do |dependency, hash| minimum_version = if (version = hash["version"]) Version.new(version) end Dependency.new(dependency).installed?(minimum_version:, minimum_revision: hash["revision"].to_i) end next false unless all_runtime_deps_installed ohai "Not upgrading #{fi.formula.full_specified_name}: " \ "installed runtime dependencies satisfy bottle metadata" true end end |
.format_upgrade_summary(upgrades) ⇒ 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.
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
# File 'upgrade.rb', line 26 def format_upgrade_summary(upgrades) return upgrades if upgrades.size < 2 name_width = upgrades.map { |upgrade| upgrade.split(" ", 2).fetch(0).length }.max name_width ||= 0 old_version_width = upgrades.filter_map do |upgrade| versions = upgrade.split(" ", 2).fetch(1, "") next unless versions.include?(" -> ") versions.split(" -> ", 2).fetch(0).length end.max old_version_width ||= 0 upgrades.map do |upgrade| parts = upgrade.split(" ", 2) name = parts.fetch(0) versions = parts.fetch(1, "") next name if versions.blank? if versions.include?(" -> ") version_parts = versions.split(" -> ", 2) old_version = version_parts.fetch(0) new_version = version_parts.fetch(1) "#{name.ljust(name_width)} #{old_version.ljust(old_version_width)} -> #{new_version}" else "#{name.ljust(name_width)} #{versions}" end end end |
.formula_installers(formulae_to_install, flags:, dry_run: false, force_bottle: false, build_from_source_formulae: [], dependents: false, interactive: false, keep_tmp: false, debug_symbols: false, force: false, overwrite: false, debug: false, quiet: false, verbose: false) ⇒ Array<FormulaInstaller>
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.
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 |
# File 'upgrade.rb', line 65 def formula_installers( formulae_to_install, flags:, dry_run: false, force_bottle: false, build_from_source_formulae: [], dependents: false, interactive: false, keep_tmp: false, debug_symbols: false, force: false, overwrite: false, debug: false, quiet: false, verbose: false ) return [] if formulae_to_install.empty? # Sort keg-only before non-keg-only formulae to avoid any needless conflicts # with outdated, non-keg-only versions of formulae being upgraded. formulae_to_install.sort! do |a, b| if !a.keg_only? && b.keg_only? 1 elsif a.keg_only? && !b.keg_only? -1 else 0 end end dependency_graph = Utils::TopologicalHash.graph_package_dependencies(formulae_to_install) sorted = dependency_graph.tsort_with_cycles do |cycles| raise CyclicDependencyError, cycles if Homebrew::EnvConfig.developer? odebug "Ignoring cyclic dependencies: #{cycles.map(&:to_sentence).join(", ")}" end formulae_to_install = sorted & formulae_to_install # We need to fetch the bottle tabs ahead of the `Install.fetch_formulae` # pipeline because we need to first filter out those formulae with all # runtime dependencies already satisfied (see below). download_queue = Homebrew::DownloadQueue.new begin installers = formulae_to_install.filter_map do |formula| Migrator.migrate_if_needed(formula, force:, dry_run:) begin fi = create_formula_installer( formula, flags:, download_queue:, force_bottle:, build_from_source_formulae:, interactive:, keep_tmp:, debug_symbols:, force:, overwrite:, debug:, quiet:, verbose:, ) fi.fetch_bottle_tab(quiet: !debug, enqueue: true) fi rescue CannotInstallFormulaError => e ofail e nil rescue UnsatisfiedRequirements, DownloadError => e ofail "#{formula}: #{e}" nil end end download_queue.fetch(only: Resource::BottleManifest, heading: "Downloading bottle manifests", allow_failures: true) ensure download_queue.shutdown end installers = installers.filter_map do |fi| fi.determine_bottle_tab_attributes if dry_run begin fi.check_install_sanity rescue CannotInstallFormulaError => e ofail e. next end end fi end return installers if dry_run || !dependents filter_dependent_formula_installers(installers) end |
.outdated_kegs(formula) ⇒ Array<Keg>
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.
248 249 250 251 252 |
# File 'upgrade.rb', line 248 def outdated_kegs(formula) [formula, *formula.old_installed_formulae].map(&:linked_keg) .select(&:directory?) .map { |k| Keg.new(k.resolved_path) } end |
.print_upgrade_message(formula, fi_options) ⇒ 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.
255 256 257 258 259 260 261 262 263 |
# File 'upgrade.rb', line 255 def (formula, ) version_upgrade = if formula.optlinked? "#{Keg.new(formula.opt_prefix).version} -> #{formula.pkg_version}" else "-> #{formula.pkg_version}" end oh1 "Upgrading #{Formatter.identifier(formula.full_specified_name)}" puts " #{version_upgrade} #{.to_a.join(" ")}" end |
.upgrade_dependents(deps, formulae, flags:, dry_run: false, installed_on_request: false, force_bottle: false, build_from_source_formulae: [], interactive: false, keep_tmp: false, debug_symbols: false, force: false, debug: false, quiet: false, verbose: false, skip_formula_names: [], cleanup: true, prefetched_formula_installers: nil) ⇒ Array<Formula>
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.
331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 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 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 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 524 525 526 |
# File 'upgrade.rb', line 331 def upgrade_dependents(deps, formulae, flags:, dry_run: false, installed_on_request: false, force_bottle: false, build_from_source_formulae: [], interactive: false, keep_tmp: false, debug_symbols: false, force: false, debug: false, quiet: false, verbose: false, skip_formula_names: [], cleanup: true, prefetched_formula_installers: nil) return [] if deps.blank? upgradeable = deps.upgradeable.dup pinned = deps.pinned skipped = deps.skipped if pinned.present? plural = Utils.pluralize("dependent", pinned.count) opoo "Not upgrading #{pinned.count} pinned #{plural}:" puts(pinned.map do |f| "#{f.full_specified_name} #{f.pkg_version}" end.join(", ")) end if skipped.present? opoo <<~EOS The following dependents of upgraded formulae are outdated but will not be upgraded because they are not bottled: #{skipped * "\n "} EOS end installed_formulae = FormulaInstaller.installed upgraded_formulae = T.let([], T::Array[Formula]) unless dry_run primary_formula_names = formulae.map(&:full_name) upgraded_formulae.concat(upgradeable.select do |f| installed_formulae.include?(f) && primary_formula_names.exclude?(f.full_name) end) end upgradeable.reject! do |f| installed_formulae.include?(f) || (dry_run && skip_formula_names.include?(f.full_name)) end return upgraded_formulae if upgradeable.blank? dependent_installers = T.let([], T::Array[FormulaInstaller]) unless dry_run dependent_installers = if prefetched_formula_installers upgradeable_names = upgradeable.map(&:full_name) filter_dependent_formula_installers( prefetched_formula_installers.select { |fi| upgradeable_names.include?(fi.formula.full_name) }, ) else formula_installers( upgradeable.dup, flags:, force_bottle:, build_from_source_formulae:, dependents: true, interactive:, keep_tmp:, debug_symbols:, force:, debug:, quiet:, verbose:, ) end upgradeable = dependent_installers.map(&:formula) end # Print the upgradable dependents. if upgradeable.present? installed_formulae = (dry_run ? formulae : FormulaInstaller.installed.to_a).dup formula_plural = Utils.pluralize("formula", installed_formulae.count) upgrade_verb = dry_run ? "Would upgrade" : "Upgrading" ohai "#{upgrade_verb} #{Utils.pluralize("dependent", upgradeable.count, include_count: true)} of upgraded #{formula_plural}:" formulae_upgrades = upgradeable.map do |f| name = f.full_specified_name if f.optlinked? "#{name} #{Keg.new(f.opt_prefix).version} -> #{f.pkg_version}" else "#{name} #{f.pkg_version}" end end puts format_upgrade_summary(formulae_upgrades).join("\n") end if !dry_run && dependent_installers.present? upgraded_formulae.concat( upgrade_formulae( dependent_installers, verbose:, cleanup:, fetch: prefetched_formula_installers.nil?, ).map(&:formula), ) end # Update non-core installed formulae for linkage checks after upgrading # Don't need to check core formulae because we do so at CI time. installed_non_core_formulae = FormulaInstaller.installed.to_a.reject(&:core_formula?) return upgraded_formulae if installed_non_core_formulae.blank? # Assess the dependents tree again now we've upgraded. unless dry_run oh1 "Checking for dependents of upgraded formulae..." end broken_dependents = check_broken_dependents(installed_non_core_formulae) if broken_dependents.blank? if dry_run ohai "No currently broken dependents found!" opoo "If they are broken by the upgrade they will also be upgraded or reinstalled." else ohai "No broken dependents found!" end return upgraded_formulae end reinstallable_broken_dependents = broken_dependents.reject(&:outdated?) .reject(&:pinned?) .sort { |a, b| depends_on(a, b) } outdated_pinned_broken_dependents = broken_dependents.select(&:outdated?) .select(&:pinned?) .sort { |a, b| depends_on(a, b) } # Print the pinned dependents. if outdated_pinned_broken_dependents.present? count = outdated_pinned_broken_dependents.count plural = Utils.pluralize("dependent", outdated_pinned_broken_dependents.count) onoe "Not reinstalling #{count} broken and outdated, but pinned #{plural}:" $stderr.puts(outdated_pinned_broken_dependents.map do |f| "#{f.full_specified_name} #{f.pkg_version}" end.join(", ")) end # Print the broken dependents. if reinstallable_broken_dependents.blank? ohai "No broken dependents to reinstall!" else ohai "Reinstalling #{Utils.pluralize("dependent", reinstallable_broken_dependents.count, include_count: true)} with broken linkage from source:" puts reinstallable_broken_dependents.map(&:full_specified_name) .join(", ") end return upgraded_formulae if dry_run reinstall_contexts = reinstallable_broken_dependents.map do |formula| Reinstall.build_install_context( formula, flags:, force_bottle:, build_from_source_formulae: build_from_source_formulae + [formula.full_name], interactive:, keep_tmp:, debug_symbols:, force:, debug:, quiet:, verbose:, ) end valid_formula_installers = Install.fetch_formulae(reinstall_contexts.map(&:formula_installer)) reinstall_contexts.each do |reinstall_context| next unless valid_formula_installers.include?(reinstall_context.formula_installer) Reinstall.reinstall_formula(reinstall_context) rescue FormulaInstallationAlreadyAttemptedError # We already attempted to reinstall f as part of the dependency tree of # another formula. In that case, don't generate an error, just move on. nil rescue BuildError => e e.dump(verbose:) puts Homebrew.failed = true rescue => e ofail e end upgraded_formulae end |
.upgrade_formula(formula_installer, dry_run: false, verbose: false, skip_formula_names: []) ⇒ 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.
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 564 565 |
# File 'upgrade.rb', line 532 def upgrade_formula(formula_installer, dry_run: false, verbose: false, skip_formula_names: []) formula = formula_installer.formula if dry_run Install.print_dry_run_dependencies(formula, formula_installer.compute_dependencies, skip_formula_names:) do |f| name = f.full_specified_name current_version = if f.optlinked? Keg.new(f.opt_prefix).version else f.installed_kegs.map(&:version).max end if current_version && current_version != f.pkg_version "#{name} #{current_version} -> #{f.pkg_version}" else "#{name} #{f.pkg_version}" end end return true end Install.install_formula(formula_installer, upgrade: true) true rescue BuildError => e e.dump(verbose:) puts Homebrew.failed = true false rescue => e # Keep a single failed upgrade (e.g. a bottle that fails to extract) # from aborting the rest of the batch while still failing the run. ofail "#{formula_installer.formula.full_specified_name}: #{e}" false end |
.upgrade_formulae(formula_installers, dry_run: false, verbose: false, fetch: true, cleanup: true, skip_formula_names: []) ⇒ Array<FormulaInstaller>
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.
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 |
# File 'upgrade.rb', line 224 def upgrade_formulae(formula_installers, dry_run: false, verbose: false, fetch: true, cleanup: true, skip_formula_names: []) valid_formula_installers = if dry_run || !fetch formula_installers else Install.fetch_formulae(formula_installers) end upgraded_formula_installers = valid_formula_installers.select do |fi| upgraded = upgrade_formula(fi, dry_run:, verbose:, skip_formula_names:) Cleanup.install_formula_clean!(fi.formula) if upgraded && !dry_run && cleanup upgraded end return upgraded_formula_installers unless dry_run formulae_to_clean = Cleanup.install_cleanup_formulae(upgraded_formula_installers.map(&:formula)) if formulae_to_clean.present? && Cleanup.printed_dry_run_output?(Cleanup.dry_run_output(formulae: formulae_to_clean), ohai: true) Cleanup. end upgraded_formula_installers end |