Skip to content

Commit 68a6f03

Browse files
authored
writing-test-plans: Update manifest with new parameters and descriptions
2 parents c0f8d3c + 6f63024 commit 68a6f03

File tree

2 files changed

+22
-5
lines changed

2 files changed

+22
-5
lines changed

getting-started.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,13 +123,17 @@ Testground tries to load this file from `$TESTGROUND_HOME/.env.toml`, where `$TE
123123

124124
### Changing default daemon bind addresses
125125

126-
You can change the default bind addresses by configuring `daemon.listen` and `client.endpoint`
126+
You can change the default values by configuring `daemon.listen`, `client.endpoint` and `daemon.scheduler`
127127

128128
###### .env.toml
129129
```toml
130130
[daemon]
131131
listen = ":8080"
132132

133+
[daemon.scheduler]
134+
task_timeout_min = 5
135+
task_repo_type = "disk"
136+
133137
[client]
134138
endpoint = "http://localhost:8080"
135139
```

writing-test-plans/test-plan-manifest.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,9 @@ The next few sections are options passed to each builder and runner when they ar
2929
```toml
3030
[builders."docker:go"]
3131
enabled = true
32-
go_version = "1.14"
33-
module_path = "github.com/your/module/name"
34-
exec_pkg = "."
3532

3633
[builders."exec:go"]
3734
enabled = true
38-
module_path = "github.com/your/module/name"
3935

4036
[runners."local:docker"]
4137
enabled = true
@@ -50,11 +46,28 @@ enabled = true
5046
### Test cases
5147

5248
Finally, we have [test cases](../concepts-and-architecture/test-structure.md#test-cases). Test cases are defined in an [array of tables](https://github.com/toml-lang/toml#array-of-tables) which specify the name of the test case, boundaries for the number of instances and the values of any parameters being tested in a particular test case.
49+
If your plan requires an integer param without a default value, the test will fail if you do not provide it.
5350

5451
```toml
5552
[[testcases]]
5653
name= "quickstart"
5754
instances = { min = 1, max = 5, default = 1 }
55+
56+
[testcases.params]
57+
conn_count = { type = "int", desc = "number of TCP sockets to open" default = 5 }
58+
conn_outgoing = { type = "int", desc = "number of outgoing TCP dials", default = 5 }
59+
conn_delay_ms = { type = "int", desc = "random milliseconds jitter before TCP dial", default = 30000 }
60+
concurrent_dials = { type = "int", desc = "max number of concurrent net.Dial calls", default = 10 }
61+
data_size_kb = { type = "int", desc = "size of data to write to each TCP connection", default = 128 }
62+
barrier_iterations = { type = "int", desc = "number of iterations of the barrier test", unit = "iteration", default = 10 }
63+
barrier_test_timeout_secs = { type = "int", desc = "barrier testcase timeout", unit = "seconds", default = 300 }
64+
subtree_iterations = { type = "int", desc = "number of iterations of the subtree test", unit = "iteration", default = 2000 }
65+
subtree_test_timeout_secs = { type = "int", desc = "subtree testcase timeout", unit = "seconds", default = 300 }
66+
expected_version = { type = "string", desc = "expected version" }
67+
expected_implementation = { type = "string", desc = "expected implementation" }
68+
messages = { type = "int", default = 50 }
69+
...
70+
5871
```
5972

6073
### The resulting `manifest.toml` test plan manifest

0 commit comments

Comments
 (0)