spec/spec/requirement-action-test-header.yml


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
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