-
Notifications
You must be signed in to change notification settings - Fork 106
/
benchmarks.schema.json
229 lines (227 loc) · 7.05 KB
/
benchmarks.schema.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "http://microsoft.com/dotnet/crank",
"type": "object",
"title": ".NET Benchmarks Labs JSON Schema",
"definitions": {
"job": {
"type": "object",
"properties": {
"source": {
"type": "object",
"title": "The source of the application.",
"required": [
],
"properties": {
"repository": {
"type": "string",
"title": "The github repository containing the source.",
"default": "",
"examples": [
"https://github.com/dotnet/crank.git"
],
"pattern": "^(.*)$"
},
"branchOrCommit": {
"type": "string",
"title": "The branch or commit hash in the repository.",
"default": "",
"examples": [
"dev",
"my_feature_branch"
],
"pattern": "^(.*)$"
},
"initSubmodules": {
"type": "boolean",
"title": "Whether to init the submodules of the git repository.",
"default": false,
"examples": [
true
]
},
"project": {
"type": "string",
"title": "The filename of the .NET project to build. Relative to the root of the source.",
"default": "",
"examples": [
"src/PipeliningClient/PipeliningClient.csproj"
],
"pattern": "^(.*)$"
},
"dockerFile": {
"type": "string",
"title": "The filename of the docker file to build. Relative to the root of the source.",
"default": "",
"examples": [
"frameworks/Rust/actix/actix-raw.dockerfile"
],
"pattern": "^(.*)$"
},
"dockerImageName": {
"type": "string",
"title": "The name of the docker image to build or load, used to prevent conflicts, and reuse cached images.",
"default": "",
"examples": [
"actix_raw"
],
"pattern": "^(.*)$"
},
"dockerCommand": {
"type": "string",
"title": "\"The 'docker run' command, e.g, \"./startup.sh\"\"",
"default": "",
"examples": [
"./startup.sh"
],
"pattern": "^(.*)$"
},
"dockerLoad": {
"type": "string",
"title": "\"The path of an image to use for 'docker load', e.g, \"./myimage.tar\"\". The argument 'dockerLoad' is required when this option is set.",
"default": "",
"examples": [
"./myimage.tar"
],
"pattern": "^(.*)$"
},
"dockerContextDirectory": {
"type": "string",
"title": "The path to the docker context. If not set, the location of the docker file is used.",
"default": "",
"examples": [
"frameworks/Rust/actix/"
],
"pattern": "^(.*)$"
}
}
},
"readyStateText": {
"type": "string",
"title": "The text in the console that informs the server it has started",
"default": "",
"examples": [
"Starting", "Application started", "Listening to requests"
],
"pattern": "^(.*)$"
},
"sdkVersion": {
"type": "string",
"title": "The .NET SDK version to build and run the project.",
"default": "",
"examples": [
"3.0.100", "Latest", "5.*"
],
"pattern": "^(.*)$"
},
"aspNetCoreVersion": {
"type": "string",
"title": "The ASP.NET version.",
"default": "",
"examples": [
"3.1"
],
"pattern": "^(.*)$"
},
"runtimeVersion": {
"type": "string",
"title": "The .NET runtime version.",
"default": "",
"examples": [
"3.0.100", "Latest", "5.*"
],
"pattern": "^(.*)$"
},
"waitForExit": {
"type": "boolean",
"title": "Whether the application should block. Use 'true' for client applications that should block.",
"default": false,
"examples": [
true
]
},
"timeout": {
"type": "integer",
"title": "The amount of time in seconds the job can run once it has started. Default is infinite.",
"default": "0",
"examples": [
"15"
]
},
"isConsoleApp": {
"type": "boolean",
"title": "Whether the application should be considered as started as soon as the process is launched. Use 'true' for applications that don't display a Ready State.",
"default": false,
"examples": [
true
]
},
"variables": {
"type": "object",
"title": "The default variables available for this job",
"required": [],
"properties": {}
},
"parameters": {
"type": "object",
"title": "The Parameters Schema",
"required": [],
"properties": {}
},
"arguments": {
"type": "string",
"title": "The arguments passed to the application. This property can use Liquid tags",
"default": "",
"examples": [
"--url \"{{serverUri}}{{path}}\" --connections {{connections}} {% if min != 0 %} -m {{ min }} {% endif %} {% if rate != 0 %} -r {{ rate }} {% endif %} {% if interval != 1 %} -i {{ interval }} {% endif %} --warmup {{warmup}} --duration {{duration}} --pipeline {{pipeline}} {{header-sets[preset-headers]}}"
],
"pattern": "^(.*)$"
}
},
"required": []
},
"job_reference": {
"type": "object",
"properties": {
"job": {
"type": "string",
"title": "The name of the job"
}
},
"required": [],
"additionalProperties": { "$ref": "#/definitions/job" }
}
},
"properties": {
"imports": {
"type": "array",
"title": "External files or urls to import",
"items": {
"type": "string"
}
},
"variables": {
"type": "object",
"title": "The global variables",
"required": [],
"properties": {}
},
"jobs": {
"type": "object",
"title": "The Jobs",
"required": [],
"properties": {},
"additionalProperties": { "$ref": "#/definitions/job" }
},
"scenarios": {
"type": "object",
"title": "The Scenarios Schema",
"required": [
],
"properties": {},
"additionalProperties": { "$ref": "#/definitions/job_reference" }
}
},
"minProperties": 1,
"required": []
}