Class: Homebrew::DevCmd::Audit Private

Inherits:
AbstractCommand show all
Defined in:
dev-cmd/audit.rb,
sorbet/rbi/dsl/homebrew/dev_cmd/audit.rbi

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.

Defined Under Namespace

Classes: Args

Instance Method Summary collapse

Methods inherited from AbstractCommand

command, command_name, dev_cmd?, #initialize, parser, #raise_sh_command_error!

Constructor Details

This class inherits a constructor from Homebrew::AbstractCommand

Instance Method Details

#argsHomebrew::DevCmd::Audit::Args

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.



10
# File 'sorbet/rbi/dsl/homebrew/dev_cmd/audit.rbi', line 10

def args; end

#runvoid

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.



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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
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
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
322
323
324
325
326
327
328
# File 'dev-cmd/audit.rb', line 105

def run
  Formulary.enable_factory_cache!

  os_arch_combinations = args.os_arch_combinations

  Homebrew.auditing = true
  Homebrew.inject_dump_stats!(FormulaAuditor, /^audit_/) if args.audit_debug?

  strict = args.new? || args.strict?
  online = args.new? || args.online?
  tap_audit = args.tap.present?
  skip_style = args.skip_style? || args.no_named? || tap_audit
  no_named_args = T.let(false, T::Boolean)

  gem_groups = ["audit"]
  gem_groups << "style" unless skip_style
  Homebrew.install_bundler_gems!(groups: gem_groups)

  ENV.activate_extensions!
  ENV.setup_build_environment

  audit_formulae, audit_casks = Homebrew.with_no_api_env do # audit requires full Ruby source
    if args.tap
      Tap.fetch(T.must(args.tap)).then do |tap|
        [
          tap.formula_files.map { |path| Formulary.factory(path) },
          tap.cask_files.map { |path| Cask::CaskLoader.load(path) },
        ]
      end
    elsif args.installed?
      no_named_args = true
      [Formula.installed, Cask::Caskroom.casks]
    elsif args.no_named?
      if !args.eval_all? && !Homebrew::EnvConfig.eval_all?
        # This odisabled should probably stick around indefinitely.
        odisabled "brew audit",
                  "brew audit --eval-all or HOMEBREW_EVAL_ALL"
      end
      no_named_args = true
      [
        Formula.all(eval_all: args.eval_all?),
        Cask::Cask.all(eval_all: args.eval_all?),
      ]
    else
      if args.named.any? { |named_arg| named_arg.end_with?(".rb") }
        # This odisabled should probably stick around indefinitely,
        # until at least we have a way to exclude error on these in the CLI parser.
        odisabled "brew audit [path ...]",
                  "brew audit [name ...]"
      end

      args.named.to_formulae_and_casks_with_taps
          .partition { |formula_or_cask| formula_or_cask.is_a?(Formula) }
    end
  end

  if audit_formulae.empty? && audit_casks.empty? && !args.tap
    ofail "No matching formulae or casks to audit!"
    return
  end

  style_files = args.named.to_paths unless skip_style

  only_cops = args.only_cops
  except_cops = args.except_cops
  style_options = { fix: args.fix?, debug: args.debug?, verbose: args.verbose? }

  if only_cops
    style_options[:only_cops] = only_cops
  elsif args.new?
    nil
  elsif except_cops
    style_options[:except_cops] = except_cops
  elsif !strict
    style_options[:except_cops] = [:FormulaAuditStrict]
  end

  # Run tap audits first
  named_arg_taps = [*audit_formulae, *audit_casks].map(&:tap).uniq if !args.tap && !no_named_args
  tap_problems = Tap.installed.each_with_object({}) do |tap, problems|
    next if args.tap && tap != args.tap
    next if named_arg_taps&.exclude?(tap)

    ta = TapAuditor.new(tap, strict: args.strict?)
    ta.audit

    problems[[tap.name, tap.path]] = ta.problems if ta.problems.any?
  end

  # Check style in a single batch run up front for performance
  style_offenses = Style.check_style_json(style_files, **style_options) if style_files
  # load licenses
  spdx_license_data = SPDX.license_data
  spdx_exception_data = SPDX.exception_data

  formula_problems = audit_formulae.sort.each_with_object({}) do |f, problems|
    path = f.path

    only = only_cops ? ["style"] : args.only
    options = {
      new_formula:         args.new?,
      strict:,
      online:,
      git:                 args.git?,
      only:,
      except:              args.except,
      spdx_license_data:,
      spdx_exception_data:,
      style_offenses:      style_offenses&.for_path(f.path),
      tap_audit:,
    }.compact

    errors = os_arch_combinations.flat_map do |os, arch|
      SimulateSystem.with(os:, arch:) do
        odebug "Auditing Formula #{f} on os #{os} and arch #{arch}"

        audit_proc = proc { FormulaAuditor.new(Formulary.factory(path), **options).tap(&:audit) }

        # Audit requires full Ruby source so disable API. We shouldn't do this for taps however so that we
        # don't unnecessarily require a full Homebrew/core clone.
        fa = if f.core_formula?
          Homebrew.with_no_api_env(&audit_proc)
        else
          audit_proc.call
        end

        fa.problems + fa.new_formula_problems
      end
    end.uniq

    problems[[f.full_name, path]] = errors if errors.any?
  end

  require "cask/auditor" if audit_casks.any?

  cask_problems = audit_casks.each_with_object({}) do |cask, problems|
    path = cask.sourcefile_path

    errors = os_arch_combinations.flat_map do |os, arch|
      next [] if os == :linux

      SimulateSystem.with(os:, arch:) do
        odebug "Auditing Cask #{cask} on os #{os} and arch #{arch}"

        Cask::Auditor.audit(
          Cask::CaskLoader.load(path),
          # For switches, we add `|| nil` so that `nil` will be passed
          # instead of `false` if they aren't set.
          # This way, we can distinguish between "not set" and "set to false".
          audit_online:          args.online? || nil,
          audit_strict:          args.strict? || nil,

          # No need for `|| nil` for `--[no-]signing`
          # because boolean switches are already `nil` if not passed
          audit_signing:         args.signing?,
          audit_new_cask:        args.new? || nil,
          audit_token_conflicts: args.token_conflicts? || nil,
          quarantine:            true,
          any_named_args:        !no_named_args,
          only:                  args.only,
          except:                args.except,
        ).to_a
      end
    end.uniq

    problems[[cask.full_name, path]] = errors if errors.any?
  end

  print_problems(tap_problems)
  print_problems(formula_problems)
  print_problems(cask_problems)

  tap_count = tap_problems.keys.count
  formula_count = formula_problems.keys.count
  cask_count = cask_problems.keys.count

  corrected_problem_count = (formula_problems.values + cask_problems.values)
                            .sum { |problems| problems.count { |problem| problem.fetch(:corrected) } }

  tap_problem_count = tap_problems.sum { |_, problems| problems.count }
  formula_problem_count = formula_problems.sum { |_, problems| problems.count }
  cask_problem_count = cask_problems.sum { |_, problems| problems.count }
  total_problems_count = formula_problem_count + cask_problem_count + tap_problem_count

  if total_problems_count.positive?
    errors_summary = Utils.pluralize("problem", total_problems_count, include_count: true)

    error_sources = []
    if formula_count.positive?
      error_sources << Utils.pluralize("formula", formula_count, plural: "e", include_count: true)
    end
    error_sources << Utils.pluralize("cask", cask_count, include_count: true) if cask_count.positive?
    error_sources << Utils.pluralize("tap", tap_count, include_count: true) if tap_count.positive?

    errors_summary += " in #{error_sources.to_sentence}" if error_sources.any?

    errors_summary += " detected"

    if corrected_problem_count.positive?
      errors_summary +=
        ", #{Utils.pluralize("problem", corrected_problem_count, include_count: true)} corrected"
    end

    ofail "#{errors_summary}."
  end

  return unless GitHub::Actions.env_set?

  annotations = formula_problems.merge(cask_problems).flat_map do |(_, path), problems|
    problems.map do |problem|
      GitHub::Actions::Annotation.new(
        :error,
        problem[:message],
        file:   path,
        line:   problem[:location]&.line,
        column: problem[:location]&.column,
      )
    end
  end.compact

  annotations.each do |annotation|
    puts annotation if annotation.relevant?
  end
end