From 819367c70e0e97893ce077f6b26b51f81feec9c6 Mon Sep 17 00:00:00 2001 From: Wendell Piez Date: Mon, 9 May 2022 16:45:40 -0400 Subject: [PATCH] Updated profile resolution (spec) readme with clarification regarding unit testing --- src/specifications/profile-resolution/readme.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/src/specifications/profile-resolution/readme.md b/src/specifications/profile-resolution/readme.md index 26a54cd0fd..e3a32f2055 100644 --- a/src/specifications/profile-resolution/readme.md +++ b/src/specifications/profile-resolution/readme.md @@ -1,3 +1,4 @@ +# Profile Resolution Specification and Testing ## Providing feedback on this specification @@ -7,7 +8,15 @@ Please post Issues in Github or questions to the OSCAL mailing list, or ask abou The specifications are being edited in an ad-hoc XML back end format, a lightweight extension to HTML tagging. If you wish to edit the files directly, we have stylesheets for presentation and HTML conversion along with Schematron for validation (runtime or at check points); please contact us. -### Capabilities +## Profile Resolution Unit Tests + +Profile resolution unit tests are maintained here and bound to the specification via markup embedded with the specifications, for convenience in alignment. Formal test scenario files can be generated dynamically from markup when needed. + +In this subdirectory, the folder `profile-resolution-examples` includes old tests kept here for potential future use/reuse while we complete a common test set. + +The comment test set we are developing can be found in folder `requirement-tests`. + +## SpecML Capabilities - XML authoring of specifications - HTML previews with ToC / requirements index @@ -39,14 +48,13 @@ The `@href` is the file instance for the example. The text is a qualifying descr Presently all `eg` are inside `req` so there is an implicit relation there (no examples are named apart from stated requirements). -### Unit tests +### Unit test scenario generation Based on markup in the SpecML document, XSpec unit test sheets can be generated framing the unit test held in this subdirectory, to be executed in any (current) XSpec implementation. #### Requirements listing Broken out by requirement - corresponding line by line to //req in the Spec document source. - This XSpec is generated by applying the XSLT `lib/build-reqs-xspec.xsl` to the SpecML source document (marked with `req` and `eg` tags). #### File listing