spec: Add specification of test items

7 files changed, 237 insertions, 0 deletions

diff --git a/spec/spec/test-case-action-list.yml b/spec/spec/test-case-action-list.yml
new file mode 100644
index 00000000..bc399ae7
--- /dev/null
+++ b/spec/spec/test-case-action-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: test-case-action
+spec-name: Test Case Action List
+spec-type: test-case-action-list
+type: spec
diff --git a/spec/spec/test-case-action.yml b/spec/spec/test-case-action.yml
new file mode 100644
index 00000000..2dcedb61
--- /dev/null
+++ b/spec/spec/test-case-action.yml
@@ -0,0 +1,32 @@
+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:
+      action:
+        description: |
+          It shall be the test case action code.
+        spec-type: str
+      checks:
+        description: null
+        spec-type: test-case-check-list
+      description:
+        description: |
+          It shall be the test case action description.
+        spec-type: optional-str
+      links:
+        description: null
+        spec-type: links
+    description: |
+      This set of attributes specifies a test case action.
+    required-attributes: all
+spec-name: Test Case Action
+spec-type: test-case-action
+type: spec
diff --git a/spec/spec/test-case-check-list.yml b/spec/spec/test-case-check-list.yml
new file mode 100644
index 00000000..b4d97958
--- /dev/null
+++ b/spec/spec/test-case-check-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: test-case-check
+spec-name: Test Case Check List
+spec-type: test-case-check-list
+type: spec
diff --git a/spec/spec/test-case-check.yml b/spec/spec/test-case-check.yml
new file mode 100644
index 00000000..47b4d912
--- /dev/null
+++ b/spec/spec/test-case-check.yml
@@ -0,0 +1,29 @@
+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:
+      check:
+        description: |
+          It shall be the test case check code.
+        spec-type: str
+      description:
+        description: |
+          It shall be the test case check description.
+        spec-type: optional-str
+      links:
+        description: null
+        spec-type: links
+    description: |
+      This set of attributes specifies a test case check.
+    required-attributes: all
+spec-name: Test Case Check
+spec-type: test-case-check
+type: spec
diff --git a/spec/spec/test-case.yml b/spec/spec/test-case.yml
new file mode 100644
index 00000000..b182b712
--- /dev/null
+++ b/spec/spec/test-case.yml
@@ -0,0 +1,74 @@
+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 attribute 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 attribute 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
+      name:
+        description: null
+        spec-type: test-name
+      prologue:
+        description: |
+          If the attribute 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 attribute 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.
+    required-attributes: all
+spec-name: Test Case Item Type
+spec-type: test-case
+type: spec
diff --git a/spec/spec/test-name.yml b/spec/spec/test-name.yml
new file mode 100644
index 00000000..e3302266
--- /dev/null
+++ b/spec/spec/test-name.yml
@@ -0,0 +1,20 @@
+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:
+  str:
+    assert:
+    - re: ^[A-Z][a-zA-Z0-9 _]+$
+    description: |
+      It shall be the name of a test suite or test case.  It shall be formatted
+      in the style of a caption.  If shall form a valid C designator after
+      removal of all white space characters.
+spec-name: Test Name
+spec-type: test-name
+type: spec
diff --git a/spec/spec/test-suite.yml b/spec/spec/test-suite.yml
new file mode 100644
index 00000000..517f5428
--- /dev/null
+++ b/spec/spec/test-suite.yml
@@ -0,0 +1,50 @@
+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-suite
+  uid: root
+spec-description: null
+spec-example: null
+spec-info:
+  dict:
+    attributes:
+      brief:
+        description: |
+          It shall be the test suite brief description.
+        spec-type: str
+      code:
+        description: |
+          It shall be the test suite code.  The test suite code is placed at
+          file scope in the target source file.
+        spec-type: str
+      description:
+        description: |
+          It shall be the test suite description.
+        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
+      name:
+        description: null
+        spec-type: test-name
+      target:
+        description: |
+          It shall be the path to the generated target test suite source file.
+        spec-type: str
+    description: |
+      This set of attributes specifies a test suite.
+    required-attributes: all
+spec-name: Test Suite Item Type
+spec-type: test-suite
+type: spec