Skip to content

Commit b14029b

Browse files
authored
[Documentation:Autograding] add missing config.json fields (#629)
1 parent 21ea2a7 commit b14029b

File tree

1 file changed

+86
-1
lines changed

1 file changed

+86
-1
lines changed

Diff for: _docs/instructor/autograding/specification.md

+86-1
Original file line numberDiff line numberDiff line change
@@ -79,9 +79,67 @@ executables.
7979
These resources can be for the overall assignment configuration, or
8080
per test case.
8181

82+
* **field:** ``"required_capabilities"``
83+
**type:** _string_
84+
**default value:** ``"default"``
8285

86+
_Helps define what machine this gradeable should run on. Each machine has a certain set of capabilities, so defining this properly will improve grading speed and reduce errors._
8387

88+
* **field:** ``"autograding_method"``
89+
**type:** _string_
90+
**default value:** ``"jailed_sandbox"``
8491

92+
_Defines how Submitty will grade this gradeable. Most commonly changed to ``"docker"`` for grading through Docker._
93+
94+
95+
* **field:** ``"container options"``
96+
**type:** _string_
97+
**default value:** ``"jailed_sandbox"``
98+
99+
_Defines how Submitty will grade this gradeable. Most commonly changed to ``"docker"`` for grading through Docker._
100+
101+
* **field:** ``"autograding"``
102+
**type:** _associative array / mapping from string to array_
103+
104+
_These fields define how files are moved through the autograding process._
105+
106+
* **field:** ``"compilation_to_runner"``
107+
**type:** _array of strings_
108+
109+
* **field:** ``"compilation_to_validation"``
110+
**type:** _array of strings_
111+
112+
* **field:** ``"submission_to_compilation"``
113+
**type:** _array of strings_
114+
115+
* **field:** ``"submission_to_runner"``
116+
**type:** _array of strings_
117+
118+
* **field:** ``"submission_to_validation"``
119+
**type:** _array of strings_
120+
121+
* **field:** ``"work_to_details"``
122+
**type:** _array of strings_
123+
124+
* **field:** ``"use_checkout_subdirectory"``
125+
**type:** _string_
126+
127+
* **field:** ``"container_options"``
128+
**type:** _associative array / mapping from string to object_
129+
130+
* **field:** ``"container_image"``
131+
**type:** _string_
132+
133+
_Set this field when using Docker grading to specify which image you would like to use for all testcases by default._
134+
135+
* **field:** ``"number_of_ports"``
136+
**type:** _integer_
137+
138+
* **field:** ``"single_port_per_container"``
139+
**type:** _boolean_
140+
141+
* **field:** ``"use_router"``
142+
**type:** _boolean_
85143

86144
* **field:** ``"allow_system_calls"``
87145
**type:** _array of strings_
@@ -157,11 +215,38 @@ executables.
157215
be executed during either the compilation or execution phases of
158216
automated grading._
159217

218+
* **field:** ``"containers"``
219+
**type:** _array of objects_
220+
**REQUIRED** for ``"compilation"`` and ``"execution"`` testcases
221+
if not using ``"command"``
222+
223+
_Specifies Docker containers for this testcase and what will be run in each of them. Each container is specified by an object with no key that contains the following fields._
224+
225+
* **field:** ``"commands"``
226+
**type:** _string_ -or- _array of strings_
227+
228+
* **field:** ``"container_name"``
229+
**type:** _string_
230+
231+
* **field:** ``"container_image"``
232+
**type:** _string_
233+
234+
_Set this field when using Docker grading to specify which image you would like to use for a single test case._
235+
236+
* **field:** ``"number_of_ports"``
237+
**type:** _integer_
238+
239+
* **field:** ``"outgoing_connections"``
240+
**type:** _array_
241+
242+
* **field:** ``"server"``
243+
**type:** _boolean_
244+
160245

161246
* **field:** ``"resource_limits"``
162247
**type:** _associative array / mapping from string to integer_
163248

164-
_NOTE: See details for assignment level description above.
249+
_NOTE: See details for assignment level description above._
165250

166251

167252
* **field:** ``"validation"``

0 commit comments

Comments
 (0)