ceedling 0.28.3 → 0.29.0

data/plugins/teamcity_tests_report/config/teamcity_tests_report.yml

@@ -1,4 +1,4 @@
----
-:plugins:
-  # tell Ceedling we got results display taken care of
-  :display_raw_test_results: FALSE
+---
+:plugins:
+  # tell Ceedling we got results display taken care of
+  :display_raw_test_results: FALSE

data/plugins/teamcity_tests_report/lib/teamcity_tests_report.rb

@@ -1,57 +1,57 @@
-require 'ceedling/plugin'
-require 'ceedling/defaults'
-
-class TeamcityTestsReport < Plugin
-
-  def setup
-    @suite_started = nil
-    @output_enabled = !defined?(TEAMCITY_BUILD) || TEAMCITY_BUILD
-  end
-
-  def escape(string)
-    string.gsub(/['|\[\]]/, '|\0').gsub('\r', '|r').gsub('\n', '|n')
-  end
-
-  def pre_test(test)
-    teamcity_message "testSuiteStarted name='#{File.basename(test, '.c')}'"
-    @suite_started = Time.now
-  end
-
-  def post_test(test)
-    teamcity_message "testSuiteFinished name='#{File.basename(test, '.c')}'"
-  end
-
-  def post_test_fixture_execute(arg_hash)
-    duration = (Time.now - @suite_started) * 1000
-    results = @ceedling[:plugin_reportinator].assemble_test_results([arg_hash[:result_file]])
-    avg_duration = (duration / [1, results[:counts][:passed] + results[:counts][:failed]].max).round
-
-    results[:successes].each do |success|
-      success[:collection].each do |test|
-        teamcity_message "testStarted name='#{test[:test]}'"
-        teamcity_message "testFinished name='#{test[:test]}' duration='#{avg_duration}'"
-      end
-    end
-
-    results[:failures].each do |failure|
-      failure[:collection].each do |test|
-        teamcity_message "testStarted name='#{test[:test]}'"
-        teamcity_message "testFailed name='#{test[:test]}' message='#{escape(test[:message])}' details='File: #{failure[:source][:path]}/#{failure[:source][:file]} Line: #{test[:line]}'"
-        teamcity_message "testFinished name='#{test[:test]}' duration='#{avg_duration}'"
-      end
-    end
-
-    results[:ignores].each do |failure|
-      failure[:collection].each do |test|
-        teamcity_message "testIgnored name='#{test[:test]}' message='#{escape(test[:message])}'"
-      end
-    end
-
-    # We ignore stdout
-  end
-
-  def teamcity_message(content)
-    puts "##teamcity[#{content}]" unless !@output_enabled
-  end
-
-end
+require 'ceedling/plugin'
+require 'ceedling/defaults'
+
+class TeamcityTestsReport < Plugin
+
+  def setup
+    @suite_started = nil
+    @output_enabled = !defined?(TEAMCITY_BUILD) || TEAMCITY_BUILD
+  end
+
+  def escape(string)
+    string.gsub(/['|\[\]]/, '|\0').gsub('\r', '|r').gsub('\n', '|n')
+  end
+
+  def pre_test(test)
+    teamcity_message "testSuiteStarted name='#{File.basename(test, '.c')}'"
+    @suite_started = Time.now
+  end
+
+  def post_test(test)
+    teamcity_message "testSuiteFinished name='#{File.basename(test, '.c')}'"
+  end
+
+  def post_test_fixture_execute(arg_hash)
+    duration = (Time.now - @suite_started) * 1000
+    results = @ceedling[:plugin_reportinator].assemble_test_results([arg_hash[:result_file]])
+    avg_duration = (duration / [1, results[:counts][:passed] + results[:counts][:failed]].max).round
+
+    results[:successes].each do |success|
+      success[:collection].each do |test|
+        teamcity_message "testStarted name='#{test[:test]}'"
+        teamcity_message "testFinished name='#{test[:test]}' duration='#{avg_duration}'"
+      end
+    end
+
+    results[:failures].each do |failure|
+      failure[:collection].each do |test|
+        teamcity_message "testStarted name='#{test[:test]}'"
+        teamcity_message "testFailed name='#{test[:test]}' message='#{escape(test[:message])}' details='File: #{failure[:source][:path]}/#{failure[:source][:file]} Line: #{test[:line]}'"
+        teamcity_message "testFinished name='#{test[:test]}' duration='#{avg_duration}'"
+      end
+    end
+
+    results[:ignores].each do |failure|
+      failure[:collection].each do |test|
+        teamcity_message "testIgnored name='#{test[:test]}' message='#{escape(test[:message])}'"
+      end
+    end
+
+    # We ignore stdout
+  end
+
+  def teamcity_message(content)
+    puts "##teamcity[#{content}]" unless !@output_enabled
+  end
+
+end

data/plugins/warnings_report/lib/warnings_report.rb

@@ -1,69 +1,69 @@
-require 'ceedling/plugin'
-require 'ceedling/constants'
-
-class WarningsReport < Plugin
-  def setup
-    @stderr_redirect = nil
-    @log_paths = {}
-  end
-
-  def pre_compile_execute(arg_hash)
-    # at beginning of compile, override tool's stderr_redirect so we can parse $stderr + $stdout
-    set_stderr_redirect(arg_hash)
-  end
-
-  def post_compile_execute(arg_hash)
-    # after compilation, grab output for parsing/logging, restore stderr_redirect, log warning if it exists
-    output = arg_hash[:shell_result][:output]
-    restore_stderr_redirect(arg_hash)
-    write_warning_log(arg_hash[:context], output)
-  end
-
-  def pre_link_execute(arg_hash)
-    # at beginning of link, override tool's stderr_redirect so we can parse $stderr + $stdout
-    set_stderr_redirect(arg_hash)
-  end
-
-  def post_link_execute(arg_hash)
-    # after linking, grab output for parsing/logging, restore stderr_redirect, log warning if it exists
-    output = arg_hash[:shell_result][:output]
-    restore_stderr_redirect(arg_hash)
-    write_warning_log(arg_hash[:context], output)
-  end
-
-  private
-
-  def set_stderr_redirect(hash)
-    @stderr_redirect = hash[:tool][:stderr_redirect]
-    hash[:tool][:stderr_redirect] = StdErrRedirect::AUTO
-  end
-
-  def restore_stderr_redirect(hash)
-    hash[:tool][:stderr_redirect] = @stderr_redirect
-  end
-
-  def write_warning_log(context, output)
-    # if $stderr/$stdout contain "warning", log it
-    if output =~ /warning/i
-      # generate a log path & file io write flags
-      logging = generate_log_path(context)
-      @ceedling[:file_wrapper].write(logging[:path], output + "\n", logging[:flags]) unless logging.nil?
-    end
-  end
-
-  def generate_log_path(context)
-    # if path has already been generated, return it & 'append' file io flags (append to log)
-    return { path: @log_paths[context], flags: 'a' } unless @log_paths[context].nil?
-
-    # first time through, generate path & 'write' file io flags (create new log)
-    base_path = File.join(PROJECT_BUILD_ARTIFACTS_ROOT, context.to_s)
-    file_path = File.join(base_path, 'warnings.log')
-
-    if @ceedling[:file_wrapper].exist?(base_path)
-      @log_paths[context] = file_path
-      return { path: file_path, flags: 'w' }
-    end
-
-    nil
-  end
-end
+require 'ceedling/plugin'
+require 'ceedling/constants'
+
+class WarningsReport < Plugin
+  def setup
+    @stderr_redirect = nil
+    @log_paths = {}
+  end
+
+  def pre_compile_execute(arg_hash)
+    # at beginning of compile, override tool's stderr_redirect so we can parse $stderr + $stdout
+    set_stderr_redirect(arg_hash)
+  end
+
+  def post_compile_execute(arg_hash)
+    # after compilation, grab output for parsing/logging, restore stderr_redirect, log warning if it exists
+    output = arg_hash[:shell_result][:output]
+    restore_stderr_redirect(arg_hash)
+    write_warning_log(arg_hash[:context], output)
+  end
+
+  def pre_link_execute(arg_hash)
+    # at beginning of link, override tool's stderr_redirect so we can parse $stderr + $stdout
+    set_stderr_redirect(arg_hash)
+  end
+
+  def post_link_execute(arg_hash)
+    # after linking, grab output for parsing/logging, restore stderr_redirect, log warning if it exists
+    output = arg_hash[:shell_result][:output]
+    restore_stderr_redirect(arg_hash)
+    write_warning_log(arg_hash[:context], output)
+  end
+
+  private
+
+  def set_stderr_redirect(hash)
+    @stderr_redirect = hash[:tool][:stderr_redirect]
+    hash[:tool][:stderr_redirect] = StdErrRedirect::AUTO
+  end
+
+  def restore_stderr_redirect(hash)
+    hash[:tool][:stderr_redirect] = @stderr_redirect
+  end
+
+  def write_warning_log(context, output)
+    # if $stderr/$stdout contain "warning", log it
+    if output =~ /warning/i
+      # generate a log path & file io write flags
+      logging = generate_log_path(context)
+      @ceedling[:file_wrapper].write(logging[:path], output + "\n", logging[:flags]) unless logging.nil?
+    end
+  end
+
+  def generate_log_path(context)
+    # if path has already been generated, return it & 'append' file io flags (append to log)
+    return { path: @log_paths[context], flags: 'a' } unless @log_paths[context].nil?
+
+    # first time through, generate path & 'write' file io flags (create new log)
+    base_path = File.join(PROJECT_BUILD_ARTIFACTS_ROOT, context.to_s)
+    file_path = File.join(base_path, 'warnings.log')
+
+    if @ceedling[:file_wrapper].exist?(base_path)
+      @log_paths[context] = file_path
+      return { path: file_path, flags: 'w' }
+    end
+
+    nil
+  end
+end

data/plugins/xml_tests_report/README.md

@@ -0,0 +1,36 @@
+xml_tests_report
+====================
+
+## Overview
+
+The xml_tests_report plugin creates an XML file of test results in xUnit
+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 `xml_tests_report` to the list
+of enabled plugins.
+
+``` YAML
+:plugins:
+  :enabled:
+    - xml_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
+:xml_tests_report:
+  :artifact_filename: report_xunit.xml
+```

data/plugins/xml_tests_report/lib/xml_tests_report.rb

@@ -1,108 +1,110 @@
-require 'ceedling/plugin'
-require 'ceedling/constants'
-
-class XmlTestsReport < 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])
-
-      file_path = File.join(PROJECT_BUILD_ARTIFACTS_ROOT, context.to_s, 'report.xml')
-
-      @ceedling[:file_wrapper].open(file_path, 'w') do |f|
-        @test_counter = 1
-        write_results(results, f)
-      end
-    end
-  end
-
-  private
-
-  def write_results(results, stream)
-    write_header(stream)
-    write_failures(results[:failures], stream)
-    write_tests(results[:successes], stream, 'SuccessfulTests')
-    write_tests(results[:ignores], stream, 'IgnoredTests')
-    write_statistics(results[:counts], stream)
-    write_footer(stream)
-  end
-
-  def write_header(stream)
-    stream.puts "<?xml version='1.0' encoding='utf-8' ?>"
-    stream.puts '<TestRun>'
-  end
-
-  def write_failures(results, stream)
-    if results.size.zero?
-      stream.puts "\t<FailedTests/>"
-      return
-    end
-
-    stream.puts "\t<FailedTests>"
-
-    results.each do |result|
-      result[:collection].each do |item|
-        filename = File.join(result[:source][:path], result[:source][:file])
-
-        stream.puts "\t\t<Test id=\"#{@test_counter}\">"
-        stream.puts "\t\t\t<Name>#{filename}::#{item[:test]}</Name>"
-        stream.puts "\t\t\t<FailureType>Assertion</FailureType>"
-        stream.puts "\t\t\t<Location>"
-        stream.puts "\t\t\t\t<File>#{filename}</File>"
-        stream.puts "\t\t\t\t<Line>#{item[:line]}</Line>"
-        stream.puts "\t\t\t</Location>"
-        stream.puts "\t\t\t<Message>#{item[:message]}</Message>"
-        stream.puts "\t\t</Test>"
-        @test_counter += 1
-      end
-    end
-
-    stream.puts "\t</FailedTests>"
-  end
-
-  def write_tests(results, stream, tag)
-    if results.size.zero?
-      stream.puts "\t<#{tag}/>"
-      return
-    end
-
-    stream.puts "\t<#{tag}>"
-
-    results.each do |result|
-      result[:collection].each do |item|
-        stream.puts "\t\t<Test id=\"#{@test_counter}\">"
-        stream.puts "\t\t\t<Name>#{File.join(result[:source][:path], result[:source][:file])}::#{item[:test]}</Name>"
-        stream.puts "\t\t</Test>"
-        @test_counter += 1
-      end
-    end
-
-    stream.puts "\t</#{tag}>"
-  end
-
-  def write_statistics(counts, stream)
-    stream.puts "\t<Statistics>"
-    stream.puts "\t\t<Tests>#{counts[:total]}</Tests>"
-    stream.puts "\t\t<Ignores>#{counts[:ignored]}</Ignores>"
-    stream.puts "\t\t<FailuresTotal>#{counts[:failed]}</FailuresTotal>"
-    stream.puts "\t\t<Errors>0</Errors>"
-    stream.puts "\t\t<Failures>#{counts[:failed]}</Failures>"
-    stream.puts "\t</Statistics>"
-  end
-
-  def write_footer(stream)
-    stream.puts '</TestRun>'
-  end
-end
+require 'ceedling/plugin'
+require 'ceedling/constants'
+
+class XmlTestsReport < 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[:xml_tests_report_artifact_filename] || 'report.xml'
+      artifact_fullpath = @ceedling[:configurator].project_config_hash[:xml_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
+        write_results(results, f)
+      end
+    end
+  end
+
+  private
+
+  def write_results(results, stream)
+    write_header(stream)
+    write_failures(results[:failures], stream)
+    write_tests(results[:successes], stream, 'SuccessfulTests')
+    write_tests(results[:ignores], stream, 'IgnoredTests')
+    write_statistics(results[:counts], stream)
+    write_footer(stream)
+  end
+
+  def write_header(stream)
+    stream.puts "<?xml version='1.0' encoding='utf-8' ?>"
+    stream.puts '<TestRun>'
+  end
+
+  def write_failures(results, stream)
+    if results.size.zero?
+      stream.puts "\t<FailedTests/>"
+      return
+    end
+
+    stream.puts "\t<FailedTests>"
+
+    results.each do |result|
+      result[:collection].each do |item|
+        filename = File.join(result[:source][:path], result[:source][:file])
+
+        stream.puts "\t\t<Test id=\"#{@test_counter}\">"
+        stream.puts "\t\t\t<Name>#{filename}::#{item[:test]}</Name>"
+        stream.puts "\t\t\t<FailureType>Assertion</FailureType>"
+        stream.puts "\t\t\t<Location>"
+        stream.puts "\t\t\t\t<File>#{filename}</File>"
+        stream.puts "\t\t\t\t<Line>#{item[:line]}</Line>"
+        stream.puts "\t\t\t</Location>"
+        stream.puts "\t\t\t<Message>#{item[:message]}</Message>"
+        stream.puts "\t\t</Test>"
+        @test_counter += 1
+      end
+    end
+
+    stream.puts "\t</FailedTests>"
+  end
+
+  def write_tests(results, stream, tag)
+    if results.size.zero?
+      stream.puts "\t<#{tag}/>"
+      return
+    end
+
+    stream.puts "\t<#{tag}>"
+
+    results.each do |result|
+      result[:collection].each do |item|
+        stream.puts "\t\t<Test id=\"#{@test_counter}\">"
+        stream.puts "\t\t\t<Name>#{File.join(result[:source][:path], result[:source][:file])}::#{item[:test]}</Name>"
+        stream.puts "\t\t</Test>"
+        @test_counter += 1
+      end
+    end
+
+    stream.puts "\t</#{tag}>"
+  end
+
+  def write_statistics(counts, stream)
+    stream.puts "\t<Statistics>"
+    stream.puts "\t\t<Tests>#{counts[:total]}</Tests>"
+    stream.puts "\t\t<Ignores>#{counts[:ignored]}</Ignores>"
+    stream.puts "\t\t<FailuresTotal>#{counts[:failed]}</FailuresTotal>"
+    stream.puts "\t\t<Errors>0</Errors>"
+    stream.puts "\t\t<Failures>#{counts[:failed]}</Failures>"
+    stream.puts "\t</Statistics>"
+  end
+
+  def write_footer(stream)
+    stream.puts '</TestRun>'
+  end
+end