ceedling 0.31.1 → 1.0.1

data/lib/ceedling/tasks_vendor.rake

@@ -1,35 +0,0 @@
-require 'ceedling/constants'
-require 'ceedling/file_path_utils'
-
-# create file dependencies to ensure C-based components of vendor tools are recompiled when they are updated with new versions
-# forming these explicitly rather than depend on auxiliary dependencies so all scenarios are explicitly covered
-
-file( @ceedling[:file_path_utils].form_test_build_c_object_filepath( UNITY_C_FILE ) => [
-  File.join( UNITY_VENDOR_PATH, UNITY_LIB_PATH, UNITY_C_FILE ),
-  File.join( UNITY_VENDOR_PATH, UNITY_LIB_PATH, UNITY_H_FILE ),
-  File.join( UNITY_VENDOR_PATH, UNITY_LIB_PATH, UNITY_INTERNALS_H_FILE ) ]
-  )
-
-
-if (PROJECT_USE_MOCKS)
-file( @ceedling[:file_path_utils].form_test_build_c_object_filepath( CMOCK_C_FILE ) => [
-  File.join( CMOCK_VENDOR_PATH, CMOCK_LIB_PATH, CMOCK_C_FILE ),
-  File.join( CMOCK_VENDOR_PATH, CMOCK_LIB_PATH, CMOCK_H_FILE ) ]
-  )
-end
-
-
-if (PROJECT_USE_EXCEPTIONS)
-file( @ceedling[:file_path_utils].form_test_build_c_object_filepath( CEXCEPTION_C_FILE ) => [
-  File.join( CEXCEPTION_VENDOR_PATH, CEXCEPTION_LIB_PATH, CEXCEPTION_C_FILE ),
-  File.join( CEXCEPTION_VENDOR_PATH, CEXCEPTION_LIB_PATH, CEXCEPTION_H_FILE ) ]
-  )
-end
-
-
-if (PROJECT_USE_EXCEPTIONS and PROJECT_RELEASE_BUILD)
-file( @ceedling[:file_path_utils].form_release_build_c_object_filepath( CEXCEPTION_C_FILE ) => [
-  File.join( CEXCEPTION_VENDOR_PATH, CEXCEPTION_LIB_PATH, CEXCEPTION_C_FILE ),
-  File.join( CEXCEPTION_VENDOR_PATH, CEXCEPTION_LIB_PATH, CEXCEPTION_H_FILE ) ]
-  )
-end

data/lib/ceedling/test_includes_extractor.rb

@@ -1,111 +0,0 @@
-
-class TestIncludesExtractor
-
-  constructor :configurator, :yaml_wrapper, :file_wrapper
-
-  def setup
-    @includes  = {}
-    @mocks     = {}
-  end
-
-
-  # for includes_list file, slurp up array from yaml file and sort & store includes
-  def parse_includes_list(includes_list)
-    gather_and_store_includes( includes_list, @yaml_wrapper.load(includes_list) )
-  end
-
-  # open, scan for, and sort & store includes of test file
-  def parse_test_file(test)
-    gather_and_store_includes( test, extract_from_file(test) )
-  end
-
-  # open, scan for, and sort & store includes of test file
-  def parse_test_file_source_include(test)
-    return extract_source_include_from_file(test)
-  end
-
-  # mocks with no file extension
-  def lookup_raw_mock_list(test)
-    file_key = form_file_key(test)
-    return [] if @mocks[file_key].nil?
-    return @mocks[file_key]
-  end
-
-  # includes with file extension
-  def lookup_includes_list(file)
-    file_key = form_file_key(file)
-    return [] if (@includes[file_key]).nil?
-    return @includes[file_key]
-  end
-
-  private #################################
-
-  def form_file_key(filepath)
-    return File.basename(filepath).to_sym
-  end
-
-  def extract_from_file(file)
-    includes = []
-    header_extension = @configurator.extension_header
-
-    contents = @file_wrapper.read(file)
-
-    # remove line comments
-    contents = contents.gsub(/\/\/.*$/, '')
-    # remove block comments
-    contents = contents.gsub(/\/\*.*?\*\//m, '')
-
-    contents.split("\n").each do |line|
-      # look for include statement
-      scan_results = line.scan(/#include\s+\"\s*(.+#{'\\'+header_extension})\s*\"/)
-
-      includes << scan_results[0][0] if (scan_results.size > 0)
-
-      # look for TEST_FILE statement
-      scan_results = line.scan(/TEST_FILE\(\s*\"\s*(.+\.\w+)\s*\"\s*\)/)
-
-      includes << scan_results[0][0] if (scan_results.size > 0)
-    end
-
-    return includes.uniq
-  end
-
-  def extract_source_include_from_file(file)
-    source_includes = []
-    source_extension = @configurator.extension_source
-
-    contents = @file_wrapper.read(file)
-
-    # remove line comments
-    contents = contents.gsub(/\/\/.*$/, '')
-    # remove block comments
-    contents = contents.gsub(/\/\*.*?\*\//m, '')
-
-    contents.split("\n").each do |line|
-      # look for include statement
-      scan_results = line.scan(/#include\s+\"\s*(.+#{'\\'+source_extension})\s*\"/)
-
-      source_includes << scan_results[0][0] if (scan_results.size > 0)
-    end
-
-    return source_includes.uniq
-  end
-
-  def gather_and_store_includes(file, includes)
-    mock_prefix      = @configurator.cmock_mock_prefix
-    header_extension = @configurator.extension_header
-    file_key         = form_file_key(file)
-    @mocks[file_key] = []
-
-    # add includes to lookup hash
-    @includes[file_key] = includes
-
-    includes.each do |include_file|
-      # check if include is a mock
-      scan_results = include_file.scan(/(#{mock_prefix}.+)#{'\\'+header_extension}/)
-      # add mock to lookup hash
-      @mocks[file_key] << scan_results[0][0] if (scan_results.size > 0)
-    end
-  end
-
-end

data/lib/ceedling/version.rb

@@ -1,54 +0,0 @@
-
-# @private
-module Ceedling
-  module Version
-    { "UNITY" => File.join("unity","src","unity.h"),
-      "CMOCK" => File.join("cmock","src","cmock.h"),
-      "CEXCEPTION" => File.join("c_exception","lib","CException.h")
-    }.each_pair do |name, path|
-      # Check for local or global version of vendor directory in order to look up versions
-      path1 = File.expand_path( File.join("..","..","vendor",path) )
-      path2 = File.expand_path( File.join(File.dirname(__FILE__),"..","..","vendor",path) )
-      filename = if (File.exists?(path1))
-        path1
-      elsif (File.exists?(path2))
-        path2
-      elsif File.exists?(CEEDLING_VENDOR)
-        path3 = File.expand_path( File.join(CEEDLING_VENDOR,path) )
-        if (File.exists?(path3))
-          path3
-        else
-          basepath = File.join( CEEDLING_VENDOR, path.split(/\\\//)[0], 'release')
-          begin
-            [ @ceedling[:file_wrapper].read( File.join(base_path, 'release', 'version.info') ).strip,
-              @ceedling[:file_wrapper].read( File.join(base_path, 'release', 'build.info') ).strip ].join('.')
-          rescue
-            "#{name}"
-          end
-        end
-      else
-        module_eval("#{name} = 'unknown'")
-        continue
-      end
-
-      # Actually look up the versions
-      a = [0,0,0]
-      begin
-        File.readlines(filename).each do |line|
-          ["VERSION_MAJOR", "VERSION_MINOR", "VERSION_BUILD"].each_with_index do |field, i|
-            m = line.match(/#{name}_#{field}\s+(\d+)/)
-            a[i] = m[1] unless (m.nil?)
-          end
-        end
-      rescue
-        abort("Can't collect data for vendor component: \"#{filename}\" . \nPlease check your setup.")
-      end
-
-      # splat it to return the final value
-      eval("#{name} = '#{a.join(".")}'")
-    end
-
-    GEM = "0.31.1"
-    CEEDLING = GEM
-  end
-end

data/out.fail

@@ -1,24 +0,0 @@
----
-:source:
-  :path: some/place
-  :file: test_example.c
-:successes: []
-:failures:
-- :test: test_one
-  :line: 257
-  :message: ''
-  :unity_test_time: 0
-- :test: test_two
-  :line: 269
-  :message: ''
-  :unity_test_time: 0
-:ignores: []
-:counts:
-  :total: 2
-  :passed: 0
-  :failed: 2
-  :ignored: 0
-:stdout:
-- Verbose output one
-- Verbous output two
-:time: 0.0

data/plugins/colour_report/README.md

@@ -1,20 +0,0 @@
-ceedling-colour-report
-======================
-
-## Overview
-
-The colour_report replaces the normal ceedling "pretty" output with 
-a colorized variant, in order to make the results easier to read from
-a standard command line. This is very useful on developer machines, but
-can occasionally cause problems with parsing on CI servers.
-
-## Setup
-
-Enable the plugin in your project.yml by adding `colour_report`
-to the list of enabled plugins.
-
-``` YAML
-:plugins:
-  :enabled:
-    - colour_report
-```

data/plugins/colour_report/lib/colour_report.rb

@@ -1,16 +0,0 @@
-require 'ceedling/plugin'
-require 'ceedling/streaminator'
-require 'ceedling/constants'
-
-class ColourReport < Plugin
-
-  def setup
-    @ceedling[:stream_wrapper].stdout_override(&ColourReport.method(:colour_stdout))
-  end
-
-  def self.colour_stdout(string)
-    require 'colour_reporter.rb'
-    report string
-  end
-
-end

data/plugins/compile_commands_json/README.md

@@ -1,29 +0,0 @@
-compile_commands_json
-=====================
-
-## Overview
-
-Syntax highlighting and code completion are hard. Historically each editor or IDE has implemented their own and then competed amongst themselves to offer the best experience for developers. Often developers would still to an IDE that felt cumbersome and slow just because it had the best syntax highlighting on the market. If doing it for one language is hard (and it is) imagine doing it for dozens of them. Imagine a full stack developer who has to work with CSS, HTML, JavaScript and some Ruby - they need excellent support in all those languages which just made things even harder.
-
-In June of 2016, Microsoft with Red Hat and Codenvy got together to create a standard called the Language Server Protocol (LSP). The idea was simple, by standardising on one protocol, all the IDEs and editors out there would only have to support LSP, and not have custom plugins for each language. In turn, the backend code that actually does the highlighting can be written once and used by any IDE that supports LSP. Many editors already support it such as Sublime Text, vim and emacs. This means that if you're using a crufty old IDE or worse, you're using a shiny new editor without code completion, then this could be just the upgrade you're looking for!
-
-For C and C++ projects, many people use the `clangd` backend. So that it can do things like "go to definition", `clangd` needs to know how to build the project so that it can figure out all the pieces to the puzzle. There are manual tools such as `bear` which can be run with `gcc` or `clang` to extract this information it has a big limitation in that if run with `ceedling release` you won't get any auto completion for Unity and you'll also get error messages reported by your IDE because of what it perceives as missing headers. If you do the same with `ceedling test` now you get Unity but you might miss things that are only seen in the release build.
-
-This plugin resolves that issue. As it is run by Ceedling, it has access to all the build information it needs to create the perfect `compile_commands.json`. Once enabled, this plugin will generate that file and place it in `./build/artifacts/compile_commands.json`. `clangd` will search your project for this file, but it is easier to symlink it into the root directory (for example `ln -s ./build/artifacts/compile_commands.json`. 
-
-For more information on LSP and to find out if your editor supports it, check out https://langserver.org/
-
-## Setup
-
-Enable the plugin in your project.yml by adding `compile_commands_json` to the list
-of enabled plugins.
-
-``` YAML
-:plugins:
-  :enabled:
-    - compile_commands_json
-```
-
-## Configuration
-
-There is no additional configuration necessary to run this plugin.

data/plugins/compile_commands_json/lib/compile_commands_json.rb

@@ -1,35 +0,0 @@
-require 'ceedling/plugin'
-require 'ceedling/constants'
-require 'json'
-
-class CompileCommandsJson < Plugin
-  def setup
-    @fullpath = File.join(PROJECT_BUILD_ARTIFACTS_ROOT, "compile_commands.json")
-    @database = if (File.exists?(@fullpath))
-                  JSON.parse( File.read(@fullpath) )
-                else
-                  []
-                end
-  end
-
-  def post_compile_execute(arg_hash)
-
-    # Create the new Entry
-    value = {
-      "directory" => Dir.pwd,
-      "command" => arg_hash[:shell_command],
-      "file" => arg_hash[:source]
-    }
-
-    # Determine if we're updating an existing file description or adding a new one
-    index = @database.index {|h| h["file"] == arg_hash[:source]}
-    if index
-      @database[index] = value
-    else
-      @database << value
-    end
-
-    # Update the Actual compile_commands.json file
-    File.open(@fullpath,'w') {|f| f << JSON.pretty_generate(@database)}
-  end
-end

data/plugins/fake_function_framework/Rakefile

@@ -1,19 +0,0 @@
-require 'rake'
-require 'rspec/core/rake_task'
-
-desc "Run all rspecs"
-RSpec::Core::RakeTask.new(:spec) do |t|
-    t.pattern = Dir.glob('spec/**/*_spec.rb')
-    t.rspec_opts = '--format documentation'
-    # t.rspec_opts << ' more options'
-end
-
-desc "Run integration test on example"
-task :integration_test do
-    chdir("./examples/fff_example") do
-        sh "rake clobber"
-        sh "rake test:all"
-    end
-end
-
-task :default => [:spec, :integration_test]

data/plugins/fake_function_framework/examples/fff_example/project.yml

@@ -1,71 +0,0 @@
----
-
-# Notes:
-# Sample project C code is not presently written to produce a release artifact.
-# As such, release build options are disabled.
-# This sample, therefore, only demonstrates running a collection of unit tests.
-
-:project:
-  :use_exceptions: FALSE
-  :use_test_preprocessor: TRUE
-  :use_auxiliary_dependencies: TRUE
-  :build_root: build
-#  :release_build: TRUE
-  :test_file_prefix: test_
-
-#:release_build:
-#  :output: MyApp.out
-#  :use_assembly: FALSE
-
-:environment:
-
-:extension:
-  :executable: .out
-
-:paths:
-  :test:
-    - +:test/**
-  :source:
-    - src/**
-  :support:
-      
-:defines:
-  # in order to add common defines:
-  #  1) remove the trailing [] from the :common: section
-  #  2) add entries to the :common: section (e.g. :test: has TEST defined)
-  :commmon: &common_defines []
-  :test:
-    - *common_defines
-    - TEST
-  :test_preprocess:
-    - *common_defines
-    - TEST
-
-:cmock:
-  :mock_prefix: mock_
-  :when_no_prototypes: :warn
-  :enforce_strict_ordering: TRUE
-  :plugins:
-    - :ignore
-    - :callback
-  :treat_as:
-    uint8:    HEX8
-    uint16:   HEX16
-    uint32:   UINT32
-    int8:     INT8
-    bool:     UINT8
-
-#:tools:
-# Ceedling defaults to using gcc for compiling, linking, etc.
-# As [:tools] is blank, gcc will be used (so long as it's in your system path)
-# See documentation to configure a given toolchain for use
-
-:plugins:
-  :load_paths:
-    # This change from the default is for running Ceedling out of another folder.
-    - ../../../../plugins
-  :enabled:
-    - stdout_pretty_tests_report
-    - module_generator
-    - fake_function_framework
-...

data/plugins/fake_function_framework/examples/fff_example/rakefile.rb

@@ -1,7 +0,0 @@
-# This change from the default is for running Ceedling out of another folder.
-PROJECT_CEEDLING_ROOT = "../../../.."
-load "#{PROJECT_CEEDLING_ROOT}/lib/ceedling.rb"
-
-Ceedling.load_project
-
-task :default => %w[ test:all release ]

data/plugins/fake_function_framework/examples/fff_example/src/bar.c

@@ -1 +0,0 @@
-#include "bar.h"

data/plugins/fake_function_framework/examples/fff_example/src/custom_types.h

@@ -1,6 +0,0 @@
-#ifndef custom_types_H
-#define custom_types_H
-
-typedef int custom_t;
-
-#endif

data/plugins/fake_function_framework/examples/fff_example/src/display.c

@@ -1,7 +0,0 @@
-#include <stdio.h>
-#include "display.h"
-
-void display_turnOffStatusLed(void)
-{
-    printf("Display: Status LED off");
-}

data/plugins/fake_function_framework/examples/fff_example/src/foo.c

@@ -1,16 +0,0 @@
-#include "foo.h"
-#include "bar.h"
-#include "subfolder/zzz.h"
-
-void foo_turn_on(void) {
-  bar_turn_on();
-  zzz_sleep(1, "sleepy");
-}
-
-void foo_print_message(const char * message) {
-  bar_print_message(message);
-}
-
-void foo_print_special_message(void) {
-  bar_print_message_formatted("The numbers are %d, %d and %d", 1, 2, 3);
-}

data/plugins/fake_function_framework/examples/fff_example/src/foo.h

@@ -1,8 +0,0 @@
-#ifndef foo_H
-#define foo_H
-
-void foo_turn_on(void);
-void foo_print_message(const char * message);
-void foo_print_special_message(void);
-
-#endif // foo_H

data/plugins/fake_function_framework/examples/fff_example/src/subfolder/zzz.c

@@ -1 +0,0 @@
-#include "zzz.h"

data/plugins/fake_function_framework/examples/fff_example/src/subfolder/zzz.h

@@ -1,6 +0,0 @@
-#ifndef zzz_H
-#define zzz_H
-
-int zzz_sleep(int time, char * name);
-
-#endif // zzz_H

data/plugins/gcov/assets/template.erb

@@ -1,15 +0,0 @@
-% function_string = hash[:coverage][:functions].to_s
-% branch_string   = hash[:coverage][:branches].to_s
-% format_string   = "%#{[function_string.length, branch_string.length].max}i"
-<%=@ceedling[:plugin_reportinator].generate_banner("#{GCOV_ROOT_NAME.upcase}: CODE COVERAGE SUMMARY")%>
-% if (!hash[:coverage][:functions].nil?)
-FUNCTIONS: <%=sprintf(format_string, hash[:coverage][:functions])%>%
-% else
-FUNCTIONS: none
-% end
-% if (!hash[:coverage][:branches].nil?)
-BRANCHES:  <%=sprintf(format_string, hash[:coverage][:branches])%>%
-% else
-BRANCHES:  none
-% end
-

data/plugins/json_tests_report/README.md

@@ -1,36 +0,0 @@
-json_tests_report
-=================
-
-## Overview
-
-The json_tests_report plugin creates a JSON file of test results, which is 
-handy for Continuous Integration build servers or as input into other 
-reporting tools. The JSON file is output to the appropriate
-`<build_root>/artifacts/` directory (e.g. `artifacts/test/` for test tasks,
-`artifacts/gcov/` for gcov, or `artifacts/bullseye/` for bullseye runs).
-
-## Setup
-
-Enable the plugin in your project.yml by adding `json_tests_report` to the list
-of enabled plugins.
-
-``` YAML
-:plugins:
-  :enabled:
-    - json_tests_report
-```
-
-## Configuration
-
-Optionally configure the output / artifact filename in your project.yml with
-the `artifact_filename` configuration option. The default filename is
-`report.json`.
-
-You can also configure the path that this artifact is stored. This can be done
-by setting `path`. The default is that it will be placed in a subfolder under
-the `build` directory.
-
-``` YAML
-:json_tests_report:
-  :artifact_filename: report_spectuluarly.json
-```

data/plugins/json_tests_report/lib/json_tests_report.rb

@@ -1,83 +0,0 @@
-require 'ceedling/plugin'
-require 'ceedling/constants'
-require 'json'
-
-class JsonTestsReport < 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])
-
-      artifact_filename = @ceedling[:configurator].project_config_hash[:json_tests_report_artifact_filename] || 'report.json'
-      artifact_fullpath = @ceedling[:configurator].project_config_hash[:json_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|
-        @test_counter = 1
-
-        json = {
-          "FailedTests" => write_failures(results[:failures]),
-          "PassedTests" => write_tests(results[:successes]),
-          "IgnoredTests" => write_tests(results[:ignores]),
-          "Summary" => write_statistics(results[:counts])
-        }
-        
-        f << JSON.pretty_generate(json)
-      end
-    end
-  end
-
-  private
-
-  def write_failures(results)
-    retval = []
-    results.each do |result|
-      result[:collection].each do |item|
-        @test_counter += 1
-        retval << {
-          "file" => File.join(result[:source][:path], result[:source][:file]),
-          "test" => item[:test],
-          "line" => item[:line],
-          "message" => item[:message]
-        }
-      end
-    end
-    return retval.uniq
-  end
-
-  def write_tests(results)
-    retval = []
-    results.each do |result|
-      result[:collection].each do |item|
-        @test_counter += 1
-        retval << { 
-          "file" => File.join(result[:source][:path], result[:source][:file]),
-          "test" => item[:test]
-        }
-      end
-    end
-    return retval
-  end
-
-  def write_statistics(counts)
-    return {
-      "total_tests" => counts[:total],
-      "passed" => (counts[:total] - counts[:ignored] - counts[:failed]),
-      "ignored" => counts[:ignored],
-      "failures" => counts[:failed]
-    }
-  end
-
-end

data/plugins/junit_tests_report/README.md

@@ -1,36 +0,0 @@
-junit_tests_report
-====================
-
-## Overview
-
-The junit_tests_report plugin creates an XML file of test results in JUnit
-format, which is handy for Continuous Integration build servers or as input
-into other reporting tools. The XML file is output to the appropriate
-`<build_root>/artifacts/` directory (e.g. `artifacts/test/` for test tasks,
-`artifacts/gcov/` for gcov, or `artifacts/bullseye/` for bullseye runs).
-
-## Setup
-
-Enable the plugin in your project.yml by adding `junit_tests_report`
-to the list of enabled plugins.
-
-``` YAML
-:plugins:
-  :enabled:
-    - junit_tests_report
-```
-
-## Configuration
-
-Optionally configure the output / artifact filename in your project.yml with
-the `artifact_filename` configuration option. The default filename is
-`report.xml`.
-
-You can also configure the path that this artifact is stored. This can be done
-by setting `path`. The default is that it will be placed in a subfolder under
-the `build` directory.
-
-``` YAML
-:junit_tests_report:
-  :artifact_filename: report_junit.xml
-```