Skip to content

Commit

Permalink
Add scenarios to example and describe purpose (#1683)
Browse files Browse the repository at this point in the history
  • Loading branch information
wolf99 authored Oct 13, 2020
1 parent 5c7d015 commit 126568d
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,7 @@ The file format is described in [canonical-schema.json](./canonical-schema.json)
"word" : "28948022309329048855892746252171976962977213799489202546401021394546514198529"
}
, "expected" : null
, "scenarios" : [ "big-integers" ]
}
, { "uuid" : "c7b6f24a-553f-475a-8a40-dba854fe1bff"
, "description": "Bar'ing a name with numbers gives an error"
Expand All @@ -133,6 +134,8 @@ The file format is described in [canonical-schema.json](./canonical-schema.json)

## Scenarios

An optional field to allow for selectively including/excluding test cases based on a property of the test case (such as using big integers).

- The `scenarios` field can use one or more of a predefined set of values, which are defined in a [`SCENARIOS.txt`](./SCENARIOS.txt) file.
- The `scenarios` field can be mutated additively, by adding new scenarios. Existing scenarios must not be changed or removed. Adding new scenarios does therefore does not mean adding a new test case.
- Library tests should have a `library-test` scenario added to allow for easy including/excluding of library tests. Application tests won't have their own scenario, as they must be included and should not be filtered on.
Expand Down

0 comments on commit 126568d

Please sign in to comment.