mirror of
https://github.com/engineer-man/piston.git
synced 2025-06-07 10:46:27 +02:00
Piston lint
This commit is contained in:
Brikaa
parent
d61fb8ec5b
commit
f2c91acbe6
57 changed files with 1121 additions and 893 deletions
|
|
@ -17,10 +17,10 @@ Returns a list of available languages, including the version, runtime and aliase
|
|||
|
||||
#### Response
|
||||
|
||||
- `[].language`: Name of the language
|
||||
- `[].version`: Version of the runtime
|
||||
- `[].aliases`: List of alternative names that can be used for the language
|
||||
- `[].runtime` (_optional_): Name of the runtime used to run the langage, only provided if alternative runtimes exist for the language
|
||||
- `[].language`: Name of the language
|
||||
- `[].version`: Version of the runtime
|
||||
- `[].aliases`: List of alternative names that can be used for the language
|
||||
- `[].runtime` (_optional_): Name of the runtime used to run the langage, only provided if alternative runtimes exist for the language
|
||||
|
||||
#### Example
|
||||
|
||||
|
|
@ -55,34 +55,34 @@ Runs the given code, using the given runtime and arguments, returning the result
|
|||
|
||||
#### Request
|
||||
|
||||
- `language`: Name or alias of a language listed in [runtimes](#runtimes)
|
||||
- `version`: SemVer version selector of a language listed in [runtimes](#runtimes)
|
||||
- `files`: An array of files which should be uploaded into the job context
|
||||
- `files[].name` (_optional_): Name of file to be written, if none a random name is picked
|
||||
- `files[].content`: Content of file to be written
|
||||
- `stdin` (_optional_): Text to pass into stdin of the program. Defaults to blank string.
|
||||
- `args` (_optional_): Arguments to pass to the program. Defaults to none
|
||||
- `run_timeout` (_optional_): The maximum allowed time in milliseconds for the compile stage to finish before bailing out. Must be a number, less than or equal to the configured maximum timeout.
|
||||
- `compile_timeout` (_optional_): The maximum allowed time in milliseconds for the run stage to finish before bailing out. Must be a number, less than or equal to the configured maximum timeout. Defaults to maximum.
|
||||
- `compile_memory_limit` (_optional_): The maximum amount of memory the compile stage is allowed to use in bytes. Must be a number, less than or equal to the configured maximum. Defaults to maximum, or `-1` (no limit) if none is configured.
|
||||
- `run_memory_limit` (_optional_): The maximum amount of memory the run stage is allowed to use in bytes. Must be a number, less than or equal to the configured maximum. Defaults to maximum, or `-1` (no limit) if none is configured.
|
||||
- `language`: Name or alias of a language listed in [runtimes](#runtimes)
|
||||
- `version`: SemVer version selector of a language listed in [runtimes](#runtimes)
|
||||
- `files`: An array of files which should be uploaded into the job context
|
||||
- `files[].name` (_optional_): Name of file to be written, if none a random name is picked
|
||||
- `files[].content`: Content of file to be written
|
||||
- `stdin` (_optional_): Text to pass into stdin of the program. Defaults to blank string.
|
||||
- `args` (_optional_): Arguments to pass to the program. Defaults to none
|
||||
- `run_timeout` (_optional_): The maximum allowed time in milliseconds for the compile stage to finish before bailing out. Must be a number, less than or equal to the configured maximum timeout.
|
||||
- `compile_timeout` (_optional_): The maximum allowed time in milliseconds for the run stage to finish before bailing out. Must be a number, less than or equal to the configured maximum timeout. Defaults to maximum.
|
||||
- `compile_memory_limit` (_optional_): The maximum amount of memory the compile stage is allowed to use in bytes. Must be a number, less than or equal to the configured maximum. Defaults to maximum, or `-1` (no limit) if none is configured.
|
||||
- `run_memory_limit` (_optional_): The maximum amount of memory the run stage is allowed to use in bytes. Must be a number, less than or equal to the configured maximum. Defaults to maximum, or `-1` (no limit) if none is configured.
|
||||
|
||||
#### Response
|
||||
|
||||
- `language`: Name (not alias) of the runtime used
|
||||
- `version`: Version of the used runtime
|
||||
- `run`: Results from the run stage
|
||||
- `run.stdout`: stdout from run stage process
|
||||
- `run.stderr`: stderr from run stage process
|
||||
- `run.output`: stdout and stderr combined in order of data from run stage process
|
||||
- `run.code`: Exit code from run process, or null if signal is not null
|
||||
- `run.signal`: Signal from run process, or null if code is not null
|
||||
- `compile` (_optional_): Results from the compile stage, only provided if the runtime has a compile stage
|
||||
- `compile.stdout`: stdout from compile stage process
|
||||
- `compile.stderr`: stderr from compile stage process
|
||||
- `compile.output`: stdout and stderr combined in order of data from compile stage process
|
||||
- `compile.code`: Exit code from compile process, or null if signal is not null
|
||||
- `compile.signal`: Signal from compile process, or null if code is not null
|
||||
- `language`: Name (not alias) of the runtime used
|
||||
- `version`: Version of the used runtime
|
||||
- `run`: Results from the run stage
|
||||
- `run.stdout`: stdout from run stage process
|
||||
- `run.stderr`: stderr from run stage process
|
||||
- `run.output`: stdout and stderr combined in order of data from run stage process
|
||||
- `run.code`: Exit code from run process, or null if signal is not null
|
||||
- `run.signal`: Signal from run process, or null if code is not null
|
||||
- `compile` (_optional_): Results from the compile stage, only provided if the runtime has a compile stage
|
||||
- `compile.stdout`: stdout from compile stage process
|
||||
- `compile.stderr`: stderr from compile stage process
|
||||
- `compile.output`: stdout and stderr combined in order of data from compile stage process
|
||||
- `compile.code`: Exit code from compile process, or null if signal is not null
|
||||
- `compile.signal`: Signal from compile process, or null if code is not null
|
||||
|
||||
#### Example
|
||||
|
||||
|
|
@ -133,9 +133,9 @@ Returns a list of all possible packages, and whether their installation status.
|
|||
|
||||
#### Response
|
||||
|
||||
- `[].language`: Name of the contained runtime
|
||||
- `[].language_version`: Version of the contained runtime
|
||||
- `[].installed`: Status on the package being installed
|
||||
- `[].language`: Name of the contained runtime
|
||||
- `[].language_version`: Version of the contained runtime
|
||||
- `[].installed`: Status on the package being installed
|
||||
|
||||
#### Example
|
||||
|
||||
|
|
@ -167,13 +167,13 @@ Install the given package.
|
|||
|
||||
#### Request
|
||||
|
||||
- `language`: Name of package from [package list](#get-apiv2packages)
|
||||
- `version`: SemVer version selector for package from [package list](#get-apiv2packages)
|
||||
- `language`: Name of package from [package list](#get-apiv2packages)
|
||||
- `version`: SemVer version selector for package from [package list](#get-apiv2packages)
|
||||
|
||||
#### Response
|
||||
|
||||
- `language`: Name of package installed
|
||||
- `version`: Version of package installed
|
||||
- `language`: Name of package installed
|
||||
- `version`: Version of package installed
|
||||
|
||||
#### Example
|
||||
|
||||
|
|
@ -203,13 +203,13 @@ Uninstall the given package.
|
|||
|
||||
#### Request
|
||||
|
||||
- `language`: Name of package from [package list](#get-apiv2packages)
|
||||
- `version`: SemVer version selector for package from [package list](#get-apiv2packages)
|
||||
- `language`: Name of package from [package list](#get-apiv2packages)
|
||||
- `version`: SemVer version selector for package from [package list](#get-apiv2packages)
|
||||
|
||||
#### Response
|
||||
|
||||
- `language`: Name of package uninstalled
|
||||
- `version`: Version of package uninstalled
|
||||
- `language`: Name of package uninstalled
|
||||
- `version`: Version of package uninstalled
|
||||
|
||||
#### Example
|
||||
|
||||
|
|
|
|||
|
|
@ -50,15 +50,15 @@ Absolute path to piston related data, including packages and job contexts.
|
|||
|
||||
```yaml
|
||||
key:
|
||||
- PISTON_RUNNER_UID_MIN
|
||||
- PISTON_RUNNER_UID_MAX
|
||||
- PISTON_RUNNER_GID_MIN
|
||||
- PISTON_RUNNER_GID_MAX
|
||||
- PISTON_RUNNER_UID_MIN
|
||||
- PISTON_RUNNER_UID_MAX
|
||||
- PISTON_RUNNER_GID_MIN
|
||||
- PISTON_RUNNER_GID_MAX
|
||||
default:
|
||||
- 1001
|
||||
- 1500
|
||||
- 1001
|
||||
- 1500
|
||||
- 1001
|
||||
- 1500
|
||||
- 1001
|
||||
- 1500
|
||||
```
|
||||
|
||||
UID and GID ranges to use when executing jobs.
|
||||
|
|
@ -124,6 +124,7 @@ Maximum size for a singular file written to disk.
|
|||
Resists against large file writes to exhaust disk space.
|
||||
|
||||
## Compile/Run timeouts
|
||||
|
||||
```yaml
|
||||
key:
|
||||
- PISTON_COMPILE_TIMEOUT
|
||||
|
|
@ -133,6 +134,7 @@ key:
|
|||
- PISTON_RUN_TIMEOUT
|
||||
default: 3000
|
||||
```
|
||||
|
||||
The maximum time that is allowed to be taken by a stage in milliseconds.
|
||||
Use -1 for unlimited time.
|
||||
|
||||
|
|
@ -140,8 +142,8 @@ Use -1 for unlimited time.
|
|||
|
||||
```yaml
|
||||
key:
|
||||
- PISTON_COMPILE_MEMORY_LIMIT
|
||||
- PISTON_RUN_MEMORY_LIMIT
|
||||
- PISTON_COMPILE_MEMORY_LIMIT
|
||||
- PISTON_RUN_MEMORY_LIMIT
|
||||
default: -1
|
||||
```
|
||||
|
||||
|
|
@ -177,7 +179,9 @@ default: {}
|
|||
|
||||
Per-language overrides/exceptions for the each of `max_process_count`, `max_open_files`, `max_file_size`,
|
||||
`compile_memory_limit`, `run_memory_limit`, `compile_timeout`, `run_timeout`, `output_max_size`. Defined as follows:
|
||||
|
||||
```
|
||||
PISTON_LIMIT_OVERRIDES={"c++":{"max_process_count":128}}
|
||||
```
|
||||
|
||||
This will give `c++` a max_process_count of 128 regardless of the configuration.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue