Convert and validate some READMEs to use the new YAML format. #2903

wenovus · 2024-04-17T23:48:30Z

TODOs were added for READMEs that require domain expertise or longer code perusing.

You can find them via the following command using zsh:

grep -E 'TODO.(OCPATH|OCRPC)' **/README.md

OpenConfigBot · 2024-04-17T23:49:24Z

Pull Request Functional Test Report for #2903 / `33812f7`

Virtual Devices

Device	Test Documentation	Job	Raw Log
Arista cEOS	gNOI-3.3: Supervisor Switchover Authz: General Authz (1-4) tests RT-1.26: Basic static route support gNMI-1.10: Telemetry: Basic Check gNMI-1.27: gNMI Sample Mode Test RT-4.10: AFTs Route Summary gNOI-3.4: Chassis Reboot Status and Reboot Cancellation gNOI-5.1: Ping Test MTU-1.3: Large IP Packet Transmission gNMI-1.11: Telemetry: Interface Packet Counters gNMI-1.5: Telemetry: Port Speed Test gNOI-4.1: Software Upgrade RT-2.13: Weighted-ECMP for IS-IS OC-1.2: Default Address Families	93b99710	Log
Cisco 8000E	gNOI-3.3: Supervisor Switchover Authz: General Authz (1-4) tests RT-1.26: Basic static route support gNMI-1.10: Telemetry: Basic Check gNMI-1.27: gNMI Sample Mode Test RT-4.10: AFTs Route Summary gNOI-3.4: Chassis Reboot Status and Reboot Cancellation gNOI-5.1: Ping Test MTU-1.3: Large IP Packet Transmission gNMI-1.11: Telemetry: Interface Packet Counters gNMI-1.5: Telemetry: Port Speed Test gNOI-4.1: Software Upgrade RT-2.13: Weighted-ECMP for IS-IS OC-1.2: Default Address Families	4c44064e	Log
Cisco XRd	gNOI-3.3: Supervisor Switchover Authz: General Authz (1-4) tests RT-1.26: Basic static route support gNMI-1.10: Telemetry: Basic Check gNMI-1.27: gNMI Sample Mode Test RT-4.10: AFTs Route Summary gNOI-3.4: Chassis Reboot Status and Reboot Cancellation gNOI-5.1: Ping Test MTU-1.3: Large IP Packet Transmission gNMI-1.11: Telemetry: Interface Packet Counters gNMI-1.5: Telemetry: Port Speed Test gNOI-4.1: Software Upgrade RT-2.13: Weighted-ECMP for IS-IS OC-1.2: Default Address Families	5aba6902	Log
Juniper ncPTX	gNOI-3.3: Supervisor Switchover Authz: General Authz (1-4) tests RT-1.26: Basic static route support gNMI-1.10: Telemetry: Basic Check gNMI-1.27: gNMI Sample Mode Test RT-4.10: AFTs Route Summary gNOI-3.4: Chassis Reboot Status and Reboot Cancellation gNOI-5.1: Ping Test MTU-1.3: Large IP Packet Transmission gNMI-1.11: Telemetry: Interface Packet Counters gNMI-1.5: Telemetry: Port Speed Test gNOI-4.1: Software Upgrade RT-2.13: Weighted-ECMP for IS-IS OC-1.2: Default Address Families	1ab4d0cf	Log
Nokia SR Linux	gNOI-3.3: Supervisor Switchover Authz: General Authz (1-4) tests RT-1.26: Basic static route support gNMI-1.10: Telemetry: Basic Check gNMI-1.27: gNMI Sample Mode Test RT-4.10: AFTs Route Summary gNOI-3.4: Chassis Reboot Status and Reboot Cancellation gNOI-5.1: Ping Test MTU-1.3: Large IP Packet Transmission gNMI-1.11: Telemetry: Interface Packet Counters gNMI-1.5: Telemetry: Port Speed Test gNOI-4.1: Software Upgrade RT-2.13: Weighted-ECMP for IS-IS OC-1.2: Default Address Families	0daf35ec	Log
Openconfig Lemming	gNOI-3.3: Supervisor Switchover Authz: General Authz (1-4) tests RT-1.26: Basic static route support gNMI-1.10: Telemetry: Basic Check gNMI-1.27: gNMI Sample Mode Test RT-4.10: AFTs Route Summary gNOI-3.4: Chassis Reboot Status and Reboot Cancellation gNOI-5.1: Ping Test MTU-1.3: Large IP Packet Transmission gNMI-1.11: Telemetry: Interface Packet Counters gNMI-1.5: Telemetry: Port Speed Test gNOI-4.1: Software Upgrade RT-2.13: Weighted-ECMP for IS-IS OC-1.2: Default Address Families	95719bfd	Log

Hardware Devices

Device	Test	Test Documentation	Raw Log
Arista 7808		gNOI-3.3: Supervisor Switchover Authz: General Authz (1-4) tests RT-1.26: Basic static route support gNMI-1.10: Telemetry: Basic Check gNMI-1.27: gNMI Sample Mode Test RT-4.10: AFTs Route Summary gNOI-3.4: Chassis Reboot Status and Reboot Cancellation gNOI-5.1: Ping Test MTU-1.3: Large IP Packet Transmission gNMI-1.11: Telemetry: Interface Packet Counters gNMI-1.5: Telemetry: Port Speed Test gNOI-4.1: Software Upgrade RT-2.13: Weighted-ECMP for IS-IS OC-1.2: Default Address Families
Cisco 8808		gNOI-3.3: Supervisor Switchover Authz: General Authz (1-4) tests RT-1.26: Basic static route support gNMI-1.10: Telemetry: Basic Check gNMI-1.27: gNMI Sample Mode Test RT-4.10: AFTs Route Summary gNOI-3.4: Chassis Reboot Status and Reboot Cancellation gNOI-5.1: Ping Test MTU-1.3: Large IP Packet Transmission gNMI-1.11: Telemetry: Interface Packet Counters gNMI-1.5: Telemetry: Port Speed Test gNOI-4.1: Software Upgrade RT-2.13: Weighted-ECMP for IS-IS OC-1.2: Default Address Families
Juniper PTX10008		gNOI-3.3: Supervisor Switchover Authz: General Authz (1-4) tests RT-1.26: Basic static route support gNMI-1.10: Telemetry: Basic Check gNMI-1.27: gNMI Sample Mode Test RT-4.10: AFTs Route Summary gNOI-3.4: Chassis Reboot Status and Reboot Cancellation gNOI-5.1: Ping Test MTU-1.3: Large IP Packet Transmission gNMI-1.11: Telemetry: Interface Packet Counters gNMI-1.5: Telemetry: Port Speed Test gNOI-4.1: Software Upgrade RT-2.13: Weighted-ECMP for IS-IS OC-1.2: Default Address Families
Nokia 7250 IXR-10e		gNOI-3.3: Supervisor Switchover Authz: General Authz (1-4) tests RT-1.26: Basic static route support gNMI-1.10: Telemetry: Basic Check gNMI-1.27: gNMI Sample Mode Test RT-4.10: AFTs Route Summary gNOI-3.4: Chassis Reboot Status and Reboot Cancellation gNOI-5.1: Ping Test MTU-1.3: Large IP Packet Transmission gNMI-1.11: Telemetry: Interface Packet Counters gNMI-1.5: Telemetry: Port Speed Test gNOI-4.1: Software Upgrade RT-2.13: Weighted-ECMP for IS-IS OC-1.2: Default Address Families

Help

coveralls · 2024-04-17T23:51:45Z

Pull Request Test Coverage Report for Build 8901815342

Details

27 of 32 (84.38%) changed or added relevant lines in 1 file are covered.
No unchanged relevant lines lost coverage.
Overall coverage increased (+0.2%) to 55.647%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
tools/internal/mdocspec/ocspec.go	27	32	84.38%

Totals
Change from base Build 8876484813:	0.2%
Covered Lines:	1966
Relevant Lines:	3533

💛 - Coveralls

* fix telemetry_basic_check_test * enable workflow * fix basic check add int packet * enable workflow * revise yaml format * fix hw port path --------- Co-authored-by: Wen Bo Li <[email protected]>

…rofiles into convert-some-readmes

…s that require domain expertise or longer code perusing

dplore

couple items that can be fixed now, and some static errors to fix. All the other TODOs LGTM

feature/gnmi/subscribe/tests/gnmi_subscriptionlist_test/README.md

tools/validate_readme_spec/validate_readme_spec.go

…nfig#2903) * Convert and validate some READMEs to use the new YAML format. * Change YAML format of platform_type to list * Improve error messages * fix telemetry_basic_check_test (openconfig#2904) * fix telemetry_basic_check_test * enable workflow * fix basic check add int packet * enable workflow * revise yaml format * fix hw port path --------- Co-authored-by: Wen Bo Li <[email protected]> * Make exempted readmes populatable via CLI flag * fix * Enable all validations after making fixes and adding TODOs for READMEs that require domain expertise or longer code perusing * fix typo * add component type for a few paths and fix static analysis errors * fix typo --------- Co-authored-by: Darren Loher <[email protected]>

Convert and validate some READMEs to use the new YAML format.

3c886da

wenovus requested a review from dplore April 17, 2024 23:48

wenovus and others added 10 commits April 17, 2024 19:34

Change YAML format of platform_type to list

57255e1

Improve error messages

49a5b8a

fix telemetry_basic_check_test (#2904)

2b7eda6

* fix telemetry_basic_check_test * enable workflow * fix basic check add int packet * enable workflow * revise yaml format * fix hw port path --------- Co-authored-by: Wen Bo Li <[email protected]>

Merge branch 'main' into convert-some-readmes

eaaf455

Make exempted readmes populatable via CLI flag

e011107

Merge branch 'convert-some-readmes' of github.com:openconfig/featurep…

23cf954

…rofiles into convert-some-readmes

fix

e80ffc8

Merge branch 'main' into convert-some-readmes

9b20391

Enable all validations after making fixes and adding TODOs for README…

4b911eb

…s that require domain expertise or longer code perusing

fix typo

894376a

wenovus marked this pull request as ready for review April 30, 2024 01:50

wenovus requested review from a team as code owners April 30, 2024 01:50

dplore reviewed Apr 30, 2024

View reviewed changes

wenovus added 2 commits April 30, 2024 14:22

add component type for a few paths and fix static analysis errors

49772de

fix typo

33812f7

wenovus requested a review from dplore April 30, 2024 22:07

dplore approved these changes Apr 30, 2024

View reviewed changes

wenovus merged commit 4458701 into main Apr 30, 2024
15 checks passed

wenovus deleted the convert-some-readmes branch April 30, 2024 22:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Convert and validate some READMEs to use the new YAML format. #2903

Convert and validate some READMEs to use the new YAML format. #2903

wenovus commented Apr 17, 2024 •

edited

Loading

OpenConfigBot commented Apr 17, 2024 •

edited

Loading

coveralls commented Apr 17, 2024 •

edited

Loading

dplore left a comment

Convert and validate some READMEs to use the new YAML format. #2903

Convert and validate some READMEs to use the new YAML format. #2903

Conversation

wenovus commented Apr 17, 2024 • edited Loading

OpenConfigBot commented Apr 17, 2024 • edited Loading

Pull Request Functional Test Report for #2903 / 33812f7

Virtual Devices

Hardware Devices

coveralls commented Apr 17, 2024 • edited Loading

Pull Request Test Coverage Report for Build 8901815342

Details

💛 - Coveralls

dplore left a comment

Choose a reason for hiding this comment

wenovus commented Apr 17, 2024 •

edited

Loading

OpenConfigBot commented Apr 17, 2024 •

edited

Loading

Pull Request Functional Test Report for #2903 / `33812f7`

coveralls commented Apr 17, 2024 •

edited

Loading