ceedling 0.28.3 → 0.29.0

data/plugins/gcov/lib/gcov.rb

@@ -1,106 +1,113 @@
-require 'ceedling/plugin'
-require 'ceedling/constants'
-require 'gcov_constants'
-
-class Gcov < Plugin
-  attr_reader :config
-
-  def setup
-    @result_list = []
-
-    @config = {
-      project_test_build_output_path: GCOV_BUILD_OUTPUT_PATH,
-      project_test_build_output_c_path: GCOV_BUILD_OUTPUT_PATH,
-      project_test_results_path: GCOV_RESULTS_PATH,
-      project_test_dependencies_path: GCOV_DEPENDENCIES_PATH,
-      defines_test: DEFINES_TEST + ['CODE_COVERAGE'],
-      collection_defines_test_and_vendor: COLLECTION_DEFINES_TEST_AND_VENDOR + ['CODE_COVERAGE'],
-      gcov_html_report_filter: GCOV_FILTER_EXPR
-    }
-
-    @plugin_root = File.expand_path(File.join(File.dirname(__FILE__), '..'))
-    @coverage_template_all = @ceedling[:file_wrapper].read(File.join(@plugin_root, 'assets/template.erb'))
-  end
-
-  def generate_coverage_object_file(source, object)
-    compile_command =
-      @ceedling[:tool_executor].build_command_line(
-        TOOLS_GCOV_COMPILER,
-        @ceedling[:flaginator].flag_down(OPERATION_COMPILE_SYM, GCOV_SYM, source),
-        source,
-        object,
-        @ceedling[:file_path_utils].form_test_build_list_filepath(object)
-      )
-    @ceedling[:streaminator].stdout_puts("Compiling #{File.basename(source)} with coverage...")
-    @ceedling[:tool_executor].exec(compile_command[:line], compile_command[:options])
-  end
-
-  def post_test_fixture_execute(arg_hash)
-    result_file = arg_hash[:result_file]
-
-    if (result_file =~ /#{GCOV_RESULTS_PATH}/) && !@result_list.include?(result_file)
-      @result_list << arg_hash[:result_file]
-    end
-  end
-
-  def post_build
-    return unless @ceedling[:task_invoker].invoked?(/^#{GCOV_TASK_ROOT}/)
-
-    # test results
-    results = @ceedling[:plugin_reportinator].assemble_test_results(@result_list)
-    hash = {
-      header: GCOV_ROOT_NAME.upcase,
-      results: results
-    }
-
-    @ceedling[:plugin_reportinator].run_test_results_report(hash) do
-      message = ''
-      message = 'Unit test failures.' if results[:counts][:failed] > 0
-      message
-    end
-
-    report_per_file_coverage_results(@ceedling[:test_invoker].sources)
-  end
-
-  def summary
-    result_list = @ceedling[:file_path_utils].form_pass_results_filelist(GCOV_RESULTS_PATH, COLLECTION_ALL_TESTS)
-
-    # test results
-    # get test results for only those tests in our configuration and of those only tests with results on disk
-    hash = {
-      header: GCOV_ROOT_NAME.upcase,
-      results: @ceedling[:plugin_reportinator].assemble_test_results(result_list, boom: false)
-    }
-
-    @ceedling[:plugin_reportinator].run_test_results_report(hash)
-  end
-
-  private ###################################
-
-  def report_per_file_coverage_results(sources)
-    banner = @ceedling[:plugin_reportinator].generate_banner "#{GCOV_ROOT_NAME.upcase}: CODE COVERAGE SUMMARY"
-    @ceedling[:streaminator].stdout_puts "\n" + banner
-
-    coverage_sources = sources.clone
-    coverage_sources.delete_if { |item| item =~ /#{CMOCK_MOCK_PREFIX}.+#{EXTENSION_SOURCE}$/ }
-    coverage_sources.delete_if { |item| item =~ /#{GCOV_IGNORE_SOURCES.join('|')}#{EXTENSION_SOURCE}$/ }
-
-    coverage_sources.each do |source|
-      basename         = File.basename(source)
-      command          = @ceedling[:tool_executor].build_command_line(TOOLS_GCOV_REPORT, [], [basename])
-      shell_results    = @ceedling[:tool_executor].exec(command[:line], command[:options])
-      coverage_results = shell_results[:output]
-
-      if coverage_results.strip =~ /(File\s+'#{Regexp.escape(source)}'.+$)/m
-        report = Regexp.last_match(1).lines.to_a[1..-1].map { |line| basename + ' ' + line }.join('')
-        @ceedling[:streaminator].stdout_puts(report + "\n\n")
-      end
-    end
-  end
-end
-
-# end blocks always executed following rake run
-END {
-  # cache our input configurations to use in comparison upon next execution
-  @ceedling[:cacheinator].cache_test_config(@ceedling[:setupinator].config_hash) if @ceedling[:task_invoker].invoked?(/^#{GCOV_TASK_ROOT}/)
-}
+require 'ceedling/plugin'
+require 'ceedling/constants'
+require 'gcov_constants'
+
+class Gcov < Plugin
+  attr_reader :config
+
+  def setup
+    @result_list = []
+
+    @config = {
+      project_test_build_output_path: GCOV_BUILD_OUTPUT_PATH,
+      project_test_build_output_c_path: GCOV_BUILD_OUTPUT_PATH,
+      project_test_results_path: GCOV_RESULTS_PATH,
+      project_test_dependencies_path: GCOV_DEPENDENCIES_PATH,
+      defines_test: DEFINES_TEST + ['CODE_COVERAGE'],
+      gcov_html_report_filter: GCOV_FILTER_EXCLUDE
+    }
+
+    @plugin_root = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+    @coverage_template_all = @ceedling[:file_wrapper].read(File.join(@plugin_root, 'assets/template.erb'))
+  end
+
+  def generate_coverage_object_file(source, object)
+    lib_args = @ceedling[:test_invoker].convert_libraries_to_arguments()
+    compile_command =
+      @ceedling[:tool_executor].build_command_line(
+        TOOLS_GCOV_COMPILER,
+        @ceedling[:flaginator].flag_down(OPERATION_COMPILE_SYM, GCOV_SYM, source),
+        source,
+        object,
+        @ceedling[:file_path_utils].form_test_build_list_filepath(object),
+        lib_args
+      )
+    @ceedling[:streaminator].stdout_puts("Compiling #{File.basename(source)} with coverage...")
+    @ceedling[:tool_executor].exec(compile_command[:line], compile_command[:options])
+  end
+
+  def post_test_fixture_execute(arg_hash)
+    result_file = arg_hash[:result_file]
+
+    if (result_file =~ /#{GCOV_RESULTS_PATH}/) && !@result_list.include?(result_file)
+      @result_list << arg_hash[:result_file]
+    end
+  end
+
+  def post_build
+    return unless @ceedling[:task_invoker].invoked?(/^#{GCOV_TASK_ROOT}/)
+
+    # test results
+    results = @ceedling[:plugin_reportinator].assemble_test_results(@result_list)
+    hash = {
+      header: GCOV_ROOT_NAME.upcase,
+      results: results
+    }
+
+    @ceedling[:plugin_reportinator].run_test_results_report(hash) do
+      message = ''
+      message = 'Unit test failures.' if results[:counts][:failed] > 0
+      message
+    end
+
+    report_per_file_coverage_results(@ceedling[:test_invoker].sources)
+  end
+
+  def summary
+    result_list = @ceedling[:file_path_utils].form_pass_results_filelist(GCOV_RESULTS_PATH, COLLECTION_ALL_TESTS)
+
+    # test results
+    # get test results for only those tests in our configuration and of those only tests with results on disk
+    hash = {
+      header: GCOV_ROOT_NAME.upcase,
+      results: @ceedling[:plugin_reportinator].assemble_test_results(result_list, boom: false)
+    }
+
+    @ceedling[:plugin_reportinator].run_test_results_report(hash)
+  end
+
+  private ###################################
+
+  def report_per_file_coverage_results(sources)
+    banner = @ceedling[:plugin_reportinator].generate_banner "#{GCOV_ROOT_NAME.upcase}: CODE COVERAGE SUMMARY"
+    @ceedling[:streaminator].stdout_puts "\n" + banner
+
+    coverage_sources = sources.clone
+    coverage_sources.delete_if { |item| item =~ /#{CMOCK_MOCK_PREFIX}.+#{EXTENSION_SOURCE}$/ }
+    coverage_sources.delete_if { |item| item =~ /#{GCOV_IGNORE_SOURCES.join('|')}#{EXTENSION_SOURCE}$/ }
+
+    coverage_sources.each do |source|
+      basename         = File.basename(source)
+      command          = @ceedling[:tool_executor].build_command_line(TOOLS_GCOV_REPORT, [], [basename])
+      shell_results    = @ceedling[:tool_executor].exec(command[:line], command[:options])
+      coverage_results = shell_results[:output]
+
+      if coverage_results.strip =~ /(File\s+'#{Regexp.escape(source)}'.+$)/m
+        report = Regexp.last_match(1).lines.to_a[1..-1].map { |line| basename + ' ' + line }.join('')
+        @ceedling[:streaminator].stdout_puts(report + "\n\n")
+      end
+    end
+
+    COLLECTION_ALL_SOURCE.each do |source|
+      unless coverage_sources.include?(source)
+        @ceedling[:streaminator].stdout_puts("Could not find coverage results for " + source + "\n")
+      end
+    end
+  end
+end
+
+# end blocks always executed following rake run
+END {
+  # cache our input configurations to use in comparison upon next execution
+  @ceedling[:cacheinator].cache_test_config(@ceedling[:setupinator].config_hash) if @ceedling[:task_invoker].invoked?(/^#{GCOV_TASK_ROOT}/)
+}

data/plugins/gcov/lib/gcov_constants.rb

@@ -1,18 +1,19 @@
-
-GCOV_ROOT_NAME         = 'gcov'.freeze
-GCOV_TASK_ROOT         = GCOV_ROOT_NAME + ':'
-GCOV_SYM               = GCOV_ROOT_NAME.to_sym
-
-GCOV_BUILD_PATH        = File.join(PROJECT_BUILD_ROOT, GCOV_ROOT_NAME)
-GCOV_BUILD_OUTPUT_PATH = File.join(GCOV_BUILD_PATH, "out")
-GCOV_RESULTS_PATH      = File.join(GCOV_BUILD_PATH, "results")
-GCOV_DEPENDENCIES_PATH = File.join(GCOV_BUILD_PATH, "dependencies")
-GCOV_ARTIFACTS_PATH    = File.join(PROJECT_BUILD_ARTIFACTS_ROOT, GCOV_ROOT_NAME)
-
-GCOV_ARTIFACTS_FILE    = File.join(GCOV_ARTIFACTS_PATH, "GcovCoverageResults.html")
-
-GCOV_IGNORE_SOURCES    = %w(unity cmock cexception).freeze
-
-GCOV_FILTER_EXPR       = '^vendor.*|^build.*|^test.*|^lib.*'
-
-
+
+GCOV_ROOT_NAME         = 'gcov'.freeze
+GCOV_TASK_ROOT         = GCOV_ROOT_NAME + ':'
+GCOV_SYM               = GCOV_ROOT_NAME.to_sym
+
+GCOV_BUILD_PATH        = File.join(PROJECT_BUILD_ROOT, GCOV_ROOT_NAME)
+GCOV_BUILD_OUTPUT_PATH = File.join(GCOV_BUILD_PATH, "out")
+GCOV_RESULTS_PATH      = File.join(GCOV_BUILD_PATH, "results")
+GCOV_DEPENDENCIES_PATH = File.join(GCOV_BUILD_PATH, "dependencies")
+GCOV_ARTIFACTS_PATH    = File.join(PROJECT_BUILD_ARTIFACTS_ROOT, GCOV_ROOT_NAME)
+
+GCOV_ARTIFACTS_FILE    = File.join(GCOV_ARTIFACTS_PATH, "GcovCoverageResults.html")
+GCOV_ARTIFACTS_FILE_XML    = File.join(GCOV_ARTIFACTS_PATH, "GcovCoverageResults.xml")
+
+GCOV_IGNORE_SOURCES    = %w(unity cmock cexception).freeze
+
+GCOV_FILTER_EXCLUDE    = '^vendor.*|^build.*|^test.*|^lib.*'
+
+

data/plugins/junit_tests_report/README.md

@@ -0,0 +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
+```

data/plugins/junit_tests_report/lib/junit_tests_report.rb

@@ -1,118 +1,129 @@
-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])
-      file_path = File.join( PROJECT_BUILD_ARTIFACTS_ROOT, context.to_s, 'report.xml' )
-
-      @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{|line| stream.puts line }
-      stream.puts('    </system-out>')
-    end
-
-    stream.puts('  </testsuite>')
-  end
-
-  def write_test( test, stream )
-    case test[:result]
-    when :success
-      stream.puts('    <testcase name="%<test>s" />' % test)
-    when :failed
-      stream.puts('    <testcase name="%<test>s">' % 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">' % 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!('"', '&quot;')
+    case test[:result]
+    when :success
+      stream.puts('    <testcase name="%<test>s" />' % test)
+    when :failed
+      stream.puts('    <testcase name="%<test>s">' % 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">' % test)
+      stream.puts('      <skipped />')
+      stream.puts('    </testcase>')
+    end
+  end
+end