ipng/vppcfg
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Assert hardware APIs must be made available for testing

Browse Source
This commit is contained in:
Pim van Pelt
2022-04-07 21:39:41 +00:00
parent b7425a825d
commit 1a00f14b53
1 changed files with 18 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
docs/contributing.md
View File

@ -55,19 +55,6 @@ Developer's Certificate of Origin 1.1
this project or the open source license(s) involved. this project or the open source license(s) involved.
``` ```
### Semantic validation
`vppcfg` will be used in many different scenarios - from the bench just doing a quick test
when hacking on a VPP feature, all the way through to large production networks where dataplane
crashes cause user harm. As such, contributing code has to be done with care.
Static analysis is incredibly important, to help ensure that the YAML configuration files can
be safely applied to running VPP instances:
* All changes to syntax validation are expected to have 100% unit test coverage.
* All changes to semantic validation are expected to have 100% YAMLTest coverage.
* New code cannot break an existing test unless the test is objectively incorrect.
### Completeness ### Completeness
Feature additions are expected to be reasonably complete when merged. Keep work-in-progress in Feature additions are expected to be reasonably complete when merged. Keep work-in-progress in
@ -81,6 +68,24 @@ a git branch until it's completed. New VPP APIs should have:
crashing `vppcfg` or VPP itself) crashing `vppcfg` or VPP itself)
* Demonstrably work well with existing code. * Demonstrably work well with existing code.
### Testing Requirements
`vppcfg` will be used in many different scenarios - from the bench just doing a quick test
when hacking on a VPP feature, all the way through to large production networks where dataplane
crashes cause user harm. As such, contributing code has to be done with care.
Static analysis is incredibly important, to help ensure that the YAML configuration files can
be safely applied to running VPP instances:
* All changes to syntax validation are expected to have 100% unit test coverage.
* All changes to semantic validation are expected to have 100% YAMLTest coverage.
* New code cannot break an existing test unless the test is objectively incorrect.
APIs integrations that require hardware, for example DPDK, RDMA or other custom hardware, are very
welcome in `vppcfg`. However, they must be tested / testable as well, so hardware must be made
available to testing rigs either remotely or locally, and integrated with release and integration
testing harnass to ensure continued support in releases. Contact the project tech lead to coordinate.
### Version Skew ### Version Skew
`vppcfg` is intended to work within two major releases of VPP. For example, 21.10 and 22.02 will `vppcfg` is intended to work within two major releases of VPP. For example, 21.10 and 22.02 will