Skip to content

Update canonical-schema.json with "timeout" property #1882

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Update canonical-schema.json with "timeout" property #1882

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4bec8d3
Update canonical-schema.json
martinfreedman Nov 8, 2021
06ffc90
Update canonical-schema.json
martinfreedman Nov 8, 2021
d48e735
Update README.md
martinfreedman Nov 9, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 63 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,69 @@ The file format is described in [canonical-schema.json](./canonical-schema.json)
]
}
```
### Test Data Format for Tests with Timeout constraints

This example shows the possible use of the optional timeout constraint for a test, not all tests need a timeout and the timeout can vary from test to test:
```json
{
"exercise": "alphametics",
"cases": [
{
"uuid": "e0c08b07-9028-4d5f-91e1-d178fead8e1a",
"description": "puzzle with three letters",
"property": "solve",
"input": {
"puzzle": "I + BB == ILL"
},
"expected": {
"I": 1,
"B": 9,
"L": 0
}
},
{
"uuid": "12125a75-7284-4f9a-a5fa-191471e0d44f",
"description": "puzzle with eight letters",
"property": "solve",
"input": {
"puzzle": "SEND + MORE == MONEY"
},
"expected": {
"S": 9,
"E": 5,
"N": 6,
"D": 7,
"M": 1,
"O": 0,
"R": 8,
"Y": 2
},
"timeout": 2000
},
{
"uuid": "fb05955f-38dc-477a-a0b6-5ef78969fffa",
"description": "puzzle with ten letters",
"property": "solve",
"input": {
"puzzle": "AND + A + STRONG + OFFENSE + AS + A + GOOD == DEFENSE"
},
"expected": {
"A": 5,
"D": 3,
"E": 4,
"F": 7,
"G": 8,
"N": 0,
"O": 2,
"R": 1,
"S": 6,
"T": 9
},
"timeout": 5000
}
]
}
```

## Scenarios

Expand Down
6 changes: 6 additions & 0 deletions canonical-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@
, "property" : { "$ref": "#/definitions/property" }
, "input" : { "$ref": "#/definitions/input" }
, "expected" : { "$ref": "#/definitions/expected" }
, "timeout" : { "$ref": "#/definitions/timeout" }
}
, "additionalProperties": false
},
Expand Down Expand Up @@ -156,6 +157,11 @@
}
},

"timeout":
{ "description": "Test timeout in milliseconds"
, "type" : "integer"
},

"error":
{ "description": "A message describing an error condition"
, "type" : "string"
Expand Down