Uploaded image for project: 'Vnfsdk'
  1. Vnfsdk
  2. VNFSDK-696

[Validation] Generate rst table with supported rules

XMLWordPrintable

    • Icon: Story Story
    • Resolution: Done
    • Icon: Medium Medium
    • Honolulu Release
    • None
    • None

      Extend validation project to generate rst table with information about supported rules.
      The generation should be done during the project building.

      Mentioned table can be used later in the project documentation.

      Tip:
      Trevor Lovett added a comment - 2 days ago

      Bogumil Zebek Here are some more details. I suspect it won't be usable as-is by VNFSDK, but hopefully, it's useful and you can adapt it to VNFSDK's build and documentation process.

      Mapping Tests to Requirements

      This is very VVP-specific. We annotate each test with a Python decorator called validates. VVP includes a copy of the VNF Requirements as JSON which is published by the VNF Requirements project. The JSON requirements and mapping is used to create the error reports, and the mapping tables. Several reports are created on each VVP run, but one is an CSV table that maps requirements to tests. This is in conftest.py

      Publishing the RST table from VVP

      When the unit tests for VVP are run the mapping table is created, and there is a job in Jenkins that uploads the RST table (and other artifacts to nexus).

      *Including Nexus artifact in VNF Requirements Document"

      We load the CSV artifact via the URL using csv-table in RST. See an example here.

            bogumil_zebek bogumil_zebek
            bogumil_zebek bogumil_zebek
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: