summaryrefslogtreecommitdiffstats
path: root/spec/spec/test-case.yml
blob: 03260915041650ac079f4fd984b6b35671bb7038 (plain) (blame)
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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
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
- role: spec-refinement
  spec-key: type
  spec-value: test-case
  uid: root
spec-description: null
spec-example: null
spec-info:
  dict:
    attributes:
      actions:
        description: null
        spec-type: test-case-action-list
      brief:
        description: |
          It shall be the test case brief description.
        spec-type: str
      description:
        description: |
          It shall be the test case description.
        spec-type: optional-str
      epilogue:
        description: |
          If the value is present, then it shall be the test case epilogue
          code.  The epilogue code is placed in the test case body after the
          test case actions.
        spec-type: optional-str
      fixture:
        description: |
          If the value is present, then it shall be a pointer to the test case
          fixture.  The test case fixture pointer declaration may be provided
          by the test case support code or via an included header file.
        spec-type: optional-str
      includes:
        description: |
          It shall be a list of header files included via ``#include <...>``.
        spec-type: list-str
      local-includes:
        description: |
          It shall be a list of header files included via ``#include "..."``.
        spec-type: list-str
      prologue:
        description: |
          If the value is present, then it shall be the test case prologue
          code.  The prologue code is placed in the test case body before the
          test case actions.  A use case is the declaration of local variables
          used by the test case actions.
        spec-type: optional-str
      support:
        description: |
          If the value is present, then it shall be the test case support code.
          The support code is placed at file scope before the test case code.
        spec-type: optional-str
      target:
        description: |
          It shall be the path to the generated target test case source file.
        spec-type: str
    description: |
      This set of attributes specifies a test case.
    mandatory-attributes: all
spec-name: Test Case Item Type
spec-type: test-case
type: spec