admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity

Merge pull request #11016 from reitermarkus/cask-audit-annotations

Browse Source 
Fix audit annotations for casks.
This commit is contained in:
Markus Reiter 2021-04-03 18:33:46 +02:00 committed by GitHub
commit 1ce8ea659c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 62 additions and 62 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Library/Homebrew/cask/audit.rb
View File

@ -96,15 +96,15 @@ module Cask
@warnings ||= []
end
def add_error(message)
errors << message
def add_error(message, location: nil)
errors << ({ message: message, location: location })
end
def add_warning(message)
def add_warning(message, location: nil)
if strict?
add_error message
add_error message, location: location
else
warnings << message
warnings << ({ message: message, location: location })
end
end
@ -134,12 +134,12 @@ module Cask
summary = ["audit for #{cask}: #{result}"]
errors.each do |error|
summary << " #{Formatter.error("-")} #{error}"
summary << " #{Formatter.error("-")} #{error[:message]}"
end
if include_warnings
warnings.each do |warning|
summary << " #{Formatter.warning("-")} #{warning}"
summary << " #{Formatter.warning("-")} #{warning[:message]}"
end
end

18
Library/Homebrew/cask/cmd/audit.rb
View File

@ -59,8 +59,6 @@ module Cask
display_failures_only: args.display_failures_only?,
)
self.class.print_annotations(results)
failed_casks = results.reject { |_, result| result[:errors].empty? }.map(&:first)
return if failed_casks.empty?
@ -103,23 +101,9 @@ module Cask
casks.map do |cask|
odebug "Auditing Cask #{cask}"
[cask, Auditor.audit(cask, **options)]
[cask.sourcefile_path, Auditor.audit(cask, **options)]
end.to_h
end
def self.print_annotations(results)
return unless ENV["GITHUB_ACTIONS"]
results.each do |cask, result|
cask_path = cask.sourcefile_path
annotations = (result[:warnings].map { |w| [:warning, w] } + result[:errors].map { |e| [:error, e] })
.map { |type, message| GitHub::Actions::Annotation.new(type, message, file: cask_path) }
annotations.each do |annotation|
puts annotation if annotation.relevant?
end
end
end
end
end
end

86
Library/Homebrew/dev-cmd/audit.rb
View File

@ -166,7 +166,7 @@ module Homebrew
spdx_license_data = SPDX.license_data
spdx_exception_data = SPDX.exception_data
new_formula_problem_lines = []
audit_formulae.sort.each do |f|
formula_results = audit_formulae.sort.map do |f|
only = only_cops ? ["style"] : args.only
options = {
new_formula: new_formula,
@ -184,31 +184,25 @@ module Homebrew
fa = FormulaAuditor.new(f, **options)
fa.audit
next if fa.problems.empty? && fa.new_formula_problems.empty?
formula_count += 1
problem_count += fa.problems.size
problem_lines = format_problem_lines(fa.problems)
corrected_problem_count += options.fetch(:style_offenses, []).count(&:corrected?)
new_formula_problem_lines += format_problem_lines(fa.new_formula_problems)
if args.display_filename?
puts problem_lines.map { |s| "#{f.path}: #{s}" }
else
puts "#{f.full_name}:", problem_lines.map { |s| " #{s}" }
if fa.problems.any? || fa.new_formula_problems.any?
formula_count += 1
problem_count += fa.problems.size
problem_lines = format_problem_lines(fa.problems)
corrected_problem_count += options.fetch(:style_offenses, []).count(&:corrected?)
new_formula_problem_lines += format_problem_lines(fa.new_formula_problems)
if args.display_filename?
puts problem_lines.map { |s| "#{f.path}: #{s}" }
else
puts "#{f.full_name}:", problem_lines.map { |s| " #{s}" }
end
end
next unless ENV["GITHUB_ACTIONS"]
[f.path, { errors: fa.problems + fa.new_formula_problems, warnings: [] }]
end.to_h
(fa.problems + fa.new_formula_problems).each do |message:, location:|
annotation = GitHub::Actions::Annotation.new(
:error, message, file: f.path, line: location&.line, column: location&.column
)
puts annotation if annotation.relevant?
end
end
casks_results = if audit_casks.empty?
[]
cask_results = if audit_casks.empty?
{}
else
require "cask/cmd/audit"
@ -228,33 +222,55 @@ module Homebrew
)
end
failed_casks = casks_results.reject { |_, result| result[:errors].empty? }
failed_casks = cask_results.reject { |_, result| result[:errors].empty? }
cask_count = failed_casks.count
cask_problem_count = failed_casks.sum { |_, result| result[:warnings].count + result[:errors].count }
new_formula_problem_count += new_formula_problem_lines.count
total_problems_count = problem_count + new_formula_problem_count + cask_problem_count + tap_problem_count
return unless total_problems_count.positive?
puts new_formula_problem_lines.map { |s| " #{s}" }
if total_problems_count.positive?
puts new_formula_problem_lines.map { |s| " #{s}" }
errors_summary = "#{total_problems_count} #{"problem".pluralize(total_problems_count)}"
errors_summary = "#{total_problems_count} #{"problem".pluralize(total_problems_count)}"
error_sources = []
error_sources << "#{formula_count} #{"formula".pluralize(formula_count)}" if formula_count.positive?
error_sources << "#{cask_count} #{"cask".pluralize(cask_count)}" if cask_count.positive?
error_sources << "#{tap_count} #{"tap".pluralize(tap_count)}" if tap_count.positive?
error_sources = []
error_sources << "#{formula_count} #{"formula".pluralize(formula_count)}" if formula_count.positive?
error_sources << "#{cask_count} #{"cask".pluralize(cask_count)}" if cask_count.positive?
error_sources << "#{tap_count} #{"tap".pluralize(tap_count)}" if tap_count.positive?
errors_summary += " in #{error_sources.to_sentence}" if error_sources.any?
errors_summary += " in #{error_sources.to_sentence}" if error_sources.any?
errors_summary += " detected"
errors_summary += " detected"
if corrected_problem_count.positive?
errors_summary += ", #{corrected_problem_count} #{"problem".pluralize(corrected_problem_count)} corrected"
if corrected_problem_count.positive?
errors_summary += ", #{corrected_problem_count} #{"problem".pluralize(corrected_problem_count)} corrected"
end
ofail errors_summary
end
ofail errors_summary
return unless ENV["GITHUB_ACTIONS"]
annotations = formula_results.merge(cask_results).flat_map do |path, result|
(
result[:warnings].map { |w| [:warning, w] } +
result[:errors].map { |e| [:error, e] }
).map do |type, problem|
GitHub::Actions::Annotation.new(
type,
problem[:message],
file: path,
line: problem[:location]&.line,
column: problem[:location]&.column,
)
end
end
annotations.each do |annotation|
puts annotation if annotation.relevant?
end
end
def format_problem_lines(problems)

6
Library/Homebrew/test/cask/audit_spec.rb
View File

@ -4,11 +4,11 @@
require "cask/audit"
describe Cask::Audit, :cask do
def include_msg?(messages, msg)
def include_msg?(problems, msg)
if msg.is_a?(Regexp)
Array(messages).any? { |m| m =~ msg }
Array(problems).any? { |problem| problem[:message] =~ msg }
else
Array(messages).include?(msg)
Array(problems).any? { |problem| problem[:message] == msg }
end
end