openconfig / featureprofiles / 8607136984

10%

push

github

Validation Script for OC Path and RPC Coverage in READMEs (#2865)

* Add yaml spec for oc path/rpc to test-requirements-template

* revise yaml

* revise yaml

* Validation Script for OC Path and RPC Coverage in READMEs

* `mdocspec` package parses ocpath.proto and ocrpcs.proto from yaml
  according to the format shown below by mdocspec.Parse's documentation.
* `tools/validate_readme_spec/validate_readme_spec.go` script is added
  that can parse and then validate OC Paths and RPCs according to
  existing repo states in github.com/openconfig.

```go
// Parse extracts sorted OpenConfig Path and RPC Coverage from an FNT
README.
//
// The first yaml code block after a heading line named exactly as
// "OpenConfig Path and RPC Coverage" will be used. Any other code
blocks are
// ignored.
//
// Expected markdown format:
//
//      ## OpenConfig Path and RPC Coverage
//
//      ```yaml
//      paths:
//        /interfaces/interface/config/description:
//        /interfaces/interface/config/enabled:
//        /components/component/state/name:
//          platform_type: "CHASSIS"
//
//      rpcs:
//        gnmi:
//          gNMI.Set:
//            union_replace: true
//          gNMI.Subscribe:
//            on_change: true
//      ```
//
// Note: For `rpcs`, only the RPC name and methods are validated. Any
// attributes defined below RPC methods (e.g. union_replace) are not validated.
```

* Add invalid README example

* Fix style

* Make YAMLRenderer unexported

* Improve comments

* Update tools/internal/mdocspec/ocspec.go

Co-authored-by: Darren Loher <dloher@google.com>

* Minor improvements for OC coverage validation

* Skip repo-cloning during validation if repo already cloned.
* Validate that at least one RPC method is specified for any coverage spec.
* Add additional validation for script in bash file.
* Style Improvements.

* Improve logic by searching from header rather than YAML block... (continued)

105 of 142 new or added lines in 3 files covered. (73.94%)

1948 of 3531 relevant lines covered (55.17%)

0.63 hits per line