ceedling 0.31.0 → 1.0.0

data/plugins/gcov/lib/reportgenerator_reportinator.rb

@@ -1,50 +1,77 @@
+# =========================================================================
+#   Ceedling - Test-Centered Build System for C
+#   ThrowTheSwitch.org
+#   Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   SPDX-License-Identifier: MIT
+# =========================================================================
+
 require 'benchmark'
 require 'reportinator_helper'
+require 'ceedling/constants'
+require 'ceedling/exceptions'
 
 class ReportGeneratorReportinator
 
+  attr_reader :artifacts_path
+
   def initialize(system_objects)
+    @artifacts_path = GCOV_REPORT_GENERATOR_ARTIFACTS_PATH
     @ceedling = system_objects
-    @reportinator_helper = ReportinatorHelper.new
+    @reportinator_helper = ReportinatorHelper.new(system_objects)
+
+    # Validate the `reportgenerator` tool since it's used to generate reports
+    @ceedling[:tool_validator].validate( 
+      tool: TOOLS_GCOV_REPORTGENERATOR_REPORT,
+      boom: true
+    )
+
+    # Validate the `gcov` report tool since it's used to generate .gcov files processed by `reportgenerator`
+    # Note: This gcov tool is a different configuration than the gcov tool used for coverage summaries
+    @ceedling[:tool_validator].validate(
+      tool: TOOLS_GCOV_REPORT,
+      boom: true
+    )
+
+    # Convenient instance variable references
+    @loginator = @ceedling[:loginator]
+    @reportinator = @ceedling[:reportinator]
+    @tool_executor = @ceedling[:tool_executor]
   end
 
 
   # Generate the ReportGenerator report(s) specified in the options.
-  def make_reports(opts)
+  def generate_reports(opts)
     shell_result = nil
     total_time = Benchmark.realtime do
       rg_opts = get_opts(opts)
 
-      print "Creating gcov results report(s) with ReportGenerator in '#{GCOV_REPORT_GENERATOR_PATH}'... "
-      STDOUT.flush
+      msg = @reportinator.generate_heading( "Running ReportGenerator Coverage Reports" )
+      @loginator.log( msg )
+
+      opts[:gcov_reports].each do |report|
+        msg = @reportinator.generate_progress("Generating #{report} coverage report in '#{GCOV_REPORT_GENERATOR_ARTIFACTS_PATH}'")
+        @loginator.log( msg )
+      end
 
       # Cleanup any existing .gcov files to avoid reporting old coverage results.
       for gcov_file in Dir.glob("*.gcov")
         File.delete(gcov_file)
       end
 
-      # Use a custom gcov executable, if specified.
-      GCOV_TOOL_CONFIG[:executable] = rg_opts[:gcov_executable] unless rg_opts[:gcov_executable].nil?
-
-      # Avoid running gcov on the mock, test, unity, and cexception gcov notes files to save time.
-      gcno_exclude_str = "#{opts[:cmock_mock_prefix]}.*"
-      gcno_exclude_str += "|#{opts[:project_test_file_prefix]}.*"
-      gcno_exclude_str += "|#{VENDORS_FILES.join('|')}"
+      gcno_exclude_str = ""
 
       # Avoid running gcov on custom specified .gcno files.
-      if !(rg_opts.nil?) && !(rg_opts[:gcov_exclude].nil?) && !(rg_opts[:gcov_exclude].empty?)
-        for gcno_exclude_expression in rg_opts[:gcov_exclude]
-          if !(gcno_exclude_expression.nil?) && !(gcno_exclude_expression.empty?)
-            # We want to filter .gcno files, not .gcov files.
-            # We will generate .gcov files from .gcno files.
-            gcno_exclude_expression = gcno_exclude_expression.chomp("\\.gcov")
-            gcno_exclude_expression = gcno_exclude_expression.chomp(".gcov")
-            # The .gcno extension will be added later as we create the regex.
-            gcno_exclude_expression = gcno_exclude_expression.chomp("\\.gcno")
-            gcno_exclude_expression = gcno_exclude_expression.chomp(".gcno")
-            # Append the custom expression.
-            gcno_exclude_str += "|#{gcno_exclude_expression}"
-          end
+      for gcno_exclude_expression in rg_opts[:gcov_exclude]
+        if !(gcno_exclude_expression.nil?) && !(gcno_exclude_expression.empty?)
+          # We want to filter .gcno files, not .gcov files.
+          # We will generate .gcov files from .gcno files.
+          gcno_exclude_expression = gcno_exclude_expression.chomp("\\.gcov")
+          gcno_exclude_expression = gcno_exclude_expression.chomp(".gcov")
+          # The .gcno extension will be added later as we create the regex.
+          gcno_exclude_expression = gcno_exclude_expression.chomp("\\.gcno")
+          gcno_exclude_expression = gcno_exclude_expression.chomp(".gcno")
+          # Append the custom expression.
+          gcno_exclude_str += "|#{gcno_exclude_expression}"
         end
       end
 
@@ -52,8 +79,7 @@ class ReportGeneratorReportinator
 
       # Generate .gcov files by running gcov on gcov notes files (*.gcno).
       for gcno_filepath in Dir.glob(File.join(GCOV_BUILD_PATH, "**", "*.gcno"))
-        match_data = gcno_filepath.match(gcno_exclude_regex)
-        if match_data.nil? || (match_data[1].nil? && match_data[1].nil?)
+        if not (gcno_filepath =~ gcno_exclude_regex) # Skip path that matches exclude pattern
           # Ensure there is a matching gcov data file.
           if File.file?(gcno_filepath.gsub(".gcno", ".gcda"))
             run_gcov("\"#{gcno_filepath}\"")
@@ -66,21 +92,31 @@ class ReportGeneratorReportinator
         args = args_builder(opts)
 
         # Generate the report(s).
-        shell_result = run(args)
+        begin
+          shell_result = run(args)
+        rescue ShellException => ex
+          shell_result = ex.shell_result
+          # Re-raise
+          raise ex
+        ensure
+          # Cleanup .gcov files.
+          for gcov_file in Dir.glob("*.gcov")
+            File.delete(gcov_file)
+          end          
+        end
       else
-        puts "\nWarning: No matching .gcno coverage files found."
+        @loginator.log( "No matching .gcno coverage files found", Verbosity::COMPLAIN )
       end
 
-      # Cleanup .gcov files.
-      for gcov_file in Dir.glob("*.gcov")
-        File.delete(gcov_file)
-      end
     end
 
     if shell_result
       shell_result[:time] = total_time
       @reportinator_helper.print_shell_result(shell_result)
     end
+
+    # White space log line
+    @loginator.log( '' )
   end
 
 
@@ -111,9 +147,6 @@ class ReportGeneratorReportinator
 
   REPORT_GENERATOR_SETTING_PREFIX = "gcov_report_generator"
 
-  # Deep clone the gcov tool config, so we can modify it locally if specified via options.
-  GCOV_TOOL_CONFIG = Marshal.load(Marshal.dump(TOOLS_GCOV_GCOV_POST_REPORT))
-
   # Build the ReportGenerator arguments.
   def args_builder(opts)
     rg_opts = get_opts(opts)
@@ -121,52 +154,42 @@ class ReportGeneratorReportinator
 
     args = ""
     args += "\"-reports:*.gcov\" "
-    args += "\"-targetdir:\"#{GCOV_REPORT_GENERATOR_PATH}\"\" "
+    args += "\"-targetdir:\"#{GCOV_REPORT_GENERATOR_ARTIFACTS_PATH}\"\" "
 
     # Build the report types argument.
-    if !(opts.nil?) && !(opts[:gcov_reports].nil?) && !(opts[:gcov_reports].empty?)
-      args += "\"-reporttypes:"
-
-      for report_type in opts[:gcov_reports]
-        rg_report_type = REPORT_TYPE_TO_REPORT_GENERATOR_REPORT_NAME[report_type.upcase]
-        if !(rg_report_type.nil?)
-          args += rg_report_type + ";"
-          report_type_count = report_type_count + 1
-        end
-      end
-
-      # Removing trailing ';' after the last report type.
-      args = args.chomp(";")
+    args += "\"-reporttypes:"
 
-      # Append a space seperator after the report type.
-      args += "\" "
+    for report_type in opts[:gcov_reports]
+      rg_report_type = REPORT_TYPE_TO_REPORT_GENERATOR_REPORT_NAME[report_type.upcase]
+      if !(rg_report_type.nil?)
+        args += rg_report_type + ";"
+        report_type_count = report_type_count + 1
+      end
     end
 
-    # Build the source directories argument.
-    args += "\"-sourcedirs:.;"
-    if !(opts[:collection_paths_source].nil?)
-      args += opts[:collection_paths_source].join(';')
-    end
+    # Removing trailing ';' after the last report type.
     args = args.chomp(";")
+
+    # Append a space separator after the report type.
     args += "\" "
 
+    # Build the source directories argument.
+    args += "\"-sourcedirs:.;#{opts[:collection_paths_source].join(';')}\" "
+
     args += "\"-historydir:#{rg_opts[:history_directory]}\" " unless rg_opts[:history_directory].nil?
     args += "\"-plugins:#{rg_opts[:plugins]}\" " unless rg_opts[:plugins].nil?
     args += "\"-assemblyfilters:#{rg_opts[:assembly_filters]}\" " unless rg_opts[:assembly_filters].nil?
     args += "\"-classfilters:#{rg_opts[:class_filters]}\" " unless rg_opts[:class_filters].nil?
-    file_filters = rg_opts[:file_filters] || @ceedling[:tool_executor_helper].osify_path_separators(GCOV_REPORT_GENERATOR_FILE_FILTERS)
-    args += "\"-filefilters:#{file_filters}\" "
-    args += "\"-verbosity:#{rg_opts[:verbosity] || "Warning"}\" "
+    args += "\"-filefilters:#{rg_opts[:file_filters]}\" " unless rg_opts[:file_filters].nil?
+    args += "\"-verbosity:#{rg_opts[:verbosity]}\" " unless rg_opts[:verbosity].nil?
     args += "\"-tag:#{rg_opts[:tag]}\" " unless rg_opts[:tag].nil?
     args += "\"settings:createSubdirectoryForAllReportTypes=true\" " unless report_type_count <= 1
     args += "\"settings:numberOfReportsParsedInParallel=#{rg_opts[:num_parallel_threads]}\" " unless rg_opts[:num_parallel_threads].nil?
     args += "\"settings:numberOfReportsMergedInParallel=#{rg_opts[:num_parallel_threads]}\" " unless rg_opts[:num_parallel_threads].nil?
 
     # Append custom arguments.
-    if !(rg_opts[:custom_args].nil?) && !(rg_opts[:custom_args].empty?)
-      for custom_arg in rg_opts[:custom_args]
-        args += "\"#{custom_arg}\" " unless custom_arg.nil? || custom_arg.empty?
-      end
+    for custom_arg in rg_opts[:custom_args]
+      args += "\"#{custom_arg}\" " unless custom_arg.nil? || custom_arg.empty?
     end
 
     return args
@@ -175,21 +198,23 @@ class ReportGeneratorReportinator
 
   # Get the ReportGenerator options from the project options.
   def get_opts(opts)
-    return opts[REPORT_GENERATOR_SETTING_PREFIX.to_sym] || {}
+    return opts[REPORT_GENERATOR_SETTING_PREFIX.to_sym]
   end
 
 
   # Run ReportGenerator with the given arguments.
   def run(args)
-    command = @ceedling[:tool_executor].build_command_line(TOOLS_GCOV_REPORT_GENERATOR_POST_REPORT, [], args)
-    return @ceedling[:tool_executor].exec(command[:line], command[:options])
+    command = @tool_executor.build_command_line(TOOLS_GCOV_REPORTGENERATOR_REPORT, [], args)
+
+    return @tool_executor.exec( command )
   end
 
 
   # Run gcov with the given arguments.
   def run_gcov(args)
-    command = @ceedling[:tool_executor].build_command_line(GCOV_TOOL_CONFIG, [], args)
-    return @ceedling[:tool_executor].exec(command[:line], command[:options])
+    command = @tool_executor.build_command_line(TOOLS_GCOV_REPORT, [], args)
+
+    return @tool_executor.exec( command )
   end
 
 end

data/plugins/gcov/lib/reportinator_helper.rb

@@ -1,15 +1,30 @@
+# =========================================================================
+#   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/constants'
+
 
 class ReportinatorHelper
 
-    # Output the shell result to the console.
-    def print_shell_result(shell_result)
-      if !(shell_result.nil?)
-        puts "Done in %.3f seconds." % shell_result[:time]
-  
-        if !(shell_result[:output].nil?) && (shell_result[:output].length > 0)
-          puts shell_result[:output]
-        end
+  def initialize(system_objects)
+    # Convenience alias
+    @loginator = system_objects[:loginator]
+  end
+
+  # Output the shell result to the console.
+  def print_shell_result(shell_result)
+    if !(shell_result.nil?)
+      msg = "Done in %.3f seconds." % shell_result[:time]
+      @loginator.log(msg, Verbosity::NORMAL)
+
+      if !(shell_result[:output].nil?) && (shell_result[:output].length > 0)
+        @loginator.log(shell_result[:output], Verbosity::OBNOXIOUS)
       end
     end
+  end
 
 end

data/plugins/module_generator/README.md

@@ -1,10 +1,10 @@
 ceedling-module-generator
 =========================
 
-## Overview
+## Plugin Overview
 
 The module_generator plugin adds a pair of new commands to Ceedling, allowing
-you to make or remove modules according to predefined templates. WIth a single call,
+you to make or remove modules according to predefined templates. With a single call,
 Ceedling can generate a source, header, and test file for a new module. If given a
 pattern, it can even create a series of submodules to support specific design patterns.
 Finally, it can just as easily remove related modules, avoiding the need to delete
@@ -22,6 +22,8 @@ specified a different default (see configuration). It will create three files:
 `MadScience.c`, `MadScience.h`, and `TestMadScience.c`. *NOTE* that it is important that
 there are no spaces between the brackets. We know, it's annoying... but it's the rules.
 
+### Patterns
+
 You can also create an entire pattern of files. To do that, just add a second argument
 to the pattern ID. Something like this:
 
@@ -33,6 +35,78 @@ In this example, we'd create 9 files total: 3 headers, 3 source files, and 3 tes
 files would be named `SecretLairModel`, `SecretLairConductor`, and `SecretLairHardware`. Isn't
 that nice?
 
+### Paths
+
+The directories found in the project `:paths:` are reused. You can also specify an alternative default generation path using: 
+```
+:module_generator:
+  :path_src: src/
+  :path_inc: src/
+  :path_tst: test/
+```
+
+But what if I don't want it to place my new files in the default location?
+
+It can do that too! You can give it a hint as to where to find your files. The pattern matching
+here is fairly basic, but it is usually sufficient. It works perfectly if your directory structure
+matches a common pattern. For example, let's say you issue this command:
+
+```
+ceedling module:create[lab:SecretLair,mch]
+```
+
+Say your directory structure looks like this:
+
+```
+:paths:
+  :source:
+    - lab/src
+    - lair/src
+    - other/src
+  :test:
+    - lab/test
+    - lair/test
+    - other/test
+```
+
+In this case, the `lab:` hint would make the module generator guess you want your files here:
+
+ - source files: `lab/src` (because it's a close match)
+ - include files: `lab/src` (because no include paths were listed)
+ - test files: `lab/test` (because it's a close match)
+
+Instead, if your directory structure looks like this:
+
+```
+:paths:
+  :source:
+    - src/**   #this might contain subfolders lab, lair, and other
+  :include:
+    - inc/**   #again, this might contain subfolders lab, lair, other, and shared
+  :test:
+    - test
+```
+
+In this case, the `lab:` hint would make the module generator guess you want your files here:
+
+ - source files: `src/lab` (because it's a close match)
+ - include files: `inc/lab` (because it's a close match)
+ - test files: `test` (because there wasn't a close match, and this was the first entry on our list)
+
+You can see that more complicated structures will have files placed in the wrong place from time to
+time... no worries... you can move the file after it's created... but if your project has any kind of 
+consistent structure, the guessing engine does a good job of making it work.
+
+Three more quick notes about the path-matching:
+
+1. You can give multiple ordered hints that map roughly to folder nesting! `lab:secret:lair` will 
+   happily match to put `lair.c` in a folder like `my/lab/secret/`.
+
+2. Whenever the matcher fails to find a good candidate (or if it finds multiple equally good 
+   candidates), it will always guess in the order you have the paths listed in your project.yml file
+
+## Stubbing
+
 Similarly, you can create stubs for all functions in a header file just by making a single call
 to your handy `stub` feature, like this:
 
@@ -40,8 +114,8 @@ to your handy `stub` feature, like this:
 ceedling module:stub[SecretLair]
 ```
 
-This call will look in SecretLair.h and will generate a file SecretLair.c that contains a stub
-for each function declared in the header! Even better, if SecretLair.c already exists, it will
+This call will look in `SecretLair.h` and will generate a file `SecretLair.c` that contains a stub
+for each function declared in the header! Even better, if `SecretLair.c` already exists, it will
 add only new functions, leaving your existing calls alone so that it doesn't cause any problems.
 
 ## Configuration
@@ -57,9 +131,15 @@ follows the default ceedling structure... but what if you have a different struc
 ```
 :module_generator:
   :project_root: ./
-  :source_root: source/
-  :inc_root: includes/
-  :test_root: tests/
+  :naming: :bumpy
+  :includes: 
+    - :src: []
+    - :inc: []
+    - :tst: []
+  :boilerplates:
+    - :src: ""
+    - :inc: ""
+    - :tst: ""
 ```
 
 Now I've redirected the location where modules are going to be generated.
@@ -72,22 +152,48 @@ by adding to the `:includes` array. For example:
 ```
 :module_generator:
   :includes:
-    - defs.h
-    - board.h
+    :tst:
+      - defs.h
+      - board.h
+    :src:
+      - board.h
 ```
 
 ### Boilerplates
 
 You can specify the actual boilerplate used for each of your files. This is the handy place to
-put that corporate copyright notice (or maybe a copyleft notice, if that's your perference?)
+put that corporate copyright notice (or maybe a copyleft notice, if that's your preference?)
+
+Notice there is a separate template for source files, include files, and test files. Also, 
+your boilerplates can optionally contain `%1$s` which will inject the filename into that spot.
 
 ```
 :module_generator:
-  :boilerplates: |
-    /***************************
-    * This file is Awesome.    *
-    * That is All.             *
-    ***************************/
+  :boilerplates: 
+    :src: |
+      /***************************
+      * %1$s
+      * This file is Awesome.
+      * That is All.
+      ***************************/
+    :inc: |
+      /***************************
+      * Header. Woo.             *
+      ***************************/
+    :tst: |
+      /***************************
+      * My Awesome Test For %1$s
+      ***************************/
+```
+
+### Test Defines
+
+You can specify the "#ifdef TEST" at the top of the test files with a custom define.
+This example will put a "#ifdef CEEDLING_TEST" at the top of the test files.  
+
+```
+:module_generator:
+  :test_define: CEEDLING_TEST
 ```
 
 ### Naming Convention
@@ -96,10 +202,11 @@ Finally, you can force a particular naming convention. Even if someone calls the
 with something like `MyNewModule`, if they have the naming convention set to `:caps`, it will
 generate files like `MY_NEW_MODULE.c`. This keeps everyone on your team behaving the same way.
 
-Your options are as follows:
+Your options for `:naming:` are as follows:
 
   - `:bumpy` - BumpyFilesLooksLikeSo
   - `:camel` - camelFilesAreSimilarButStartLow
   - `:snake` - snake_case_is_all_lower_and_uses_underscores
   - `:caps`  - CAPS_FEELS_LIKE_YOU_ARE_SCREAMING
 
+