Skip to content

Commit

Permalink
Add template for creating test requirement README files (#2106)
Browse files Browse the repository at this point in the history
  • Loading branch information
dplore authored Sep 9, 2023
1 parent 3277670 commit 5544470
Show file tree
Hide file tree
Showing 2 changed files with 87 additions and 0 deletions.
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/new_test_requirement.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
name: New featureprofiles test requirement
<<<<<<< Updated upstream
about: Use this template to document the requirements for a new test to be implemented.
title: ''
labels: enhancement
Expand Down Expand Up @@ -49,3 +50,18 @@ For example:
* Get
* Check
* Artifact
=======
about: Use this template to create an issue to assign and track implemenation of the code for a test.
title: ''
labels: enhancement
assignees: ''
---

# Request for New Test Code Implementation Instructions

* The label 'enhancement' is automatically set by this template.
* Add a label for the test priority according to the test requirements. (p0, p1, p2)
* Add a link in this issue description to the README.md for the test requirements. For example:

Implement code for [Test name here](<https://github.com/openconfig/featureprofiles/><insert link to the README.md file here>)
>>>>>>> Stashed changes
71 changes: 71 additions & 0 deletions doc/test-requirements-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
---
name: New featureprofiles test requirement
about: Use this template to document the requirements for a new test to be implemented.
title: ''
labels: enhancement
assignees: ''

---

# Instructions for this template

Below is the required template for writing test requirements. Good examples of test
requirements include:

* [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)

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

## Summary

Write a few sentences or paragraphs describing the purpose and scope of the test.

## Testbed type

* Specify the .testbed topology file from the [topologies](https://github.com/openconfig/featureprofiles/tree/main/topologies) folder to be used with this test

## Procedure

* Sub Test #1 - Name of test
* Step 1
* Step 2
* Validation and pass fail criteria

* Sub Test #2 - New of test
* Step 1
* Step 2
* Validation and pass fail criteria

## Config Parameter Coverage

Add list of OpenConfig 'config' paths used in this test, if any.

## Telemetry Parameter Coverage

Add list of OpenConfig 'state' paths used in this test, if any.

## Protocol/RPC Parameter Coverage

Add list of OpenConfig RPC's (gNMI, gNOI, gNSI, gRIBI) used in the list, if any.

For example:

* gNMI
* Set
* Subscribe
* gNOI
* System
* KillProcess
* Healthz
* Get
* Check
* Artifact

## Required DUT platform

* Specify the minimum DUT-type:
* MFF - A modular form factor device containing LINECARDs, FABRIC and redundant CONTROLLER_CARD components
* FFF - fixed form factor
* vRX - virtual router device

0 comments on commit 5544470

Please sign in to comment.