Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add canonical OC to test README template #3336

Merged
merged 9 commits into from
Nov 12, 2024
70 changes: 58 additions & 12 deletions doc/test-requirements-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ assignees: ''
Below is the required template for writing test requirements. Good examples of test
requirements include:

* [TE-18.1 gRIBI MPLS in UDP Encapsulation and Decapsulation](https://github.com/openconfig/featureprofiles/blob/main/feature/gribi/otg_tests/mpls_in_udp/README.md)
* [TE-3.7: Base Hierarchical NHG Update](/feature/gribi/otg_tests/base_hierarchical_nhg_update/README.md)
* [gNMI-1.13: Telemetry: Optics Power and Bias Current](https://github.com/openconfig/featureprofiles/blob/main/feature/platform/tests/optics_power_and_bias_current_test/README.md)
* [RT-5.1: Singleton Interface](https://github.com/openconfig/featureprofiles/blob/main/feature/interface/singleton/otg_tests/singleton_test/README.md)
dplore marked this conversation as resolved.
Show resolved Hide resolved

# TestID-x.y: Short name of test here

Expand All @@ -27,22 +27,68 @@ Write a few sentences or paragraphs describing the purpose and scope of the test

## Procedure

* Test environment setup
* Description of procedure to configure ATE and DUT with pre-requisites making it possible to cover the intended paths and RPC's.
### Test environment setup

* Description of procedure to configure ATE and DUT with pre-requisites making it possible to cover the intended paths and RPC's.
dplore marked this conversation as resolved.
Show resolved Hide resolved

#### Canonical OpenConfig Configuration for the DUT

NOTE: An example OpenConfig configuration and/or RPC content for any common
DUT configuration which is used across the subtests should be specified
robshakir marked this conversation as resolved.
Show resolved Hide resolved
here in JSON format.

```json
{
"openconfig-qos": {
"interfaces": [
{
"config": {
"interface-id": "PortChannel1.100"
},
"input": {
"classifiers": [
{
"classifier": "dest_A",
"config": {
"name": "dest_A",
"type": "IPV4"
}
}
],
"scheduler-policy": {
"config": {
"name": "limit_group_A_1Gb"
}
}
},
"interface": "PortChannel1.100"
},
]
}
}
```

### TestID-x.y.1 - Name of subtest 1

The following steps are typically present in each subtest.

* Step 1 - Generate DUT configuration
* Step 2 - Push configuration to DUT
* Step 3 - Send Traffic
* Step 4 - Validation with pass/fail criteria

* TestID-x.y.z - Name of subtest
* Step 1
* Step 2
* Validation and pass/fail criteria
### TestID-x.y.2 - Name of subtest 2

* TestID-x.y.z - Name of subtest
* Step 1
* Step 2
* Validation and pass/fail criteria
* Step 1 - Generate DUT configuration
* Step 2 - Push configuration to DUT
* Step 3 - Send Traffic
* Step 4 - Validation with pass/fail criteria

## OpenConfig Path and RPC Coverage

This example yaml defines the OC paths intended to be covered by this test. OC paths used for test environment setup are not required to be listed here.
This yaml stanza defines the OC paths intended to be covered by this test. OC paths used
for test environment setup are not required to be listed here. This content is parsed by
automation to derive the test coverage

```yaml
paths:
Expand Down
Loading