ceedling 1.1.0 → 1.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/GIT_COMMIT_SHA +1 -1
- data/README.md +7 -4
- data/docs/Changelog.md +66 -38
- data/docs/KnownIssues.md +9 -0
- data/docs/ReleaseNotes.md +5 -1
- data/docs/mkdocs/getting-started/installation.md +8 -1
- data/docs/mkdocs/getting-started/quick-start.md +20 -2
- data/docs/mkdocs/help.md +2 -2
- data/docs/mkdocs/index.md +13 -6
- data/docs/mkdocs/overview/build-system.md +4 -4
- data/docs/mkdocs/plugins/bullseye.md +6 -0
- data/docs/mkdocs/plugins/command-hooks.md +20 -15
- data/docs/mkdocs/plugins/gcov/gcovr.md +130 -109
- data/docs/mkdocs/plugins/gcov/index.md +6 -0
- data/docs/mkdocs/plugins/index.md +40 -0
- data/docs/mkdocs/plugins/valgrind.md +6 -0
- data/docs/mkdocs/testing-guide/partials/index.md +22 -13
- data/lib/ceedling/config/configurator.rb +2 -1
- data/lib/ceedling/preprocess/preprocessinator.rb +3 -2
- data/lib/ceedling/preprocess/preprocessinator_file_assembler.rb +27 -13
- data/lib/ceedling/test_invoker/test_build_executor.rb +3 -4
- data/lib/ceedling/test_invoker/test_build_planner.rb +0 -2
- data/lib/ceedling/test_invoker/test_invoker_types.rb +1 -1
- data/lib/ceedling/tool_executor.rb +5 -0
- data/lib/version.rb +1 -1
- data/plugins/command_hooks/lib/command_hooks.rb +4 -0
- data/plugins/gcov/lib/console_reportinator.rb +3 -1
- data/plugins/gcov/lib/gcov.rb +3 -3
- data/plugins/gcov/lib/gcov_reportinator.rb +4 -0
- data/plugins/gcov/lib/gcovr_reportinator.rb +61 -14
- data/plugins/gcov/lib/reportgenerator_reportinator.rb +3 -1
- data/site-local/404.html +3 -3
- data/site-local/assets/javascripts/{bundle.79ae519e.min.js → bundle.d7400e89.min.js} +2 -2
- data/site-local/assets/javascripts/{bundle.79ae519e.min.js.map → bundle.d7400e89.min.js.map} +2 -2
- data/site-local/assets/stylesheets/main.ec1eaa64.min.css +1 -0
- data/site-local/assets/stylesheets/{main.484c7ddc.min.css.map → main.ec1eaa64.min.css.map} +1 -1
- data/site-local/configuration/environment-vars.html +3 -3
- data/site-local/configuration/global-collections.html +3 -3
- data/site-local/configuration/index.html +3 -3
- data/site-local/configuration/loading.html +3 -3
- data/site-local/configuration/mixins.html +3 -3
- data/site-local/configuration/parallel-builds.html +3 -3
- data/site-local/configuration/project-file.html +3 -3
- data/site-local/configuration/reference/cexception.html +3 -3
- data/site-local/configuration/reference/cmock.html +3 -3
- data/site-local/configuration/reference/defines.html +3 -3
- data/site-local/configuration/reference/environment.html +3 -3
- data/site-local/configuration/reference/extension.html +3 -3
- data/site-local/configuration/reference/files.html +3 -3
- data/site-local/configuration/reference/flags.html +3 -3
- data/site-local/configuration/reference/index.html +3 -3
- data/site-local/configuration/reference/libraries.html +3 -3
- data/site-local/configuration/reference/mixins.html +3 -3
- data/site-local/configuration/reference/paths.html +3 -3
- data/site-local/configuration/reference/plugins.html +3 -3
- data/site-local/configuration/reference/project.html +3 -3
- data/site-local/configuration/reference/release-build.html +3 -3
- data/site-local/configuration/reference/test-build.html +3 -3
- data/site-local/configuration/reference/test-runner.html +3 -3
- data/site-local/configuration/reference/tools.html +3 -3
- data/site-local/configuration/reference/unity.html +3 -3
- data/site-local/configuration/which-ceedling.html +3 -3
- data/site-local/development/index.html +3 -3
- data/site-local/development/plugins/configuration.html +3 -3
- data/site-local/development/plugins/index.html +3 -3
- data/site-local/development/plugins/plugin-subclass.html +3 -3
- data/site-local/development/plugins/rake-tasks.html +3 -3
- data/site-local/development/workflow.html +3 -3
- data/site-local/getting-started/command-line.html +3 -3
- data/site-local/getting-started/example-projects/cipher-quest.html +3 -3
- data/site-local/getting-started/example-projects/index.html +3 -3
- data/site-local/getting-started/example-projects/temp-sensor.html +3 -3
- data/site-local/getting-started/example-projects/wondrous-forest.html +3 -3
- data/site-local/getting-started/index.html +3 -3
- data/site-local/getting-started/installation.html +12 -4
- data/site-local/getting-started/quick-start.html +18 -4
- data/site-local/help.html +4 -4
- data/site-local/index.html +13 -8
- data/site-local/overview/build-system.html +6 -6
- data/site-local/overview/index.html +3 -3
- data/site-local/overview/test-environments.html +3 -3
- data/site-local/overview/tools-and-frameworks.html +3 -3
- data/site-local/plugins/beep.html +3 -3
- data/site-local/plugins/bullseye.html +9 -3
- data/site-local/plugins/command-hooks.html +42 -38
- data/site-local/plugins/compile-commands-json-db.html +3 -3
- data/site-local/plugins/cppcheck.html +3 -3
- data/site-local/plugins/dependencies.html +3 -3
- data/site-local/plugins/fff.html +3 -3
- data/site-local/plugins/gcov/examples.html +3 -3
- data/site-local/plugins/gcov/gcovr.html +325 -227
- data/site-local/plugins/gcov/index.html +9 -3
- data/site-local/plugins/gcov/overview.html +3 -3
- data/site-local/plugins/gcov/reportgenerator.html +3 -3
- data/site-local/plugins/gcov/reporting.html +3 -3
- data/site-local/plugins/gcov/setup.html +3 -3
- data/site-local/plugins/gcov/tool-versions.html +3 -3
- data/site-local/plugins/gcov/troubleshooting.html +3 -3
- data/site-local/plugins/index.html +79 -15
- data/site-local/plugins/module-generator.html +3 -3
- data/site-local/plugins/report-build-warnings-log.html +3 -3
- data/site-local/plugins/report-tests-gtestlike-stdout.html +3 -3
- data/site-local/plugins/report-tests-ide-stdout.html +3 -3
- data/site-local/plugins/report-tests-log-factory.html +3 -3
- data/site-local/plugins/report-tests-pretty-stdout.html +3 -3
- data/site-local/plugins/report-tests-raw-output-log.html +3 -3
- data/site-local/plugins/report-tests-teamcity-stdout.html +3 -3
- data/site-local/plugins/valgrind.html +9 -3
- data/site-local/project/release-history.html +3 -3
- data/site-local/project/upgrade.html +3 -3
- data/site-local/reference/build-directives.html +3 -3
- data/site-local/reference/command-line.html +3 -3
- data/site-local/reference/environment-vars.html +3 -3
- data/site-local/reference/gcov-plugin.html +3 -3
- data/site-local/reference/global-collections.html +3 -3
- data/site-local/reference/index.html +3 -3
- data/site-local/reference/partials-macros.html +3 -3
- data/site-local/reference/project-configuration.html +3 -3
- data/site-local/sitemap.xml.gz +0 -0
- data/site-local/snapshot/examples/cipher_quest/index.html +3 -3
- data/site-local/snapshot/examples/temp_sensor/index.html +3 -3
- data/site-local/snapshot/examples/wondrous_forest/index.html +3 -3
- data/site-local/testing-guide/build-directives.html +3 -3
- data/site-local/testing-guide/conventions.html +3 -3
- data/site-local/testing-guide/frameworks.html +3 -3
- data/site-local/testing-guide/index.html +3 -3
- data/site-local/testing-guide/partials/configuration.html +3 -3
- data/site-local/testing-guide/partials/conventions.html +3 -3
- data/site-local/testing-guide/partials/directives.html +3 -3
- data/site-local/testing-guide/partials/example.html +3 -3
- data/site-local/testing-guide/partials/index.html +25 -16
- data/site-local/testing-guide/partials/overview.html +3 -3
- data/site-local/testing-guide/partials/variables.html +3 -3
- data/site-local/testing-guide/test-cases.html +3 -3
- data/site-local/testing-guide/test-sample.html +3 -3
- data/site-local/testing-guide/test-suite-anatomy.html +3 -3
- data/spec/support/system/system_context.rb +3 -1
- data/spec/system/support/gcov_common_test_cases.rb +4 -1
- data/spec/units/preprocess/preprocessinator_file_assembler_spec.rb +155 -0
- data/spec/units/test_build_executor_spec.rb +114 -0
- data/vendor/unity/auto/generate_test_runner.rb +55 -5
- data/vendor/unity/src/unity.h +1 -1
- data/vendor/unity/test/testdata/testRunnerGeneratorEmpty.c +13 -0
- data/vendor/unity/test/tests/test_generate_test_runner.rb +11 -0
- metadata +9 -7
- data/site-local/assets/stylesheets/main.484c7ddc.min.css +0 -1
- data/vendor/unity/auto/run_test.erb +0 -37
data/site-local/help.html
CHANGED
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
|
|
22
22
|
|
|
23
23
|
<link rel="icon" href="assets/images/favicon.png">
|
|
24
|
-
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.
|
|
24
|
+
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.7">
|
|
25
25
|
|
|
26
26
|
|
|
27
27
|
|
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
|
|
30
30
|
|
|
31
31
|
|
|
32
|
-
<link rel="stylesheet" href="assets/stylesheets/main.
|
|
32
|
+
<link rel="stylesheet" href="assets/stylesheets/main.ec1eaa64.min.css">
|
|
33
33
|
|
|
34
34
|
|
|
35
35
|
<link rel="stylesheet" href="assets/stylesheets/palette.ab4e12ef.min.css">
|
|
@@ -3983,7 +3983,7 @@ to host and develop the Ceedling Suite of tools.</p>
|
|
|
3983
3983
|
GitHub repository.</p>
|
|
3984
3984
|
</li>
|
|
3985
3985
|
<li>
|
|
3986
|
-
<p><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M17 12V3a1 1 0 0 0-1-1H3a1 1 0 0 0-1 1v14l4-4h10a1 1 0 0 0 1-1m4-6h-2v9H6v2a1 1 0 0 0 1 1h11l4 4V7a1 1 0 0 0-1-1"/></svg></span> <strong><a href="https://
|
|
3986
|
+
<p><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M17 12V3a1 1 0 0 0-1-1H3a1 1 0 0 0-1 1v14l4-4h10a1 1 0 0 0 1-1m4-6h-2v9H6v2a1 1 0 0 0 1 1h11l4 4V7a1 1 0 0 0-1-1"/></svg></span> <strong><a href="https://throwtheswitch.discourse.group">Discourse Forums</a></strong></p>
|
|
3987
3987
|
<hr />
|
|
3988
3988
|
<p>Trying to understand a feature or work through a testing problem?
|
|
3989
3989
|
The ThrowTheSwitch community forums are the place to ask.</p>
|
|
@@ -4074,7 +4074,7 @@ take over the world.</p>
|
|
|
4074
4074
|
<script id="__config" type="application/json">{"annotate": null, "base": ".", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
|
|
4075
4075
|
|
|
4076
4076
|
|
|
4077
|
-
<script src="assets/javascripts/bundle.
|
|
4077
|
+
<script src="assets/javascripts/bundle.d7400e89.min.js"></script>
|
|
4078
4078
|
|
|
4079
4079
|
|
|
4080
4080
|
</body>
|
data/site-local/index.html
CHANGED
|
@@ -19,7 +19,7 @@
|
|
|
19
19
|
|
|
20
20
|
|
|
21
21
|
<link rel="icon" href="assets/images/favicon.png">
|
|
22
|
-
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.
|
|
22
|
+
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.7">
|
|
23
23
|
|
|
24
24
|
|
|
25
25
|
|
|
@@ -27,7 +27,7 @@
|
|
|
27
27
|
|
|
28
28
|
|
|
29
29
|
|
|
30
|
-
<link rel="stylesheet" href="assets/stylesheets/main.
|
|
30
|
+
<link rel="stylesheet" href="assets/stylesheets/main.ec1eaa64.min.css">
|
|
31
31
|
|
|
32
32
|
|
|
33
33
|
<link rel="stylesheet" href="assets/stylesheets/palette.ab4e12ef.min.css">
|
|
@@ -4121,18 +4121,22 @@
|
|
|
4121
4121
|
|
|
4122
4122
|
<h1 id="ceedling-packet">Ceedling Packet</h1>
|
|
4123
4123
|
<p>Ceedling is a fancypants build system that greatly simplifies building
|
|
4124
|
-
C projects. While it can certainly build release targets, it
|
|
4124
|
+
C projects. While it can certainly build release targets, it
|
|
4125
4125
|
shines at running unit test suites.</p>
|
|
4126
|
-
<p>Ceedling and its suite of frameworks, including Unity and CMock, were developed
|
|
4127
|
-
for use on platforms from heavy duty workstations to teeny tiny microcontrollers.
|
|
4128
|
-
Features handy for low-level development have made these tools popular with
|
|
4129
|
-
embedded systems developers.</p>
|
|
4130
4126
|
<div class="admonition tip">
|
|
4131
4127
|
<p class="admonition-title">New to Ceedling?</p>
|
|
4132
4128
|
<p><img src="assets/images/ceedling.svg" width="130"><br/>
|
|
4133
4129
|
Jump straight to the <a href="getting-started/quick-start.html">Quick Start</a> — installation,
|
|
4134
4130
|
project set up, and your first build tasks all in one place.</p>
|
|
4135
4131
|
</div>
|
|
4132
|
+
<p>In essence, Ceedling is a project configuration in YAML and a command line
|
|
4133
|
+
tool that executes from it. Code conventions and supporting features produce
|
|
4134
|
+
executable test suites and/or release artifacts.
|
|
4135
|
+
Plugins provide reporting, code coverage, static analysis, and more.</p>
|
|
4136
|
+
<p>Ceedling and its suite of frameworks, including Unity and CMock, were developed
|
|
4137
|
+
for use on platforms from heavy duty workstations to teeny tiny microcontrollers.
|
|
4138
|
+
Features handy for low-level development have made these tools popular with
|
|
4139
|
+
embedded systems developers.</p>
|
|
4136
4140
|
<div class="admonition feature">
|
|
4137
4141
|
<p class="admonition-title">New in Ceedling 1.1.0 — Partials</p>
|
|
4138
4142
|
<p>A <a href="testing-guide/partials/index.html"><em>Partial</em></a> is your C code sliced and diced
|
|
@@ -4142,6 +4146,7 @@ for testing your code.</p>
|
|
|
4142
4146
|
<p>👀 See the <a href="https://github.com/ThrowTheSwitch/Ceedling/blob/master/docs/Changelog.md">Changelog</a>
|
|
4143
4147
|
for all the new goodness in 1.1.0.</p>
|
|
4144
4148
|
</div>
|
|
4149
|
+
<hr />
|
|
4145
4150
|
<h2 id="overview">Overview</h2>
|
|
4146
4151
|
<div class="grid cards">
|
|
4147
4152
|
<ul>
|
|
@@ -4357,7 +4362,7 @@ project customization and plugin development.</p>
|
|
|
4357
4362
|
<script id="__config" type="application/json">{"annotate": null, "base": ".", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
|
|
4358
4363
|
|
|
4359
4364
|
|
|
4360
|
-
<script src="assets/javascripts/bundle.
|
|
4365
|
+
<script src="assets/javascripts/bundle.d7400e89.min.js"></script>
|
|
4361
4366
|
|
|
4362
4367
|
|
|
4363
4368
|
</body>
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
|
|
22
22
|
|
|
23
23
|
<link rel="icon" href="../assets/images/favicon.png">
|
|
24
|
-
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.
|
|
24
|
+
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.7">
|
|
25
25
|
|
|
26
26
|
|
|
27
27
|
|
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
|
|
30
30
|
|
|
31
31
|
|
|
32
|
-
<link rel="stylesheet" href="../assets/stylesheets/main.
|
|
32
|
+
<link rel="stylesheet" href="../assets/stylesheets/main.ec1eaa64.min.css">
|
|
33
33
|
|
|
34
34
|
|
|
35
35
|
<link rel="stylesheet" href="../assets/stylesheets/palette.ab4e12ef.min.css">
|
|
@@ -4152,15 +4152,15 @@ toolchain <code>gcc</code>, the configuration file could be as simple as this:</
|
|
|
4152
4152
|
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a><span class="w"> </span><span class="nt">:include</span><span class="p">:</span>
|
|
4153
4153
|
<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">inc/**</span>
|
|
4154
4154
|
</code></pre></div>
|
|
4155
|
+
<p>From the command line, to run all your unit tests, you would run
|
|
4156
|
+
<code>ceedling test:all</code>. To build the release version of your project,
|
|
4157
|
+
you would simply run <code>ceedling release</code>. That's it!</p>
|
|
4155
4158
|
<div class="admonition tip">
|
|
4156
4159
|
<p class="admonition-title">Want to see a real world project configuration?</p>
|
|
4157
4160
|
<p>See this <a href="../snapshot/assets/project.yml">commented project file</a>
|
|
4158
4161
|
for a much more complete and sophisticated example of a project
|
|
4159
4162
|
configuration.</p>
|
|
4160
4163
|
</div>
|
|
4161
|
-
<p>From the command line, to run all your unit tests, you would run
|
|
4162
|
-
<code>ceedling test:all</code>. To build the release version of your project,
|
|
4163
|
-
you would simply run <code>ceedling release</code>. That's it!</p>
|
|
4164
4164
|
<p>Of course, many more advanced options allow you to configure
|
|
4165
4165
|
your project with a variety of features to meet a variety of needs.
|
|
4166
4166
|
Ceedling can work with practically any command line toolchain
|
|
@@ -4281,7 +4281,7 @@ and Ceedling for your test build. Your two build systems will simply
|
|
|
4281
4281
|
<script id="__config" type="application/json">{"annotate": null, "base": "..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
|
|
4282
4282
|
|
|
4283
4283
|
|
|
4284
|
-
<script src="../assets/javascripts/bundle.
|
|
4284
|
+
<script src="../assets/javascripts/bundle.d7400e89.min.js"></script>
|
|
4285
4285
|
|
|
4286
4286
|
|
|
4287
4287
|
</body>
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
|
|
22
22
|
|
|
23
23
|
<link rel="icon" href="../assets/images/favicon.png">
|
|
24
|
-
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.
|
|
24
|
+
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.7">
|
|
25
25
|
|
|
26
26
|
|
|
27
27
|
|
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
|
|
30
30
|
|
|
31
31
|
|
|
32
|
-
<link rel="stylesheet" href="../assets/stylesheets/main.
|
|
32
|
+
<link rel="stylesheet" href="../assets/stylesheets/main.ec1eaa64.min.css">
|
|
33
33
|
|
|
34
34
|
|
|
35
35
|
<link rel="stylesheet" href="../assets/stylesheets/palette.ab4e12ef.min.css">
|
|
@@ -4096,7 +4096,7 @@ choose the right test suite strategy for your project.</p>
|
|
|
4096
4096
|
<script id="__config" type="application/json">{"annotate": null, "base": "..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
|
|
4097
4097
|
|
|
4098
4098
|
|
|
4099
|
-
<script src="../assets/javascripts/bundle.
|
|
4099
|
+
<script src="../assets/javascripts/bundle.d7400e89.min.js"></script>
|
|
4100
4100
|
|
|
4101
4101
|
|
|
4102
4102
|
</body>
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
|
|
22
22
|
|
|
23
23
|
<link rel="icon" href="../assets/images/favicon.png">
|
|
24
|
-
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.
|
|
24
|
+
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.7">
|
|
25
25
|
|
|
26
26
|
|
|
27
27
|
|
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
|
|
30
30
|
|
|
31
31
|
|
|
32
|
-
<link rel="stylesheet" href="../assets/stylesheets/main.
|
|
32
|
+
<link rel="stylesheet" href="../assets/stylesheets/main.ec1eaa64.min.css">
|
|
33
33
|
|
|
34
34
|
|
|
35
35
|
<link rel="stylesheet" href="../assets/stylesheets/palette.ab4e12ef.min.css">
|
|
@@ -4109,7 +4109,7 @@ item listed below.</p>
|
|
|
4109
4109
|
<script id="__config" type="application/json">{"annotate": null, "base": "..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
|
|
4110
4110
|
|
|
4111
4111
|
|
|
4112
|
-
<script src="../assets/javascripts/bundle.
|
|
4112
|
+
<script src="../assets/javascripts/bundle.d7400e89.min.js"></script>
|
|
4113
4113
|
|
|
4114
4114
|
|
|
4115
4115
|
</body>
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
|
|
22
22
|
|
|
23
23
|
<link rel="icon" href="../assets/images/favicon.png">
|
|
24
|
-
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.
|
|
24
|
+
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.7">
|
|
25
25
|
|
|
26
26
|
|
|
27
27
|
|
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
|
|
30
30
|
|
|
31
31
|
|
|
32
|
-
<link rel="stylesheet" href="../assets/stylesheets/main.
|
|
32
|
+
<link rel="stylesheet" href="../assets/stylesheets/main.ec1eaa64.min.css">
|
|
33
33
|
|
|
34
34
|
|
|
35
35
|
<link rel="stylesheet" href="../assets/stylesheets/palette.ab4e12ef.min.css">
|
|
@@ -4426,7 +4426,7 @@ aliasing one list inside another.</p>
|
|
|
4426
4426
|
<script id="__config" type="application/json">{"annotate": null, "base": "..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
|
|
4427
4427
|
|
|
4428
4428
|
|
|
4429
|
-
<script src="../assets/javascripts/bundle.
|
|
4429
|
+
<script src="../assets/javascripts/bundle.d7400e89.min.js"></script>
|
|
4430
4430
|
|
|
4431
4431
|
|
|
4432
4432
|
</body>
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
|
|
22
22
|
|
|
23
23
|
<link rel="icon" href="../assets/images/favicon.png">
|
|
24
|
-
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.
|
|
24
|
+
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.7">
|
|
25
25
|
|
|
26
26
|
|
|
27
27
|
|
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
|
|
30
30
|
|
|
31
31
|
|
|
32
|
-
<link rel="stylesheet" href="../assets/stylesheets/main.
|
|
32
|
+
<link rel="stylesheet" href="../assets/stylesheets/main.ec1eaa64.min.css">
|
|
33
33
|
|
|
34
34
|
|
|
35
35
|
<link rel="stylesheet" href="../assets/stylesheets/palette.ab4e12ef.min.css">
|
|
@@ -4406,7 +4406,7 @@ build completion and build error events.</p>
|
|
|
4406
4406
|
<script id="__config" type="application/json">{"annotate": null, "base": "..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
|
|
4407
4407
|
|
|
4408
4408
|
|
|
4409
|
-
<script src="../assets/javascripts/bundle.
|
|
4409
|
+
<script src="../assets/javascripts/bundle.d7400e89.min.js"></script>
|
|
4410
4410
|
|
|
4411
4411
|
|
|
4412
4412
|
</body>
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
|
|
22
22
|
|
|
23
23
|
<link rel="icon" href="../assets/images/favicon.png">
|
|
24
|
-
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.
|
|
24
|
+
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.7">
|
|
25
25
|
|
|
26
26
|
|
|
27
27
|
|
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
|
|
30
30
|
|
|
31
31
|
|
|
32
|
-
<link rel="stylesheet" href="../assets/stylesheets/main.
|
|
32
|
+
<link rel="stylesheet" href="../assets/stylesheets/main.ec1eaa64.min.css">
|
|
33
33
|
|
|
34
34
|
|
|
35
35
|
<link rel="stylesheet" href="../assets/stylesheets/palette.ab4e12ef.min.css">
|
|
@@ -4113,6 +4113,12 @@ project configuration.</p>
|
|
|
4113
4113
|
<p>[June 1, 2024] Until the Bullseye Plugin can be updated for compatibility
|
|
4114
4114
|
with Ceedling >= 1.0.0, it has been disabled.</p>
|
|
4115
4115
|
</div>
|
|
4116
|
+
<div class="admonition note">
|
|
4117
|
+
<p class="admonition-title">Note</p>
|
|
4118
|
+
<p>The Bullseye plugin creates a duplicate test build with <code>bullseye:</code>
|
|
4119
|
+
command line plugin tasks. <a href="index.html#understanding-plugin-build-duplication">This is intentional and needed</a>.</p>
|
|
4120
|
+
</div>
|
|
4121
|
+
<hr />
|
|
4116
4122
|
<h2 id="configuration">Configuration</h2>
|
|
4117
4123
|
<p>The bullseye plugin supports configuration options via your <code>project.yml</code> provided
|
|
4118
4124
|
by Ceedling. The following is a typical configuration example:</p>
|
|
@@ -4242,7 +4248,7 @@ by Ceedling. The following is a typical configuration example:</p>
|
|
|
4242
4248
|
<script id="__config" type="application/json">{"annotate": null, "base": "..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
|
|
4243
4249
|
|
|
4244
4250
|
|
|
4245
|
-
<script src="../assets/javascripts/bundle.
|
|
4251
|
+
<script src="../assets/javascripts/bundle.d7400e89.min.js"></script>
|
|
4246
4252
|
|
|
4247
4253
|
|
|
4248
4254
|
</body>
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
|
|
22
22
|
|
|
23
23
|
<link rel="icon" href="../assets/images/favicon.png">
|
|
24
|
-
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.
|
|
24
|
+
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.7">
|
|
25
25
|
|
|
26
26
|
|
|
27
27
|
|
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
|
|
30
30
|
|
|
31
31
|
|
|
32
|
-
<link rel="stylesheet" href="../assets/stylesheets/main.
|
|
32
|
+
<link rel="stylesheet" href="../assets/stylesheets/main.ec1eaa64.min.css">
|
|
33
33
|
|
|
34
34
|
|
|
35
35
|
<link rel="stylesheet" href="../assets/stylesheets/palette.ab4e12ef.min.css">
|
|
@@ -4790,7 +4790,7 @@
|
|
|
4790
4790
|
<h1 id="command-hooks">Command Hooks</h1>
|
|
4791
4791
|
<p>Easily run command line tools and scripts at various points in a Ceedling build.</p>
|
|
4792
4792
|
<h2 id="plugin-overview">Plugin Overview</h2>
|
|
4793
|
-
<p>This plugin allows you to skip creating a full Ceedling plugin for many common use cases. It links Ceedling
|
|
4793
|
+
<p>This plugin allows you to skip creating a full Ceedling plugin for many common use cases. It links Ceedling’s programmatic <code>Plugin</code> code hooks to easily managed tool definitions. </p>
|
|
4794
4794
|
<h2 id="setup">Setup</h2>
|
|
4795
4795
|
<p>To use this plugin, it must be enabled:</p>
|
|
4796
4796
|
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nt">:plugins</span><span class="p">:</span>
|
|
@@ -4809,7 +4809,8 @@
|
|
|
4809
4809
|
<p>See the commented examples below.</p>
|
|
4810
4810
|
<h3 id="tool-definitions">Tool definitions</h3>
|
|
4811
4811
|
<p>Each Ceedling tool requires an <code>:executable</code> string and an optional <code>:arguments</code> list. See the <a href="../configuration/reference/tools.html"><code>:tools</code> configuration reference</a> to understand how to craft your argument list and other tool options.</p>
|
|
4812
|
-
<p>This plugin passes one or two runtime parameters for use in a hook
|
|
4812
|
+
<p>This plugin passes one or two runtime parameters for use in a hook’s tool argument list depending on the hook. These parameters are referenced with Ceedling tool argument expansion identifiers <code>${1}</code>, <code>${2}</code>, etc. Wherever you place <code>${1}</code> or <code>${2}</code> in your tool argument list, they expand in the command line Ceedling constructs with the parameters this plugin provides for that build step hook. The list of build step hooks below documents which parameters are available for each hook.</p>
|
|
4813
|
+
<p>Each tool may optionally include a <code>:name</code> — a simple nickname used in log and error messages. If omitted, the plugin forms a default name from the hook’s key (e.g. <code>pre_mock_generate</code>). For a hook configured with a list of tools, the default name additionally includes the tool’s position in the list (e.g. <code>post_link_execute_0</code>, <code>post_link_execute_1</code>). See the commented examples below.</p>
|
|
4813
4814
|
<h3 id="hook-logging">Hook logging</h3>
|
|
4814
4815
|
<p>In addition to the standard Ceedling tool definition elements, a hook configuration entry may optionally include a <code>:logging</code> setting.</p>
|
|
4815
4816
|
<p><code>:logging</code> may be set to <code>TRUE</code> or <code>FALSE</code>. An omitted setting is equivalent to <code>FALSE</code>.</p>
|
|
@@ -4826,28 +4827,31 @@
|
|
|
4826
4827
|
<a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a><span class="w"> </span><span class="nt">:pre_mock_generate</span><span class="p">:</span>
|
|
4827
4828
|
<a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a><span class="w"> </span><span class="c1"># This tool is organized as a sub-hash beneath the command hook key</span>
|
|
4828
4829
|
<a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a><span class="w"> </span><span class="nt">:executable</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">python</span>
|
|
4829
|
-
<a id="__codelineno-1-7" name="__codelineno-1-7" href="#__codelineno-1-7"></a><span class="w"> </span><span class="nt">:
|
|
4830
|
-
<a id="__codelineno-1-8" name="__codelineno-1-8" href="#__codelineno-1-8"></a><span class="w">
|
|
4831
|
-
<a id="__codelineno-1-9" name="__codelineno-1-9" href="#__codelineno-1-9"></a><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain"
|
|
4832
|
-
<a id="__codelineno-1-10" name="__codelineno-1-10" href="#__codelineno-1-10"></a><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain"
|
|
4833
|
-
<a id="__codelineno-1-11" name="__codelineno-1-11" href="#__codelineno-1-11"></a><span class="w">
|
|
4834
|
-
<a id="__codelineno-1-12" name="__codelineno-1-12" href="#__codelineno-1-12"></a>
|
|
4835
|
-
<a id="__codelineno-1-13" name="__codelineno-1-13" href="#__codelineno-1-13"></a
|
|
4836
|
-
<a id="__codelineno-1-14" name="__codelineno-1-14" href="#__codelineno-1-14"></a><span class="w"> </span><span class="c1">#
|
|
4837
|
-
<a id="__codelineno-1-15" name="__codelineno-1-15" href="#__codelineno-1-15"></a><span class="w"> </span><span class="c1">#
|
|
4838
|
-
<a id="__codelineno-1-16" name="__codelineno-1-16" href="#__codelineno-1-16"></a><span class="w"> </span><span class="
|
|
4839
|
-
<a id="__codelineno-1-17" name="__codelineno-1-17" href="#__codelineno-1-17"></a><span class="w">
|
|
4840
|
-
<a id="__codelineno-1-18" name="__codelineno-1-18" href="#__codelineno-1-18"></a><span class="w">
|
|
4841
|
-
<a id="__codelineno-1-19" name="__codelineno-1-19" href="#__codelineno-1-19"></a><span class="w">
|
|
4842
|
-
<a id="__codelineno-1-20" name="__codelineno-1-20" href="#__codelineno-1-20"></a><span class="w">
|
|
4843
|
-
<a id="__codelineno-1-21" name="__codelineno-1-21" href="#__codelineno-1-21"></a><span class="w">
|
|
4844
|
-
<a id="__codelineno-1-22" name="__codelineno-1-22" href="#__codelineno-1-22"></a><span class="w">
|
|
4845
|
-
<a id="__codelineno-1-23" name="__codelineno-1-23" href="#__codelineno-1-23"></a><span class="w">
|
|
4846
|
-
<a id="__codelineno-1-24" name="__codelineno-1-24" href="#__codelineno-1-24"></a><span class="w">
|
|
4847
|
-
<a id="__codelineno-1-25" name="__codelineno-1-25" href="#__codelineno-1-25"></a><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain"
|
|
4848
|
-
<a id="__codelineno-1-26" name="__codelineno-1-26" href="#__codelineno-1-26"></a><span class="w">
|
|
4849
|
-
<a id="__codelineno-1-27" name="__codelineno-1-27" href="#__codelineno-1-27"></a><span class="w">
|
|
4850
|
-
<a id="__codelineno-1-28" name="__codelineno-1-28" href="#__codelineno-1-28"></a><span class="w"> </span><span class="
|
|
4830
|
+
<a id="__codelineno-1-7" name="__codelineno-1-7" href="#__codelineno-1-7"></a><span class="w"> </span><span class="nt">:name</span><span class="p">:</span><span class="w"> </span><span class="s">'mock</span><span class="nv"> </span><span class="s">prep</span><span class="nv"> </span><span class="s">script'</span><span class="w"> </span><span class="c1"># Explicit nickname used in log/error messages</span>
|
|
4831
|
+
<a id="__codelineno-1-8" name="__codelineno-1-8" href="#__codelineno-1-8"></a><span class="w"> </span><span class="nt">:arguments</span><span class="p">:</span>
|
|
4832
|
+
<a id="__codelineno-1-9" name="__codelineno-1-9" href="#__codelineno-1-9"></a><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my_script.py</span>
|
|
4833
|
+
<a id="__codelineno-1-10" name="__codelineno-1-10" href="#__codelineno-1-10"></a><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">--some-arg</span>
|
|
4834
|
+
<a id="__codelineno-1-11" name="__codelineno-1-11" href="#__codelineno-1-11"></a><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">${1}</span><span class="w"> </span><span class="c1"># Replaced with the filepath of the header file that will be mocked</span>
|
|
4835
|
+
<a id="__codelineno-1-12" name="__codelineno-1-12" href="#__codelineno-1-12"></a><span class="w"> </span><span class="nt">:logging</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">TRUE</span><span class="w"> </span><span class="c1"># Log any tool output to console</span>
|
|
4836
|
+
<a id="__codelineno-1-13" name="__codelineno-1-13" href="#__codelineno-1-13"></a>
|
|
4837
|
+
<a id="__codelineno-1-14" name="__codelineno-1-14" href="#__codelineno-1-14"></a><span class="w"> </span><span class="c1"># Hook called for each linking operation</span>
|
|
4838
|
+
<a id="__codelineno-1-15" name="__codelineno-1-15" href="#__codelineno-1-15"></a><span class="w"> </span><span class="c1"># Here, we are performing two tasks for the same build step hook, converting a</span>
|
|
4839
|
+
<a id="__codelineno-1-16" name="__codelineno-1-16" href="#__codelineno-1-16"></a><span class="w"> </span><span class="c1"># binary executable to S-record format and, then, archiving with other artifacts.</span>
|
|
4840
|
+
<a id="__codelineno-1-17" name="__codelineno-1-17" href="#__codelineno-1-17"></a><span class="w"> </span><span class="c1"># Neither tool below is given a :name -- the plugin defaults them to</span>
|
|
4841
|
+
<a id="__codelineno-1-18" name="__codelineno-1-18" href="#__codelineno-1-18"></a><span class="w"> </span><span class="c1"># "post_link_execute_0" and "post_link_execute_1"</span>
|
|
4842
|
+
<a id="__codelineno-1-19" name="__codelineno-1-19" href="#__codelineno-1-19"></a><span class="w"> </span><span class="nt">:post_link_execute</span><span class="p">:</span>
|
|
4843
|
+
<a id="__codelineno-1-20" name="__codelineno-1-20" href="#__codelineno-1-20"></a><span class="w"> </span><span class="c1"># These tools are organized in a YAML list beneath the command hook key</span>
|
|
4844
|
+
<a id="__codelineno-1-21" name="__codelineno-1-21" href="#__codelineno-1-21"></a><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">:executable</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">objcopy.exe</span>
|
|
4845
|
+
<a id="__codelineno-1-22" name="__codelineno-1-22" href="#__codelineno-1-22"></a><span class="w"> </span><span class="nt">:arguments</span><span class="p">:</span>
|
|
4846
|
+
<a id="__codelineno-1-23" name="__codelineno-1-23" href="#__codelineno-1-23"></a><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">${1}</span><span class="w"> </span><span class="c1"># Replaced with the filepath to the linker’s binary artifact output</span>
|
|
4847
|
+
<a id="__codelineno-1-24" name="__codelineno-1-24" href="#__codelineno-1-24"></a><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">output.srec</span>
|
|
4848
|
+
<a id="__codelineno-1-25" name="__codelineno-1-25" href="#__codelineno-1-25"></a><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">--strip-all</span>
|
|
4849
|
+
<a id="__codelineno-1-26" name="__codelineno-1-26" href="#__codelineno-1-26"></a><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">:executable</span><span class="p">:</span><span class="w"> </span>
|
|
4850
|
+
<a id="__codelineno-1-27" name="__codelineno-1-27" href="#__codelineno-1-27"></a><span class="w"> </span><span class="nt">:arguments</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">tar.exe</span>
|
|
4851
|
+
<a id="__codelineno-1-28" name="__codelineno-1-28" href="#__codelineno-1-28"></a><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">- -acf</span>
|
|
4852
|
+
<a id="__codelineno-1-29" name="__codelineno-1-29" href="#__codelineno-1-29"></a><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">- awesome_build.zip</span>
|
|
4853
|
+
<a id="__codelineno-1-30" name="__codelineno-1-30" href="#__codelineno-1-30"></a><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">- ${1}</span><span class="w"> </span><span class="c1"># Replaced with the filepath to the linker’s binary artifact output</span>
|
|
4854
|
+
<a id="__codelineno-1-31" name="__codelineno-1-31" href="#__codelineno-1-31"></a><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">memory_report.txt</span>
|
|
4851
4855
|
</code></pre></div>
|
|
4852
4856
|
<h2 id="available-build-step-hooks">Available Build Step Hooks</h2>
|
|
4853
4857
|
<p>Define any of the following entries within a top-level <code>:command_hooks:</code> section of your Ceedling project file to automagically connect utilities or scripts to build process steps.</p>
|
|
@@ -4859,7 +4863,7 @@
|
|
|
4859
4863
|
<li>10 occurrences of the <code>:pre_test</code> and <code>:post_test</code> hooks.</li>
|
|
4860
4864
|
<li>17 occurrences of the <code>:pre_mock_generate</code> and <code>:post_mock_generate</code> hooks.</li>
|
|
4861
4865
|
<li>10 occurrences of the <code>:pre_test_runner_generate</code> and <code>:post_test_runner_generate</code> hooks.</li>
|
|
4862
|
-
<li>27(+) occurrences of the <code>:pre_compile</code> and <code>:post_compile</code> hooks. These hooks would be called 27 times for test file and mock file compilation. A test suite build will also include compilation of the source files under tests, Unity
|
|
4866
|
+
<li>27(+) occurrences of the <code>:pre_compile</code> and <code>:post_compile</code> hooks. These hooks would be called 27 times for test file and mock file compilation. A test suite build will also include compilation of the source files under tests, Unity’s source, CMock’s source, and generated test runner C files -- easily more than another two dozen compilation hook calls.</li>
|
|
4863
4867
|
<li>10 occurrences of the <code>:pre_link</code> and <code>:post_link</code> hooks for test executable creation.</li>
|
|
4864
4868
|
<li>10 occurrences of the <code>:pre_test_fixture_execute</code> and <code>:post_test_fixture_execute</code> hooks for running test executables and gathering the results of the tests cases they contain.</li>
|
|
4865
4869
|
<li>1 occurrence of the <code>:post_test_build</code> hook.</li>
|
|
@@ -4876,12 +4880,12 @@
|
|
|
4876
4880
|
<p>The parameter available to a tool (<code>${1}</code>) when the hook is called is a floating-point stopwatch value in seconds at the moment the error is handled.</p>
|
|
4877
4881
|
<h3 id="pre_test"><code>:pre_test</code></h3>
|
|
4878
4882
|
<p>Called just before each test begins its build pipeline and just after all context for that build has been gathered.</p>
|
|
4879
|
-
<p>The parameter available to a tool (<code>${1}</code>) when the hook is called is the test
|
|
4883
|
+
<p>The parameter available to a tool (<code>${1}</code>) when the hook is called is the test’s filepath.</p>
|
|
4880
4884
|
<h3 id="post_test"><code>:post_test</code></h3>
|
|
4881
4885
|
<p>Called just after each test completes its build and execution.</p>
|
|
4882
|
-
<p>The parameter available to a tool (<code>${1}</code>) when the hook is called is the test
|
|
4886
|
+
<p>The parameter available to a tool (<code>${1}</code>) when the hook is called is the test’s filepath.</p>
|
|
4883
4887
|
<h3 id="pre_test_build"><code>:pre_test_build</code></h3>
|
|
4884
|
-
<p>Called once just before the full test build pipeline begins (before any individual test
|
|
4888
|
+
<p>Called once just before the full test build pipeline begins (before any individual test’s configure, preprocess, compile, link, or execute steps).</p>
|
|
4885
4889
|
<p>Two parameters are available to a tool when the hook is called:</p>
|
|
4886
4890
|
<ul>
|
|
4887
4891
|
<li><code>${1}</code> — the build context as a string (e.g. <code>"test"</code>, <code>"gcov"</code>).</li>
|
|
@@ -4915,18 +4919,18 @@
|
|
|
4915
4919
|
<p>The parameter available to a tool (<code>${1}</code>) when the hook is called is the filepath of the header file to be mocked.</p>
|
|
4916
4920
|
<h3 id="pre_test_preprocess"><code>:pre_test_preprocess</code></h3>
|
|
4917
4921
|
<p>If preprocessing is in use, this is called just before each test file is preprocessed before runner generation.</p>
|
|
4918
|
-
<p>The parameter available to a tool (<code>${1}</code>) when the hook is called is the test
|
|
4922
|
+
<p>The parameter available to a tool (<code>${1}</code>) when the hook is called is the test’s filepath.</p>
|
|
4919
4923
|
<p>See <a href="../testing-guide/conventions.html#test-preprocessing"><em>Conventions & Behaviors</em></a> for details on how Ceedling preprocessing operates.</p>
|
|
4920
4924
|
<h3 id="post_test_preprocess"><code>:post_test_preprocess</code></h3>
|
|
4921
4925
|
<p>If preprocessing is in use, this is called just after each test file is preprocessed.</p>
|
|
4922
|
-
<p>The parameter available to a tool (<code>${1}</code>) when the hook is called is the test
|
|
4926
|
+
<p>The parameter available to a tool (<code>${1}</code>) when the hook is called is the test’s filepath.</p>
|
|
4923
4927
|
<p>See <a href="../testing-guide/conventions.html#test-preprocessing"><em>Conventions & Behaviors</em></a> for details on how Ceedling preprocessing operates.</p>
|
|
4924
4928
|
<h3 id="pre_runner_generate"><code>:pre_runner_generate</code></h3>
|
|
4925
4929
|
<p>Called just before each test file is processed by test runner generation.</p>
|
|
4926
|
-
<p>The parameter available to a tool (<code>${1}</code>) when the hook is called is the test
|
|
4930
|
+
<p>The parameter available to a tool (<code>${1}</code>) when the hook is called is the test’s filepath.</p>
|
|
4927
4931
|
<h3 id="post_runner_generate"><code>:post_runner_generate</code></h3>
|
|
4928
4932
|
<p>Called just after each test runner is generated.</p>
|
|
4929
|
-
<p>The parameter available to a tool (<code>${1}</code>) when the hook is called is the test
|
|
4933
|
+
<p>The parameter available to a tool (<code>${1}</code>) when the hook is called is the test’s filepath.</p>
|
|
4930
4934
|
<h3 id="pre_compile_execute"><code>:pre_compile_execute</code></h3>
|
|
4931
4935
|
<p>Called just before each C or assembly file is compiled.</p>
|
|
4932
4936
|
<p>The parameter available to a tool (<code>${1}</code>) when the hook is called is the filepath of the file to be compiled.</p>
|
|
@@ -4935,15 +4939,15 @@
|
|
|
4935
4939
|
<p>The parameter available to a tool (<code>${1}</code>) when the hook is called is the filepath of the input file that was compiled.</p>
|
|
4936
4940
|
<h3 id="pre_link_execute"><code>:pre_link_execute</code></h3>
|
|
4937
4941
|
<p>Called just before any binary artifact—test or release—is linked.</p>
|
|
4938
|
-
<p>The parameter available to a tool (<code>${1}</code>) when the hook is called is the binary output artifact
|
|
4942
|
+
<p>The parameter available to a tool (<code>${1}</code>) when the hook is called is the binary output artifact’s filepath.</p>
|
|
4939
4943
|
<h3 id="post_link_execute"><code>:post_link_execute</code></h3>
|
|
4940
4944
|
<p>Called just after a binary artifact is linked.</p>
|
|
4941
|
-
<p>The parameter available to a tool (<code>${1}</code>) when the hook is called is the binary output artifact
|
|
4945
|
+
<p>The parameter available to a tool (<code>${1}</code>) when the hook is called is the binary output artifact’s filepath.</p>
|
|
4942
4946
|
<h3 id="pre_test_fixture_execute"><code>:pre_test_fixture_execute</code></h3>
|
|
4943
4947
|
<p>Called just before each test is executed in its corresponding test fixture.</p>
|
|
4944
4948
|
<p>The parameter available to a tool (<code>${1}</code>) when the hook is called is the filepath of the binary artifact to be executed by the fixture.</p>
|
|
4945
4949
|
<h3 id="post_test_fixture_execute"><code>:post_test_fixture_execute</code></h3>
|
|
4946
|
-
<p>Called just after each test
|
|
4950
|
+
<p>Called just after each test’s fixture is executed and test results are collected.</p>
|
|
4947
4951
|
<p>The parameter available to a tool (<code>${1}</code>) when the hook is called is the filepath of the binary artifact that was executed by the fixture.</p>
|
|
4948
4952
|
<p><br/><br/></p>
|
|
4949
4953
|
|
|
@@ -5016,7 +5020,7 @@
|
|
|
5016
5020
|
<script id="__config" type="application/json">{"annotate": null, "base": "..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
|
|
5017
5021
|
|
|
5018
5022
|
|
|
5019
|
-
<script src="../assets/javascripts/bundle.
|
|
5023
|
+
<script src="../assets/javascripts/bundle.d7400e89.min.js"></script>
|
|
5020
5024
|
|
|
5021
5025
|
|
|
5022
5026
|
</body>
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
|
|
22
22
|
|
|
23
23
|
<link rel="icon" href="../assets/images/favicon.png">
|
|
24
|
-
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.
|
|
24
|
+
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.7">
|
|
25
25
|
|
|
26
26
|
|
|
27
27
|
|
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
|
|
30
30
|
|
|
31
31
|
|
|
32
|
-
<link rel="stylesheet" href="../assets/stylesheets/main.
|
|
32
|
+
<link rel="stylesheet" href="../assets/stylesheets/main.ec1eaa64.min.css">
|
|
33
33
|
|
|
34
34
|
|
|
35
35
|
<link rel="stylesheet" href="../assets/stylesheets/palette.ab4e12ef.min.css">
|
|
@@ -4236,7 +4236,7 @@
|
|
|
4236
4236
|
<script id="__config" type="application/json">{"annotate": null, "base": "..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
|
|
4237
4237
|
|
|
4238
4238
|
|
|
4239
|
-
<script src="../assets/javascripts/bundle.
|
|
4239
|
+
<script src="../assets/javascripts/bundle.d7400e89.min.js"></script>
|
|
4240
4240
|
|
|
4241
4241
|
|
|
4242
4242
|
</body>
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
|
|
22
22
|
|
|
23
23
|
<link rel="icon" href="../assets/images/favicon.png">
|
|
24
|
-
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.
|
|
24
|
+
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.7">
|
|
25
25
|
|
|
26
26
|
|
|
27
27
|
|
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
|
|
30
30
|
|
|
31
31
|
|
|
32
|
-
<link rel="stylesheet" href="../assets/stylesheets/main.
|
|
32
|
+
<link rel="stylesheet" href="../assets/stylesheets/main.ec1eaa64.min.css">
|
|
33
33
|
|
|
34
34
|
|
|
35
35
|
<link rel="stylesheet" href="../assets/stylesheets/palette.ab4e12ef.min.css">
|
|
@@ -4844,7 +4844,7 @@ e.g.:</p>
|
|
|
4844
4844
|
<script id="__config" type="application/json">{"annotate": null, "base": "..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
|
|
4845
4845
|
|
|
4846
4846
|
|
|
4847
|
-
<script src="../assets/javascripts/bundle.
|
|
4847
|
+
<script src="../assets/javascripts/bundle.d7400e89.min.js"></script>
|
|
4848
4848
|
|
|
4849
4849
|
|
|
4850
4850
|
</body>
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
|
|
22
22
|
|
|
23
23
|
<link rel="icon" href="../assets/images/favicon.png">
|
|
24
|
-
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.
|
|
24
|
+
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.7">
|
|
25
25
|
|
|
26
26
|
|
|
27
27
|
|
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
|
|
30
30
|
|
|
31
31
|
|
|
32
|
-
<link rel="stylesheet" href="../assets/stylesheets/main.
|
|
32
|
+
<link rel="stylesheet" href="../assets/stylesheets/main.ec1eaa64.min.css">
|
|
33
33
|
|
|
34
34
|
|
|
35
35
|
<link rel="stylesheet" href="../assets/stylesheets/palette.ab4e12ef.min.css">
|
|
@@ -4821,7 +4821,7 @@ source and/or assembly files into the specified library:</p>
|
|
|
4821
4821
|
<script id="__config" type="application/json">{"annotate": null, "base": "..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
|
|
4822
4822
|
|
|
4823
4823
|
|
|
4824
|
-
<script src="../assets/javascripts/bundle.
|
|
4824
|
+
<script src="../assets/javascripts/bundle.d7400e89.min.js"></script>
|
|
4825
4825
|
|
|
4826
4826
|
|
|
4827
4827
|
</body>
|