Module: FormulaCellarChecks Abstract Private
- Extended by:
- T::Helpers
- Included in:
- FormulaInstaller, Homebrew::FormulaAuditor
- Defined in:
- formula_cellar_checks.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.
Subclasses must implement the abstract
methods below.
Checks to perform on a formula's cellar.
Constant Summary collapse
- VALID_LIBRARY_EXTENSIONS =
This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning.
%w[.a .jnilib .la .o .so .jar .prl .pm .sh].freeze
Constants included from OS::Mac::FormulaCellarChecks
OS::Mac::FormulaCellarChecks::MACOS_LIB_EXTENSIONS
Instance Method Summary collapse
- #audit_installed ⇒ void private
- #check_binary_arches(formula) ⇒ String? private
- #check_cpuid_instruction(formula) ⇒ String? private
- #check_easy_install_pth(lib) ⇒ String? private
- #check_elisp_dirname(share, name) ⇒ String? private
- #check_elisp_root(share, name) ⇒ String? private
- #check_env_path(bin) ⇒ String? private
- #check_generic_executables(bin) ⇒ String? private
- #check_infopages ⇒ String? private
- #check_jars ⇒ String? private
- #check_manpages ⇒ String? private
- #check_non_executables(bin) ⇒ String? private
- #check_non_libraries ⇒ String? private
- #check_plist(prefix, plist) ⇒ String? private
- #check_python_packages(lib, deps) ⇒ String? private
- #check_python_symlinks(name, keg_only) ⇒ String? private
- #check_service_command(formula) ⇒ String? private
- #check_shim_references(prefix) ⇒ String? private
- #formula ⇒ Formula abstract private
- #problem_if_output(output) ⇒ void abstract private
- #valid_library_extension?(filename) ⇒ Boolean private
Methods included from OS::Mac::FormulaCellarChecks
#check_flat_namespace, #check_linkage, #check_openssl_links, #check_python_framework_links, #check_shadowed_headers
Instance Method Details
#audit_installed ⇒ 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.
417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 |
# File 'formula_cellar_checks.rb', line 417 def audit_installed @new_formula ||= T.let(false, T.nilable(T::Boolean)) problem_if_output(check_manpages) problem_if_output(check_infopages) problem_if_output(check_jars) problem_if_output(check_service_command(formula)) problem_if_output(check_non_libraries) if @new_formula problem_if_output(check_non_executables(formula.bin)) problem_if_output(check_generic_executables(formula.bin)) problem_if_output(check_non_executables(formula.sbin)) problem_if_output(check_generic_executables(formula.sbin)) problem_if_output(check_easy_install_pth(formula.lib)) problem_if_output(check_elisp_dirname(formula.share, formula.name)) problem_if_output(check_elisp_root(formula.share, formula.name)) problem_if_output(check_python_packages(formula.lib, formula.deps)) problem_if_output(check_shim_references(formula.prefix)) problem_if_output(check_plist(formula.prefix, formula.launchd_service_path)) problem_if_output(check_python_symlinks(formula.name, formula.keg_only?)) problem_if_output(check_cpuid_instruction(formula)) problem_if_output(check_binary_arches(formula)) end |
#check_binary_arches(formula) ⇒ 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.
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 |
# File 'formula_cellar_checks.rb', line 355 def check_binary_arches(formula) return unless formula.prefix.directory? keg = Keg.new(formula.prefix) mismatches = {} keg.binary_executable_or_library_files.each do |file| farch = file.arch mismatches[file] = farch if farch != Hardware::CPU.arch end return if mismatches.empty? compatible_universal_binaries, mismatches = mismatches.partition do |file, arch| arch == :universal && file.archs.include?(Hardware::CPU.arch) end # To prevent transformation into nested arrays compatible_universal_binaries = compatible_universal_binaries.to_h mismatches = mismatches.to_h universal_binaries_expected = if (formula_tap = formula.tap).present? && formula_tap.core_tap? formula_tap.audit_exception(:universal_binary_allowlist, formula.name) else true end mismatches_expected = (formula_tap = formula.tap).blank? || formula_tap.audit_exception(:mismatched_binary_allowlist, formula.name) mismatches_expected = [mismatches_expected] if mismatches_expected.is_a?(String) if mismatches_expected.is_a?(Array) glob_flags = File::FNM_DOTMATCH | File::FNM_EXTGLOB | File::FNM_PATHNAME mismatches.delete_if do |file, _arch| mismatches_expected.any? { |pattern| file.fnmatch?("#{formula.prefix.realpath}/#{pattern}", glob_flags) } end mismatches_expected = false return if mismatches.empty? && compatible_universal_binaries.empty? end return if mismatches.empty? && universal_binaries_expected return if compatible_universal_binaries.empty? && mismatches_expected return if universal_binaries_expected && mismatches_expected s = "" if mismatches.present? && !mismatches_expected s += <<~EOS Binaries built for a non-native architecture were installed into #{formula}'s prefix. The offending files are: #{mismatches.map { |m| "#{m.first}\t(#{m.last})" } * "\n "} EOS end if compatible_universal_binaries.present? && !universal_binaries_expected s += <<~EOS Unexpected universal binaries were found. The offending files are: #{compatible_universal_binaries.keys * "\n "} EOS end s end |
#check_cpuid_instruction(formula) ⇒ 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.
313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 |
# File 'formula_cellar_checks.rb', line 313 def check_cpuid_instruction(formula) # Checking for `cpuid` only makes sense on Intel: # https://en.wikipedia.org/wiki/CPUID return unless Hardware::CPU.intel? dot_brew_formula = formula.prefix/".brew/#{formula.name}.rb" return unless dot_brew_formula.exist? return unless dot_brew_formula.read.include? "ENV.runtime_cpu_detection" return if formula.tap&.audit_exception(:no_cpuid_allowlist, formula.name) # macOS `objdump` is a bit slow, so we prioritise llvm's `llvm-objdump` (~5.7x faster) # or binutils' `objdump` (~1.8x faster) if they are installed. objdump = Formula["llvm"].opt_bin/"llvm-objdump" if Formula["llvm"].any_version_installed? objdump ||= Formula["binutils"].opt_bin/"objdump" if Formula["binutils"].any_version_installed? objdump ||= which("objdump") objdump ||= which("objdump", ORIGINAL_PATHS) unless objdump return <<~EOS No `objdump` found, so cannot check for a `cpuid` instruction. Install `objdump` with brew install binutils EOS end keg = Keg.new(formula.prefix) return if keg.binary_executable_or_library_files.any? do |file| cpuid_instruction?(file, objdump) end hardlinks = Set.new return if formula.lib.directory? && formula.lib.find.any? do |pn| next false if pn.symlink? || pn.directory? || pn.extname != ".a" next false unless hardlinks.add? [pn.stat.dev, pn.stat.ino] cpuid_instruction?(pn, objdump) end "No `cpuid` instruction detected. #{formula} should not use `ENV.runtime_cpu_detection`." end |
#check_easy_install_pth(lib) ⇒ 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.
140 141 142 143 144 145 146 147 148 149 150 151 |
# File 'formula_cellar_checks.rb', line 140 def check_easy_install_pth(lib) pth_found = Dir["#{lib}/python3*/site-packages/easy-install.pth"].map { |f| File.dirname(f) } return if pth_found.empty? <<~EOS 'easy-install.pth' files were found. These '.pth' files are likely to cause link conflicts. Easy install is now deprecated, do not use it. The offending files are: #{pth_found * "\n "} EOS end |
#check_elisp_dirname(share, name) ⇒ 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.
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 |
# File 'formula_cellar_checks.rb', line 154 def check_elisp_dirname(share, name) return unless (share/"emacs/site-lisp").directory? # Emacs itself can do what it wants return if name == "emacs" bad_dir_name = (share/"emacs/site-lisp").children.any? do |child| child.directory? && child.basename.to_s != name end return unless bad_dir_name <<~EOS Emacs Lisp files were installed into the wrong "site-lisp" subdirectory. They should be installed into: #{share}/emacs/site-lisp/#{name} EOS end |
#check_elisp_root(share, name) ⇒ 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.
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 |
# File 'formula_cellar_checks.rb', line 173 def check_elisp_root(share, name) return unless (share/"emacs/site-lisp").directory? # Emacs itself can do what it wants return if name == "emacs" elisps = (share/"emacs/site-lisp").children.select do |file| Keg::ELISP_EXTENSIONS.include? file.extname end return if elisps.empty? <<~EOS Emacs Lisp files were linked directly to "#{HOMEBREW_PREFIX}/share/emacs/site-lisp". This may cause conflicts with other packages. They should instead be installed into: #{share}/emacs/site-lisp/#{name} The offending files are: #{elisps * "\n "} EOS end |
#check_env_path(bin) ⇒ 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.
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
# File 'formula_cellar_checks.rb', line 20 def check_env_path(bin) return if Homebrew::EnvConfig.no_env_hints? # warn the user if stuff was installed outside of their PATH return unless bin.directory? return if bin.children.empty? prefix_bin = (HOMEBREW_PREFIX/bin.basename) return unless prefix_bin.directory? prefix_bin = prefix_bin.realpath return if ORIGINAL_PATHS.include? prefix_bin <<~EOS "#{prefix_bin}" is not in your PATH. You can amend this by altering your #{Utils::Shell.profile} file. EOS end |
#check_generic_executables(bin) ⇒ 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.
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 |
# File 'formula_cellar_checks.rb', line 122 def check_generic_executables(bin) return unless bin.directory? generic_names = %w[service start stop] generics = bin.children.select { |g| generic_names.include? g.basename.to_s } return if generics.empty? <<~EOS Generic binaries were installed to "#{bin}". Binaries with generic names are likely to conflict with other software. Homebrew suggests that this software is installed to "libexec" and then symlinked as needed. The offending files are: #{generics * "\n "} EOS end |
#check_infopages ⇒ 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.
52 53 54 55 56 57 58 59 60 61 |
# File 'formula_cellar_checks.rb', line 52 def check_infopages # Check for info pages that aren't in share/info return unless (formula.prefix/"info").directory? <<~EOS A top-level "info" directory was found. Homebrew suggests that info pages live under "share". This can often be fixed by passing `--infodir=\#{info}` to `configure`. EOS end |
#check_jars ⇒ 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.
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 |
# File 'formula_cellar_checks.rb', line 64 def check_jars return unless formula.lib.directory? jars = formula.lib.children.select { |g| g.extname == ".jar" } return if jars.empty? <<~EOS JARs were installed to "#{formula.lib}". Installing JARs to "lib" can cause conflicts between packages. For Java software, it is typically better for the formula to install to "libexec" and then symlink or wrap binaries into "bin". See formulae 'activemq', 'jruby', etc. for examples. The offending files are: #{jars * "\n "} EOS end |
#check_manpages ⇒ 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.
40 41 42 43 44 45 46 47 48 49 |
# File 'formula_cellar_checks.rb', line 40 def check_manpages # Check for man pages that aren't in share/man return unless (formula.prefix/"man").directory? <<~EOS A top-level "man" directory was found. Homebrew requires that man pages live under "share". This can often be fixed by passing `--mandir=\#{man}` to `configure`. EOS end |
#check_non_executables(bin) ⇒ 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.
108 109 110 111 112 113 114 115 116 117 118 119 |
# File 'formula_cellar_checks.rb', line 108 def check_non_executables(bin) return unless bin.directory? non_exes = bin.children.select { |g| g.directory? || !g.executable? } return if non_exes.empty? <<~EOS Non-executables were installed to "#{bin}". The offending files are: #{non_exes * "\n "} EOS end |
#check_non_libraries ⇒ 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.
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 |
# File 'formula_cellar_checks.rb', line 89 def check_non_libraries return unless formula.lib.directory? non_libraries = formula.lib.children.reject do |g| next true if g.directory? valid_library_extension? g end return if non_libraries.empty? <<~EOS Non-libraries were installed to "#{formula.lib}". Installing non-libraries to "lib" is discouraged. The offending files are: #{non_libraries * "\n "} EOS end |
#check_plist(prefix, plist) ⇒ 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.
255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 |
# File 'formula_cellar_checks.rb', line 255 def check_plist(prefix, plist) return unless prefix.directory? plist = begin Plist.parse_xml(plist, marshal: false) rescue nil end return if plist.blank? program_location = plist["ProgramArguments"]&.first key = "first ProgramArguments value" if program_location.blank? program_location = plist["Program"] key = "Program" end return if program_location.blank? Dir.chdir("/") do unless File.exist?(program_location) return <<~EOS The plist "#{key}" does not exist: #{program_location} EOS end return if File.executable?(program_location) end <<~EOS The plist "#{key}" is not executable: #{program_location} EOS end |
#check_python_packages(lib, deps) ⇒ 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.
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 |
# File 'formula_cellar_checks.rb', line 194 def check_python_packages(lib, deps) return unless lib.directory? lib_subdirs = lib.children .select(&:directory?) .map(&:basename) pythons = lib_subdirs.filter_map do |p| match = p.to_s.match(/^python(\d+\.\d+)$/) next if match.blank? next if match.captures.blank? match.captures.first end return if pythons.blank? python_deps = deps.to_a .map(&:name) .grep(/^python(@.*)?$/) .filter_map { |d| Formula[d].version.to_s[/^\d+\.\d+/] } return if python_deps.blank? return if pythons.any? { |v| python_deps.include? v } pythons = pythons.map { |v| "Python #{v}" } python_deps = python_deps.map { |v| "Python #{v}" } <<~EOS Packages have been installed for: #{pythons * "\n "} but this formula depends on: #{python_deps * "\n "} EOS end |
#check_python_symlinks(name, keg_only) ⇒ 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.
291 292 293 294 295 296 297 298 299 300 301 |
# File 'formula_cellar_checks.rb', line 291 def check_python_symlinks(name, keg_only) return unless keg_only return unless name.start_with? "python" return if %w[pip3 wheel3].none? do |l| link = HOMEBREW_PREFIX/"bin"/l link.exist? && File.realpath(link).start_with?(HOMEBREW_CELLAR/name) end "Python formulae that are keg-only should not create `pip3` and `wheel3` symlinks." end |
#check_service_command(formula) ⇒ 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.
304 305 306 307 308 309 310 |
# File 'formula_cellar_checks.rb', line 304 def check_service_command(formula) return unless formula.prefix.directory? return unless formula.service? return unless formula.service.command? "Service command does not exist" unless File.exist?(T.must(formula.service.command).first) end |
#check_shim_references(prefix) ⇒ 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.
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 |
# File 'formula_cellar_checks.rb', line 231 def check_shim_references(prefix) return unless prefix.directory? keg = Keg.new(prefix) matches = [] keg.each_unique_file_matching(HOMEBREW_SHIMS_PATH) do |f| match = f.relative_path_from(keg.to_path) next if match.to_s.match? %r{^share/doc/.+?/INFO_BIN$} matches << match end return if matches.empty? <<~EOS Files were found with references to the Homebrew shims directory. The offending files are: #{matches * "\n "} EOS end |
#formula ⇒ 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.
14 |
# File 'formula_cellar_checks.rb', line 14 def formula; end |
#problem_if_output(output) ⇒ 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.
17 |
# File 'formula_cellar_checks.rb', line 17 def problem_if_output(output); end |
#valid_library_extension?(filename) ⇒ 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.
84 85 86 |
# File 'formula_cellar_checks.rb', line 84 def valid_library_extension?(filename) VALID_LIBRARY_EXTENSIONS.include? filename.extname end |