RubyGems - ceedling - Versions diffs - 0.31.1 → 1.0.1 - Mend

ceedling 0.31.1 → 1.0.1

Files changed (1477) hide show

data/plugins/report_tests_log_factory/lib/html_tests_reporter.rb ADDED Viewed

@@ -0,0 +1,181 @@
+# =========================================================================
+#   Ceedling - Test-Centered Build System for C
+#   ThrowTheSwitch.org
+#   Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   SPDX-License-Identifier: MIT
+# =========================================================================
+require 'tests_reporter'
+class HtmlTestsReporter < TestsReporter
+  def setup()
+    super( default_filename: 'tests_report.html' )
+  end
+  # HTML header
+  def header(results:, stream:)
+    stream.puts "<!DOCTYPE html>"
+    stream.puts '<html lang="en">'
+    stream.puts '<head>'
+    stream.puts '<meta charset="UTF-8">'
+    stream.puts '<meta name="viewport" content="width=device-width, initial-scale=1.0">'
+    stream.puts '<meta http-equiv="X-UA-Compatible" content="ie=edge">'
+    stream.puts '<title>Test Overview</title>'
+    stream.puts '<style>'
+    stream.puts '* { font-family: sans-serif;}'
+    stream.puts 'table {'
+    stream.puts 'border-collapse: collapse;'
+    stream.puts 'table-layout: fixed;'
+    stream.puts 'width: 99%;'
+    stream.puts 'margin: 0 0px 25px 7px;'
+    stream.puts 'padding-right: 7px;'
+    stream.puts 'font-size: 0.9em;'
+    stream.puts 'min-width: 400px;'
+    stream.puts 'border-radius: 5px 5px 0 0;'
+    stream.puts 'overflow: hidden;'
+    stream.puts 'box-shadow: 0 0 20px rgba(0, 0, 0, 0.15);'
+    stream.puts '}'
+    stream.puts 'details summary { cursor: pointer; }'
+    stream.puts 'h1 {'
+    stream.puts 'margin: 0 0 7px 14px;'
+    stream.puts 'font-size: 1.5em;'
+    stream.puts 'font-weight: bold;'
+    stream.puts 'text-align: left;'
+    stream.puts '}'
+    stream.puts 'thead tr {'
+    stream.puts 'background-color: #009879;'
+    stream.puts 'color: #ffffff;'
+    stream.puts 'text-align: left;'
+    stream.puts 'font-weight: bold;'
+    stream.puts '}'
+    stream.puts '.failed thead tr { background-color: #983500; }'
+    stream.puts '.ignored thead tr { background-color: #849800; }'
+    stream.puts '.success thead tr { background-color: #00981e; }'
+    stream.puts 'table th, td { padding: 12px 15px; word-break: break-all; }'
+    stream.puts 'table tbody tr { border-bottom: 1px solid #dddddd; }'
+    stream.puts 'table tbody tr:nth-of-type(even) { background-color: #f3f3f3; }'
+    stream.puts 'table tbody tr:last-of-type { border-bottom: 2px solid #009879; }'
+    stream.puts '.failed tbody tr:last-of-type { border-bottom: 2px solid #983500; }'
+    stream.puts '.ignored tbody tr:last-of-type { border-bottom: 2px solid #849800; }'
+    stream.puts '.success tbody tr:last-of-type { border-bottom: 2px solid #00981e; }'
+    stream.puts 'table tbody tr:hover { color: #009879; }'
+    stream.puts '.failed tbody tr:hover { color: #983500; }'
+    stream.puts '.ignored tbody tr:hover { color: #849800; }'
+    stream.puts '.success tbody tr:hover { color: #00981e; }'
+    stream.puts '</style>'
+    stream.puts '</head>'
+    stream.puts '<body>'
+  end
+  # CppUnit XML test list contents
+  def body(results:, stream:)
+    write_statistics( results[:counts], stream)
+    write_failures( results[:failures], stream)
+    write_tests( results[:ignores], stream, "Ignored Tests", "ignored" )
+    write_tests( results[:successes], stream, "Success Tests", "success" )
+  end
+  # HTML footer
+  def footer(results:, stream:)
+    stream.puts '</body>'
+    stream.puts '</html>'
+  end
+  ### Private
+  private
+  def write_statistics(counts, stream)
+    stream.puts '<h1>Summary</h1>'
+    stream.puts '<table>'
+    stream.puts '<thead><tr><th>Total</th><th>Passed</th><th>Ignored</th><th>Failed</th></tr></thead>'
+    stream.puts '<tbody>'
+    stream.puts "<tr>"
+    stream.puts "<td>#{counts[:total]}</td>"
+    stream.puts "<td>#{counts[:total] - counts[:ignored] - counts[:failed]}</td>"
+    stream.puts "<td>#{counts[:ignored]}</td>"
+    stream.puts "<td>#{counts[:failed]}</td>"
+    stream.puts "</tr>"
+    stream.puts "</tbody>"
+    stream.puts "</table>"
+  end
+  def write_failures(results, stream)
+    return if results.size.zero?
+    stream.puts '<h1>Failed Tests</h1>'
+    stream.puts '<table class="failed">'
+    stream.puts '<thead><tr><th>File</th><th>Location</th><th>Message</th></tr></thead>'
+    stream.puts '<tbody>'
+    results.each do |result|
+      filename = result[:source][:file]
+      @first_row = true
+      result[:collection].each do |item|
+        stream.puts "<tr>"
+        if @first_row
+          stream.puts "<td rowspan=\"#{result[:collection].size}\">#{filename}</td>"
+          @first_row = false
+        end
+        stream.puts "<td>#{item[:test]}::#{item[:line]}</td>"
+        if item[:message].empty?
+          stream.puts "<td>—</td>"
+        else
+          if item[:message].size > 150
+            stream.puts "<td><details><summary>Message hidden due to long length.</summary>#{item[:message]}</details></td>"
+          else
+            stream.puts "<td>#{item[:message]}</td>"
+          end
+        end
+        stream.puts "</tr>"
+      end
+    end
+    stream.puts "</tbody>"
+    stream.puts "</table>"
+  end
+  def write_tests(results, stream, title, style)
+    return if results.size.zero?
+    stream.puts "<h1>#{title}</h1>"
+    stream.puts "<table class='#{style}'>"
+    stream.puts '<thead><tr><th>File</th><th>Name</th><th>Message</th></tr></thead>'
+    stream.puts '<tbody>'
+    results.each do |result|
+      filename = result[:source][:file]
+      @first_row = true
+      result[:collection].each do |item|
+        stream.puts "<tr>"
+        if @first_row
+          stream.puts "<td rowspan=\"#{result[:collection].size}\">#{filename}</td>"
+          @first_row = false
+        end
+        stream.puts "<td>#{item[:test]}</td>"
+        if item[:message].empty?
+          stream.puts "<td>—</td>"
+        else
+          if item[:message].size > 150
+            stream.puts "<td><details><summary>Message hidden due to long length.</summary>#{item[:message]}</details></td>"
+          else
+            stream.puts "<td>#{item[:message]}</td>"
+          end
+        end
+        stream.puts "</tr>"
+      end
+    end
+    stream.puts "</tbody>"
+    stream.puts "</table>"
+  end
+end

data/plugins/report_tests_log_factory/lib/json_tests_reporter.rb ADDED Viewed

@@ -0,0 +1,72 @@
+# =========================================================================
+#   Ceedling - Test-Centered Build System for C
+#   ThrowTheSwitch.org
+#   Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   SPDX-License-Identifier: MIT
+# =========================================================================
+require 'json'
+require 'tests_reporter'
+class JsonTestsReporter < TestsReporter
+  def setup()
+    super( default_filename: 'tests_report.json' )
+  end
+  def body(results:, stream:)
+    hash = {
+      "FailedTests"  => write_failures( results[:failures] ),
+      "PassedTests"  => write_tests( results[:successes] ),
+      "IgnoredTests" => write_tests( results[:ignores] ),
+      "Summary"      => write_statistics( results[:counts] )
+    }
+    stream << JSON.pretty_generate(hash)
+  end
+  ### Private
+  private
+  def write_failures(results)
+    # Array of hashes relating a source file, test, and test failure
+    failures = []
+    results.each do |result|
+      result[:collection].each do |item|
+        failures << {
+          "file" => result[:source][:file],
+          "test" => item[:test],
+          "line" => item[:line],
+          "message" => item[:message]
+        }
+      end
+    end
+    return failures.uniq
+  end
+  def write_tests(results)
+    # Array of hashes relating a source file and test
+    successes = []
+    results.each do |result|
+      result[:collection].each do |item|
+        successes << {
+          "file" => result[:source][:file],
+          "test" => item[:test]
+        }
+      end
+    end
+    return successes
+  end
+  def write_statistics(counts)
+    # Hash of keys:values for statistics
+    return {
+      "total_tests" => counts[:total],
+      "passed" => (counts[:total] - counts[:ignored] - counts[:failed]),
+      "ignored" => counts[:ignored],
+      "failures" => counts[:failed]
+    }
+  end
+end

data/plugins/report_tests_log_factory/lib/junit_tests_reporter.rb ADDED Viewed

@@ -0,0 +1,197 @@
+# =========================================================================
+#   Ceedling - Test-Centered Build System for C
+#   ThrowTheSwitch.org
+#   Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   SPDX-License-Identifier: MIT
+# =========================================================================
+require 'tests_reporter'
+class JunitTestsReporter < TestsReporter
+  def setup()
+    super( default_filename: 'junit_tests_report.xml' )
+  end
+  def header(results:, stream:)
+    stream.puts( '<?xml version="1.0" encoding="utf-8" ?>' )
+    stream.puts(
+      '<testsuites tests="%d" '    % results[:counts][:total] +
+                  'failures="%d" ' % results[:counts][:failed] +
+                  'time="%.3f">'   % results[:total_time]
+    )
+  end
+  def body(results:, stream:)
+    suites = reorganize_results( results )
+    suites.each do |suite|
+      write_suite( suite, stream )
+    end
+  end
+  def footer(results:, stream:)
+    stream.puts( '</testsuites>' )
+  end
+  ### Private
+  private
+  # Reorganize test results by test executable instead of by result category
+  # Original success structure: successeses { file => test_cases[] }
+  # Reorganized test results:   file => test_cases[{... result: :success}]
+  def reorganize_results( results )
+    # Create structure of hash with default values
+    suites = Hash.new() do |h,k|
+      h[k] = {
+        collection: [],
+        total:   0,
+        success: 0,
+        failed:  0,
+        ignored: 0,
+        errors:  0,
+        time:    0,
+        stdout:  []
+      }
+    end
+    results[:successes].each do |result|
+      # Extract filepath
+      source = result[:source][:file]
+      # Filepath minus file extension
+      name = source.sub( /#{File.extname(source)}$/, '' )
+      # Sanitize: Ensure no nil elements
+      result[:collection].compact!
+      # Sanitize: Ensure no empty test result hashes
+      result[:collection].select! {|test| !test.empty?() }
+      # Add success test cases to full test case collection and update statistics
+      suites[name][:collection] += result[:collection].map{|test| test.merge(result: :success)}
+      suites[name][:total] += result[:collection].length
+      suites[name][:success] += result[:collection].length
+      suites[name][:time] = results[:times][source]
+    end
+    results[:failures].each do |result|
+      # Extract filepath
+      source = result[:source][:file]
+      # Filepath minus file extension
+      name = source.sub( /#{File.extname(source)}$/, '' )
+      # Sanitize: Ensure no nil elements
+      result[:collection].compact!
+      # Sanitize: Ensure no empty test result hashes
+      result[:collection].select! {|test| !test.empty?() }
+      # Add failure test cases to full test case collection and update statistics
+      suites[name][:collection] += result[:collection].map{|test| test.merge(result: :failed)}
+      suites[name][:total] += result[:collection].length
+      suites[name][:failed] += result[:collection].length
+      suites[name][:time] = results[:times][source]
+    end
+    results[:ignores].each do |result|
+      # Extract filepath
+      source = result[:source][:file]
+      # Filepath minus file extension
+      name = source.sub( /#{File.extname(source)}$/, '' )
+      # Sanitize: Ensure no nil elements
+      result[:collection].compact!
+      # Sanitize: Ensure no empty test result hashes
+      result[:collection].select! {|test| !test.empty?() }
+      # Add ignored test cases to full test case collection and update statistics
+      suites[name][:collection] += result[:collection].map{|test| test.merge(result: :ignored)}
+      suites[name][:total] += result[:collection].length
+      suites[name][:ignored] += result[:collection].length
+      suites[name][:time] = results[:times][source]
+    end
+    results[:stdout].each do |result|
+      # Extract filepath
+      source = result[:source][:file]
+      # Filepath minus file extension
+      name = source.sub( /#{File.extname(source)}$/, '' )
+      # Add $stdout messages to collection
+      suites[name][:stdout] += result[:collection]
+    end
+    # Add name to suite hashes (duplicating the key for suites)
+    suites.map{|name, data| data.merge(name: name) }
+  end
+  def write_suite( suite, stream )
+    stream.puts(
+      '  <testsuite name="%s" '     % suite[:name] +
+                   'tests="%d" '    % suite[:total] +
+                   'failures="%d" ' % suite[:failed] +
+                   'skipped="%d" '  % suite[:ignored] +
+                   'errors="%d" '   % suite[:errors] +
+                   'time="%.3f">'   % suite[:time]
+    )
+    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" '               % test +
+                      'time="%<unity_test_time>.3f"/>' % test
+      )
+    when :failed
+      stream.puts(
+        '    <testcase name="%<test>s" '              % test +
+                      'time="%<unity_test_time>.3f">' % 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>.3f">' % test )
+      stream.puts( '      <skipped />' )
+      stream.puts( '    </testcase>' )
+    end
+  end
+end

data/plugins/report_tests_log_factory/lib/report_tests_log_factory.rb ADDED Viewed

@@ -0,0 +1,135 @@
+# =========================================================================
+#   Ceedling - Test-Centered Build System for C
+#   ThrowTheSwitch.org
+#   Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   SPDX-License-Identifier: MIT
+# =========================================================================
+require 'ceedling/plugin'
+class ReportTestsLogFactory < Plugin
+  # `Plugin` setup()
+  def setup
+    # Hash: Context => Array of test executable results files
+    @results = {}
+    # Get our test suite reports' configuration
+    config = @ceedling[:setupinator].config_hash
+    @config = config[:report_tests_log_factory]
+    # Get list of enabled reports
+    reports = @config[:reports]
+    # Array of Reporter subclass objects
+    @reporters = load_reporters( reports, @config )
+    # Disable this plugin if no reports configured
+    @enabled = !(reports.empty?)
+    @mutex = Mutex.new()
+    @loginator = @ceedling[:loginator]
+    @reportinator = @ceedling[:reportinator]
+  end
+  # `Plugin` build step hook -- collect context:results_filepath after test fixture runs
+  def post_test_fixture_execute(arg_hash)
+    # Do nothing if no reports configured
+    return if not @enabled
+    # Get context from test run
+    context = arg_hash[:context]
+    @mutex.synchronize do
+      # Create an empty array if context does not already exist as a key
+      @results[context] = [] if @results[context].nil?
+      # Add results filepath to array at context key
+      @results[context] << arg_hash[:result_file]
+    end
+  end
+  # `Plugin` build step hook -- process results into log files after test build completes
+  def post_build
+    # Do nothing if no reports configured
+    return if not @enabled
+    empty = false
+    @mutex.synchronize { empty = @results.empty? }
+    # Do nothing if no results were generated (e.g. not a test build)
+    return if empty
+    msg = @reportinator.generate_heading( "Running Test Suite Reports" )
+    @loginator.log( msg )
+    @mutex.synchronize do
+      # For each configured reporter, generate a test suite report per test context
+      @results.each do |context, results_filepaths|
+        # Assemble results from all results filepaths collected
+        _results = @ceedling[:plugin_reportinator].assemble_test_results( results_filepaths )
+        # Provide results to each Reporter
+        @reporters.each do |reporter|
+          filepath = File.join( PROJECT_BUILD_ARTIFACTS_ROOT, context.to_s, reporter.filename )
+          msg = @reportinator.generate_progress( "Generating artifact #{filepath}" )
+          @loginator.log( msg )
+          reporter.write( filepath: filepath, results: _results )
+        end
+      end
+    end
+  # White space at command line after progress messages
+  @loginator.log( '' )
+  end
+  ### Private
+  private
+  def load_reporters(reports, config)
+    reporters = []
+    # For each report name string in configuration, dynamically load the corresponding
+    # Reporter subclass by convention
+    # The steps below limit the set up complexity that would otherwise be
+    # required of a user's custom Reporter subclass
+    reports.each do |report|
+      # Enforce lowercase convention internally
+      report = report.downcase()
+      # Convert report configuration name 'foo_bar' to 'FooBarTestReporter' class name
+      #  1. Convert 'x_Y' (snake case) to camel case ('xY')
+      #  2. Capitalize first character of config name and add rest of class name
+      _reporter = report.gsub(/_./) {|match| match.upcase().delete('_') }
+      _reporter = _reporter[0].capitalize() + _reporter[1..-1] + 'TestsReporter'
+      # Load each Reporter sublcass Ruby file dynamically by convention
+      # For custom user subclasses, requires directoy in :plugins ↳ :load_paths
+      require "#{report}_tests_reporter"
+      # Dynamically instantiate Reporter subclass object
+      reporter = eval( "#{_reporter}.new(handle: :#{report})" )
+      # Inject configuration
+      reporter.config = config[report.to_sym]
+      # Inject utilty object
+      reporter.config_walkinator = @ceedling[:config_walkinator]
+      # Perform Reporter sublcass set up
+      reporter.setup()
+      # Add new object to our internal list
+      reporters << reporter
+    end
+    return reporters
+  end
+end

data/plugins/report_tests_log_factory/lib/tests_reporter.rb ADDED Viewed

@@ -0,0 +1,70 @@
+# =========================================================================
+#   Ceedling - Test-Centered Build System for C
+#   ThrowTheSwitch.org
+#   Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   SPDX-License-Identifier: MIT
+# =========================================================================
+class TestsReporter
+  # Dependency injection
+  attr_writer :config_walkinator
+  # Setup value injection
+  attr_writer :config
+  # Publicly accessible filename for the resulting report
+  attr_reader :filename
+  def initialize(handle:)
+    @handle = handle
+    # Safe default filename in case user's custom subclass forgets to call
+    # setup() with a default filename.
+    # If the report is named 'foo_bar' in project configuration, the
+    # fallback filename is 'foo_bar.report'
+    @filename = "#{handle}.report"
+  end
+  def setup(default_filename:)
+    @filename = update_filename( default_filename )
+  end
+  # Write report contents to file
+  def write(filepath:, results:)
+    File.open( filepath, 'w' ) do |f|
+      header( results: results, stream: f )
+      body( results: results, stream: f )
+      footer( results: results, stream: f )
+    end
+  end
+  def header(results:, stream:)
+    # Override in subclass to do something
+  end
+  def body(results:, stream:)
+    # Override in subclass to do something
+  end
+  def footer(results:, stream:)
+    # Override in subclass to do something
+  end
+  ### Private
+  private
+  def update_filename(default_filename)
+    # Fetch configured filename if it exists, otherwise return default filename
+    filename, _ = @config_walkinator.fetch_value( :filename, hash:@config, default:default_filename )
+    return filename
+  end
+  # Handy convenience method for subclasses
+  def fetch_config_value(*keys)
+    result, _ = @config_walkinator.fetch_value( *keys, hash:@config )
+    return result
+  end
+end

data/plugins/report_tests_log_factory/sample_html_report.png ADDED Viewed

Binary file