spec: Specify action requirement test headers

4 files changed, 105 insertions, 1 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
diff --git a/spec/spec/requirement-action-test-run-param-list.yml b/spec/spec/requirement-action-test-run-param-list.yml
new file mode 100644
index 00000000..0cf965d7
--- /dev/null
+++ b/spec/spec/requirement-action-test-run-param-list.yml
@@ -0,0 +1,16 @@
+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:
+  list:
+    description: null
+    spec-type: requirement-action-test-run-param
+spec-name: Action Requirement Test Run Parameter List
+spec-type: requirement-action-test-run-param-list
+type: spec
diff --git a/spec/spec/requirement-action-test-run-param.yml b/spec/spec/requirement-action-test-run-param.yml
new file mode 100644
index 00000000..8d23c11d
--- /dev/null
+++ b/spec/spec/requirement-action-test-run-param.yml
@@ -0,0 +1,37 @@
+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:
+      description:
+        description: |
+          It shall be the description of the parameter.
+        spec-type: str
+      dir:
+        description: null
+        spec-type: interface-param-dir
+      name:
+        description: |
+          It shall be the parameter name.
+        spec-type: str
+      specifier:
+        description: |
+          It shall be the complete function parameter specifier.  Use
+          ``$${.:name}`` for the parameter name, for example
+          ``"int $${.:name}"``.
+        spec-type: str
+    description: |
+      This set of attributes specifies a parameter for the test run function.
+      The parameter is also added as a member to the test context, see
+      ${requirement-action-test-context:/spec-name}.
+    mandatory-attributes: all
+spec-name: Action Requirement Test Run Parameter
+spec-type: requirement-action-test-run-param
+type: spec
diff --git a/spec/spec/requirement-action.yml b/spec/spec/requirement-action.yml
index 85d027d0..137e6206 100644
--- a/spec/spec/requirement-action.yml
+++ b/spec/spec/requirement-action.yml
@@ -36,6 +36,9 @@ spec-info:
         description: |
           If the value is present, then it shall be the test case description.
         spec-type: optional-str
+      test-header:
+        description: null
+        spec-type: requirement-action-test-header
       test-includes:
         description: |
           It shall be a list of header files included via ``#include <...>``.
@@ -60,7 +63,7 @@ spec-info:
         spec-type: optional-str
       test-target:
         description: |
-          It shall be the path to the generated target test case source file.
+          It shall be the path to the generated test case source file.
         spec-type: str
       test-teardown:
         description: null