1# Test Case Guidelines for `rnp` 2 3The document aims to describe and capture various use cases for `rnp` in 4the form of the test cases. These can be used as acceptance tests for 5the maintenance of the project. 6 7 8## Naming conventions 9 10The test case name is composed of the three parts. 11 12* First being the module under test, 13* Second being the feature and third details the motivation of the test. 14 15Naming structure looks like: `<module>_<component>_<test-motivation>`. 16 17For example, when testing the `generatekey` feature of `rnpkeys`, the 18test case name would be `rnpkeys.generatekey.<test-motivation>`. 19 20 21## Test Case Specification Template 22 23The following template **SHOULD** be used for describing a test case. 24 25 26~~~~~~ md 27# <test-case-name> 28 29Component 30: <component-name> 31 32Feature 33: <feature-name> 34 35## Objective 36 37% Objective of test case 38 39## Description 40 41% Describe test case briefly 42 43## Preconditions 44 45% List of conditions prior to testing 46 47* condition 1 48* condition 2 49* condition 3 50 51## Test steps and expected behavior 52 531. Test step 1 54 551. Test step 2 56 57Expectation: expectation here 58 59## Verification steps and logic 60 611. Verification step 1 62 * Rationale: verification logic 63 641. Verification step 2 65 * Rationale: verification logic 66 67## Comments 68 69% if any 70 71~~~~~~ 72 73