Added support for xpath coverage report generation

[saba8814]

Description

This PR introduces heatmap report for all XPaths covered by tests.
PR introduces extract-all-xpaths routine in Make, that is run before "make test" it's output is list of all xpaths this file is used to compare with actually covered xpaths, that are marked as "seen" in the test "transport" layer.

Output of the the file is approximately 80 pages .md file that has 2 sections:
section 1. - Summary of coverage per module
section 2. - Detailed heatmap

Xpaths are marked in 3 colors and their meanings are:

• 🟢 Every XPath in the module was touched by at least one test operation
• 🟠 Some XPaths were touched but others were not
• 🔴 No test operation reached any XPath in the module

Screenshots

Title Page:

Summary:

Detailed:

Checklist

Tick relevant boxes, this PR is-a or has-a:

• Bugfix
  • Regression tests
  • ChangeLog updates (for next release)
• Feature
  • YANG model change => revision updated?
  • Regression tests added?
  • ChangeLog updates (for next release)
  • Documentation added?
• Test changes
  • Checked in changed Readme.adoc (make test-spec)
  • Added new test to group Readme.adoc and yaml file
• Code style update (formatting, renaming)
• Refactoring (please detail in commit messages)
• Build related changes
• Documentation content changes
  • ChangeLog updated (for major changes)
• Other (please describe):

[mattiaswal]

Just a general thing:

and the yang model:

  leaf gm-timebase-indicator {
      type uint16;
      config false;
      description
        "The timeBaseIndicator of the current Grandmaster PTP
         Instance.";
      reference
        "14.3.6 of IEEE Std 802.1AS";
    }
    leaf gm-change-count {
      type yang:counter32;
      config false;
      description
        "This statistics counter tracks the number of times the
         Grandmaster PTP Instance has changed in a gPTP domain.";
      reference
        "14.3.7 of IEEE Std 802.1AS";
    }

this is notes that is impossible to set since config false the coverage looks much worse than it is. Is it possible to skip config false nodes, since they only is operational.

[saba8814]

Just a general thing: and the yang model:

  leaf gm-timebase-indicator {
      type uint16;
      config false;
      description
        "The timeBaseIndicator of the current Grandmaster PTP
         Instance.";
      reference
        "14.3.6 of IEEE Std 802.1AS";
    }
    leaf gm-change-count {
      type yang:counter32;
      config false;
      description
        "This statistics counter tracks the number of times the
         Grandmaster PTP Instance has changed in a gPTP domain.";
      reference
        "14.3.7 of IEEE Std 802.1AS";
    }

this is notes that is impossible to set since config false the coverage looks much worse than it is. Is it possible to skip config false nodes, since they only is operational.

I've addded SKIP_MODULES list, guess I can extract all config false and place them there.

[saba8814]

Collaborator

@mattiaswal I've added skip for all config false now in separate commit.

[mattiaswal]

Great work on this 👍