Requirement ID Generation and RST Validation

The new check.py script will now perform a variety of
actions to simplify updates and ensure specific
practices are followed for each update.

The script has been integrated with tox and
will run whenever the documentation is created.
It can also be ran separately by just invoking
python check.py.

The script will perform a variety of automatic
updates where possible, and provide a warning
where auto-updates are not possible.

The expecation is that all warnings are addressed
before submitting for review, but given it is a
new feature warnings do not block validation at
this time.

Here is a summary of the warnings and updates:

Warnings:
- Requirement missing required attributes
- Invalid values for attributes
- Invalid section header usage in any file
- :keyword: and requirement mismatch

Auto Updates:
- Assigning :id: on new requirements where an ID missing
- Adding :introduced: attribute on new requirements
- Adding/correcting :updated: attribute on changed requirements

Issue-ID: VNFRQTS-896
Signed-off-by: Lovett, Trevor <trevor.lovett@att.com>
Change-Id: I283441330a139aa1c6e2e79f0c54c5979bf44642

1 files changed, 12 insertions, 6 deletions

diff --git a/docs/Chapter5/Heat/ONAP Heat Template Constructs.rst b/docs/Chapter5/Heat/ONAP Heat Template Constructs.rst
index a45491c..389b7b7 100644
--- a/docs/Chapter5/Heat/ONAP Heat Template Constructs.rst
+++ b/docs/Chapter5/Heat/ONAP Heat Template Constructs.rst
@@ -5,7 +5,7 @@
 .. _ONAP Heat Heat Template Constructs:
 
 ONAP Heat Heat Template Constructs
---------------------------------------
+----------------------------------
 
 .. _Nested Heat Templates:
 
@@ -59,6 +59,7 @@ have a unique name in the scope of the VNF.
 
 .. req::
     :id: R-60011
+    :target: VNF
     :keyword: MUST
     :updated: casablanca
     :validation_mode: static
@@ -75,7 +76,8 @@ the second level of nested heat.
 
 .. req::
     :id: R-17528
-    :keyword: MUST
+    :target: VNF
+    :keyword: MUST NOT
     :updated: frankfurt
     :validation_mode: static
 
@@ -86,6 +88,7 @@ the second level of nested heat.
 
 .. req::
     :id: R-708564
+    :target: VNF
     :keyword: MUST NOT
     :introduced: dublin
     :validation_mode: static
@@ -145,6 +148,7 @@ cause issues for other ONAP applications/features.
 
 .. req::
     :id: R-11041
+    :target: VNF
     :keyword: MUST
     :updated: casablanca
     :validation_mode: static
@@ -155,6 +159,7 @@ cause issues for other ONAP applications/features.
 
 .. req::
     :id: R-90022
+    :target: VNF
     :keyword: MAY
     :updated: casablanca
 
@@ -163,6 +168,7 @@ cause issues for other ONAP applications/features.
 
 .. req::
     :id: R-04344
+    :target: VNF
     :keyword: MAY
     :updated: casablanca
 
@@ -305,8 +311,8 @@ OS::Heat::ResourceGroup Property count
     :id: R-50011
     :target: VNF
     :keyword: MUST
-    :validation_mode: static
     :updated: casablanca
+    :validation_mode: static
 
     A VNF's Heat Orchestration Template's ``OS::Heat::ResourceGroup``
     property ``count`` **MUST** be enumerated in the VNF's
@@ -624,8 +630,8 @@ following limitations:
     :id: R-76718
     :target: VNF
     :keyword: MUST
-    :validation_mode: static
     :updated: casablanca
+    :validation_mode: static
 
     If a VNF's Heat Orchestration Template uses the intrinsic function
     ``get_file``, the ``get_file`` target **MUST** be referenced in
@@ -639,8 +645,8 @@ See requirement R-511776.
     :id: R-41888
     :target: VNF
     :keyword: MUST NOT
-    :validation_mode: static
     :updated: casablanca
+    :validation_mode: static
 
     A VNF's Heat Orchestration Template intrinsic function
     ``get_file`` **MUST NOT** utilize URL-based file retrieval.
@@ -703,10 +709,10 @@ automatically assign a public/private key pair.
 
 .. req::
     :id: R-100380
+    :target: VNF
     :keyword: SHOULD
     :introduced: dublin
     :validation_mode: none
-    :target: VNF
 
     If a VNF requires the use of an SSH key created by OpenStack, the VNF
     Heat Orchestration Template **SHOULD** create the ``OS::Nova::Keypair``