Improve verification templates for code

Resolves: #193
Signed-off-by: Philipp Ahmann <[email protected]>

Author: pahmann

process/process_areas/verification/guidance/verification_process_reqs.rst

@@ -47,7 +47,7 @@ Process Requirements
 
 
     More information can be found in the :need:`gd_guidl__verification_guide`, :need:`doc_concept__verification_process`,
-    and :need:`gd_guidl__verification_specification`.
+    and :need:`gd_guidl__verification_specification` .
 
 .. gd_req:: Linking Requirements to Tests (C++)
     :id: gd_req__verification_link_tests_cpp
@@ -57,30 +57,12 @@ Process Requirements
     :complies: std_req__iso26262__support_6432
 
 
-    For linking C++ test suites to requirements **record properties** shall be used. Attributes
+    For linking C++ tests to requirements **record properties** shall be used. Attributes
     which are common for all test cases can be specified in the Setup Function (SetUp()), the other
     attributes which are specific for each test case need to be specified within the test case:
 
-    .. code-block:: cpp
+    A more detailed description of how to link code to requirements looks like is available in the :ref:`verification_template_cpp`
 
-      class TestSuite : public ::testing::Test{
-         public:
-            void SetUp() override
-            {
-               RecordProperty("TestType", "<TestType>");
-               RecordProperty("DerivationTechnique", "<DerivationTechnique>");
-               ...
-            }
-      };
-
-      TEST_F(TestSuite, <Test Case>)
-      {
-         RecordProperty("PartiallyVerifies", "ID_2, ID_3, ...");
-         RecordProperty("FullyVerifies", "ID_4, ID_5, ...");
-         RecordProperty("Description", "<Description>");
-
-         ASSERT ...
-      }
 
 .. gd_req:: Linking Requirements to Tests (Python)
     :id: gd_req__verification_link_tests_python
@@ -101,17 +83,8 @@ Process Requirements
     For allowed values for test_type & derivation_technique please check :need:`gd_req__verification_link_tests`
     Further more, this decorator will also check if your test has a `docstring` which should act as the description of the test.
 
+    A more detailed description of how to link code to requirements looks like is available in the :ref:`verification_template_python`
 
-    .. code-block:: python
-
-         @add_test_properties(
-             partially_verifies=["tool_req__docs_dd_link_source_code_link"],
-             test_type="requirements-based",
-             derivation_technique="requirements-analysis",
-         )
-         def test_group_by_need_empty_list():
-             """Test grouping empty list of needlinks."""
-             ...
 
 .. gd_req:: Linking Requirements to Tests (Rust)
     :id: gd_req__verification_link_tests_rust
@@ -122,19 +95,7 @@ Process Requirements
 
     For linking Rust tests to requirements **#[record_property]** shall be used:
 
-    .. code-block:: rust
-
-        use test_properties::record_property;
-
-        #[record_property("PartiallyVerifies", "ID_2, ID_3, ...")]
-        #[record_property("FullyVerifies", "ID_4, ID_5, ...")]
-        #[record_property("Description", "<Description>")]
-        #[record_property("TestType", "<TestType>")]
-        #[record_property("DerivationTechnique", "<DerivationTechnique>")]
-        #[test]
-        fn test_case_function() {
-            ...
-        }
+    A more detailed description of how to link code to requirements looks like is available in the :ref:`verification_template_rust`
 
 .. gd_req:: Independence
     :id: gd_req__verification_independence

process/process_areas/verification/guidance/verification_templates.rst

@@ -20,13 +20,44 @@ Verification Templates
 The sections below are seen as typical ways when writing tests and their specification.
 Their usage differs based on the selected testing framework and the implementation language of the module(s).
 
-gTest
------
+C++
+---
 
-gTest is a commonly used and accepted test framework to write test cases for C/C++ code.
+For C++ code gTest is a commonly used and accepted test framework to write test cases for C/C++ code.
 
 Each test case requires a link to one or more requirement/design element.
-A more detailed description of how to link code to requirements is available here: :need:`gd_req__verification_link_tests_cpp`
+
+For linking C++ tests to requirements **record properties** shall be used. Attributes
+which are common for all test cases can be specified in the Setup Function (SetUp()), the other
+attributes which are specific for each test case need to be specified within the test case:
+
+Below code is exemplary and can be used as a template when writing test cases.
+
+.. _verification_template_cpp:
+
+C++ Properties Template
+^^^^^^^^^^^^^^^^^^^^^^^
+
+   .. code-block:: cpp
+
+      class TestSuite : public ::testing::Test{
+         public:
+            void SetUp() override
+            {
+               RecordProperty("TestType", "<TestType>");
+               RecordProperty("DerivationTechnique", "<DerivationTechnique>");
+               ...
+            }
+      };
+
+      TEST_F(TestSuite, <Test Case>)
+      {
+         RecordProperty("PartiallyVerifies", "ID_2, ID_3, ...");
+         RecordProperty("FullyVerifies", "ID_4, ID_5, ...");
+         RecordProperty("Description", "<Description>");
+
+         ASSERT ...
+      }
 
 When writing test cases using gTest, they shall follow the recommendations from the official gTest documentation.
 For very basic start follow http://google.github.io/googletest/primer.html
@@ -41,7 +72,29 @@ Details on the definition an the test organization in rust can be found here:
 https://doc.rust-lang.org/book/ch11-03-test-organization.html
 
 Each test case requires a link to one or more requirement/design element.
-A more detailed description of how to link code to requirements is available here: :need:`gd_req__verification_link_tests_rust`
+
+Below code is exemplary and can be used as a template when writing test cases.
+
+.. _verification_template_rust:
+
+Rust Properties Template
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+   For linking Rust tests to requirements **#[record_property]** shall be used:
+
+   .. code-block:: rust
+
+      use test_properties::record_property;
+
+      #[record_property("PartiallyVerifies", "ID_2, ID_3, ...")]
+      #[record_property("FullyVerifies", "ID_4, ID_5, ...")]
+      #[record_property("Description", "<Description>")]
+      #[record_property("TestType", "<TestType>")]
+      #[record_property("DerivationTechnique", "<DerivationTechnique>")]
+      #[test]
+      fn test_case_function() {
+         ...
+      }
 
 When writing test cases in rust, they shall follow the recommendations from the official rust documentation.
 https://doc.rust-lang.org/book/ch11-01-writing-tests.html
@@ -54,7 +107,28 @@ When writing test cases in python, this should be done using pytest.
 Note that python unittest does not support metatags and therefore should not be considered as test framework.
 
 Each test case requires a link to one or more requirement/design element.
-A more detailed description of how to link code to requirements is available here: :need:`gd_req__verification_link_tests_python`
+
+For linking python tests to requirements **metadata** shall be used.
+
+For allowed values for test_type & derivation_technique please check :need:`gd_req__verification_link_tests`
+
+Below code is exemplary and can be used as a template when writing test cases.
+
+.. _verification_template_python:
+
+Python Properties Template
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+   .. code-block:: python
+
+      @add_test_properties(
+            partially_verifies=["tool_req__docs_dd_link_source_code_link"],
+            test_type="requirements-based",
+            derivation_technique="requirements-analysis",
+      )
+      def test_group_by_need_empty_list():
+            """Test grouping empty list of needlinks."""
+            ...
 
 When writing test cases in python, they shall follow the recommendations from the official python and community documentation.
 https://docs.python-guide.org/writing/tests/