ceedling 0.31.1 → 1.0.1

data/plugins/junit_tests_report/lib/junit_tests_report.rb

@@ -1,134 +0,0 @@
-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" time="%<time>.3f">' % 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, errors: 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" errors="%<errors>d" time="%<time>.3f">' % 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>.3f"/>' % test)
-    when :failed
-      stream.puts('    <testcase name="%<test>s" 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/raw_output_report/README.md

@@ -1,19 +0,0 @@
-ceedling-raw-output-report
-==========================
-
-## Overview
-
-The raw-output-report allows you to capture all the output from the called
-tools in a single document, so you can trace back through it later. This is
-useful for debugging... but can eat through memory quickly if left running.
-
-## Setup
-
-Enable the plugin in your project.yml by adding `raw_output_report`
-to the list of enabled plugins.
-
-``` YAML
-:plugins:
-  :enabled:
-    - raw_output_report
-```

data/plugins/raw_output_report/lib/raw_output_report.rb

@@ -1,41 +0,0 @@
-require 'ceedling/plugin'
-require 'ceedling/constants'
-
-class RawOutputReport < Plugin
-  def setup
-    @log_paths = {}
-  end
-
-  def post_test_fixture_execute(arg_hash)
-    output = strip_output(arg_hash[:shell_result][:output])
-    write_raw_output_log(arg_hash, output)
-  end
-
-  private
-
-  def strip_output(raw_output)
-    output = ""
-    raw_output.each_line do |line|
-      next if line =~ /^\n$/
-      next if line =~ /^.*:\d+:.*:(IGNORE|PASS|FAIL)/
-      return output if line =~/^-----------------------\n$/
-      output << line
-    end
-  end
-  def write_raw_output_log(arg_hash, output)
-    logging = generate_log_path(arg_hash)
-    @ceedling[:file_wrapper].write(logging[:path], output , logging[:flags]) unless logging.nil?
-  end
-
-  def generate_log_path(arg_hash)
-    f_name = File.basename(arg_hash[:result_file], '.pass')
-    base_path = File.join(PROJECT_BUILD_ARTIFACTS_ROOT, arg_hash[:context].to_s)
-    file_path = File.join(base_path, f_name + '.log')
-
-    if @ceedling[:file_wrapper].exist?(base_path)
-      return { path: file_path, flags: 'w' }
-    end
-
-    nil
-  end
-end

data/plugins/stdout_gtestlike_tests_report/README.md

@@ -1,19 +0,0 @@
-ceedling-stdout-gtestlike-tests-report
-======================
-
-## Overview
-
-The stdout_gtestlike_tests_report replaces the normal ceedling "pretty" output with 
-a variant that resembles the output of gtest. This is most helpful when trying to 
-integrate into an IDE or CI that is meant to work with google test.
-
-## Setup
-
-Enable the plugin in your project.yml by adding `stdout_gtestlike_tests_report`
-to the list of enabled plugins.
-
-``` YAML
-:plugins:
-  :enabled:
-    - stdout_gtestlike_tests_report
-```

data/plugins/stdout_gtestlike_tests_report/assets/template.erb copy

@@ -1,59 +0,0 @@
-% ignored        = hash[:results][:counts][:ignored]
-% failed         = hash[:results][:counts][:failed]
-% stdout_count   = hash[:results][:counts][:stdout]
-% header_prepend = ((hash[:header].length > 0) ? "#{hash[:header]}: " : '')
-% banner_width   = 25 + header_prepend.length # widest message
-
-
-% if (stdout_count > 0)
-[==========] Running <%=hash[:results][:counts][:total].to_s%> tests from <%=hash[:results][:stdout].length.to_s%> test cases.
-[----------] Global test environment set-up.
-% end
-% if (failed > 0)
-%   hash[:results][:failures].each do |failure|
-[----------] <%=failure[:collection].length.to_s%> tests from <%=failure[:source][:file]%>
-%     failure[:collection].each do |item|
-[ RUN      ] <%=failure[:source][:file]%>.<%=item[:test]%>
-% if (not item[:message].empty?)
-<%=failure[:source][:file]%>(<%=item[:line]%>): error: <%=item[:message]%>
-
-%   m = item[:message].match(/Expected\s+(.*)\s+Was\s+([^\.]*)\./)
-%    if m.nil?
- Actual:   FALSE
- Expected: TRUE
-%    else
- Actual:   <%=m[2]%>
- Expected: <%=m[1]%>
-%    end
-% else
-<%=failure[:source][:file]%>(<%=item[:line]%>): fail: <%=item[:message]%>
- Actual:   FALSE
- Expected: TRUE
-% end
-[  FAILED  ] <%=failure[:source][:file]%>.<%=item[:test]%> (0 ms)
-%     end
-[----------] <%=failure[:collection].length.to_s%> tests from <%=failure[:source][:file]%> (0 ms total)
-%   end
-% end
-% if (hash[:results][:counts][:total] > 0)
-[----------] Global test environment tear-down.
-[==========] <%=hash[:results][:counts][:total].to_s%> tests from <%=hash[:results][:stdout].length.to_s%> test cases ran.
-[  PASSED  ] <%=hash[:results][:counts][:passed].to_s%> tests.
-% if (failed == 0)
-[  FAILED  ] 0 tests.
-
- 0 FAILED TESTS
-% else
-[  FAILED  ] <%=failed.to_s%> tests, listed below:
-%   hash[:results][:failures].each do |failure|
-%     failure[:collection].each do |item|
-[  FAILED  ] <%=failure[:source][:file]%>.<%=item[:test]%>
-%     end
-%   end
-
- <%=failed.to_s%> FAILED TESTS
-% end
-% else
-
-No tests executed.
-% end

data/plugins/stdout_gtestlike_tests_report/config/stdout_gtestlike_tests_report.yml

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

data/plugins/stdout_gtestlike_tests_report/lib/stdout_gtestlike_tests_report.rb

@@ -1,43 +0,0 @@
-require 'ceedling/plugin'
-require 'ceedling/defaults'
-
-class StdoutGtestlikeTestsReport < Plugin
-
-  def setup
-    @result_list = []
-    @plugin_root = File.expand_path(File.join(File.dirname(__FILE__), '..'))
-    template = @ceedling[:file_wrapper].read(File.join(@plugin_root, 'assets/template.erb'))
-    @ceedling[:plugin_reportinator].register_test_results_template( template )
-  end
-
-  def post_test_fixture_execute(arg_hash)
-    return if not (arg_hash[:context] == TEST_SYM)
-
-    @result_list << arg_hash[:result_file]
-  end
-
-  def post_build
-    return if not (@ceedling[:task_invoker].test_invoked?)
-
-    results = @ceedling[:plugin_reportinator].assemble_test_results(@result_list)
-    hash = {
-      :header => '',
-      :results => results
-    }
-
-    @ceedling[:plugin_reportinator].run_test_results_report(hash)
-  end
-
-  def summary
-    result_list = @ceedling[:file_path_utils].form_pass_results_filelist( PROJECT_TEST_RESULTS_PATH, COLLECTION_ALL_TESTS )
-
-    # get test results for only those tests in our configuration and of those only tests with results on disk
-    hash = {
-      :header => '',
-      :results => @ceedling[:plugin_reportinator].assemble_test_results(result_list, {:boom => false})
-    }
-
-    @ceedling[:plugin_reportinator].run_test_results_report(hash)
-  end
-
-end

data/plugins/stdout_ide_tests_report/README.md

@@ -1,18 +0,0 @@
-ceedling-stdout-ide-tests-report
-================================
-
-## Overview
-
-The stdout_ide_tests_report replaces the normal ceedling "pretty" output with 
-a simplified variant intended to be easily parseable.
-
-## Setup
-
-Enable the plugin in your project.yml by adding `stdout_ide_tests_report`
-to the list of enabled plugins.
-
-``` YAML
-:plugins:
-  :enabled:
-    - stdout_ide_tests_report
-```

data/plugins/stdout_ide_tests_report/config/stdout_ide_tests_report.yml

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

data/plugins/stdout_ide_tests_report/lib/stdout_ide_tests_report.rb

@@ -1,44 +0,0 @@
-require 'ceedling/plugin'
-require 'ceedling/defaults'
-
-class StdoutIdeTestsReport < Plugin
-
-  def setup
-    @result_list = []
-  end
-
-  def post_test_fixture_execute(arg_hash)
-    return if not (arg_hash[:context] == TEST_SYM)
-
-    @result_list << arg_hash[:result_file]
-  end
-
-  def post_build
-    return if (not @ceedling[:task_invoker].test_invoked?)
-
-    results = @ceedling[:plugin_reportinator].assemble_test_results(@result_list)
-    hash = {
-      :header => '',
-      :results => results
-    }
-
-    @ceedling[:plugin_reportinator].run_test_results_report(hash) do
-      message = ''
-      message = 'Unit test failures.' if (hash[:results][:counts][:failed] > 0)
-      message
-    end
-  end
-
-  def summary
-    result_list = @ceedling[:file_path_utils].form_pass_results_filelist( PROJECT_TEST_RESULTS_PATH, COLLECTION_ALL_TESTS )
-
-    # get test results for only those tests in our configuration and of those only tests with results on disk
-    hash = {
-      :header => '',
-      :results => @ceedling[:plugin_reportinator].assemble_test_results(result_list, {:boom => false})
-    }
-
-    @ceedling[:plugin_reportinator].run_test_results_report(hash)
-  end
-
-end

data/plugins/stdout_pretty_tests_report/README.md

@@ -1,20 +0,0 @@
-ceedling-pretty-tests-report
-============================
-
-## Overview
-
-The stdout_pretty_tests_report is the default output of ceedling. Instead of
-showing most of the raw output of CMock, Ceedling, etc., it shows a simplified
-view. It also creates a nice summary at the end of execution which groups the 
-results into ignored and failed tests.
-
-## Setup
-
-Enable the plugin in your project.yml by adding `stdout_pretty_tests_report`
-to the list of enabled plugins.
-
-``` YAML
-:plugins:
-  :enabled:
-    - stdout_pretty_tests_report
-```

data/plugins/stdout_pretty_tests_report/config/stdout_pretty_tests_report.yml

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

data/plugins/stdout_pretty_tests_report/lib/stdout_pretty_tests_report.rb

@@ -1,47 +0,0 @@
-require 'ceedling/plugin'
-require 'ceedling/defaults'
-
-class StdoutPrettyTestsReport < Plugin
-  
-  def setup
-    @result_list = []
-    @plugin_root = File.expand_path(File.join(File.dirname(__FILE__), '..'))
-    template = @ceedling[:file_wrapper].read(File.join(@plugin_root, 'assets/template.erb'))
-    @ceedling[:plugin_reportinator].register_test_results_template( template )
-  end
-  
-  def post_test_fixture_execute(arg_hash)
-    return if not (arg_hash[:context] == TEST_SYM)
-  
-    @result_list << arg_hash[:result_file]
-  end
-  
-  def post_build
-    return if not (@ceedling[:task_invoker].test_invoked?)
-
-    results = @ceedling[:plugin_reportinator].assemble_test_results(@result_list)
-    hash = {
-      :header => '',
-      :results => results
-    }
-
-    @ceedling[:plugin_reportinator].run_test_results_report(hash) do
-      message = ''
-      message = 'Unit test failures.' if (results[:counts][:failed] > 0)
-      message
-    end
-  end
-
-  def summary
-    result_list = @ceedling[:file_path_utils].form_pass_results_filelist( PROJECT_TEST_RESULTS_PATH, COLLECTION_ALL_TESTS )
-
-    # get test results for only those tests in our configuration and of those only tests with results on disk
-    hash = {
-      :header => '',
-      :results => @ceedling[:plugin_reportinator].assemble_test_results(result_list, {:boom => false})
-    }
-
-    @ceedling[:plugin_reportinator].run_test_results_report(hash)
-  end
-
-end

data/plugins/subprojects/README.md

@@ -1,63 +0,0 @@
-ceedling-subprojects
-====================
-
-Plugin for supporting subprojects that are built as static libraries. It continues to support  
-dependency tracking, without getting confused between your main project files and your   
-subproject files. It accepts different compiler flags and linker flags, allowing you to   
-optimize for your situation.
-
-First, you're going to want to add the extension to your list of known extensions:
-
-```
-:extension:
-  :subprojects: '.a'
-```
-
-Define a new section called :subprojects. There, you can list as many subprojects  
-as you may need under the :paths key. For each, you specify a unique place to build  
-and a unique name.
-
-```
-:subprojects:  
-  :paths:
-   - :name: libprojectA
-     :source:
-       - ./subprojectA/first/dir
-       - ./subprojectA/second/dir
-     :include:
-       - ./subprojectA/include/dir
-     :build_root: ./subprojectA/build/dir
-     :defines: 
-       - DEFINE_JUST_FOR_THIS_FILE
-       - AND_ANOTHER
-   - :name: libprojectB
-     :source:
-       - ./subprojectB/only/dir
-     :include:
-       - ./subprojectB/first/include/dir
-       - ./subprojectB/second/include/dir
-     :build_root: ./subprojectB/build/dir
-     :defines: [] #none for this one
-```
-
-You can specify the compiler and linker, just as you would a release build:
-
-```
-:tools:
-  :subprojects_compiler:
-    :executable: gcc
-    :arguments:
-      - -g
-      - -I"$": COLLECTION_PATHS_SUBPROJECTS
-      - -D$: COLLECTION_DEFINES_SUBPROJECTS
-      - -c "${1}"
-      - -o "${2}"
-  :subprojects_linker:
-    :executable: ar
-    :arguments:
-      - rcs
-      - ${2}
-      - ${1}
-```
-
-That's all there is to it! Happy Hacking!

data/plugins/subprojects/config/defaults.yml

@@ -1,33 +0,0 @@
----
-#:extension:
-#  :subprojects: '.a'
-
-:subprojects:
-  :paths: []
-#   - :name: subprojectA
-#     :source:
-#       - ./first/subproject/dir
-#       - ./second/subproject/dir
-#     :include:
-#       - ./first/include/dir
-#     :build_root: ./subproject/build/dir
-#     :defines:
-#       - FIRST_DEFINE
-
-:tools:
-  :subprojects_compiler:
-    :executable: gcc
-    :arguments:
-      - -g
-      - -I"$": COLLECTION_PATHS_SUBPROJECTS
-      - -D$: COLLECTION_DEFINES_SUBPROJECTS
-      - -c "${1}"
-      - -o "${2}"
-  :subprojects_linker:
-    :executable: ar
-    :arguments:
-      - rcs
-      - ${2}
-      - ${1}
-
-...

data/plugins/subprojects/lib/subprojects.rb

@@ -1,92 +0,0 @@
-require 'ceedling/plugin'
-require 'ceedling/constants'
-
-SUBPROJECTS_ROOT_NAME         = 'subprojects'
-SUBPROJECTS_TASK_ROOT         = SUBPROJECTS_ROOT_NAME + ':'
-SUBPROJECTS_SYM               = SUBPROJECTS_ROOT_NAME.to_sym
-
-class Subprojects < Plugin
-
-  def setup
-    @plugin_root = File.expand_path(File.join(File.dirname(__FILE__), '..'))
-
-    # Add to the test paths
-    SUBPROJECTS_PATHS.each do |subproj|
-      subproj[:source].each do |path|
-        COLLECTION_PATHS_TEST_SUPPORT_SOURCE_INCLUDE_VENDOR << path
-      end
-      subproj[:include].each do |path|
-        COLLECTION_PATHS_TEST_SUPPORT_SOURCE_INCLUDE_VENDOR << path
-      end
-    end
-
-    # Gather information about the subprojects
-    @subprojects = {}
-    @subproject_lookup_by_path = {}
-    SUBPROJECTS_PATHS.each do |subproj|
-      @subprojects[ subproj[:name] ] = subproj.clone
-      @subprojects[ subproj[:name] ][:c] = []
-      @subprojects[ subproj[:name] ][:asm] = []
-      subproj[:source].each do |path|
-        search_path = "#{path[-1].match(/\\|\//) ? path : "#{path}/"}*#{EXTENSION_SOURCE}"
-        @subprojects[ subproj[:name] ][:c] += Dir[search_path]
-        if (EXTENSION_ASSEMBLY && !EXTENSION_ASSEMBLY.empty?)
-          search_path = "#{path[-1].match(/\\|\//) ? path : "#{path}/"}*#{EXTENSION_ASSEMBLY}"
-          @subprojects[ subproj[:name] ][:asm] += Dir[search_path]
-        end
-      end
-      @subproject_lookup_by_path[ subproj[:build_root] ] = subproj[:name]
-    end
-  end
-
-  def find_my_project( c_file, file_type = :c )
-    @subprojects.each_pair do |subprojname, subproj|
-      return subprojname if (subproj[file_type].include?(c_file))
-    end
-  end
-
-  def find_my_paths( c_file, file_type = :c )
-    @subprojects.each_pair do |subprojname, subproj|
-      return (subproj[:source] + (subproj[:include] || [])) if (subproj[file_type].include?(c_file))
-    end
-    return []
-  end
-
-  def find_my_defines( c_file, file_type = :c )
-    @subprojects.each_pair do |subprojname, subproj|
-      return (subproj[:defines] || []) if (subproj[file_type].include?(c_file))
-    end
-    return []
-  end
-
-  def list_all_object_files_for_subproject( lib_name )
-    subproj = File.basename(lib_name, EXTENSION_SUBPROJECTS)
-    objpath = "#{@subprojects[subproj][:build_root]}/out/c"
-    bbb = @subprojects[subproj][:c].map{|f| "#{objpath}/#{File.basename(f,EXTENSION_SOURCE)}#{EXTENSION_OBJECT}" }
-    bbb
-  end
-
-  def find_library_source_file_for_object( obj_name )
-    cname = "#{File.basename(obj_name, EXTENSION_OBJECT)}#{EXTENSION_SOURCE}"
-    dname = File.dirname(obj_name)[0..-7]
-    pname = @subproject_lookup_by_path[dname]
-    return @ceedling[:file_finder].find_file_from_list(cname, @subprojects[pname][:c], :error)
-  end
-
-  def find_library_assembly_file_for_object( obj_name )
-    cname = "#{File.basename(obj_name, EXTENSION_OBJECT)}#{EXTENSION_ASEMBLY}"
-    dname = File.dirname(obj_name)[0..-7]
-    pname = @subproject_lookup_by_path[dname]
-    return @ceedling[:file_finder].find_file_from_list(cname, @subprojects[pname][:asm], :error)
-  end
-
-  def replace_constant(constant, new_value)
-    Object.send(:remove_const, constant.to_sym) if (Object.const_defined? constant)
-    Object.const_set(constant, new_value)
-  end
-
-end
-
-# end blocks always executed following rake run
-END {
-}