summaryrefslogtreecommitdiff
path: root/spec/spec/requirement-action-test-header.yml
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-06-10 09:52:45 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-06-10 09:54:18 +0200
commitca159fc9acaab5c291fc0e0d2fb29f9293dc1b7a (patch)
tree6c776dcb5febb9b5e9128678e0fef48c3d16eb4d /spec/spec/requirement-action-test-header.yml
parentd9075e27a517fec7cc9d1e5db2a5f290f260ef15 (diff)
spec: Specify action requirement test headers
Diffstat (limited to 'spec/spec/requirement-action-test-header.yml')
-rw-r--r--spec/spec/requirement-action-test-header.yml48
1 files changed, 48 insertions, 0 deletions
diff --git a/spec/spec/requirement-action-test-header.yml b/spec/spec/requirement-action-test-header.yml
new file mode 100644
index 00000000..2836e8da
--- /dev/null
+++ b/spec/spec/requirement-action-test-header.yml
@@ -0,0 +1,48 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+enabled-by: true
+links:
+- role: spec-member
+ uid: root
+spec-description: null
+spec-example: null
+spec-info:
+ dict:
+ attributes:
+ code:
+ description: |
+ If the value is present, then it shall be the test case header code.
+ The header code is placed at file scope after the test enum
+ declarations and before the test run function declaration.
+ spec-type: optional-str
+ includes:
+ description: |
+ It shall be a list of header files included by the header file via
+ ``#include <...>``.
+ spec-type: list-str
+ local-includes:
+ description: |
+ It shall be a list of header files included by the header file via
+ ``#include "..."``.
+ spec-type: list-str
+ run-params:
+ description: null
+ spec-type: requirement-action-test-run-param-list
+ target:
+ description: |
+ It shall be the path to the generated test header file.
+ spec-type: str
+ description: |
+ This set of attributes specifies an action requirement test header. In
+ case a test header is specified, then instead of a test case a test run
+ function will be generated. The test run function will be declared in
+ the test header target file and defined in the test source target file.
+ The test run function can be used to compose test cases. The test header
+ file is not automatically included in the test source file. It should be
+ added to the includes or local includes of the test.
+ mandatory-attributes: all
+ none: null
+spec-name: Action Requirement Test Header
+spec-type: requirement-action-test-header
+type: spec