ceedling 0.29.1 → 0.30.0

data/plugins/gcov/lib/reportgenerator_reportinator.rb

@@ -0,0 +1,153 @@
+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
+
+      # Avoid running gcov on the mock, test, unity, and cexception gcov notes files to save time.
+      gcno_exclude_regex = /(\/|\\)(#{opts[:cmock_mock_prefix]}.*|#{opts[:project_test_file_prefix]}.*|#{VENDORS_FILES.join('|')})\.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?)
+          run_gcov("-b -c -r -x \"#{gcno_filepath}\"")
+        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"
+
+  # Build the ReportGenerator arguments.
+  def args_builder(opts)
+    rg_opts = get_opts(opts)
+
+    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 + ";"
+        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?
+
+    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_REPORT_GENERATOR_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(TOOLS_GCOV_GCOV_POST_REPORT, [], args)
+    return @ceedling[:tool_executor].exec(command[:line], command[:options])
+  end
+
+end

data/plugins/gcov/lib/reportinator_helper.rb

@@ -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

data/plugins/json_tests_report/README.md

@@ -0,0 +1,36 @@
+json_tests_report
+=================
+
+## Overview
+
+The json_tests_report plugin creates a JSON file of test results, which is 
+handy for Continuous Integration build servers or as input into other 
+reporting tools. The JSON file is output to the appropriate
+`<build_root>/artifacts/` directory (e.g. `artifacts/test/` for test tasks,
+`artifacts/gcov/` for gcov, or `artifacts/bullseye/` for bullseye runs).
+
+## Setup
+
+Enable the plugin in your project.yml by adding `json_tests_report` to the list
+of enabled plugins.
+
+``` YAML
+:plugins:
+  :enabled:
+    - json_tests_report
+```
+
+## Configuration
+
+Optionally configure the output / artifact filename in your project.yml with
+the `artifact_filename` configuration option. The default filename is
+`report.json`.
+
+You can also configure the path that this artifact is stored. This can be done
+by setting `path`. The default is that it will be placed in a subfolder under
+the `build` directory.
+
+``` YAML
+:json_tests_report:
+  :artifact_filename: report_spectuluarly.json
+```

data/plugins/json_tests_report/lib/json_tests_report.rb

@@ -0,0 +1,83 @@
+require 'ceedling/plugin'
+require 'ceedling/constants'
+require 'json'
+
+class JsonTestsReport < Plugin
+  def setup
+    @results_list = {}
+    @test_counter = 0
+  end
+
+  def post_test_fixture_execute(arg_hash)
+    context = arg_hash[:context]
+
+    @results_list[context] = [] if @results_list[context].nil?
+
+    @results_list[context] << arg_hash[:result_file]
+  end
+
+  def post_build
+    @results_list.each_key do |context|
+      results = @ceedling[:plugin_reportinator].assemble_test_results(@results_list[context])
+
+      artifact_filename = @ceedling[:configurator].project_config_hash[:json_tests_report_artifact_filename] || 'report.json'
+      artifact_fullpath = @ceedling[:configurator].project_config_hash[:json_tests_report_path] || File.join(PROJECT_BUILD_ARTIFACTS_ROOT, context.to_s)
+      file_path = File.join(artifact_fullpath, artifact_filename)
+
+      @ceedling[:file_wrapper].open(file_path, 'w') do |f|
+        @test_counter = 1
+
+        json = {
+          "FailedTests" => write_failures(results[:failures]),
+          "PassedTests" => write_tests(results[:successes]),
+          "IgnoredTests" => write_tests(results[:ignores]),
+          "Summary" => write_statistics(results[:counts])
+        }
+        
+        f << JSON.pretty_generate(json)
+      end
+    end
+  end
+
+  private
+
+  def write_failures(results)
+    retval = []
+    results.each do |result|
+      result[:collection].each do |item|
+        @test_counter += 1
+        retval << {
+          "file" => File.join(result[:source][:path], result[:source][:file]),
+          "test" => item[:test],
+          "line" => item[:line],
+          "message" => item[:message]
+        }
+      end
+    end
+    return retval.uniq
+  end
+
+  def write_tests(results)
+    retval = []
+    results.each do |result|
+      result[:collection].each do |item|
+        @test_counter += 1
+        retval << { 
+          "file" => File.join(result[:source][:path], result[:source][:file]),
+          "test" => item[:test]
+        }
+      end
+    end
+    return retval
+  end
+
+  def write_statistics(counts)
+    return {
+      "total_tests" => counts[:total],
+      "passed" => (counts[:total] - counts[:ignored] - counts[:failed]),
+      "ignored" => counts[:ignored],
+      "failures" => counts[:failed]
+    }
+  end
+
+end

data/plugins/junit_tests_report/README.md

@@ -1,36 +1,36 @@
-junit_tests_report
-====================
-
-## Overview
-
-The junit_tests_report plugin creates an XML file of test results in JUnit
-format, which is handy for Continuous Integration build servers or as input
-into other reporting tools. The XML file is output to the appropriate
-`<build_root>/artifacts/` directory (e.g. `artifacts/test/` for test tasks,
-`artifacts/gcov/` for gcov, or `artifacts/bullseye/` for bullseye runs).
-
-## Setup
-
-Enable the plugin in your project.yml by adding `junit_tests_report`
-to the list of enabled plugins.
-
-``` YAML
-:plugins:
-  :enabled:
-    - junit_tests_report
-```
-
-## Configuration
-
-Optionally configure the output / artifact filename in your project.yml with
-the `artifact_filename` configuration option. The default filename is
-`report.xml`.
-
-You can also configure the path that this artifact is stored. This can be done
-by setting `path`. The default is that it will be placed in a subfolder under
-the `build` directory.
-
-``` YAML
-:junit_tests_report:
-  :artifact_filename: report_junit.xml
-```
+junit_tests_report
+====================
+
+## Overview
+
+The junit_tests_report plugin creates an XML file of test results in JUnit
+format, which is handy for Continuous Integration build servers or as input
+into other reporting tools. The XML file is output to the appropriate
+`<build_root>/artifacts/` directory (e.g. `artifacts/test/` for test tasks,
+`artifacts/gcov/` for gcov, or `artifacts/bullseye/` for bullseye runs).
+
+## Setup
+
+Enable the plugin in your project.yml by adding `junit_tests_report`
+to the list of enabled plugins.
+
+``` YAML
+:plugins:
+  :enabled:
+    - junit_tests_report
+```
+
+## Configuration
+
+Optionally configure the output / artifact filename in your project.yml with
+the `artifact_filename` configuration option. The default filename is
+`report.xml`.
+
+You can also configure the path that this artifact is stored. This can be done
+by setting `path`. The default is that it will be placed in a subfolder under
+the `build` directory.
+
+``` YAML
+:junit_tests_report:
+  :artifact_filename: report_junit.xml
+```

data/plugins/junit_tests_report/lib/junit_tests_report.rb

@@ -1,130 +1,134 @@
-require 'ceedling/plugin'
-require 'ceedling/constants'
-
-class JunitTestsReport < Plugin
-
-  def setup
-    @results_list = {}
-    @test_counter = 0
-    @time_result = []
-  end
-
-  def post_test_fixture_execute(arg_hash)
-    context = arg_hash[:context]
-
-    @results_list[context] = [] if (@results_list[context].nil?)
-
-    @results_list[context] << arg_hash[:result_file]
-    @time_result << arg_hash[:shell_result][:time]
-
-  end
-
-  def post_build
-    @results_list.each_key do |context|
-      results = @ceedling[:plugin_reportinator].assemble_test_results(@results_list[context])
-
-      artifact_filename = @ceedling[:configurator].project_config_hash[:junit_tests_report_artifact_filename] || 'report.xml'
-      artifact_fullpath = @ceedling[:configurator].project_config_hash[:junit_tests_report_path] || File.join(PROJECT_BUILD_ARTIFACTS_ROOT, context.to_s)
-      file_path = File.join(artifact_fullpath, artifact_filename)
-
-      @ceedling[:file_wrapper].open( file_path, 'w' ) do |f|
-        @testsuite_counter = 0
-        @testcase_counter = 0
-        suites = reorganise_results( results )
-
-        write_header( results, f )
-        suites.each{|suite| write_suite( suite, f ) }
-        write_footer( f )
-      end
-    end
-  end
-
-  private
-
-  def write_header( results, stream )
-    results[:counts][:time] = @time_result.reduce(0, :+)
-    stream.puts '<?xml version="1.0" encoding="utf-8" ?>'
-    stream.puts('<testsuites tests="%<total>d" failures="%<failed>d" skipped="%<ignored>d" time="%<time>f">' % results[:counts])
-  end
-
-  def write_footer( stream )
-    stream.puts '</testsuites>'
-  end
-
-  def reorganise_results( results )
-    # Reorganise the output by test suite instead of by result
-    suites = Hash.new{ |h,k| h[k] = {collection: [], total: 0, success: 0, failed: 0, ignored: 0, stdout: []} }
-    results[:successes].each do |result|
-      source = result[:source]
-      name = source[:file].sub(/\..{1,4}$/, "")
-      suites[name][:collection] += result[:collection].map{|test| test.merge(result: :success)}
-      suites[name][:total] += result[:collection].length
-      suites[name][:success] += result[:collection].length
-    end
-    results[:failures].each do |result|
-      source = result[:source]
-      name = source[:file].sub(/\..{1,4}$/, "")
-      suites[name][:collection] += result[:collection].map{|test| test.merge(result: :failed)}
-      suites[name][:total] += result[:collection].length
-      suites[name][:failed] += result[:collection].length
-    end
-    results[:ignores].each do |result|
-      source = result[:source]
-      name = source[:file].sub(/\..{1,4}$/, "")
-      suites[name][:collection] += result[:collection].map{|test| test.merge(result: :ignored)}
-      suites[name][:total] += result[:collection].length
-      suites[name][:ignored] += result[:collection].length
-    end
-    results[:stdout].each do |result|
-      source = result[:source]
-      name = source[:file].sub(/\..{1,4}$/, "")
-      suites[name][:stdout] += result[:collection]
-    end
-    suites.map{|name, data| data.merge(name: name) }
-  end
-
-  def write_suite( suite, stream )
-    suite[:time] = @time_result.shift
-    stream.puts('  <testsuite name="%<name>s" tests="%<total>d" failures="%<failed>d" skipped="%<ignored>d" time="%<time>f">' % suite)
-
-    suite[:collection].each do |test|
-      write_test( test, stream )
-    end
-
-    unless suite[:stdout].empty?
-      stream.puts('    <system-out>')
-      suite[:stdout].each do |line|
-        line.gsub!(/&/, '&amp;')
-        line.gsub!(/</, '&lt;')
-        line.gsub!(/>/, '&gt;')
-        line.gsub!(/"/, '&quot;')
-        line.gsub!(/'/, '&apos;')
-        stream.puts(line)
-      end
-      stream.puts('    </system-out>')
-    end
-
-    stream.puts('  </testsuite>')
-  end
-
-  def write_test( test, stream )
-    test[:test].gsub!('"', '&quot;')
-    pp test
-    case test[:result]
-    when :success
-      stream.puts('    <testcase name="%<test>s" time="%<unity_test_time>f"/>' % test)
-    when :failed
-      stream.puts('    <testcase name="%<test>s" time="%<unity_test_time>f">' % test)
-      if test[:message].empty?
-        stream.puts('      <failure />')
-      else
-        stream.puts('      <failure message="%s" />' % test[:message])
-      end
-      stream.puts('    </testcase>')
-    when :ignored
-      stream.puts('    <testcase name="%<test>s" time="%<unity_test_time>f">' % test)
-      stream.puts('      <skipped />')
-      stream.puts('    </testcase>')
-    end
-  end
-end
+require 'ceedling/plugin'
+require 'ceedling/constants'
+
+class JunitTestsReport < Plugin
+
+  def setup
+    @results_list = {}
+    @test_counter = 0
+    @time_result = []
+  end
+
+  def post_test_fixture_execute(arg_hash)
+    context = arg_hash[:context]
+
+    @results_list[context] = [] if (@results_list[context].nil?)
+
+    @results_list[context] << arg_hash[:result_file]
+    @time_result << arg_hash[:shell_result][:time]
+
+  end
+
+  def post_build
+    @results_list.each_key do |context|
+      results = @ceedling[:plugin_reportinator].assemble_test_results(@results_list[context])
+
+      artifact_filename = @ceedling[:configurator].project_config_hash[:junit_tests_report_artifact_filename] || 'report.xml'
+      artifact_fullpath = @ceedling[:configurator].project_config_hash[:junit_tests_report_path] || File.join(PROJECT_BUILD_ARTIFACTS_ROOT, context.to_s)
+      file_path = File.join(artifact_fullpath, artifact_filename)
+
+      @ceedling[:file_wrapper].open( file_path, 'w' ) do |f|
+        @testsuite_counter = 0
+        @testcase_counter = 0
+        suites = reorganise_results( results )
+
+        write_header( results, f )
+        suites.each{|suite| write_suite( suite, f ) }
+        write_footer( f )
+      end
+    end
+  end
+
+  private
+
+  def write_header( results, stream )
+    results[:counts][:time] = @time_result.reduce(0, :+)
+    stream.puts '<?xml version="1.0" encoding="utf-8" ?>'
+    stream.puts('<testsuites tests="%<total>d" failures="%<failed>d" skipped="%<ignored>d" time="%<time>f">' % results[:counts])
+  end
+
+  def write_footer( stream )
+    stream.puts '</testsuites>'
+  end
+
+  def reorganise_results( results )
+    # Reorganise the output by test suite instead of by result
+    suites = Hash.new{ |h,k| h[k] = {collection: [], total: 0, success: 0, failed: 0, ignored: 0, stdout: []} }
+    results[:successes].each do |result|
+      source = result[:source]
+      name = source[:file].sub(/\..{1,4}$/, "")
+      suites[name][:collection] += result[:collection].map{|test| test.merge(result: :success)}
+      suites[name][:total] += result[:collection].length
+      suites[name][:success] += result[:collection].length
+    end
+    results[:failures].each do |result|
+      source = result[:source]
+      name = source[:file].sub(/\..{1,4}$/, "")
+      suites[name][:collection] += result[:collection].map{|test| test.merge(result: :failed)}
+      suites[name][:total] += result[:collection].length
+      suites[name][:failed] += result[:collection].length
+    end
+    results[:ignores].each do |result|
+      source = result[:source]
+      name = source[:file].sub(/\..{1,4}$/, "")
+      suites[name][:collection] += result[:collection].map{|test| test.merge(result: :ignored)}
+      suites[name][:total] += result[:collection].length
+      suites[name][:ignored] += result[:collection].length
+    end
+    results[:stdout].each do |result|
+      source = result[:source]
+      name = source[:file].sub(/\..{1,4}$/, "")
+      suites[name][:stdout] += result[:collection]
+    end
+    suites.map{|name, data| data.merge(name: name) }
+  end
+
+  def write_suite( suite, stream )
+    suite[:time] = @time_result.shift
+    stream.puts('  <testsuite name="%<name>s" tests="%<total>d" failures="%<failed>d" skipped="%<ignored>d" time="%<time>f">' % suite)
+
+    suite[:collection].each do |test|
+      write_test( test, stream )
+    end
+
+    unless suite[:stdout].empty?
+      stream.puts('    <system-out>')
+      suite[:stdout].each do |line|
+        line.gsub!(/&/, '&amp;')
+        line.gsub!(/</, '&lt;')
+        line.gsub!(/>/, '&gt;')
+        line.gsub!(/"/, '&quot;')
+        line.gsub!(/'/, '&apos;')
+        stream.puts(line)
+      end
+      stream.puts('    </system-out>')
+    end
+
+    stream.puts('  </testsuite>')
+  end
+
+  def write_test( test, stream )
+    test[:test].gsub!(/&/, '&amp;')
+    test[:test].gsub!(/</, '&lt;')
+    test[:test].gsub!(/>/, '&gt;')
+    test[:test].gsub!(/"/, '&quot;')
+    test[:test].gsub!(/'/, '&apos;')
+
+    case test[:result]
+    when :success
+      stream.puts('    <testcase name="%<test>s" time="%<unity_test_time>f"/>' % test)
+    when :failed
+      stream.puts('    <testcase name="%<test>s" time="%<unity_test_time>f">' % test)
+      if test[:message].empty?
+        stream.puts('      <failure />')
+      else
+        stream.puts('      <failure message="%s" />' % test[:message])
+      end
+      stream.puts('    </testcase>')
+    when :ignored
+      stream.puts('    <testcase name="%<test>s" time="%<unity_test_time>f">' % test)
+      stream.puts('      <skipped />')
+      stream.puts('    </testcase>')
+    end
+  end
+end