Skip to content

Commit

Permalink
Merge pull request #589 from luck3y/test-plan
Browse files Browse the repository at this point in the history
Test plan updates & stability levels
  • Loading branch information
bstansberry authored Sep 22, 2024
2 parents c6d3807 + 7f9b6e1 commit 9a0c592
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions design-doc-template.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,23 @@ or a confirmation that there are no security implications to consider.

== Test Plan

Depending on the selected stability level, the appropriate section below should be completed, including a brief description of how testing is to be performed in accordance with the selected stability level. The non-relevant sections may be removed as needed.
////
Depending on the stability level, the test plan required may vary. see below:
////

** Experimental - no test plan is required. Basic unit / integration tests should be added during development.

** Preview - a brief high-level description of the testing approach should be added here, including types of tests added (unit, integration, smoke, component, subsystem, etc.) Note that not all test types are required for a particular feature, so include a description of what is being tested and the approach chosen to perform the testing.

** Community - this level should include everything in the 'Preview' stability level, plus the following additional testing as relevant:
*** Manual tests: briefly describe checks to be performed during one-time exploratory testing. The purpose of this testing is to check corner cases and other cases that are not worth implementing as automated tests. Typical checks are: bad configurations are easy to reveal, attribute descriptions and error messages are clear, names are descriptive and consistent with similar resources, default values are reasonable.
*** Miscellaneous checks: Manual checks for significant changes in server performance, memory and disk footprint should be described here. These checks are not always relevant, but consideration of these impacts, and others, are strongly encouraged and should be described here. Fully qualified test case names should be provided along with a brief description of what the test is doing.
*** Integration tests - at the 'Community' stability level, complete integration tests should be provided.
*** Compatibility tests - if backwards compatibility is relevant to the feature, then describe how the testing is performed.

** Default - This stability level is reserved and requires approval by a professional Quality Engineer with subject matter expertise.

== Community Documentation
////
Generally a feature should have documentation as part of the PR to wildfly main, or as a follow up PR if the feature is in wildfly-core. In some cases though the documentation belongs more in a component, or does not need any documentation. Indicate which of these will happen.
Expand Down

0 comments on commit 9a0c592

Please sign in to comment.