Skip to content

Commit

Permalink
More docs adjustments
Browse files Browse the repository at this point in the history
  • Loading branch information
wendellpiez committed Feb 16, 2024
1 parent ad14635 commit dd65ac0
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 18 deletions.
20 changes: 5 additions & 15 deletions src/schema-gen/InspectorXSLT/TESTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,26 +19,16 @@ Find resources for testing the XSLT Inspector and its production in the [testing

Documented in the Makefile -

For example
Use

```
> make test
> make help
```

Runs all tests using provided scripting.
to see the available make targets, supporting smoke testing, unit testing of XSLT production and others.

Don't commit unless this passes.

```
> make smoke-test
```

Runs only the 'smoke tests' (end to end production pipeline testing - are viable artifacts produced irrespective of their functionality or correctness)

Available:
- `smoke-test` - builds an XSLT from the `computer_metaschema.xml` test example, and attempts to execute the resulting XSLT over stub input. A failure indicates a problem in the production pipeline - it is either broken or wrong
- `spec-test` - runs specification tests - does the produced XSLT behave as expected when used on the possible range of (XML) inputs? this is a validator: does it validate?
- `unit-test` - runs transformation template- and function-level unit tests regulating the mapping between source (Metaschema) and target (XSLT) expressions.
Some utilities described on this page are also available using scripts, which will function in place despite not being accessible via `make`.
expressions.

Note this is work in progress and may change over time especially as we bring more tests in.

Expand Down
5 changes: 2 additions & 3 deletions src/schema-gen/InspectorXSLT/testing/planning.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,8 @@

## Testing

- [ ] [Run CI/CD on forks?]( https://github.com/marketplace/actions/publish-test-results#support-fork-repositories-and-dependabot-branches)
- [ ] If not, then find a graceful way to error on failures, in forks
- [x] Refactor testing in this directory
- [x] Run CI/CD on forks?
- [x] Refactor testing in this directory
- [x] smoke-test: is a functional XSLT produced from a valid Metaschema
- [x] unit-test:
- current production tests (build out a little)
Expand Down
6 changes: 6 additions & 0 deletions src/schema-gen/InspectorXSLT/testing/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

See the [TESTING](../TESTING.md) docs for Inspector XSLT for explanation of how to test the application using these resources.

*Plus* - to see quickly what utilities for testing and development are supported using `make`, open a command line interface to the [InspectorXSLT directory[(..) and use

```
> make help
```

## Apologies to the XML-averse (for now)

Keep in mind when considering testing that Inspector XSLT currently only supports XML-based formats defined by a metaschema. Your JSON can be inspected only if you convert it to XML first - a conversion that is dependable only if the data was already valid to begin with.
Expand Down

0 comments on commit dd65ac0

Please sign in to comment.