Class: Brakeman::Report::Github

Inherits:
Base
  • Object
show all
Defined in:
lib/brakeman/report/report_github.rb

Overview

Github Actions Formatter Formats warnings as workflow commands to create annotations in GitHub UI

Constant Summary

Constants included from Util

Util::ALL_COOKIES, Util::ALL_PARAMETERS, Util::COOKIES, Util::COOKIES_SEXP, Util::DIR_CONST, Util::LITERALS, Util::PARAMETERS, Util::PARAMS_SEXP, Util::PATH_PARAMETERS, Util::QUERY_PARAMETERS, Util::REQUEST_COOKIES, Util::REQUEST_ENV, Util::REQUEST_PARAMETERS, Util::REQUEST_PARAMS, Util::REQUEST_REQUEST_PARAMETERS, Util::SAFE_LITERAL, Util::SESSION, Util::SESSION_SEXP, Util::SIMPLE_LITERALS

Instance Attribute Summary

Attributes inherited from Base

#checks, #tracker

Instance Method Summary collapse

Methods inherited from Base

#absolute_paths?, #all_warnings, #context_for, #controller_information, #controller_warnings, #filter_warnings, #generic_warnings, #github_url, #ignored_warnings, #initialize, #model_warnings, #number_of_templates, #rails_version, #template_warnings, #warning_file, #warnings_summary

Methods included from Util

#all_literals?, #array?, #block?, #call?, #camelize, #class_name, #constant?, #contains_class?, #cookies?, #dir_glob?, #false?, #hash?, #hash_access, #hash_insert, #hash_iterate, #hash_values, #integer?, #kwsplat?, #literal?, #make_call, #node_type?, #number?, #params?, #pluralize, #rails_version, #recurse_check?, #regexp?, #remove_kwsplat, #request_env?, #request_value?, #result?, #safe_literal, #safe_literal?, #safe_literal_target?, #set_env_defaults, #sexp?, #simple_literal?, #string?, #string_interp?, #symbol?, #template_path_to_name, #true?, #underscore

Constructor Details

This class inherits a constructor from Brakeman::Report::Base

Instance Method Details

#errors ⇒ Object 



14
15
16
17
18
19
20
21
22
23
24
 
# File 'lib/brakeman/report/report_github.rb', line 14

def errors
  tracker.errors.map do |error|
    if error[:exception].is_a?(Racc::ParseError)
      # app/services/balance.rb:4 :: parse error on value "..." (tDOT3)
      file, line = error[:exception].message.split(':').map(&:strip)[0,2]
      "::error file=#{file},line=#{line}::#{clean_message(error[:error])}"
    else
      "::error ::#{clean_message(error[:error])}"
    end
  end
end

#generate_report ⇒ Object 



4
5
6
7
 
# File 'lib/brakeman/report/report_github.rb', line 4

def generate_report
  # @see https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-a-warning-message
  errors.concat(warnings).join("\n")
end

#warnings ⇒ Object 



9
10
11
12
 
# File 'lib/brakeman/report/report_github.rb', line 9

def warnings
  all_warnings
    .map { |warning| "::warning file=#{warning_file(warning)},line=#{warning.line}::#{warning.message}" }
end