ceedling 0.31.1 → 1.0.1

data/plugins/dependencies/example/boss/project.yml

@@ -0,0 +1,231 @@
+# =========================================================================
+#   Ceedling - Test-Centered Build System for C
+#   ThrowTheSwitch.org
+#   Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   SPDX-License-Identifier: MIT
+# =========================================================================
+
+---
+:project:
+  # how to use ceedling. If you're not sure, leave this as `gem` and `?`
+  :which_ceedling: ../../../..
+  :ceedling_version: '?'
+
+  # optional features. If you don't need them, keep them turned off for performance
+  :use_mocks: TRUE
+  :use_test_preprocessor: :all
+  :use_backtrace: :none
+
+  # tweak the way ceedling handles automatic tasks
+  :build_root: build
+  :test_file_prefix: test_
+  :default_tasks:
+    - test:all
+
+  # performance options. If your tools start giving mysterious errors, consider 
+  # dropping this to 1 to force single-tasking
+  :test_threads: 8
+  :compile_threads: 8
+
+  # enable release build (more details in release_build section below)
+  :release_build: TRUE
+
+# further details to configure the way Ceedling handles test code
+:test_build:
+  :use_assembly: FALSE
+
+# further details to configure the way Ceedling handles release code
+:release_build:
+  :output: DepTest
+  :use_assembly: FALSE
+  :artifacts: []
+
+# add the following dependencies to our build
+:dependencies:
+  :deps:
+    - :name: SupervisorSupremo
+      :paths:
+        :fetch:    ../supervisor/
+        :source:   ../supervisor/
+        :build:    ../supervisor/build
+        :artifact: ../supervisor/build
+      :fetch:
+        :method: :none
+      :environment: []
+      :build:
+        - "ceedling clobber test:all release"
+      :artifacts:
+        :static_libraries:
+          - release/libsupervisor.a
+        :dynamic_libraries: []
+        :includes: 
+          - ../src/supervisor.h
+    - :name: WorkerBees
+      :paths:
+        :fetch:    third_party/bees/source
+        :source:   third_party/bees/source
+        :build:    third_party/bees/source/build
+        :artifact: third_party/bees/source/build
+      :fetch:
+        :method: :zip
+        :source: ../../../../workerbees.zip #relative to source_path above
+      :environment: []
+      :build:
+        - make
+      :artifacts:
+        :static_libraries:
+          - libworker.a
+        :dynamic_libraries: []
+        :includes:
+          - libworker.h
+    - :name: VersionReporter
+      :paths:
+        :fetch:    third_party/version/reporter
+        :source:   third_party/version/reporter
+        :build:    third_party/version/build
+        :artifact: third_party/version/build
+      :fetch:
+        :method: :tar_gzip
+        :source: ../../../../version.tar.gzip #relative to source_path above
+      :environment: []
+      :build:
+        - :build_lib
+      :artifacts:
+        :static_libraries:
+          - libver.a
+        :dynamic_libraries: []
+        :includes:
+          - ../reporter/version.h
+
+# Plugins are optional Ceedling features which can be enabled. Ceedling supports
+# a variety of plugins which may effect the way things are compiled, reported, 
+# or may provide new command options. Refer to the readme in each plugin for 
+# details on how to use it.
+:plugins:
+  :load_paths: []
+  :enabled:
+    #- beep                           # beeps when finished, so you don't waste time waiting for ceedling
+    #- module_generator               # handy for quickly creating source, header, and test templates
+    #- gcov                           # test coverage using gcov. Requires gcc, gcov, and a coverage analyzer like gcovr
+    #- bullseye                       # test coverage using bullseye. Requires bullseye for your platform
+    #- command_hooks                  # write custom actions to be called at different points during the build process
+    #- compile_commands_json          # generate a compile_commands.json file
+    - dependencies                    # automatically fetch 3rd party libraries, etc.
+    #- subprojects                    # managing builds and test for static libraries
+    #- fake_function_framework        # use FFF instead of CMock
+
+    # Report options (You'll want to choose one stdout option, but may choose multiple stored options if desired)
+    - report_tests_pretty_stdout
+
+# override the default extensions for your system and toolchain
+:extension:
+  #:header: .h
+  #:source: .c
+  #:assembly: .s
+  #:dependencies: .d
+  #:object: .o
+  :executable: .out
+  #:testpass: .pass
+  #:testfail: .fail
+  :subprojects: .a
+
+# This is where Ceedling should look for your source and test files.
+# see documentation for the many options for specifying this.
+:paths:
+  :test:
+    - ./test
+  :source:
+    - ./src
+  :include:
+    - ./src
+  :libraries: []
+
+# You can even specify specific files to add or remove from your test
+# and release collections. Usually it's better to use paths and let
+# Ceedling do the work for you!
+:files:
+  :test: []
+  :source: []
+
+# Compilation symbols to be injected into builds
+# See documentation for advanced options:
+#  - Test name matchers for different symbols per test executable build
+#  - Referencing symbols in multiple lists using advanced YAML
+#  - Specifiying symbols used during test preprocessing
+:defines:
+  :test:
+    - TEST # Simple list option to add symbol 'TEST' to compilation of all files in all test executables
+    - STATIC=
+  :release:
+    - STATIC=static
+
+  # Enable to inject name of a test as a unique compilation symbol into its respective executable build. 
+  :use_test_definition: FALSE 
+
+# Configure additional command line flags provided to tools used in each build step
+# :flags:
+#   :release:
+#     :compile:         # Add '-Wall' and '--02' to compilation of all files in release target
+#       - -Wall
+#       - --O2
+#   :test:
+#     :compile:
+#       '(_|-)special': # Add '-pedantic' to compilation of all files in all test executables with '_special' or '-special' in their names
+#         - -pedantic
+#       '*':            # Add '-foo' to compilation of all files in all test executables
+#         - -foo
+
+# Configuration Options specific to CMock. See CMock docs for details
+: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
+
+# Configuration options specific to Unity. 
+:unity:
+  :defines:
+    - UNITY_EXCLUDE_FLOAT
+
+# You can optionally have ceedling create environment variables for you before
+# performing the rest of its tasks.
+:environment: []
+
+# LIBRARIES
+# These libraries are automatically injected into the build process. Those specified as
+# common will be used in all types of builds. Otherwise, libraries can be injected in just
+# tests or releases. These options are MERGED with the options in supplemental yaml files.
+:libraries:
+  :placement: :end
+  :flag: "-l${1}"
+  :path_flag: "-L ${1}"
+  :system: []    # for example, you might list 'm' to grab the math library
+  :test: []
+  :release: []
+
+# TOOLS 
+# This is custom configuration for any tools, but in this case, we are highlighting the
+# configuration options for the dependency tools
+:tools:
+  :deps_compiler:
+    :executable: gcc
+    :arguments:
+      - -g
+      - -I"$": COLLECTION_PATHS_DEPS
+      - -D$: COLLECTION_DEFINES_DEPS
+      - -c "${1}"
+      - -o "${2}"
+  :deps_linker:
+    :executable: ar
+    :arguments:
+      - -rcs
+      - ${2}
+      - ${1}

data/plugins/dependencies/example/boss/src/boss.c

@@ -0,0 +1,80 @@
+/* =========================================================================
+    Ceedling - Test-Centered Build System for C
+    ThrowTheSwitch.org
+    Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+    SPDX-License-Identifier: MIT
+========================================================================= */
+
+#include "boss.h"
+#include "supervisor.h"
+#include "libworker.h"
+
+#define MAXIMUM_WORKERS 20
+
+STATIC int hours_worked[MAXIMUM_WORKERS];
+STATIC int total_workers = 0;
+STATIC int total_hours = 0;
+
+void boss_start()
+{
+	int i = 0;
+
+	total_workers = 0;
+	total_hours = 0;
+
+	for (i = 0; i < MAXIMUM_WORKERS; i++)
+	{
+		hours_worked[i] = 0;
+	}
+}
+
+void boss_hire_workers(int num_workers)
+{
+	if (num_workers > 0) {
+		total_workers += num_workers;
+	}
+}
+
+void boss_fire_workers(int num_workers)
+{
+	if (num_workers > total_workers)
+	{
+		num_workers = total_workers;
+	}
+
+	if (num_workers > 0)
+	{
+		total_workers -= num_workers;
+	}
+}
+
+int boss_micro_manage(int* chunks_of_work, int num_chunks)
+{
+	int i;
+	int id;
+
+	if ((num_chunks < 0) || (chunks_of_work == 0))
+	{
+		return -1;
+	}
+
+	/* Start of the work iteration */
+	for (i = 0; i < total_workers; i++)
+	{
+		worker_start_over(i);
+	}
+
+	/* Distribute the work "fairly" */
+	for (i = 0; i < num_chunks; i++)
+	{
+		id = supervisor_delegate(hours_worked, total_workers);
+		if (id >= 0)
+		{
+			worker_work(id, chunks_of_work[i]);
+			hours_worked[id] = worker_progress(id);
+		}
+	}
+
+	/* How much work was finished? */
+	return supervisor_progress(hours_worked, total_workers);
+}

data/plugins/dependencies/example/boss/src/boss.h

@@ -0,0 +1,16 @@
+/* =========================================================================
+    Ceedling - Test-Centered Build System for C
+    ThrowTheSwitch.org
+    Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+    SPDX-License-Identifier: MIT
+========================================================================= */
+
+#ifndef BOSS_H
+#define BOSS_H
+
+void boss_start();
+void boss_hire_workers(int num_workers);
+void boss_fire_workers(int num_workers);
+int boss_micro_manage(int* chunks_of_work, int num_chunks);
+
+#endif 

data/plugins/dependencies/example/boss/src/main.c

@@ -0,0 +1,45 @@
+/* =========================================================================
+    Ceedling - Test-Centered Build System for C
+    ThrowTheSwitch.org
+    Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+    SPDX-License-Identifier: MIT
+========================================================================= */
+
+#include <stdlib.h>
+#include <stdio.h>
+
+#include "boss.h"
+#include "version.h"
+
+#define WORK 20
+
+int main(int argc, char *argv[]) 
+{
+    int i;
+    int work[WORK];
+    int retval;
+
+    /* output the version */
+    puts(get_version());
+
+	/* This could be more interesting... but honestly, we're just proving this all builds */
+	boss_start();
+
+	/* Hire some workers */
+	for (i=0; i < 3; i++)
+	{
+		boss_hire_workers( 1 + rand() % 5 );
+	}
+
+	/* Fire a few */
+	boss_fire_workers( rand() % 3 );
+
+	/* Do some work */
+	for (i= 0; i < WORK; i++)
+	{
+		work[i] = rand() % 10;
+	}
+	retval = boss_micro_manage(work, WORK);
+
+	return retval;
+}

data/plugins/dependencies/example/boss/test/test_boss.c

@@ -0,0 +1,118 @@
+/* =========================================================================
+    Ceedling - Test-Centered Build System for C
+    ThrowTheSwitch.org
+    Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+    SPDX-License-Identifier: MIT
+========================================================================= */
+
+#ifdef TEST
+
+#include "unity.h"
+
+#include "mock_supervisor.h"
+#include "mock_libworker.h"
+#include "boss.h"
+
+
+extern int hours_worked[];
+extern int total_workers;
+extern int total_hours;
+
+void setUp(void)
+{
+    boss_start();
+}
+
+void tearDown(void)
+{
+}
+
+void test_boss_start_ResetsAllTheStuff(void)
+{
+    int i;
+
+    total_workers = 3;
+    total_hours = 33;
+
+    for (i=0; i < 3; i++)
+    {
+        hours_worked[i] = i+1;
+    }
+
+    boss_start();
+
+    TEST_ASSERT_EQUAL_INT(0, total_workers);
+    TEST_ASSERT_EQUAL_INT(0, total_hours);
+    TEST_ASSERT_EQUAL_INT(0, hours_worked[0]);
+    TEST_ASSERT_EQUAL_INT(0, hours_worked[1]);
+    TEST_ASSERT_EQUAL_INT(0, hours_worked[2]);
+}
+
+void test_boss_can_HireAndFireWorkers(void)
+{
+    TEST_ASSERT_EQUAL(0, total_workers);
+
+    boss_hire_workers(3);
+    TEST_ASSERT_EQUAL(3, total_workers);
+
+    boss_hire_workers(1);
+    boss_hire_workers(7);
+    TEST_ASSERT_EQUAL(11, total_workers);
+
+    boss_hire_workers(0);
+    TEST_ASSERT_EQUAL(11, total_workers);
+
+    boss_hire_workers(-1);
+    TEST_ASSERT_EQUAL(11, total_workers);
+
+    boss_fire_workers(3);
+    TEST_ASSERT_EQUAL(8, total_workers);
+
+    boss_fire_workers(2);
+    boss_fire_workers(4);
+    TEST_ASSERT_EQUAL(2, total_workers);
+
+    boss_fire_workers(0);
+    TEST_ASSERT_EQUAL(2, total_workers);
+
+    boss_fire_workers(-1);
+    TEST_ASSERT_EQUAL(2, total_workers);
+
+    boss_hire_workers(18);
+    TEST_ASSERT_EQUAL(20, total_workers);
+
+    boss_fire_workers(20);
+    TEST_ASSERT_EQUAL(0, total_workers);
+
+    boss_fire_workers(5);
+    TEST_ASSERT_EQUAL(0, total_workers);
+}
+
+void test_boss_can_MicroManageLikeABoss(void)
+{
+    /* An ever-increasing amount of work. this boss is kinda mean. */
+    int i;
+    const int work_to_do[8] = { 1, 2, 3, 4, 5, 6, 7, 8 };
+
+    worker_start_over_Ignore();
+    worker_work_Ignore();
+    worker_progress_IgnoreAndReturn(1);
+    supervisor_progress_IgnoreAndReturn(36);
+
+    for (i=0; i < 8; i++)
+    {
+        supervisor_delegate_IgnoreAndReturn(i % 4);
+    }
+
+    /* assign all the hours */
+    boss_hire_workers(4);
+    TEST_ASSERT_EQUAL_INT(36, boss_micro_manage(work_to_do, 8));
+
+    /* make sure everyone has work to do */
+    for (i=0; i < 4; i++)
+    {
+        TEST_ASSERT_NOT_EQUAL_INT(0, hours_worked[i]);
+    }
+}
+
+#endif 

data/plugins/dependencies/example/supervisor/project.yml

@@ -0,0 +1,165 @@
+# =========================================================================
+#   Ceedling - Test-Centered Build System for C
+#   ThrowTheSwitch.org
+#   Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   SPDX-License-Identifier: MIT
+# =========================================================================
+
+---
+:project:
+  # how to use ceedling. If you're not sure, leave this as `gem` and `?`
+  :which_ceedling: ../../../..
+  :ceedling_version: '?'
+
+  # optional features. If you don't need them, keep them turned off for performance
+  :use_mocks: TRUE
+  :use_test_preprocessor: :all
+  :use_backtrace: :none
+
+  # tweak the way ceedling handles automatic tasks
+  :build_root: build
+  :test_file_prefix: test_
+  :default_tasks:
+    - test:all
+
+  # performance options. If your tools start giving mysterious errors, consider 
+  # dropping this to 1 to force single-tasking
+  :test_threads: 8
+  :compile_threads: 8
+
+  # enable release build (more details in release_build section below)
+  :release_build: TRUE
+
+# further details to configure the way Ceedling handles test code
+:test_build:
+  :use_assembly: FALSE
+
+# further details to configure the way Ceedling handles release code
+:release_build:
+  :output: libsupervisor.a
+  :use_assembly: FALSE
+  :artifacts: []
+
+# Plugins are optional Ceedling features which can be enabled. Ceedling supports
+# a variety of plugins which may effect the way things are compiled, reported, 
+# or may provide new command options. Refer to the readme in each plugin for 
+# details on how to use it.
+:plugins:
+  :load_paths: []
+  :enabled:
+    #- beep                           # beeps when finished, so you don't waste time waiting for ceedling
+    #- module_generator               # handy for quickly creating source, header, and test templates
+    #- gcov                           # test coverage using gcov. Requires gcc, gcov, and a coverage analyzer like gcovr
+    #- bullseye                       # test coverage using bullseye. Requires bullseye for your platform
+    #- command_hooks                  # write custom actions to be called at different points during the build process
+    #- compile_commands_json          # generate a compile_commands.json file
+    #- dependencies                   # automatically fetch 3rd party libraries, etc.
+    #- subprojects                    # managing builds and test for static libraries
+    #- fake_function_framework        # use FFF instead of CMock
+
+    # Report options (You'll want to choose one stdout option, but may choose multiple stored options if desired)
+    - report_tests_pretty_stdout
+
+# override the default extensions for your system and toolchain
+:extension:
+  #:header: .h
+  #:source: .c
+  #:assembly: .s
+  #:dependencies: .d
+  #:object: .o
+  :executable: .a
+  #:testpass: .pass
+  #:testfail: .fail
+  #:subprojects: .a
+
+# This is where Ceedling should look for your source and test files.
+# see documentation for the many options for specifying this.
+:paths:
+  :test:
+    - ./test
+  :source:
+    - ./src
+  :include:
+    - ./src
+  :libraries: []
+
+# You can even specify specific files to add or remove from your test
+# and release collections. Usually it's better to use paths and let
+# Ceedling do the work for you!
+:files:
+  :test: []
+  :source: []
+
+# Compilation symbols to be injected into builds
+# See documentation for advanced options:
+#  - Test name matchers for different symbols per test executable build
+#  - Referencing symbols in multiple lists using advanced YAML
+#  - Specifiying symbols used during test preprocessing
+:defines:
+  :test:
+    - TEST # Simple list option to add symbol 'TEST' to compilation of all files in all test executables
+  :release: []
+
+  # Enable to inject name of a test as a unique compilation symbol into its respective executable build. 
+  :use_test_definition: FALSE 
+
+# Configure additional command line flags provided to tools used in each build step
+# :flags:
+#   :release:
+#     :compile:         # Add '-Wall' and '--02' to compilation of all files in release target
+#       - -Wall
+#       - --O2
+#   :test:
+#     :compile:
+#       '(_|-)special': # Add '-pedantic' to compilation of all files in all test executables with '_special' or '-special' in their names
+#         - -pedantic
+#       '*':            # Add '-foo' to compilation of all files in all test executables
+#         - -foo
+
+# Configuration Options specific to CMock. See CMock docs for details
+: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
+
+# Configuration options specific to Unity. 
+:unity:
+  :defines:
+    - UNITY_EXCLUDE_FLOAT
+
+# You can optionally have ceedling create environment variables for you before
+# performing the rest of its tasks.
+:environment: []
+
+# LIBRARIES
+# These libraries are automatically injected into the build process. Those specified as
+# common will be used in all types of builds. Otherwise, libraries can be injected in just
+# tests or releases. These options are MERGED with the options in supplemental yaml files.
+:libraries:
+  :placement: :end
+  :flag: "-l${1}"
+  :path_flag: "-L ${1}"
+  :system: []    # for example, you might list 'm' to grab the math library
+  :test: []
+  :release: []
+
+# Override the default linker tool to build a static library release instead of  
+# as executable. woo!
+:tools:
+  :release_linker:
+    :name: library linker
+    :executable: as
+    :arguments:
+      - "\"${1}\""
+      - "${5}"
+      - "-o \"${2}\""
+      - "${4}"

data/plugins/dependencies/example/supervisor/src/supervisor.c

@@ -0,0 +1,45 @@
+/* =========================================================================
+    Ceedling - Test-Centered Build System for C
+    ThrowTheSwitch.org
+    Copyright (c) 2010-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+    SPDX-License-Identifier: MIT
+========================================================================= */
+
+#include "supervisor.h"
+
+int supervisor_delegate(int* worker_loads, int num_workers)
+{
+	int i;
+	int most_bored_id = 0;
+	int most_bored_hours = 999999;
+
+	if ((num_workers < 0) || (worker_loads == 0))
+		return -1;
+
+	for (i=0; i < num_workers; i++)
+	{
+		if (worker_loads[i] < most_bored_hours)
+		{
+			most_bored_hours = worker_loads[i];
+			most_bored_id = i;
+		}
+	}
+
+	return most_bored_id;
+}
+
+int supervisor_progress(int* worker_loads, int num_workers)
+{
+	int i;
+	int total_hours = 0;
+
+	if (worker_loads == 0)
+		return 0;
+
+	for (i=0; i < num_workers; i++)
+	{
+		total_hours += worker_loads[i];
+	}
+	
+	return total_hours;
+}