ceedling 0.9.0 → 1.0.1

data/lib/ceedling/reportinator.rb

@@ -0,0 +1,124 @@
+# =========================================================================
+#   Ceedling - Test-Centered Build System for C
+#   ThrowTheSwitch.org
+#   Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   SPDX-License-Identifier: MIT
+# =========================================================================
+
+require 'unicode/display_width'
+
+##
+# Pretifies reports
+class Reportinator
+
+  # Generate human readable string of days, hours, minutes, seconds (and 
+  # milliseconds) from a start count of seconds and end count of seconds.
+  def self.generate_duration(start_time_s:, end_time_s:)
+    return '' if start_time_s.nil? or end_time_s.nil?
+
+    # Calculate duration as integer milliseconds
+    duration_ms = ((end_time_s - start_time_s) * 1000).to_i
+
+    # Collect human readable time string tidbits
+    duration = []
+
+    # Singular / plural whole days
+    if duration_ms >= DurationCounts::DAY_MS
+      days = duration_ms / DurationCounts::DAY_MS
+      duration << "#{days} day#{'s' if days > 1}"
+      duration_ms -= (days * DurationCounts::DAY_MS)
+      # End duration string if remainder is less than 1 second (e.g. no 2 days 13 milliseconds)
+      duration_ms = 0 if duration_ms < 1000
+    end
+
+    # Singular / plural whole hours
+    if duration_ms >= DurationCounts::HOUR_MS
+      hours = duration_ms / DurationCounts::HOUR_MS
+      duration << "#{hours} hour#{'s' if hours > 1}"
+      duration_ms -= (hours * DurationCounts::HOUR_MS)
+      # End duration string if remainder is less than 1 second (e.g. no 2 days 13 milliseconds)
+      duration_ms = 0 if duration_ms < 1000
+    end
+
+    # Singular / plural whole minutes
+    if duration_ms >= DurationCounts::MINUTE_MS
+      minutes = duration_ms / DurationCounts::MINUTE_MS
+      duration << "#{minutes} minute#{'s' if minutes > 1}"
+      duration_ms -= (minutes * DurationCounts::MINUTE_MS)
+      # End duration string if remainder is less than 1 second (e.g. no 2 days 13 milliseconds)
+      duration_ms = 0 if duration_ms < 1000
+    end
+
+    # Plural fractional seconds (rounded)
+    if duration_ms >= DurationCounts::SECOND_MS
+      seconds = (duration_ms.to_f() / 1000.0).round(2)
+      duration << "#{seconds} seconds"
+      # End duration string
+      duration_ms = 0
+    end
+
+    # Singular / plural whole milliseconds (only if orginal duration less than 1 second)
+    if duration_ms > 0
+      duration << "#{duration_ms} millisecond#{'s' if duration_ms > 1}"
+    end
+
+    return duration.join(' ')
+  end
+
+  def generate_duration(start_time_s:, end_time_s:)
+    return Reportinator.generate_duration( start_time_s: start_time_s, end_time_s: end_time_s )
+  end
+
+  ##
+  # Generates a banner for a message based on the length of the message or a
+  # given width.
+  # ==== Attributes
+  #
+  # * _message_:  The message to put.
+  # * _width_:    The width of the message. If nil the size of the banner is
+  # determined by the length of the message.
+  #
+  # ==== Examples
+  #
+  #    rp = Reportinator.new
+  #    rp.generate_banner("Hello world!") => "------------\nHello world!\n------------\n" 
+  #    rp.generate_banner("Hello world!", 3) => "---\nHello world!\n---\n" 
+  #
+  #
+  def generate_banner(message, width=nil)
+    # ---------
+    # <Message>
+    # ---------
+    dash_count = ((width.nil?) ? Unicode::DisplayWidth.of( message.strip ) : width)
+    return "#{'-' * dash_count}\n#{message}\n#{'-' * dash_count}\n"
+  end
+
+  def generate_heading(message)
+    # <Message>
+    # ---------
+    return "\n#{message}\n#{'-' * Unicode::DisplayWidth.of( message.strip )}"
+  end
+
+  def generate_progress(message)
+    # <Message>...
+    return "#{message}..."
+  end
+
+  def generate_module_progress(module_name:, filename:, operation:)
+    # <Operation [module_name::]filename>..."
+
+    # If filename is the module name, don't add the module label
+    label = (File.basename(filename).ext('') == module_name.to_s) ? '' : "#{module_name}::"
+    return generate_progress("#{operation} #{label}#{filename}")
+  end
+
+  def generate_config_walk(keys, depth=0)
+    # :key ↳ :key ↳ :key
+
+    _keys = keys.clone
+    _keys = _keys.slice(0, depth) if depth > 0
+    _keys.reject! { |key| key.nil? }
+    return _keys.map{|key| ":#{key}"}.join(' ↳ ')
+  end
+
+end

data/lib/ceedling/rules_release.rake

@@ -0,0 +1,107 @@
+# =========================================================================
+#   Ceedling - Test-Centered Build System for C
+#   ThrowTheSwitch.org
+#   Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   SPDX-License-Identifier: MIT
+# =========================================================================
+
+RELEASE_COMPILE_TASK_ROOT  = RELEASE_TASK_ROOT + 'compile:'  unless defined?(RELEASE_COMPILE_TASK_ROOT)
+RELEASE_ASSEMBLE_TASK_ROOT = RELEASE_TASK_ROOT + 'assemble:' unless defined?(RELEASE_ASSEMBLE_TASK_ROOT)
+
+# If GCC and Releasing a Library, Update Tools to Automatically Have Necessary Tags
+if (TOOLS_RELEASE_COMPILER[:executable] == DEFAULT_RELEASE_COMPILER_TOOL[:executable])
+  if (File.extname(PROJECT_RELEASE_BUILD_TARGET) == '.so')
+    TOOLS_RELEASE_COMPILER[:arguments] << "-fPIC" unless TOOLS_RELEASE_COMPILER[:arguments].include?("-fPIC")
+    TOOLS_RELEASE_LINKER[:arguments] << "-shared" unless TOOLS_RELEASE_LINKER[:arguments].include?("-shared")
+  elsif (File.extname(PROJECT_RELEASE_BUILD_TARGET) == '.a')
+    TOOLS_RELEASE_COMPILER[:arguments] << "-fPIC" unless TOOLS_RELEASE_COMPILER[:arguments].include?("-fPIC")
+    TOOLS_RELEASE_LINKER[:executable] = 'ar'
+    TOOLS_RELEASE_LINKER[:arguments] = ['rcs', '${2}', '${1}'].compact
+  end
+end
+
+rule(/#{PROJECT_RELEASE_BUILD_OUTPUT_PATH}\/#{'.+' + Regexp.escape(EXTENSION_OBJECT)}$/ => [
+    proc do |task_name|
+      @ceedling[:file_finder].find_build_input_file(filepath: task_name, complain: :error, context: RELEASE_SYM)
+    end
+  ]) do |object|
+
+  if @ceedling[:file_wrapper].extname(object.source) != EXTENSION_ASSEMBLY
+    @ceedling[:generator].generate_object_file_c(
+      tool:         TOOLS_RELEASE_COMPILER,
+      module_name:  File.basename(object.source).ext(), # Source filename as module name
+      context:      RELEASE_SYM,
+      source:       object.source,
+      object:       object.name,
+      search_paths: COLLECTION_PATHS_INCLUDE,
+      flags:        @ceedling[:flaginator].flag_down( context:RELEASE_SYM, operation:OPERATION_COMPILE_SYM ),
+      defines:      @ceedling[:defineinator].defines( subkey:RELEASE_SYM ),
+      list:         @ceedling[:file_path_utils].form_release_build_list_filepath( object.name ),
+      dependencies: @ceedling[:file_path_utils].form_release_dependencies_filepath( object.name ) )
+  else
+    @ceedling[:generator].generate_object_file_asm(
+      tool:         TOOLS_RELEASE_ASSEMBLER,
+      module_name:  File.basename(object.source).ext(), # Source filename as module name
+      context:      RELEASE_SYM,
+      source:       object.source,
+      object:       object.name,
+      search_paths: COLLECTION_PATHS_INCLUDE,
+      flags:        @ceedling[:flaginator].flag_down( context:RELEASE_SYM, operation:OPERATION_ASSEMBLE_SYM ),
+      defines:      @ceedling[:defineinator].defines( subkey:RELEASE_SYM ),
+      list:         @ceedling[:file_path_utils].form_release_build_list_filepath( object.name ),
+      dependencies: @ceedling[:file_path_utils].form_release_dependencies_filepath( object.name ) )
+  end
+end
+
+rule(/#{PROJECT_RELEASE_BUILD_TARGET}/) do |bin_file|
+  objects, libraries = @ceedling[:release_invoker].sort_objects_and_libraries(bin_file.prerequisites)
+  tool      = TOOLS_RELEASE_LINKER.clone
+  lib_args  = @ceedling[:release_invoker].convert_libraries_to_arguments(libraries)
+  lib_paths = @ceedling[:release_invoker].get_library_paths_to_arguments()
+  map_file  = @ceedling[:configurator].project_release_build_map
+
+  @ceedling[:generator].generate_executable_file(
+    tool,
+    RELEASE_SYM,
+    objects,
+    [], # Flags
+    bin_file.name,
+    map_file,
+    lib_args,
+    lib_paths )
+  @ceedling[:release_invoker].artifactinate( bin_file.name, map_file, @ceedling[:configurator].release_build_artifacts )
+end
+
+namespace RELEASE_SYM do
+  # Use rules to increase efficiency for large projects (instead of iterating through all sources and creating defined tasks)
+
+  # Unadvertised Rake tasks to execute source file compilation
+  namespace :compile do
+    rule(/^#{RELEASE_COMPILE_TASK_ROOT}\S+(#{Regexp.escape(EXTENSION_SOURCE)}|#{Regexp.escape(EXTENSION_CORE_SOURCE)})$/ => [ # compile task names by regex
+        proc do |task_name|
+          source = task_name.sub(/#{RELEASE_COMPILE_TASK_ROOT}/, '')
+          @ceedling[:file_finder].find_source_file(source)
+        end
+    ]) do |compile|
+      @ceedling[:rake_wrapper][:prepare].invoke
+      @ceedling[:release_invoker].setup_and_invoke_objects( [compile.source] )
+    end
+  end
+
+  # Unadvertised Rake tasks to execute source file assembly
+  if (RELEASE_BUILD_USE_ASSEMBLY)
+  namespace :assemble do
+    rule(/^#{RELEASE_ASSEMBLE_TASK_ROOT}\S+#{Regexp.escape(EXTENSION_ASSEMBLY)}$/ => [ # assemble task names by regex
+        proc do |task_name|
+          source = task_name.sub(/#{RELEASE_ASSEMBLE_TASK_ROOT}/, '')
+          @ceedling[:file_finder].find_assembly_file(source)
+        end
+    ]) do |assemble|
+      @ceedling[:rake_wrapper][:prepare].invoke
+      @ceedling[:release_invoker].setup_and_invoke_objects( [assemble.source] )
+    end
+  end
+  end
+
+end
+

data/lib/ceedling/rules_tests.rake

@@ -0,0 +1,62 @@
+# =========================================================================
+#   Ceedling - Test-Centered Build System for C
+#   ThrowTheSwitch.org
+#   Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   SPDX-License-Identifier: MIT
+# =========================================================================
+
+rule(/#{PROJECT_TEST_BUILD_OUTPUT_PATH}\/#{'.+\\' + EXTENSION_OBJECT}$/ => [
+    proc do |task_name|
+      _, object = (task_name.split('+'))
+      @ceedling[:file_finder].find_build_input_file(filepath: object, context: TEST_SYM)
+    end
+  ]) do |target|
+    test, object = (target.name.split('+'))
+
+    tool = TOOLS_TEST_COMPILER
+
+    if @ceedling[:file_wrapper].extname(target.source) == EXTENSION_ASSEMBLY
+      tool = TOOLS_TEST_ASSEMBLER
+    end
+
+    @ceedling[:test_invoker].compile_test_component(
+      tool: tool,
+      test: test.to_sym,
+      source: target.source,
+      object: object
+    )
+  end
+
+namespace TEST_SYM do
+  TOOL_COLLECTION_TEST_RULES = {
+    :context        => TEST_SYM,
+    :test_compiler  => TOOLS_TEST_COMPILER,
+    :test_assembler => TOOLS_TEST_ASSEMBLER,
+    :test_linker    => TOOLS_TEST_LINKER,
+    :test_fixture   => TOOLS_TEST_FIXTURE
+  }
+
+  # Use rules to increase efficiency for large projects (instead of iterating through all sources and creating defined tasks)
+  rule(/^#{TEST_TASK_ROOT}\S+$/ => [ # Test task names by regex
+      proc do |task_name|
+        # Yield clean test name => Strip the task string, remove Rake test task prefix, and remove any code file extension
+        test = task_name.strip().sub(/^#{TEST_TASK_ROOT}/, '').chomp( EXTENSION_SOURCE )
+
+        # Ensure the test name begins with a test name prefix
+        test = PROJECT_TEST_FILE_PREFIX + test if not (test.start_with?( PROJECT_TEST_FILE_PREFIX ))
+
+        # Provide the filepath for the target test task back to the Rake task
+        @ceedling[:file_finder].find_test_file_from_name( test )
+      end
+  ]) do |test|
+    # Do essential Rake-based set up
+    @ceedling[:rake_wrapper][:prepare].invoke
+
+    # Execute the test task
+    @ceedling[:test_invoker].setup_and_invoke(
+      tests:[test.source],
+      options:{:force_run => true, :build_only => false}.merge( TOOL_COLLECTION_TEST_RULES )
+    )
+  end
+end
+

data/lib/ceedling/setupinator.rb

@@ -0,0 +1,199 @@
+# =========================================================================
+#   Ceedling - Test-Centered Build System for C
+#   ThrowTheSwitch.org
+#   Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   SPDX-License-Identifier: MIT
+# =========================================================================
+
+class Setupinator
+
+  attr_reader :config_hash
+
+  def setup
+    @config_hash = {}
+  end
+
+
+  # Override to prevent exception handling from walking & stringifying the object variables.
+  # Object variables are gigantic and produce a flood of output.
+  def inspect
+    # TODO: When identifying information is added to constructor, insert it into `inspect()` string
+    return this.class.name
+  end
+
+
+  # Injector method for setting Ceedling application object hash
+  def ceedling=(value)
+    # Capture application objects hash as instance variable
+    @ceedling = value
+
+    # Get our dependencies from object hash rather than DIY constructor
+    # This is a shortcut / validates aspects of our setup
+    @configurator         = value[:configurator]
+    @loginator            = value[:loginator]
+    @reportinator         = value[:reportinator]
+    @plugin_manager       = value[:plugin_manager]
+    @plugin_reportinator  = value[:plugin_reportinator]
+    @test_runner_manager  = value[:test_runner_manager]
+  end
+
+
+  # Load up all the constants and accessors our rake files, objects, & external scripts will need.
+  def do_setup( app_cfg )
+    @config_hash = app_cfg[:project_config]
+
+    ##
+    ## 1. Miscellaneous handling and essential configuration prep
+    ##
+
+    # Set special purpose test case filters (from command line)
+    @configurator.include_test_case = app_cfg[:include_test_case]
+    @configurator.exclude_test_case = app_cfg[:exclude_test_case]
+
+    # Verbosity handling
+    @configurator.set_verbosity( config_hash )
+
+    # Logging configuration
+    @loginator.set_logfile( app_cfg[:log_filepath] )
+    @configurator.project_logging = @loginator.project_logging
+
+    log_step( 'Validating configuration contains minimum required sections', heading:false )
+
+    # Complain early about anything essential that's missing
+    @configurator.validate_essential( config_hash )
+
+    # Merge any needed runtime settings into user configuration
+    @configurator.merge_ceedling_runtime_config( config_hash, CEEDLING_RUNTIME_CONFIG.deep_clone )
+
+    ##
+    ## 2. Handle basic configuration
+    ##
+
+    log_step( 'Base configuration handling', heading:false )
+
+    # Evaluate environment vars before plugin configurations that might reference with inline Ruby string expansion
+    @configurator.eval_environment_variables( config_hash )
+
+    # Standardize paths and add to Ruby load paths
+    plugins_paths_hash = @configurator.prepare_plugins_load_paths( app_cfg[:ceedling_plugins_path], config_hash )
+
+    ##
+    ## 3. Plugin Handling
+    ##
+
+    log_step( 'Plugin Handling' )
+
+    # Plugin handling
+    @configurator.discover_plugins( plugins_paths_hash, config_hash )
+    @configurator.merge_config_plugins( config_hash )
+    @configurator.populate_plugins_config( plugins_paths_hash, config_hash )
+
+    ##
+    ## 4. Collect and apply defaults to user configuration
+    ##
+
+    log_step( 'Assembling Default Settings' )
+
+    # Assemble defaults
+    defaults_hash = DEFAULT_CEEDLING_PROJECT_CONFIG.deep_clone()
+    @configurator.merge_tools_defaults( config_hash, defaults_hash )
+    @configurator.populate_cmock_defaults( config_hash, defaults_hash )
+    @configurator.merge_plugins_defaults( plugins_paths_hash, config_hash, defaults_hash )
+
+    # Set any missing essential or plugin values in configuration with assembled default values
+    @configurator.populate_with_defaults( config_hash, defaults_hash )
+
+    ##
+    ## 5. Fill out / modify remaining configuration from user configuration + defaults
+    ##
+
+    log_step( 'Completing Project Configuration' )
+
+    # Populate Unity configuration with values to tie vendor tool configurations together
+    @configurator.populate_unity_config( config_hash )
+
+    # Populate CMock configuration with values to tie vendor tool configurations together
+    @configurator.populate_cmock_config( config_hash )
+
+    # Configure test runner generation
+    @configurator.populate_test_runner_generation_config( config_hash )
+
+    # Automagically enable use of exceptions based on CMock settings
+    @configurator.populate_exceptions_config( config_hash )
+
+    # Evaluate environment vars again before subsequent configurations that might reference with inline Ruby string expansion
+    @configurator.eval_environment_variables( config_hash )
+
+    # Standardize values and expand inline Ruby string substitutions
+    @configurator.eval_paths( config_hash )
+    @configurator.eval_flags( config_hash )
+    @configurator.eval_defines( config_hash )
+    @configurator.standardize_paths( config_hash )
+
+    # Fill out any missing tool config value
+    @configurator.populate_tools_config( config_hash )
+
+    # From any tool definition shortcuts:
+    #  - Redefine executable if set
+    #  - Add arguments from tool definition shortcuts if set
+    @configurator.populate_tools_shortcuts( config_hash )
+
+    # Configure test runner build & runtime options
+    @test_runner_manager.configure_build_options( config_hash )
+    @test_runner_manager.configure_runtime_options( app_cfg[:include_test_case], app_cfg[:exclude_test_case] )
+
+    ##
+    ## 6. Validate configuration
+    ##
+
+    log_step( 'Validating final project configuration', heading:false )
+
+    @configurator.validate_final( config_hash, app_cfg )
+
+    ##
+    ## 7. Flatten configuration + process it into globals and accessors
+    ##
+
+    # Skip logging this step as the end user doesn't care about this internal preparation
+
+    # Partially flatten config + build Configurator accessors and globals
+    @configurator.build( app_cfg[:ceedling_lib_path], app_cfg[:logging_path], config_hash, :environment )
+
+    ##
+    ## 8. Final plugins handling
+    ##
+
+    # Detailed logging already happend for plugin processing
+    log_step( 'Loading Plugins' )
+
+    @configurator.insert_rake_plugins( @configurator.rake_plugins )
+    
+    # Merge in any environment variables that plugins specify after the main build
+    @plugin_manager.load_programmatic_plugins( @configurator.programmatic_plugins, @ceedling ) do |env|
+      # Evaluate environment vars that plugins may have added
+      @configurator.eval_environment_variables( env )
+      @configurator.build_supplement( config_hash, env )
+    end
+    
+    # Inject dependencies for plugin needs
+    @plugin_reportinator.set_system_objects( @ceedling )
+  end
+
+
+### Private
+
+private
+
+  # Neaten up a build step with progress message and some scope encapsulation
+  def log_step(msg, heading:true)
+    if heading
+      msg = @reportinator.generate_heading( @loginator.decorate( msg, LogLabels::CONSTRUCT ) )
+    else # Progress message
+      msg = "\n" + @reportinator.generate_progress( @loginator.decorate( msg, LogLabels::CONSTRUCT ) )
+    end
+
+    @loginator.log( msg, Verbosity::OBNOXIOUS )
+  end
+
+
+end

data/lib/ceedling/stream_wrapper.rb

@@ -0,0 +1,51 @@
+# =========================================================================
+#   Ceedling - Test-Centered Build System for C
+#   ThrowTheSwitch.org
+#   Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   SPDX-License-Identifier: MIT
+# =========================================================================
+
+BEGIN {
+  require 'io/nonblock'
+
+  # If possible, capture standard data streams non-blocking mode at startup (to be restored at shutdown).
+  # A sophisticated build setup (e.g. CI) may have intended this change on either side of Ceedling, 
+  # but it will cause trouble for Ceedling itself.
+
+  if STDOUT.respond_to?(:nonblock?) # Non-blocking mode query not implemented on all platforms
+    STDIN_STARTUP_NONBLOCKING_MODE = (STDIN.nonblock?).freeze if !defined?( STDIN_STARTUP_NONBLOCKING_MODE )
+    STDOUT_STARTUP_NONBLOCKING_MODE = (STDOUT.nonblock?).freeze if !defined?( STDOUT_STARTUP_NONBLOCKING_MODE )
+    STDERR_STARTUP_NONBLOCKING_MODE = (STDERR.nonblock?).freeze if !defined?( STDERR_STARTUP_NONBLOCKING_MODE )
+  end
+
+  # Ensure standard data streams are in blocking mode for Ceedling runs
+  STDIN.nonblock = false
+  STDOUT.nonblock = false
+  STDERR.nonblock = false
+}
+
+class StreamWrapper
+
+  def initialize
+    STDOUT.sync
+    STDERR.sync
+  end
+
+  def stdout_puts(string)
+    $stdout.puts(string)
+  end
+
+  def stderr_puts(string)
+    $stderr.puts(string)
+  end
+
+end
+
+END {
+  require 'io/nonblock'
+
+  # If they were captured, reset standard data streams' non-blocking mode to the setting captured at startup
+  STDIN.nonblock = STDIN_STARTUP_NONBLOCKING_MODE if defined?( STDIN_STARTUP_NONBLOCKING_MODE )
+  STDOUT.nonblock = STDOUT_STARTUP_NONBLOCKING_MODE if defined?( STDOUT_STARTUP_NONBLOCKING_MODE )
+  STDERR.nonblock = STDERR_STARTUP_NONBLOCKING_MODE if defined?( STDERR_STARTUP_NONBLOCKING_MODE )
+}

data/lib/ceedling/system_utils.rb

@@ -0,0 +1,43 @@
+# =========================================================================
+#   Ceedling - Test-Centered Build System for C
+#   ThrowTheSwitch.org
+#   Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   SPDX-License-Identifier: MIT
+# =========================================================================
+
+class Object
+  def deep_clone
+    Marshal::load(Marshal.dump(self))
+  end
+end
+
+
+##
+# Class containing system utility funcions.
+class SystemUtils
+
+  constructor :system_wrapper
+
+  ##
+  # Sets up the class. 
+  def setup
+    @tcsh_shell = nil
+  end
+
+  ##
+  # Checks the system shell to see if it a tcsh shell.
+  def tcsh_shell?
+    # once run a single time, return state determined at that execution
+    return @tcsh_shell unless @tcsh_shell.nil?
+  
+    result = @system_wrapper.shell_backticks(command:'echo $version')
+
+    if ((result[:exit_code] == 0) and (result[:output].strip =~ /^tcsh/))
+      @tcsh_shell = true
+    else
+      @tcsh_shell = false
+    end
+  
+    return @tcsh_shell
+  end
+end