ceedling 0.29.1 → 0.30.0

data/plugins/stdout_pretty_tests_report/README.md

@@ -0,0 +1,20 @@
+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/assets/template.erb

@@ -1,59 +1,59 @@
-% 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)
-<%=@ceedling[:plugin_reportinator].generate_banner(header_prepend + 'TEST OUTPUT')%>
-%   hash[:results][:stdout].each do |string|
-[<%=string[:source][:file]%>]
-%     string[:collection].each do |item|
-  - "<%=item%>"
-%     end
-
-%   end
-% end
-% if (ignored > 0)
-<%=@ceedling[:plugin_reportinator].generate_banner(header_prepend + 'IGNORED TEST SUMMARY')%>
-%   hash[:results][:ignores].each do |ignore|
-[<%=ignore[:source][:file]%>]
-%     ignore[:collection].each do |item|
-  Test: <%=item[:test]%>
-% if (not item[:message].empty?)
-  At line (<%=item[:line]%>): "<%=item[:message]%>"
-% else
-  At line (<%=item[:line]%>)
-% end
-
-%     end
-%   end
-% end
-% if (failed > 0)
-<%=@ceedling[:plugin_reportinator].generate_banner(header_prepend + 'FAILED TEST SUMMARY')%>
-%   hash[:results][:failures].each do |failure|
-[<%=failure[:source][:file]%>]
-%     failure[:collection].each do |item|
-  Test: <%=item[:test]%>
-% if (not item[:message].empty?)
-  At line (<%=item[:line]%>): "<%=item[:message]%>"
-% else
-  At line (<%=item[:line]%>)
-% end
-
-%     end
-%   end
-% end
-% total_string = hash[:results][:counts][:total].to_s
-% format_string = "%#{total_string.length}i"
-<%=@ceedling[:plugin_reportinator].generate_banner(header_prepend + 'OVERALL TEST SUMMARY')%>
-% if (hash[:results][:counts][:total] > 0)
-TESTED:  <%=hash[:results][:counts][:total].to_s%>
-PASSED:  <%=sprintf(format_string, hash[:results][:counts][:passed])%>
-FAILED:  <%=sprintf(format_string, failed)%>
-IGNORED: <%=sprintf(format_string, ignored)%>
-% else
-
-No tests executed.
-% end
-
+% 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)
+<%=@ceedling[:plugin_reportinator].generate_banner(header_prepend + 'TEST OUTPUT')%>
+%   hash[:results][:stdout].each do |string|
+[<%=string[:source][:file]%>]
+%     string[:collection].each do |item|
+  - "<%=item%>"
+%     end
+
+%   end
+% end
+% if (ignored > 0)
+<%=@ceedling[:plugin_reportinator].generate_banner(header_prepend + 'IGNORED TEST SUMMARY')%>
+%   hash[:results][:ignores].each do |ignore|
+[<%=ignore[:source][:file]%>]
+%     ignore[:collection].each do |item|
+  Test: <%=item[:test]%>
+% if (not item[:message].empty?)
+  At line (<%=item[:line]%>): "<%=item[:message]%>"
+% else
+  At line (<%=item[:line]%>)
+% end
+
+%     end
+%   end
+% end
+% if (failed > 0)
+<%=@ceedling[:plugin_reportinator].generate_banner(header_prepend + 'FAILED TEST SUMMARY')%>
+%   hash[:results][:failures].each do |failure|
+[<%=failure[:source][:file]%>]
+%     failure[:collection].each do |item|
+  Test: <%=item[:test]%>
+% if (not item[:message].empty?)
+  At line (<%=item[:line]%>): "<%=item[:message]%>"
+% else
+  At line (<%=item[:line]%>)
+% end
+
+%     end
+%   end
+% end
+% total_string = hash[:results][:counts][:total].to_s
+% format_string = "%#{total_string.length}i"
+<%=@ceedling[:plugin_reportinator].generate_banner(header_prepend + 'OVERALL TEST SUMMARY')%>
+% if (hash[:results][:counts][:total] > 0)
+TESTED:  <%=hash[:results][:counts][:total].to_s%>
+PASSED:  <%=sprintf(format_string, hash[:results][:counts][:passed])%>
+FAILED:  <%=sprintf(format_string, failed)%>
+IGNORED: <%=sprintf(format_string, ignored)%>
+% else
+
+No tests executed.
+% end
+

data/plugins/stdout_pretty_tests_report/config/stdout_pretty_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/stdout_pretty_tests_report/lib/stdout_pretty_tests_report.rb

@@ -1,47 +1,47 @@
-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
+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 +1,63 @@
-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!
+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 +1,33 @@
----
-#: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}
-
-...
+---
+#: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 +1,92 @@
-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 {
-}
+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 {
+}