andy/tinyUSB
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

add missing ceedling files

Browse Source
This commit is contained in:
hathach
2022-12-08 09:54:15 +07:00
parent 91d5fa5639
commit 4b50ca2a61
23 changed files with 1909 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

331
test/vendor/ceedling/plugins/gcov/lib/gcovr_reportinator.rb vendored Normal file
View File

@@ -0,0 +1,331 @@
require 'reportinator_helper'
class GcovrReportinator
def initialize(system_objects)
@ceedling = system_objects
@reportinator_helper = ReportinatorHelper.new
end
# Generate the gcovr report(s) specified in the options.
def make_reports(opts)
# Get the gcovr version number.
gcovr_version_info = get_gcovr_version()
# Build the common gcovr arguments.
args_common = args_builder_common(opts)
if ((gcovr_version_info[0] == 4) && (gcovr_version_info[1] >= 2)) || (gcovr_version_info[0] > 4)
# gcovr version 4.2 and later supports generating multiple reports with a single call.
args = args_common
args += args_builder_cobertura(opts, false)
args += args_builder_sonarqube(opts, false)
args += args_builder_json(opts, true)
# As of gcovr version 4.2, the --html argument must appear last.
args += args_builder_html(opts, false)
print "Creating gcov results report(s) in '#{GCOV_ARTIFACTS_PATH}'... "
STDOUT.flush
# Generate the report(s).
run(args)
else
# gcovr version 4.1 and earlier supports HTML and Cobertura XML reports.
# It does not support SonarQube and JSON reports.
# Reports must also be generated separately.
args_cobertura = args_builder_cobertura(opts, true)
args_html = args_builder_html(opts, true)
if args_html.length > 0
print "Creating a gcov HTML report in '#{GCOV_ARTIFACTS_PATH}'... "
STDOUT.flush
# Generate the HTML report.
run(args_common + args_html)
end
if args_cobertura.length > 0
print "Creating a gcov XML report in '#{GCOV_ARTIFACTS_PATH}'... "
STDOUT.flush
# Generate the Cobertura XML report.
run(args_common + args_cobertura)
end
end
# Determine if the gcovr text report is enabled. Defaults to disabled.
if is_report_enabled(opts, ReportTypes::TEXT)
make_text_report(opts, args_common)
end
end
def support_deprecated_options(opts)
# Support deprecated :html_report: and ":html_report_type: basic" options.
if !is_report_enabled(opts, ReportTypes::HTML_BASIC) && (opts[:gcov_html_report] || (opts[:gcov_html_report_type].is_a? String) && (opts[:gcov_html_report_type].casecmp("basic") == 0))
opts[:gcov_reports].push(ReportTypes::HTML_BASIC)
end
# Support deprecated ":html_report_type: detailed" option.
if !is_report_enabled(opts, ReportTypes::HTML_DETAILED) && (opts[:gcov_html_report_type].is_a? String) && (opts[:gcov_html_report_type].casecmp("detailed") == 0)
opts[:gcov_reports].push(ReportTypes::HTML_DETAILED)
end
# Support deprecated :xml_report: option.
if opts[:gcov_xml_report]
opts[:gcov_reports].push(ReportTypes::COBERTURA)
end
# Default to HTML basic report when no report types are defined.
if opts[:gcov_reports].empty? && opts[:gcov_html_report_type].nil? && opts[:gcov_xml_report].nil?
opts[:gcov_reports] = [ReportTypes::HTML_BASIC]
puts "In your project.yml, define one or more of the"
puts "following to specify which reports to generate."
puts "For now, creating only an #{ReportTypes::HTML_BASIC} report."
puts ""
puts ":gcov:"
puts " :reports:"
puts " - #{ReportTypes::HTML_BASIC}"
puts " - #{ReportTypes::HTML_DETAILED}"
puts " - #{ReportTypes::TEXT}"
puts " - #{ReportTypes::COBERTURA}"
puts " - #{ReportTypes::SONARQUBE}"
puts " - #{ReportTypes::JSON}"
puts ""
end
end
private
GCOVR_SETTING_PREFIX = "gcov_gcovr"
# Build the gcovr report generation common arguments.
def args_builder_common(opts)
gcovr_opts = get_opts(opts)
args = ""
args += "--root \"#{gcovr_opts[:report_root] || '.'}\" "
args += "--config \"#{gcovr_opts[:config_file]}\" " unless gcovr_opts[:config_file].nil?
args += "--filter \"#{gcovr_opts[:report_include]}\" " unless gcovr_opts[:report_include].nil?
args += "--exclude \"#{gcovr_opts[:report_exclude] || GCOV_FILTER_EXCLUDE}\" "
args += "--gcov-filter \"#{gcovr_opts[:gcov_filter]}\" " unless gcovr_opts[:gcov_filter].nil?
args += "--gcov-exclude \"#{gcovr_opts[:gcov_exclude]}\" " unless gcovr_opts[:gcov_exclude].nil?
args += "--exclude-directories \"#{gcovr_opts[:exclude_directories]}\" " unless gcovr_opts[:exclude_directories].nil?
args += "--branches " if gcovr_opts[:branches].nil? || gcovr_opts[:branches] # Defaults to enabled.
args += "--sort-uncovered " if gcovr_opts[:sort_uncovered]
args += "--sort-percentage " if gcovr_opts[:sort_percentage].nil? || gcovr_opts[:sort_percentage] # Defaults to enabled.
args += "--print-summary " if gcovr_opts[:print_summary]
args += "--gcov-executable \"#{gcovr_opts[:gcov_executable]}\" " unless gcovr_opts[:gcov_executable].nil?
args += "--exclude-unreachable-branches " if gcovr_opts[:exclude_unreachable_branches]
args += "--exclude-throw-branches " if gcovr_opts[:exclude_throw_branches]
args += "--use-gcov-files " if gcovr_opts[:use_gcov_files]
args += "--gcov-ignore-parse-errors " if gcovr_opts[:gcov_ignore_parse_errors]
args += "--keep " if gcovr_opts[:keep]
args += "--delete " if gcovr_opts[:delete]
args += "-j #{gcovr_opts[:num_parallel_threads]} " if !(gcovr_opts[:num_parallel_threads].nil?) && (gcovr_opts[:num_parallel_threads].is_a? Integer)
[:fail_under_line, :fail_under_branch, :source_encoding, :object_directory].each do |opt|
unless gcovr_opts[opt].nil?
value = gcovr_opts[opt]
if (opt == :fail_under_line) || (opt == :fail_under_branch)
if not value.is_a? Integer
puts "Option value #{opt} has to be an integer"
value = nil
elsif (value < 0) || (value > 100)
puts "Option value #{opt} has to be a percentage from 0 to 100"
value = nil
end
end
args += "--#{opt.to_s.gsub('_','-')} #{value} " unless value.nil?
end
end
return args
end
# Build the gcovr Cobertura XML report generation arguments.
def args_builder_cobertura(opts, use_output_option=false)
gcovr_opts = get_opts(opts)
args = ""
# Determine if the Cobertura XML report is enabled. Defaults to disabled.
if is_report_enabled(opts, ReportTypes::COBERTURA)
# Determine the Cobertura XML report file name.
artifacts_file_cobertura = GCOV_ARTIFACTS_FILE_COBERTURA
if !(gcovr_opts[:cobertura_artifact_filename].nil?)
artifacts_file_cobertura = File.join(GCOV_ARTIFACTS_PATH, gcovr_opts[:cobertura_artifact_filename])
elsif !(gcovr_opts[:xml_artifact_filename].nil?)
artifacts_file_cobertura = File.join(GCOV_ARTIFACTS_PATH, gcovr_opts[:xml_artifact_filename])
end
args += "--xml-pretty " if gcovr_opts[:xml_pretty] || gcovr_opts[:cobertura_pretty]
args += "--xml #{use_output_option ? "--output " : ""} \"#{artifacts_file_cobertura}\" "
end
return args
end
# Build the gcovr SonarQube report generation arguments.
def args_builder_sonarqube(opts, use_output_option=false)
gcovr_opts = get_opts(opts)
args = ""
# Determine if the gcovr SonarQube XML report is enabled. Defaults to disabled.
if is_report_enabled(opts, ReportTypes::SONARQUBE)
# Determine the SonarQube XML report file name.
artifacts_file_sonarqube = GCOV_ARTIFACTS_FILE_SONARQUBE
if !(gcovr_opts[:sonarqube_artifact_filename].nil?)
artifacts_file_sonarqube = File.join(GCOV_ARTIFACTS_PATH, gcovr_opts[:sonarqube_artifact_filename])
end
args += "--sonarqube #{use_output_option ? "--output " : ""} \"#{artifacts_file_sonarqube}\" "
end
return args
end
# Build the gcovr JSON report generation arguments.
def args_builder_json(opts, use_output_option=false)
gcovr_opts = get_opts(opts)
args = ""
# Determine if the gcovr JSON report is enabled. Defaults to disabled.
if is_report_enabled(opts, ReportTypes::JSON)
# Determine the JSON report file name.
artifacts_file_json = GCOV_ARTIFACTS_FILE_JSON
if !(gcovr_opts[:json_artifact_filename].nil?)
artifacts_file_json = File.join(GCOV_ARTIFACTS_PATH, gcovr_opts[:json_artifact_filename])
end
args += "--json-pretty " if gcovr_opts[:json_pretty]
# Note: In gcovr 4.2, the JSON report is output only when the --output option is specified.
# Hopefully we can remove --output after a future gcovr release.
args += "--json #{use_output_option ? "--output " : ""} \"#{artifacts_file_json}\" "
end
return args
end
# Build the gcovr HTML report generation arguments.
def args_builder_html(opts, use_output_option=false)
gcovr_opts = get_opts(opts)
args = ""
# Determine if the gcovr HTML report is enabled. Defaults to enabled.
html_enabled = (opts[:gcov_html_report].nil? && opts[:gcov_reports].empty?) ||
is_report_enabled(opts, ReportTypes::HTML_BASIC) ||
is_report_enabled(opts, ReportTypes::HTML_DETAILED)
if html_enabled
# Determine the HTML report file name.
artifacts_file_html = GCOV_ARTIFACTS_FILE_HTML
if !(gcovr_opts[:html_artifact_filename].nil?)
artifacts_file_html = File.join(GCOV_ARTIFACTS_PATH, gcovr_opts[:html_artifact_filename])
end
is_html_report_type_detailed = (opts[:gcov_html_report_type].is_a? String) && (opts[:gcov_html_report_type].casecmp("detailed") == 0)
args += "--html-details " if is_html_report_type_detailed || is_report_enabled(opts, ReportTypes::HTML_DETAILED)
args += "--html-title \"#{gcovr_opts[:html_title]}\" " unless gcovr_opts[:html_title].nil?
args += "--html-absolute-paths " if !(gcovr_opts[:html_absolute_paths].nil?) && gcovr_opts[:html_absolute_paths]
args += "--html-encoding \"#{gcovr_opts[:html_encoding]}\" " unless gcovr_opts[:html_encoding].nil?
[:html_medium_threshold, :html_high_threshold].each do |opt|
args += "--#{opt.to_s.gsub('_','-')} #{gcovr_opts[opt]} " unless gcovr_opts[opt].nil?
end
# The following option must be appended last for gcovr version <= 4.2 to properly work.
args += "--html #{use_output_option ? "--output " : ""} \"#{artifacts_file_html}\" "
end
return args
end
# Generate a gcovr text report.
def make_text_report(opts, args_common)
gcovr_opts = get_opts(opts)
args_text = ""
message_text = "Creating a gcov text report"
if !(gcovr_opts[:text_artifact_filename].nil?)
artifacts_file_txt = File.join(GCOV_ARTIFACTS_PATH, gcovr_opts[:text_artifact_filename])
args_text += "--output \"#{artifacts_file_txt}\" "
message_text += " in '#{GCOV_ARTIFACTS_PATH}'... "
else
message_text += "... "
end
print message_text
STDOUT.flush
# Generate the text report.
run(args_common + args_text)
end
# Get the gcovr options from the project options.
def get_opts(opts)
return opts[GCOVR_SETTING_PREFIX.to_sym] || {}
end
# Run gcovr with the given arguments.
def run(args)
begin
command = @ceedling[:tool_executor].build_command_line(TOOLS_GCOV_GCOVR_POST_REPORT, [], args)
shell_result = @ceedling[:tool_executor].exec(command[:line], command[:options])
@reportinator_helper.print_shell_result(shell_result)
rescue
# handle any unforeseen issues with called tool
exitcode = $?.exitstatus
show_gcovr_message(exitcode)
exit(exitcode)
end
end
# Get the gcovr version number as components.
# Returns [major, minor].
def get_gcovr_version()
version_number_major = 0
version_number_minor = 0
command = @ceedling[:tool_executor].build_command_line(TOOLS_GCOV_GCOVR_POST_REPORT, [], "--version")
shell_result = @ceedling[:tool_executor].exec(command[:line], command[:options])
version_number_match_data = shell_result[:output].match(/gcovr ([0-9]+)\.([0-9]+)/)
if !(version_number_match_data.nil?) && !(version_number_match_data[1].nil?) && !(version_number_match_data[2].nil?)
version_number_major = version_number_match_data[1].to_i
version_number_minor = version_number_match_data[2].to_i
end
return version_number_major, version_number_minor
end
# Show a more human-friendly message on gcovr return code
def show_gcovr_message(exitcode)
if ((exitcode & 2) == 2)
puts "The line coverage is less than the minimum"
end
if ((exitcode & 4) == 4)
puts "The branch coverage is less than the minimum"
end
end
# Returns true if the given report type is enabled, otherwise returns false.
def is_report_enabled(opts, report_type)
return !(opts.nil?) && !(opts[:gcov_reports].nil?) && (opts[:gcov_reports].map(&:upcase).include? report_type.upcase)
end
end

195
test/vendor/ceedling/plugins/gcov/lib/reportgenerator_reportinator.rb vendored Normal file
View File

@@ -0,0 +1,195 @@
require 'benchmark'
require 'reportinator_helper'
class ReportGeneratorReportinator
def initialize(system_objects)
@ceedling = system_objects
@reportinator_helper = ReportinatorHelper.new
end
# Generate the ReportGenerator report(s) specified in the options.
def make_reports(opts)
shell_result = nil
total_time = Benchmark.realtime do
rg_opts = get_opts(opts)
print "Creating gcov results report(s) with ReportGenerator in '#{GCOV_REPORT_GENERATOR_PATH}'... "
STDOUT.flush
# Cleanup any existing .gcov files to avoid reporting old coverage results.
for gcov_file in Dir.glob("*.gcov")
File.delete(gcov_file)
end
# Use a custom gcov executable, if specified.
GCOV_TOOL_CONFIG[:executable] = rg_opts[:gcov_executable] unless rg_opts[:gcov_executable].nil?
# Avoid running gcov on the mock, test, unity, and cexception gcov notes files to save time.
gcno_exclude_str = "#{opts[:cmock_mock_prefix]}.*"
gcno_exclude_str += "|#{opts[:project_test_file_prefix]}.*"
gcno_exclude_str += "|#{VENDORS_FILES.join('|')}"
# Avoid running gcov on custom specified .gcno files.
if !(rg_opts.nil?) && !(rg_opts[:gcov_exclude].nil?) && !(rg_opts[:gcov_exclude].empty?)
for gcno_exclude_expression in rg_opts[:gcov_exclude]
if !(gcno_exclude_expression.nil?) && !(gcno_exclude_expression.empty?)
# We want to filter .gcno files, not .gcov files.
# We will generate .gcov files from .gcno files.
gcno_exclude_expression = gcno_exclude_expression.chomp("\\.gcov")
gcno_exclude_expression = gcno_exclude_expression.chomp(".gcov")
# The .gcno extension will be added later as we create the regex.
gcno_exclude_expression = gcno_exclude_expression.chomp("\\.gcno")
gcno_exclude_expression = gcno_exclude_expression.chomp(".gcno")
# Append the custom expression.
gcno_exclude_str += "|#{gcno_exclude_expression}"
end
end
end
gcno_exclude_regex = /(\/|\\)(#{gcno_exclude_str})\.gcno/
# Generate .gcov files by running gcov on gcov notes files (*.gcno).
for gcno_filepath in Dir.glob(File.join(GCOV_BUILD_PATH, "**", "*.gcno"))
match_data = gcno_filepath.match(gcno_exclude_regex)
if match_data.nil? || (match_data[1].nil? && match_data[1].nil?)
# Ensure there is a matching gcov data file.
if File.file?(gcno_filepath.gsub(".gcno", ".gcda"))
run_gcov("\"#{gcno_filepath}\"")
end
end
end
if Dir.glob("*.gcov").length > 0
# Build the command line arguments.
args = args_builder(opts)
# Generate the report(s).
shell_result = run(args)
else
puts "\nWarning: No matching .gcno coverage files found."
end
# Cleanup .gcov files.
for gcov_file in Dir.glob("*.gcov")
File.delete(gcov_file)
end
end
if shell_result
shell_result[:time] = total_time
@reportinator_helper.print_shell_result(shell_result)
end
end
private
# A dictionary of report types defined in this plugin to ReportGenerator report types.
REPORT_TYPE_TO_REPORT_GENERATOR_REPORT_NAME = {
ReportTypes::HTML_BASIC.upcase => "HtmlSummary",
ReportTypes::HTML_DETAILED.upcase => "Html",
ReportTypes::HTML_CHART.upcase => "HtmlChart",
ReportTypes::HTML_INLINE.upcase => "HtmlInline",
ReportTypes::HTML_INLINE_AZURE.upcase => "HtmlInline_AzurePipelines",
ReportTypes::HTML_INLINE_AZURE_DARK.upcase => "HtmlInline_AzurePipelines_Dark",
ReportTypes::MHTML.upcase => "MHtml",
ReportTypes::TEXT.upcase => "TextSummary",
ReportTypes::COBERTURA.upcase => "Cobertura",
ReportTypes::SONARQUBE.upcase => "SonarQube",
ReportTypes::BADGES.upcase => "Badges",
ReportTypes::CSV_SUMMARY.upcase => "CsvSummary",
ReportTypes::LATEX.upcase => "Latex",
ReportTypes::LATEX_SUMMARY.upcase => "LatexSummary",
ReportTypes::PNG_CHART.upcase => "PngChart",
ReportTypes::TEAM_CITY_SUMMARY.upcase => "TeamCitySummary",
ReportTypes::LCOV.upcase => "lcov",
ReportTypes::XML.upcase => "Xml",
ReportTypes::XML_SUMMARY.upcase => "XmlSummary",
}
REPORT_GENERATOR_SETTING_PREFIX = "gcov_report_generator"
# Deep clone the gcov tool config, so we can modify it locally if specified via options.
GCOV_TOOL_CONFIG = Marshal.load(Marshal.dump(TOOLS_GCOV_GCOV_POST_REPORT))
# Build the ReportGenerator arguments.
def args_builder(opts)
rg_opts = get_opts(opts)
report_type_count = 0
args = ""
args += "\"-reports:*.gcov\" "
args += "\"-targetdir:\"#{GCOV_REPORT_GENERATOR_PATH}\"\" "
# Build the report types argument.
if !(opts.nil?) && !(opts[:gcov_reports].nil?) && !(opts[:gcov_reports].empty?)
args += "\"-reporttypes:"
for report_type in opts[:gcov_reports]
rg_report_type = REPORT_TYPE_TO_REPORT_GENERATOR_REPORT_NAME[report_type.upcase]
if !(rg_report_type.nil?)
args += rg_report_type + ";"
report_type_count = report_type_count + 1
end
end
# Removing trailing ';' after the last report type.
args = args.chomp(";")
# Append a space seperator after the report type.
args += "\" "
end
# Build the source directories argument.
args += "\"-sourcedirs:.;"
if !(opts[:collection_paths_source].nil?)
args += opts[:collection_paths_source].join(';')
end
args = args.chomp(";")
args += "\" "
args += "\"-historydir:#{rg_opts[:history_directory]}\" " unless rg_opts[:history_directory].nil?
args += "\"-plugins:#{rg_opts[:plugins]}\" " unless rg_opts[:plugins].nil?
args += "\"-assemblyfilters:#{rg_opts[:assembly_filters]}\" " unless rg_opts[:assembly_filters].nil?
args += "\"-classfilters:#{rg_opts[:class_filters]}\" " unless rg_opts[:class_filters].nil?
file_filters = rg_opts[:file_filters] || @ceedling[:tool_executor_helper].osify_path_separators(GCOV_REPORT_GENERATOR_FILE_FILTERS)
args += "\"-filefilters:#{file_filters}\" "
args += "\"-verbosity:#{rg_opts[:verbosity] || "Warning"}\" "
args += "\"-tag:#{rg_opts[:tag]}\" " unless rg_opts[:tag].nil?
args += "\"settings:createSubdirectoryForAllReportTypes=true\" " unless report_type_count <= 1
args += "\"settings:numberOfReportsParsedInParallel=#{rg_opts[:num_parallel_threads]}\" " unless rg_opts[:num_parallel_threads].nil?
args += "\"settings:numberOfReportsMergedInParallel=#{rg_opts[:num_parallel_threads]}\" " unless rg_opts[:num_parallel_threads].nil?
# Append custom arguments.
if !(rg_opts[:custom_args].nil?) && !(rg_opts[:custom_args].empty?)
for custom_arg in rg_opts[:custom_args]
args += "\"#{custom_arg}\" " unless custom_arg.nil? || custom_arg.empty?
end
end
return args
end
# Get the ReportGenerator options from the project options.
def get_opts(opts)
return opts[REPORT_GENERATOR_SETTING_PREFIX.to_sym] || {}
end
# Run ReportGenerator with the given arguments.
def run(args)
command = @ceedling[:tool_executor].build_command_line(TOOLS_GCOV_REPORTGENERATOR_POST_REPORT, [], args)
return @ceedling[:tool_executor].exec(command[:line], command[:options])
end
# Run gcov with the given arguments.
def run_gcov(args)
command = @ceedling[:tool_executor].build_command_line(GCOV_TOOL_CONFIG, [], args)
return @ceedling[:tool_executor].exec(command[:line], command[:options])
end
end

15
test/vendor/ceedling/plugins/gcov/lib/reportinator_helper.rb vendored Normal file
View File

@@ -0,0 +1,15 @@
class ReportinatorHelper
# Output the shell result to the console.
def print_shell_result(shell_result)
if !(shell_result.nil?)
puts "Done in %.3f seconds." % shell_result[:time]
if !(shell_result[:output].nil?) && (shell_result[:output].length > 0)
puts shell_result[:output]
end
end
end
end