# typed: true # frozen_string_literal: true require "macos_version" require "rubocops/extend/formula_cop" require "rubocops/shared/on_system_conditionals_helper" module RuboCop module Cop module FormulaAudit # This cop checks for various miscellaneous Homebrew coding styles. # # @api private class Lines < FormulaCop def audit_formula(_node, _class_node, _parent_class_node, _body_node) [:automake, :ant, :autoconf, :emacs, :expat, :libtool, :mysql, :perl, :postgresql, :python, :python3, :rbenv, :ruby].each do |dependency| next unless depends_on?(dependency) problem ":#{dependency} is deprecated. Usage should be \"#{dependency}\"." end { apr: "apr-util", fortran: "gcc", gpg: "gnupg", hg: "mercurial", mpi: "open-mpi", python2: "python" }.each do |requirement, dependency| next unless depends_on?(requirement) problem ":#{requirement} is deprecated. Usage should be \"#{dependency}\"." end problem ":tex is deprecated." if depends_on?(:tex) end end # This cop makes sure that a space is used for class inheritance. # # @api private class ClassInheritance < FormulaCop def audit_formula(_node, class_node, parent_class_node, _body_node) begin_pos = start_column(parent_class_node) end_pos = end_column(class_node) return if begin_pos-end_pos == 3 problem "Use a space in class inheritance: " \ "class #{@formula_name.capitalize} < #{class_name(parent_class_node)}" end end # This cop makes sure that template comments are removed. # # @api private class Comments < FormulaCop def audit_formula(_node, _class_node, _parent_class_node, _body_node) audit_comments do |comment| [ "# PLEASE REMOVE", "# Documentation:", "# if this fails, try separate make/make install steps", "# The URL of the archive", "## Naming --", "# if your formula fails when building in parallel", "# Remove unrecognized options if warned by configure", '# system "cmake', ].each do |template_comment| next unless comment.include?(template_comment) problem "Please remove default template comments" break end end audit_comments do |comment| # Commented-out depends_on next unless comment =~ /#\s*depends_on\s+(.+)\s*$/ problem "Commented-out dependency #{Regexp.last_match(1)}" end return if formula_tap != "homebrew-core" # Citation and tag comments from third-party taps audit_comments do |comment| next if comment !~ /#\s*(cite(?=\s*\w+:)|doi(?=\s*['"])|tag(?=\s*['"]))/ problem "Formulae in homebrew/core should not use `#{Regexp.last_match(1)}` comments" end end end # This cop makes sure that idiomatic `assert_*` statements are used. # # @api private class AssertStatements < FormulaCop def audit_formula(_node, _class_node, _parent_class_node, body_node) return if body_node.nil? find_every_method_call_by_name(body_node, :assert).each do |method| if method_called_ever?(method, :include?) && !method_called_ever?(method, :!) problem "Use `assert_match` instead of `assert ...include?`" end if method_called_ever?(method, :exist?) && !method_called_ever?(method, :!) problem "Use `assert_predicate , :exist?` instead of `#{method.source}`" end if method_called_ever?(method, :exist?) && method_called_ever?(method, :!) problem "Use `refute_predicate , :exist?` instead of `#{method.source}`" end if method_called_ever?(method, :executable?) && !method_called_ever?(method, :!) problem "Use `assert_predicate , :executable?` instead of `#{method.source}`" end end end end # This cop makes sure that `option`s are used idiomatically. # # @api private class OptionDeclarations < FormulaCop def audit_formula(_node, _class_node, _parent_class_node, body_node) return if body_node.nil? problem "Use new-style option definitions" if find_method_def(body_node, :options) if formula_tap == "homebrew-core" # Use of build.with? implies options, which are forbidden in homebrew/core find_instance_method_call(body_node, :build, :without?) do problem "Formulae in homebrew/core should not use `build.without?`." end find_instance_method_call(body_node, :build, :with?) do problem "Formulae in homebrew/core should not use `build.with?`." end return end depends_on_build_with(body_node) do |build_with_node| offending_node(build_with_node) problem "Use `:optional` or `:recommended` instead of `if #{build_with_node.source}`" end find_instance_method_call(body_node, :build, :without?) do |method| next unless unless_modifier?(method.parent) correct = method.source.gsub("out?", "?") problem "Use if #{correct} instead of unless #{method.source}" end find_instance_method_call(body_node, :build, :with?) do |method| next unless unless_modifier?(method.parent) correct = method.source.gsub("?", "out?") problem "Use if #{correct} instead of unless #{method.source}" end find_instance_method_call(body_node, :build, :with?) do |method| next unless expression_negated?(method) problem "Don't negate 'build.with?': use 'build.without?'" end find_instance_method_call(body_node, :build, :without?) do |method| next unless expression_negated?(method) problem "Don't negate 'build.without?': use 'build.with?'" end find_instance_method_call(body_node, :build, :without?) do |method| arg = parameters(method).first next unless (match = regex_match_group(arg, /^-?-?without-(.*)/)) problem "Don't duplicate 'without': " \ "Use `build.without? \"#{match[1]}\"` to check for \"--without-#{match[1]}\"" end find_instance_method_call(body_node, :build, :with?) do |method| arg = parameters(method).first next unless (match = regex_match_group(arg, /^-?-?with-(.*)/)) problem "Don't duplicate 'with': Use `build.with? \"#{match[1]}\"` to check for \"--with-#{match[1]}\"" end find_instance_method_call(body_node, :build, :include?) do problem "`build.include?` is deprecated" end end def unless_modifier?(node) return false unless node.if_type? node.modifier_form? && node.unless? end # Finds `depends_on "foo" if build.with?("bar")` or `depends_on "foo" if build.without?("bar")` def_node_search :depends_on_build_with, <<~EOS (if $(send (send nil? :build) {:with? :without?} str) (send nil? :depends_on str) nil?) EOS end # This cop makes sure that formulae depend on `open-mpi` instead of `mpich`. # # @api private class MpiCheck < FormulaCop extend AutoCorrector def audit_formula(_node, _class_node, _parent_class_node, body_node) return if body_node.nil? # Enforce use of OpenMPI for MPI dependency in core return if formula_tap != "homebrew-core" find_method_with_args(body_node, :depends_on, "mpich") do problem "Formulae in homebrew/core should use 'depends_on \"open-mpi\"' " \ "instead of '#{@offensive_node.source}'." do |corrector| corrector.replace(@offensive_node.source_range, "depends_on \"open-mpi\"") end end end end # This cop makes sure that formulae depend on `openssl` instead of `quictls`. # # @api private class QuicTLSCheck < FormulaCop extend AutoCorrector def audit_formula(_node, _class_node, _parent_class_node, body_node) return if body_node.nil? # Enforce use of OpenSSL for TLS dependency in core return if formula_tap != "homebrew-core" find_method_with_args(body_node, :depends_on, "quictls") do problem "Formulae in homebrew/core should use 'depends_on \"openssl@3\"' " \ "instead of '#{@offensive_node.source}'." do |corrector| corrector.replace(@offensive_node.source_range, "depends_on \"openssl@3\"") end end end end # This cop makes sure that formulae do not depend on `pyoxidizer` at build-time # or run-time. # # @api private class PyoxidizerCheck < FormulaCop def audit_formula(_node, _class_node, _parent_class_node, body_node) return if body_node.nil? # Disallow use of PyOxidizer as a dependency in core return if formula_tap != "homebrew-core" return unless depends_on?("pyoxidizer") problem "Formulae in homebrew/core should not use '#{@offensive_node.source}'." end end # This cop makes sure that the safe versions of `popen_*` calls are used. # # @api private class SafePopenCommands < FormulaCop extend AutoCorrector def audit_formula(_node, _class_node, _parent_class_node, body_node) return if body_node.nil? test = find_block(body_node, :test) [:popen_read, :popen_write].each do |unsafe_command| test_methods = [] unless test.nil? find_instance_method_call(test, "Utils", unsafe_command) do |method| test_methods << method.source_range end end find_instance_method_call(body_node, "Utils", unsafe_command) do |method| unless test_methods.include?(method.source_range) problem "Use `Utils.safe_#{unsafe_command}` instead of `Utils.#{unsafe_command}`" do |corrector| corrector.replace(@offensive_node.loc.selector, "safe_#{@offensive_node.method_name}") end end end end end end # This cop makes sure that environment variables are passed correctly to `popen_*` calls. # # @api private class ShellVariables < FormulaCop extend AutoCorrector def audit_formula(_node, _class_node, _parent_class_node, body_node) return if body_node.nil? popen_commands = [ :popen, :popen_read, :safe_popen_read, :popen_write, :safe_popen_write, ] popen_commands.each do |command| find_instance_method_call(body_node, "Utils", command) do |method| next unless (match = regex_match_group(parameters(method).first, /^([^"' ]+)=([^"' ]+)(?: (.*))?$/)) good_args = "Utils.#{command}({ \"#{match[1]}\" => \"#{match[2]}\" }, \"#{match[3]}\")" problem "Use `#{good_args}` instead of `#{method.source}`" do |corrector| corrector.replace(@offensive_node.source_range, "{ \"#{match[1]}\" => \"#{match[2]}\" }, \"#{match[3]}\"") end end end end end # This cop makes sure that `license` has the correct format. # # @api private class LicenseArrays < FormulaCop extend AutoCorrector def audit_formula(_node, _class_node, _parent_class_node, body_node) return if body_node.nil? license_node = find_node_method_by_name(body_node, :license) return unless license_node license = parameters(license_node).first return unless license.array_type? problem "Use `license any_of: #{license.source}` instead of `license #{license.source}`" do |corrector| corrector.replace(license_node.source_range, "license any_of: #{parameters(license_node).first.source}") end end end # This cop makes sure that nested `license` declarations are split onto multiple lines. # # @api private class Licenses < FormulaCop def audit_formula(_node, _class_node, _parent_class_node, body_node) return if body_node.nil? license_node = find_node_method_by_name(body_node, :license) return unless license_node return if license_node.source.include?("\n") parameters(license_node).first.each_descendant(:hash).each do |license_hash| next if license_exception? license_hash problem "Split nested license declarations onto multiple lines" end end def_node_matcher :license_exception?, <<~EOS (hash (pair (sym :with) str)) EOS end # This cop makes sure that Python versions are consistent. # # @api private class PythonVersions < FormulaCop extend AutoCorrector def audit_formula(_node, _class_node, _parent_class_node, body_node) return if body_node.nil? python_formula_node = find_every_method_call_by_name(body_node, :depends_on).find do |dep| string_content(parameters(dep).first).start_with? "python@" end python_version = if python_formula_node.blank? other_python_nodes = find_every_method_call_by_name(body_node, :depends_on).select do |dep| parameters(dep).first.instance_of?(RuboCop::AST::HashNode) && string_content(parameters(dep).first.keys.first).start_with?("python@") end return if other_python_nodes.size != 1 string_content(parameters(other_python_nodes.first).first.keys.first).split("@").last else string_content(parameters(python_formula_node).first).split("@").last end find_strings(body_node).each do |str| content = string_content(str) next unless (match = content.match(/^python(@)?(\d\.\d+)$/)) next if python_version == match[2] fix = if match[1] "python@#{python_version}" else "python#{python_version}" end offending_node(str) problem "References to `#{content}` should " \ "match the specified python dependency (`#{fix}`)" do |corrector| corrector.replace(str.source_range, "\"#{fix}\"") end end end end # This cop makes sure that OS conditionals are consistent. # # @api private class OnSystemConditionals < FormulaCop include OnSystemConditionalsHelper extend AutoCorrector NO_ON_SYSTEM_METHOD_NAMES = [:install, :post_install].freeze NO_ON_SYSTEM_BLOCK_NAMES = [:service, :test].freeze def audit_formula(_node, _class_node, _parent_class_node, body_node) NO_ON_SYSTEM_METHOD_NAMES.each do |formula_method_name| method_node = find_method_def(body_node, formula_method_name) audit_on_system_blocks(method_node, formula_method_name) if method_node end NO_ON_SYSTEM_BLOCK_NAMES.each do |formula_block_name| block_node = find_block(body_node, formula_block_name) audit_on_system_blocks(block_node, formula_block_name) if block_node end # Don't restrict OS.mac? or OS.linux? usage in taps; they don't care # as much as we do about e.g. formulae.brew.sh generation, often use # platform-specific URLs and we don't want to add DSLs to support # that case. return if formula_tap != "homebrew-core" audit_arch_conditionals(body_node, allowed_methods: NO_ON_SYSTEM_METHOD_NAMES, allowed_blocks: NO_ON_SYSTEM_BLOCK_NAMES) audit_base_os_conditionals(body_node, allowed_methods: NO_ON_SYSTEM_METHOD_NAMES, allowed_blocks: NO_ON_SYSTEM_BLOCK_NAMES) audit_macos_version_conditionals(body_node, allowed_methods: NO_ON_SYSTEM_METHOD_NAMES, allowed_blocks: NO_ON_SYSTEM_BLOCK_NAMES, recommend_on_system: true) end end # This cop makes sure the `MacOS` module is not used in Linux-facing formula code # # @api private class MacOSOnLinux < FormulaCop include OnSystemConditionalsHelper ON_MACOS_BLOCKS = [:macos, *MACOS_VERSION_OPTIONS].map { |os| :"on_#{os}" }.freeze def audit_formula(_node, _class_node, _parent_class_node, body_node) audit_macos_references(body_node, allowed_methods: OnSystemConditionals::NO_ON_SYSTEM_METHOD_NAMES, allowed_blocks: OnSystemConditionals::NO_ON_SYSTEM_BLOCK_NAMES + ON_MACOS_BLOCKS) end end # This cop makes sure that the `generate_completions_from_executable` DSL is used. # # @api private class GenerateCompletionsDSL < FormulaCop extend AutoCorrector def audit_formula(_node, _class_node, _parent_class_node, body_node) install = find_method_def(body_node, :install) return if install.blank? correctable_shell_completion_node(install) do |node, shell, base_name, executable, subcmd, shell_parameter| # generate_completions_from_executable only applicable if shell is passed next unless shell_parameter.match?(/(bash|zsh|fish)/) base_name = base_name.delete_prefix("_").delete_suffix(".fish") shell = shell.to_s.delete_suffix("_completion").to_sym shell_parameter_stripped = shell_parameter .delete_suffix("bash") .delete_suffix("zsh") .delete_suffix("fish") shell_parameter_format = if shell_parameter_stripped.empty? nil elsif shell_parameter_stripped == "--" :flag elsif shell_parameter_stripped == "--shell=" :arg else shell_parameter_stripped end replacement_args = %w[] replacement_args << executable.source replacement_args << subcmd.source replacement_args << "base_name: \"#{base_name}\"" if base_name != @formula_name replacement_args << "shells: [:#{shell}]" unless shell_parameter_format.nil? replacement_args << "shell_parameter_format: #{shell_parameter_format.inspect}" end offending_node(node) replacement = "generate_completions_from_executable(#{replacement_args.join(", ")})" problem "Use `#{replacement}` instead of `#{@offensive_node.source}`." do |corrector| corrector.replace(@offensive_node.source_range, replacement) end end shell_completion_node(install) do |node| next if node.source.include?("<<~") # skip heredoc completion scripts next if node.source.match?(/{.*=>.*}/) # skip commands needing custom ENV variables offending_node(node) problem "Use `generate_completions_from_executable` DSL instead of `#{@offensive_node.source}`." end end # match ({bash,zsh,fish}_completion/"_?foo{.fish}?").write Utils.safe_popen_read(foo, subcmd, shell_parameter) def_node_search :correctable_shell_completion_node, <<~EOS $(send (begin (send (send nil? ${:bash_completion :zsh_completion :fish_completion}) :/ (str $_))) :write (send (const nil? :Utils) :safe_popen_read $(send (send nil? :bin) :/ (str _)) $(str _) (str $_))) EOS # matches ({bash,zsh,fish}_completion/"_?foo{.fish}?").write output def_node_search :shell_completion_node, <<~EOS $(send (begin (send (send nil? {:bash_completion :zsh_completion :fish_completion}) :/ (str _))) :write _) EOS end # This cop makes sure that the `generate_completions_from_executable` DSL is used with only # a single, combined call for all shells. # # @api private class SingleGenerateCompletionsDSLCall < FormulaCop extend AutoCorrector def audit_formula(_node, _class_node, _parent_class_node, body_node) install = find_method_def(body_node, :install) return if install.blank? methods = find_every_method_call_by_name(install, :generate_completions_from_executable) return if methods.length <= 1 offenses = [] shells = [] methods.each do |method| next unless method.source.include?("shells:") shells << method.source.match(/shells: \[(:bash|:zsh|:fish)\]/).captures.first offenses << method end return if offenses.blank? T.must(offenses[0...-1]).each_with_index do |node, i| # commands have to be the same to be combined # send_type? matches `bin/"foo"`, str_type? matches remaining command parts, # the rest are kwargs we need to filter out method_commands = node.arguments.filter { |arg| arg.send_type? || arg.str_type? } next_method_commands = offenses[i + 1].arguments.filter { |arg| arg.send_type? || arg.str_type? } if method_commands != next_method_commands shells.delete_at(i) next end offending_node(node) problem "Use a single `generate_completions_from_executable` " \ "call combining all specified shells." do |corrector| # adjust range by -4 and +1 to also include & remove leading spaces and trailing \n corrector.replace(@offensive_node.source_range.adjust(begin_pos: -4, end_pos: 1), "") end end return if shells.length <= 1 # no shells to combine left offending_node(offenses.last) replacement = if (%w[:bash :zsh :fish] - shells).empty? @offensive_node.source.sub(/shells: \[(:bash|:zsh|:fish)\]/, "") .sub(", )", ")") # clean up dangling trailing comma .sub("(, ", "(") # clean up dangling leading comma .sub(", , ", ", ") # clean up dangling enclosed comma else @offensive_node.source.sub(/shells: \[(:bash|:zsh|:fish)\]/, "shells: [#{shells.join(", ")}]") end problem "Use `#{replacement}` instead of `#{@offensive_node.source}`." do |corrector| corrector.replace(@offensive_node.source_range, replacement) end end end # This cop checks for other miscellaneous style violations. # # @api private class Miscellaneous < FormulaCop def audit_formula(_node, _class_node, _parent_class_node, body_node) return if body_node.nil? # FileUtils is included in Formula # encfs modifies a file with this name, so check for some leading characters find_instance_method_call(body_node, "FileUtils", nil) do |method_node| problem "Don't need 'FileUtils.' before #{method_node.method_name}" end # Check for long inreplace block vars find_all_blocks(body_node, :inreplace) do |node| block_arg = node.arguments.children.first next if block_arg.source.size <= 1 problem "\"inreplace do |s|\" is preferred over \"|#{block_arg.source}|\"." end [:rebuild, :version_scheme].each do |method_name| find_method_with_args(body_node, method_name, 0) do problem "'#{method_name} 0' should be removed" end end find_instance_call(body_node, "ARGV") do |_method_node| problem "Use build instead of ARGV to check options" end find_instance_method_call(body_node, :man, :+) do |method| next unless (match = regex_match_group(parameters(method).first, /^man[1-8]$/)) problem "\"#{method.source}\" should be \"#{match[0]}\"" end # Avoid hard-coding compilers find_every_method_call_by_name(body_node, :system).each do |method| next if @formula_name == "bazel" # TODO: Remove shim bypass in bazel. param = parameters(method).first if (match = regex_match_group(param, %r{^(/usr/bin/)?(gcc|clang|cc|c[89]9)(\s|$)})) problem "Use \"\#{ENV.cc}\" instead of hard-coding \"#{match[2]}\"" elsif (match = regex_match_group(param, %r{^(/usr/bin/)?((g|clang|c)\+\+)(\s|$)})) problem "Use \"\#{ENV.cxx}\" instead of hard-coding \"#{match[2]}\"" end end find_instance_method_call(body_node, "ENV", :[]=) do |method| next if @formula_name == "bazel" # TODO: Remove shim bypass in bazel. param = parameters(method)[1] if (match = regex_match_group(param, %r{^(/usr/bin/)?(gcc|clang|cc|c[89]9)(\s|$)})) problem "Use \"\#{ENV.cc}\" instead of hard-coding \"#{match[2]}\"" elsif (match = regex_match_group(param, %r{^(/usr/bin/)?((g|clang|c)\+\+)(\s|$)})) problem "Use \"\#{ENV.cxx}\" instead of hard-coding \"#{match[2]}\"" end end # Prefer formula path shortcuts in strings formula_path_strings(body_node, :share) do |p| next unless (match = regex_match_group(p, %r{^(/(man))/?})) problem "\"\#{share}#{match[1]}\" should be \"\#{#{match[2]}}\"" end formula_path_strings(body_node, :prefix) do |p| if (match = regex_match_group(p, %r{^(/share/(info|man))$})) problem ['"#', "{prefix}", match[1], '" should be "#{', match[2], '}"'].join end if (match = regex_match_group(p, %r{^((/share/man/)(man[1-8]))})) problem ['"#', "{prefix}", match[1], '" should be "#{', match[3], '}"'].join end if (match = regex_match_group(p, %r{^(/(bin|include|libexec|lib|sbin|share|Frameworks))}i)) problem ['"#', "{prefix}", match[1], '" should be "#{', match[2].downcase, '}"'].join end end find_every_method_call_by_name(body_node, :depends_on).each do |method| key, value = destructure_hash(parameters(method).first) next if key.nil? || value.nil? next unless (match = regex_match_group(value, /^(lua|perl|python|ruby)(\d*)/)) problem "#{match[1]} modules should be vendored rather than use deprecated `#{method.source}`" end find_every_method_call_by_name(body_node, :system).each do |method| next unless (match = regex_match_group(parameters(method).first, /^(env|export)(\s+)?/)) problem "Use ENV instead of invoking '#{match[1]}' to modify the environment" end find_every_method_call_by_name(body_node, :depends_on).each do |method| param = parameters(method).first dep, option_child_nodes = hash_dep(param) next if dep.nil? || option_child_nodes.empty? option_child_nodes.each do |option| find_strings(option).each do |dependency| next unless (match = regex_match_group(dependency, /(with(out)?-\w+|c\+\+11)/)) problem "Dependency #{string_content(dep)} should not use option #{match[0]}" end end end find_instance_method_call(body_node, :version, :==) do |method| next unless parameters_passed?(method, ["HEAD"]) problem "Use 'build.head?' instead of inspecting 'version'" end find_instance_method_call(body_node, "ARGV", :include?) do |method| next unless parameters_passed?(method, ["--HEAD"]) problem "Use \"if build.head?\" instead" end find_const(body_node, "MACOS_VERSION") do problem "Use MacOS.version instead of MACOS_VERSION" end find_const(body_node, "MACOS_FULL_VERSION") do problem "Use MacOS.full_version instead of MACOS_FULL_VERSION" end conditional_dependencies(body_node) do |node, method, param, dep_node| dep = string_content(dep_node) if node.if? if (method == :include? && regex_match_group(param, /^with-#{dep}$/)) || (method == :with? && regex_match_group(param, /^#{dep}$/)) offending_node(dep_node.parent) problem "Replace #{node.source} with #{dep_node.parent.source} => :optional" end elsif node.unless? if (method == :include? && regex_match_group(param, /^without-#{dep}$/)) || (method == :without? && regex_match_group(param, /^#{dep}$/)) offending_node(dep_node.parent) problem "Replace #{node.source} with #{dep_node.parent.source} => :recommended" end end end find_method_with_args(body_node, :fails_with, :llvm) do problem "'fails_with :llvm' is now a no-op so should be removed" end find_method_with_args(body_node, :needs, :openmp) do problem "'needs :openmp' should be replaced with 'depends_on \"gcc\"'" end find_method_with_args(body_node, :system, /^(otool|install_name_tool|lipo)/) do problem "Use ruby-macho instead of calling #{@offensive_node.source}" end find_every_method_call_by_name(body_node, :system).each do |method_node| # Skip Kibana: npm cache edge (see formula for more details) next if @formula_name.match?(/^kibana(@\d[\d.]*)?$/) first_param, second_param = parameters(method_node) next if !node_equals?(first_param, "npm") || !node_equals?(second_param, "install") offending_node(method_node) problem "Use Language::Node for npm install args" unless languageNodeModule?(method_node) end problem "Use new-style test definitions (test do)" if find_method_def(body_node, :test) find_method_with_args(body_node, :skip_clean, :all) do problem "`skip_clean :all` is deprecated; brew no longer strips symbols. " \ "Pass explicit paths to prevent Homebrew from removing empty folders." end if find_method_def(processed_source.ast) problem "Define method #{method_name(@offensive_node)} in the class body, not at the top-level" end find_instance_method_call(body_node, :build, :universal?) do next if @formula_name == "wine" problem "macOS has been 64-bit only since 10.6 so build.universal? is deprecated." end find_instance_method_call(body_node, "ENV", :universal_binary) do next if @formula_name == "wine" problem "macOS has been 64-bit only since 10.6 so ENV.universal_binary is deprecated." end find_instance_method_call(body_node, "ENV", :runtime_cpu_detection) do next if tap_style_exception? :runtime_cpu_detection_allowlist problem "Formulae should be verified as having support for runtime hardware detection before " \ "using ENV.runtime_cpu_detection." end find_every_method_call_by_name(body_node, :depends_on).each do |method| next unless method_called?(method, :new) problem "`depends_on` can take requirement classes instead of instances" end find_instance_method_call(body_node, "ENV", :[]) do |method| next unless modifier?(method.parent) param = parameters(method).first next unless node_equals?(param, "CI") problem 'Don\'t use ENV["CI"] for Homebrew CI checks.' end find_instance_method_call(body_node, "Dir", :[]) do |method| next if parameters(method).size != 1 path = parameters(method).first next unless path.str_type? next unless (match = regex_match_group(path, /^[^*{},]+$/)) problem "Dir([\"#{string_content(path)}\"]) is unnecessary; just use \"#{match[0]}\"" end fileutils_methods = Regexp.new( FileUtils.singleton_methods(false) .map { |m| "(?-mix:^#{Regexp.escape(m)}$)" } .join("|"), ) find_every_method_call_by_name(body_node, :system).each do |method| param = parameters(method).first next unless (match = regex_match_group(param, fileutils_methods)) problem "Use the `#{match}` Ruby method instead of `#{method.source}`" end end def modifier?(node) return false unless node.if_type? node.modifier_form? end def_node_search :conditional_dependencies, <<~EOS {$(if (send (send nil? :build) ${:include? :with? :without?} $(str _)) (send nil? :depends_on $({str sym} _)) nil?) $(if (send (send nil? :build) ${:include? :with? :without?} $(str _)) nil? (send nil? :depends_on $({str sym} _)))} EOS def_node_matcher :hash_dep, <<~EOS (hash (pair $(str _) $...)) EOS def_node_matcher :destructure_hash, <<~EOS (hash (pair $(str _) $(sym _))) EOS def_node_search :formula_path_strings, <<~EOS {(dstr (begin (send nil? %1)) $(str _ )) (dstr _ (begin (send nil? %1)) $(str _ ))} EOS # Node Pattern search for Language::Node def_node_search :languageNodeModule?, <<~EOS (const (const nil? :Language) :Node) EOS end end module FormulaAuditStrict # This cop makes sure that no build-time checks are performed. # # @api private class MakeCheck < FormulaCop def audit_formula(_node, _class_node, _parent_class_node, body_node) return if formula_tap != "homebrew-core" # Avoid build-time checks in homebrew/core find_every_method_call_by_name(body_node, :system).each do |method| next if @formula_name.start_with?("lib") next if tap_style_exception? :make_check_allowlist params = parameters(method) next unless node_equals?(params[0], "make") params[1..].each do |arg| next unless regex_match_group(arg, /^(checks?|tests?)$/) offending_node(method) problem "Formulae in homebrew/core (except e.g. cryptography, libraries) " \ "should not run build-time checks" end end end end # This cop ensures that new formulae depending on removed Requirements are not used class Requirements < FormulaCop def audit_formula(_node, _class_node, _parent_class_node, _body_node) problem "Formulae should depend on a versioned `openjdk` instead of :java" if depends_on? :java problem "Formulae should depend on specific X libraries instead of :x11" if depends_on? :x11 problem "Formulae should not depend on :osxfuse" if depends_on? :osxfuse problem "Formulae should not depend on :tuntap" if depends_on? :tuntap end end # This cop makes sure that formulae build with `rust` instead of `rustup-init`. # # @api private class RustCheck < FormulaCop extend AutoCorrector def audit_formula(_node, _class_node, _parent_class_node, body_node) return if body_node.nil? # Enforce use of `rust` for rust dependency in core return if formula_tap != "homebrew-core" find_method_with_args(body_node, :depends_on, "rustup-init") do problem "Formulae in homebrew/core should use 'depends_on \"rust\"' " \ "instead of '#{@offensive_node.source}'." do |corrector| corrector.replace(@offensive_node.source_range, "depends_on \"rust\"") end end # TODO: Enforce order of dependency types so we don't need to check for # depends_on "rustup-init" => [:test, :build] [:build, [:build, :test], [:test, :build]].each do |type| find_method_with_args(body_node, :depends_on, "rustup-init" => type) do problem "Formulae in homebrew/core should use 'depends_on \"rust\" => #{type}' " \ "instead of '#{@offensive_node.source}'." do |corrector| corrector.replace(@offensive_node.source_range, "depends_on \"rust\" => #{type}") end end end install_node = find_method_def(body_node, :install) return if install_node.blank? find_every_method_call_by_name(install_node, :system).each do |method| param = parameters(method).first next if param.blank? # FIXME: Handle Pathname parameters (e.g. `system bin/"rustup-init"`). next if regex_match_group(param, /rustup-init$/).blank? problem "Formula in homebrew/core should not use `rustup-init` at build-time." end end end end end end