# typed: true # frozen_string_literal: true require "formula" require "cask/cask_loader" # Helper module for validating syntax in taps. # # @api private module Readall class << self def valid_ruby_syntax?(ruby_files) failed = T.let(false, T::Boolean) ruby_files.each do |ruby_file| # As a side effect, print syntax errors/warnings to `$stderr`. failed = true if syntax_errors_or_warnings?(ruby_file) end !failed end def valid_aliases?(alias_dir, formula_dir) return true unless alias_dir.directory? failed = T.let(false, T::Boolean) alias_dir.each_child do |f| if !f.symlink? onoe "Non-symlink alias: #{f}" failed = true elsif !f.file? onoe "Non-file alias: #{f}" failed = true end if (formula_dir/"#{f.basename}.rb").exist? onoe "Formula duplicating alias: #{f}" failed = true end end !failed end def valid_formulae?(formulae, bottle_tag: nil) success = T.let(true, T::Boolean) formulae.each do |file| base = Formulary.factory(file) next if bottle_tag.blank? || !base.path.exist? || !base.class.on_system_blocks_exist? formula_contents = base.path.read readall_namespace = Formulary.class_s("Readall#{bottle_tag.to_sym.capitalize}") readall_formula_class = Formulary.load_formula(base.name, base.path, formula_contents, readall_namespace, flags: base.class.build_flags, ignore_errors: true) readall_formula_class.new(base.name, base.path, :stable, alias_path: base.alias_path, force_bottle: base.force_bottle) rescue Interrupt raise rescue Exception => e # rubocop:disable Lint/RescueException onoe "Invalid formula (#{bottle_tag}): #{file}" $stderr.puts e success = false end success end def valid_casks?(_casks, os_name: nil, arch: nil) true end def valid_tap?(tap, aliases: false, no_simulate: false, os_arch_combinations: nil) success = true if aliases valid_aliases = valid_aliases?(tap.alias_dir, tap.formula_dir) success = false unless valid_aliases end if no_simulate success = false unless valid_formulae?(tap.formula_files) success = false unless valid_casks?(tap.cask_files) else # TODO: Remove this default case once `--os` and `--arch` are passed explicitly to `brew readall` in CI. os_arch_combinations ||= [*MacOSVersion::SYMBOLS.keys, :linux].product(OnSystem::ARCH_OPTIONS) os_arch_combinations.each do |os, arch| bottle_tag = Utils::Bottles::Tag.new(system: os, arch: arch) next unless bottle_tag.valid_combination? Homebrew::SimulateSystem.with os: os, arch: arch do success = false unless valid_formulae?(tap.formula_files, bottle_tag: bottle_tag) success = false unless valid_casks?(tap.cask_files, os_name: os, arch: arch) end end end success end private def syntax_errors_or_warnings?(filename) # Retrieve messages about syntax errors/warnings printed to `$stderr`. _, err, status = system_command(RUBY_PATH, args: ["-c", "-w", filename], print_stderr: false) # Ignore unnecessary warning about named capture conflicts. # See https://bugs.ruby-lang.org/issues/12359. messages = err.lines .grep_v(/named capture conflicts a local variable/) .join $stderr.print messages # Only syntax errors result in a non-zero status code. To detect syntax # warnings we also need to inspect the output to `$stderr`. !status.success? || !messages.chomp.empty? end end end require "extend/os/readall"