You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
246 lines
5.4 KiB
Markdown
246 lines
5.4 KiB
Markdown
# Exercise Configuration
|
|
|
|
In ReCodEx there are two configurations of exercise High Level Configuration (HiLC) and Low Level Configuration (LoLC). LoLC is used in backend, by workers for instance and should be general enough to create all kinds of worker tasks. On the other hand HiLC should be easy enough to be written or composed by normal application users, preferably in the form of graphical editation. But this configuration always has to be somehow stored, that is where this document comes in handy.
|
|
|
|
HiLC is divided in several parts which takes care of different things. There are ExerciseConfig, Pipelines, Limits and RuntimeConfig. From these components configuration of exercise is composed and on every submit new LoLC is compiled from it.
|
|
|
|
## ExerciseConfig
|
|
|
|
Represents basic exercise configuration which connects all things together. For some reasons there two formats of this configuration, one which is saved in the database and the other one which is sent back to web application. Both formats are described bellow.
|
|
|
|
### Backend Format
|
|
|
|
Stored in yaml.
|
|
|
|
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:
|
|
|
|
```
|
|
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
|
|
|
|
Returned as JSON.
|
|
|
|
Mandatory items are bold, optional italic, description of items follows:
|
|
|
|
* **${implicit list of environments}** - ...
|
|
* **name** - ...
|
|
* **tests** - ...
|
|
* **name** - ...
|
|
* **pipelines** - ...
|
|
* **name** - ...
|
|
* _variables_ - ...
|
|
* **name** - ...
|
|
* **type** - ...
|
|
* **value** - ...
|
|
|
|
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
|
|
|
|
Mandatory items are bold, optional italic, description of items follows:
|
|
|
|
* ...
|
|
|
|
Example:
|
|
|
|
```
|
|
```
|
|
|
|
## Limits
|
|
|
|
Mandatory items are bold, optional italic, description of items follows:
|
|
|
|
* **${box identification}** - ...
|
|
* _wall-time_ - ...
|
|
* _memory_ - ...
|
|
* _parallel_ - ...
|
|
|
|
Example:
|
|
|
|
```
|
|
box-id-1:
|
|
wall-time: 5
|
|
memory: 50
|
|
parallel: 500
|
|
box-id-2:
|
|
wall-time: 6
|
|
memory: 60
|
|
```
|
|
|
|
## RuntimeConfig
|
|
|
|
Mandatory items are bold, optional italic, description of items follows:
|
|
|
|
* ...
|
|
|
|
Example:
|
|
|
|
```
|
|
```
|