structure and examples

master
Martin Polanka 7 years ago
parent 60dc60b87e
commit f962a60b76

@ -10,24 +10,195 @@ Represents basic exercise configuration which connects all things together. For
### Backend Format ### Backend Format
Stored in yaml.
Mandatory items are bold, optional italic, description of items follows: Mandatory items are bold, optional italic, description of items follows:
* ... * **environments** - ...
* **tests** - ...
* **${test identification}** - ...
* **pipelines** - ...
* **${pipeline identification}** - ...
* **variables** - ...
* **${variable identification}** - ...
* **type** - ...
* **value** - ...
* **environments** - ...
* **${environment identification}** - ...
* **pipelines** - ...
* **${pipeline identification}** - ...
* **variables** - ...
* **${variable identification}** - ...
* **type** - ...
* **value** - ...
Example: Example:
``` ```
environments:
- java8
- cpp11
tests:
"Test 1":
pipelines:
"pipeline1":
variables:
varA:
type: string
value: valA
environments:
java8:
pipelines:
"pipelineJava":
variables:
varJava:
type: string
value: valJava
cpp11: []
"Test 2":
pipelines:
"pipeline2":
variables:
varB:
type: file
value: valB
environments:
cpp11:
pipelines:
"pipeline2":
variables:
varCpp:
type: file
value: valCpp
``` ```
### Frontend Format ### Frontend Format
Returned as JSON.
Mandatory items are bold, optional italic, description of items follows: Mandatory items are bold, optional italic, description of items follows:
* ... * **${implicit list of environments}** - ...
* **name** - ...
* **tests** - ...
* **name** - ...
* **pipelines** - ...
* **name** - ...
* _variables_ - ...
* **name** - ...
* **type** - ...
* **value** - ...
Example: Example:
``` ```
[
{
"name":"default",
"tests":[
{
"name":"Test 1",
"pipelines":[
{
"name":"pipeline1",
"variables":[
{
"name":"varA",
"type":"string",
"value":"valA"
}
]
}
]
},
{
"name":"Test 2",
"pipelines":[
{
"name":"pipeline2",
"variables":[
{
"name":"varB",
"type":"file",
"value":"valB"
}
]
}
]
}
]
},
{
"name":"java8",
"tests":[
{
"name":"Test 1",
"pipelines":[
{
"name":"pipelineJava",
"variables":[
{
"name":"varJava",
"type":"string",
"value":"valJava"
}
]
}
]
},
{
"name":"Test 2",
"pipelines":[
{
"name":"pipeline2",
"variables":[
{
"name":"varB",
"type":"file",
"value":"valB"
}
]
}
]
}
]
},
{
"name":"cpp11",
"tests":[
{
"name":"Test 1",
"pipelines":[
{
"name":"pipeline1",
"variables":[
{
"name":"varA",
"type":"string",
"value":"valA"
}
]
}
]
},
{
"name":"Test 2",
"pipelines":[
{
"name":"pipeline2",
"variables":[
{
"name":"varCpp",
"type":"file",
"value":"valCpp"
}
]
}
]
}
]
}
]
``` ```
## Pipeline ## Pipeline
@ -45,11 +216,21 @@ Example:
Mandatory items are bold, optional italic, description of items follows: Mandatory items are bold, optional italic, description of items follows:
* ... * **${box identification}** - ...
* _wall-time_ - ...
* _memory_ - ...
* _parallel_ - ...
Example: Example:
``` ```
box-id-1:
wall-time: 5
memory: 50
parallel: 500
box-id-2:
wall-time: 6
memory: 60
``` ```
## RuntimeConfig ## RuntimeConfig

Loading…
Cancel
Save