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

wenovus · 2024-03-30T02:48:23Z

tools/internal/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.

// 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.
func Parse(source []byte) (*ppb.OCPaths, *rpb.OCRPCs, error) {

* `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. ```

OpenConfigBot · 2024-03-30T02:48:52Z

Pull Request Functional Test Report for #2865 / `2b79d7b`

No tests identified for validation.

Help

coveralls · 2024-03-30T02:55:11Z

Pull Request Test Coverage Report for Build 8606754992

Details

105 of 142 (73.94%) changed or added relevant lines in 3 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage increased (+0.8%) to 55.169%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
tools/internal/mdocspec/md.go	41	44	93.18%
tools/internal/mdocspec/ocspec.go	64	72	88.89%
tools/internal/ocpaths/clone_public.go	0	26	0.0%

Totals
Change from base Build 8596811599:	0.8%
Covered Lines:	1948
Relevant Lines:	3531

💛 - Coveralls

wenovus · 2024-03-30T03:41:16Z

This validation routine is based on the template README style being defined in #2863

.github/workflows/readme_oc_path_and_rpc.yml

tools/internal/mdocspec/md_test.go

tools/internal/mdocspec/ocspec.go

tools/internal/mdocspec/md.go

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

… mdocspec

* 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.

tools/internal/mdocspec/md.go

tools/internal/mdocspec/ocspec.go

tools/internal/ocpaths/clone_public.go

tools/internal/ocrpcs/ocrpcs.go

wenovus · 2024-04-08T21:18:38Z

@dplore Need another approval due to slight doc fix.

…#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 * add another corner case test * add another corner case test * Improve doc comment * Improve doc comments * Fix doc comment --------- Co-authored-by: Darren Loher <dloher@google.com>

dplore and others added 4 commits March 28, 2024 12:07

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

6632935

revise yaml

7329e95

revise yaml

e5a0e45

Add invalid README example

2515f36

wenovus requested a review from dplore March 30, 2024 03:10

wenovus marked this pull request as ready for review March 30, 2024 03:10

wenovus requested review from a team as code owners March 30, 2024 03:10

wenovus requested a review from robshakir March 30, 2024 03:10

wenovus assigned dplore Mar 30, 2024

wenovus removed the request for review from robshakir March 30, 2024 03:12

wenovus assigned robshakir Mar 30, 2024

Fix style

890d3f2

wenovus added 2 commits April 2, 2024 14:02

Make YAMLRenderer unexported

93bc9bd

Improve comments

5ee1b4c

dplore reviewed Apr 5, 2024

View reviewed changes

Base automatically changed from dplore-patch-2 to main April 5, 2024 04:39

wenovus and others added 4 commits April 5, 2024 10:07

Merge branch 'main' into mdocspec

d6e80be

Update tools/internal/mdocspec/ocspec.go

04b2b0c

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

Merge branch 'mdocspec' of github.com:openconfig/featureprofiles into…

18658b9

… mdocspec

Minor improvements for OC coverage validation

08f5448

* 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.

wenovus requested a review from dplore April 5, 2024 20:59

wenovus added 4 commits April 5, 2024 15:59

Improve logic by searching from header rather than YAML block

5826fd9

add another corner case test

9a1ffc5

add another corner case test

b0515e0

Improve doc comment

218ea66

dplore reviewed Apr 8, 2024

View reviewed changes

tools/internal/mdocspec/md.go Show resolved Hide resolved

tools/internal/mdocspec/ocspec.go Show resolved Hide resolved

tools/internal/ocpaths/clone_public.go Show resolved Hide resolved

tools/internal/ocrpcs/ocrpcs.go Show resolved Hide resolved

Improve doc comments

73d317c

dplore previously approved these changes Apr 8, 2024

View reviewed changes

Fix doc comment

1f5be99

wenovus dismissed dplore’s stale review via 1f5be99 April 8, 2024 21:17

Merge branch 'main' into mdocspec

2b79d7b

dplore approved these changes Apr 8, 2024

View reviewed changes

wenovus merged commit 7d92195 into main Apr 8, 2024
15 checks passed

wenovus deleted the mdocspec branch April 8, 2024 21:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

wenovus commented Mar 30, 2024

OpenConfigBot commented Mar 30, 2024 •

edited

Loading

coveralls commented Mar 30, 2024 •

edited

Loading

wenovus commented Mar 30, 2024

wenovus commented Apr 8, 2024

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

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

Conversation

wenovus commented Mar 30, 2024

OpenConfigBot commented Mar 30, 2024 • edited Loading

Pull Request Functional Test Report for #2865 / 2b79d7b

coveralls commented Mar 30, 2024 • edited Loading

Pull Request Test Coverage Report for Build 8606754992

Details

💛 - Coveralls

wenovus commented Mar 30, 2024

wenovus commented Apr 8, 2024

OpenConfigBot commented Mar 30, 2024 •

edited

Loading

Pull Request Functional Test Report for #2865 / `2b79d7b`

coveralls commented Mar 30, 2024 •

edited

Loading