ceedling 0.25.0 → 0.27.0

data/plugins/fake_function_framework/spec/fff_mock_source_generator_spec.rb

@@ -0,0 +1,149 @@
+require 'stringio'
+require 'fff_mock_generator.rb'
+
+# Test the contents of the .c file created for the mock.
+describe "FffMockGenerator.create_mock_source" do
+
+  context "when there is nothing to mock," do
+    let(:mock_source) {
+      parsed_header = {}
+      FffMockGenerator.create_mock_source("mock_my_module", parsed_header)
+    }
+    it "then the generated file includes the fff header" do
+      expect(mock_source).to include(
+        # fff.h also requires including string.h
+        %{#include <string.h>\n} +
+        %{#include "fff.h"}
+      )
+    end
+    it "then the generated file includes the mock header" do
+      expect(mock_source).to include(
+        %{#include "mock_my_module.h"\n}
+      )
+    end
+    it "then the generated file defines the init function" do
+      expect(mock_source).to include(
+        "void mock_my_module_Init(void)\n" +
+        "{\n" +
+        "    FFF_RESET_HISTORY();\n" +
+        "}"
+      )
+    end
+    it "then the generated file defines the verify function" do
+      expect(mock_source).to include(
+        "void mock_my_module_Verify(void)\n" +
+        "{\n" +
+        "}"
+      )
+    end
+    it "then the generated file defines the destroy function" do
+      expect(mock_source).to include(
+        "void mock_my_module_Destroy(void)\n" +
+        "{\n" +
+        "}"
+      )
+    end
+  end
+
+  context "when there are multiple functions," do
+    let(:mock_source) {
+      parsed_header = create_cmock_style_parsed_header(
+        [ {:name => 'a_function', :return_type => 'int', :args => ['char *']},
+          {:name => 'another_function', :return_type => 'void'},
+          {:name => 'three', :return_type => 'bool', :args => ['float', 'int']}
+        ])
+      FffMockGenerator.create_mock_source("mock_display", parsed_header)
+    }
+    it "then the generated file contains the first fake function definition" do
+      expect(mock_source).to include(
+        "DEFINE_FAKE_VALUE_FUNC1(int, a_function, char *);"
+      )
+    end
+    it "then the generated file contains the second fake function definition" do
+      expect(mock_source).to include(
+        "DEFINE_FAKE_VOID_FUNC0(another_function);"
+      )
+    end
+    it "then the generated file contains the third fake function definition" do
+      expect(mock_source).to include(
+        "DEFINE_FAKE_VALUE_FUNC2(bool, three, float, int);"
+      )
+    end
+    it "then the init function resets all of the fakes" do
+      expect(mock_source).to include(
+        "void mock_display_Init(void)\n" +
+        "{\n" +
+        "    FFF_RESET_HISTORY();\n" +
+        "    RESET_FAKE(a_function)\n" +
+        "    RESET_FAKE(another_function)\n" +
+        "    RESET_FAKE(three)\n" +
+        "}"
+      )
+    end
+  end
+
+  context "when there is a void function with variable arguments and " +
+          "additional arguments" do
+    let(:mock_source){
+      parsed_header = {}
+      parsed_header[:functions] = [{
+        :name => "function_with_var_args",
+        :return => {:type => "void"},
+        :var_arg => "...",
+        :args => [{:type => 'char *'}, {:type => 'int'}]
+      }]
+      FffMockGenerator.create_mock_source("mock_display", parsed_header)
+    }
+    it "then the generated file contains the vararg definition" do
+      expect(mock_source).to include(
+        "DEFINE_FAKE_VOID_FUNC3_VARARG(function_with_var_args, char *, int, ...)"
+      )
+    end
+  end
+
+  context "when there is a function with a pointer to a const value" do
+    let(:mock_source){
+      parsed_header = {}
+      parsed_header[:functions] = [{
+        :name => "const_test_function",
+        :return => {:type => "void"},
+        :args => [{:type => "char *", :name => "a", :ptr? => false, :const? => true},
+                  {:type => "char *", :name => "b", :ptr? => false, :const? => false}]
+      }]
+      FffMockGenerator.create_mock_source("mock_display", parsed_header)
+    }
+    it "then the generated file contains the correct const argument in the declaration" do
+      expect(mock_source).to include(
+        "DEFINE_FAKE_VOID_FUNC2(const_test_function, const char *, char *)"
+      )
+    end
+  end
+
+  context "when there are pre-includes" do
+    let(:mock_source) {
+      parsed_source = {}
+      FffMockGenerator.create_mock_source("mock_display", parsed_source,
+        [%{"another_header.h"}])
+    }
+    it "then they are included before the other files" do
+      expect(mock_source).to include(
+        %{#include "another_header.h"\n} +
+        %{#include <string.h>}
+      )
+    end
+  end
+
+  context "when there are post-includes" do
+    let(:mock_source) {
+      parsed_source = {}
+      FffMockGenerator.create_mock_source("mock_display", parsed_source,
+        nil, [%{"another_header.h"}])
+    }
+    it "then they are included before the other files" do
+      expect(mock_source).to include(
+        %{#include "mock_display.h"\n} +
+        %{#include "another_header.h"\n}
+      )
+    end
+  end
+end

data/plugins/fake_function_framework/spec/header_generator.rb

@@ -0,0 +1,51 @@
+# Create a CMock-style parsed header hash. This the type of hash created by
+# CMock when parsing header files for automock generation. It contains all of
+# includes, typedefs and functions (with return types and arguments) parsed from
+# the header file.
+def create_cmock_style_parsed_header(functions, typedefs = nil)
+  parsed_header = {
+      :includes => nil,
+      :functions => [],
+      :typedefs => []
+  }
+
+  # Add the typedefs.
+  if typedefs
+      typedefs.each do |typedef|
+          parsed_header[:typedefs] << typedef
+      end
+  end
+
+  # Add the functions.
+  if functions
+    functions.each do |function|
+      # Build the array of arguments.
+      args = []
+      if function.key?(:args)
+        function[:args].each do |arg|
+          args << {
+            :type => arg
+          }
+        end
+      end
+      parsed_header[:functions] << {
+        :name => function[:name],
+        :modifier => "",
+        :return => {
+          :type => function[:return_type],
+          :name => "cmock_to_return",
+          :ptr? => false,
+          :const? => false,
+          :str => "void cmock_to_return",
+          :void? => true
+        },
+        :var_arg => nil,
+        :args_string => "void",
+        :args => args,
+        :args_call => "",
+        :contains_ptr? => false
+      }
+    end
+  end
+  parsed_header
+end

data/plugins/junit_tests_report/lib/junit_tests_report.rb

@@ -0,0 +1,115 @@
+require 'ceedling/plugin'
+require 'ceedling/constants'
+require 'pp'
+
+class JunitTestsReport < 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|
+        @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 )
+    stream.puts '<?xml version="1.0" encoding="utf-8" ?>'
+    stream.puts('<testsuites tests="%<total>d" failures="%<failed>d" skipped="%<ignored>d">' % 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, 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 )
+    stream.puts('  <testsuite name="%<name>s" tests="%<total>d" failures="%<failed>d" skipped="%<ignored>d">' % suite)
+
+    suite[:collection].each do |test|
+      write_test( test, stream )
+    end
+
+    unless suite[:stdout].empty?
+      stream.puts('    <system-out>')
+      suite[:stdout].each{|line| stream.puts line }
+      stream.puts('    </system-out>')
+    end
+
+    stream.puts('  </testsuite>')
+  end
+
+  def write_test( test, stream )
+    case test[:result]
+    when :success
+      stream.puts('    <testcase name="%<test>s" />' % test)
+    when :failed
+      stream.puts('    <testcase name="%<test>s">' % 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">' % test)
+      stream.puts('      <skipped />')
+      stream.puts('    </testcase>')
+    end
+  end
+end

data/plugins/subprojects/README.md

@@ -0,0 +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!

data/plugins/subprojects/config/defaults.yml

@@ -0,0 +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}
+
+...

data/plugins/subprojects/lib/subprojects.rb

@@ -0,0 +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 {
+}