Skip to content

Commit

Permalink
Updated profile resolution (spec) readme with clarification regarding…
Browse files Browse the repository at this point in the history
… unit testing
  • Loading branch information
wendellpiez committed May 31, 2022
1 parent 507f5cd commit 819367c
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions src/specifications/profile-resolution/readme.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Profile Resolution Specification and Testing

## Providing feedback on this specification

Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 819367c

Please sign in to comment.