docker-runner/dev.ust.zinc.grader.pipeline.docker/StdioTest

StdioTest

class StdioTest(val distro: LangDockerfile, val config: StdioTest.Config, val id: Int, val file: String, val input: StdioTest.InputSrc?, val expected: StdioTest.InputSrc, val visibility: TestCase.Visibility, val hidden: Set<TestCase.HiddenItem>, val args: List<String>?, val score: Double?) : DockerPipelineStage, Reportable

Pipeline stage for grading based on standard input and output.

Effectively executes a file with provided STDIN, and pipes all STDOUT output to a file.

Parameters

distro

Distro image to run the test on.

config

The configuration to instantiate this class.

The ID of the test case.

file

File to execute.

input

File contents to pipe as String into STDIN.

expected

Expected STDOUT result for comparison

visibility

The visibility of this test case.

args

Arguments to pass into the executable.

score

The score of this test case. If null, implies that scoring is disabled for this stage.

Constructors

StdioTest

constructor(distro: LangDockerfile, config: StdioTest.Config, testCase: TestCase)

Secondary constructor for convenience.

constructor(distro: LangDockerfile, config: StdioTest.Config, id: Int, file: String, input: StdioTest.InputSrc?, expected: StdioTest.InputSrc, visibility: TestCase.Visibility, hidden: Set<TestCase.HiddenItem>, args: List<String>?, score: Double?)

Types

Config

data class Config(val testCases: List<TestCase>, val _denyStderr: Boolean?, val diff_ignore_flags: List<Settings.DiffIgnoreFlag>?, val additional_packages: List<String>?, val additional_pip_packages: List<String>?) : ConfigUnit

InputSrc

sealed class InputSrc

Report

data class Report(val file: String, val id: Int, val args: String, val stdin: List<String>?, val stdout: List<String>?, val stderr: List<String>?, val stderrEmpty: Boolean, val denyStderr: Boolean, val exitCode: Int, val expect: List<String>, val visibility: TestCase.Visibility, val diff: List<String>?, val diffStderr: List<String>?, val hasTimedOut: Boolean, val scoreGenerator: ScoreGenerator, val exeExitCode: Int, val diffExitCode: Int) : DockerPipelineStage.ExecutableReport, StageReportUnit.Scorable

Properties

_runner

protected lateinit var _runner: Runner

additionalPackages

private val additionalPackages: List<String>

additionalPipPackages

private val additionalPipPackages: List<String>

allowNetwork

protected open val ~~allowNetwork~~: Boolean

Whether the container is allowed network access.

args

private val args: List<String>?

className

open val className: String

cmdLang

open val cmdLang: CmdLang

Command language used for constructing the command specification.

cmdOutputHandler

open val cmdOutputHandler: CmdOutputHandler

Handler describing how the stage performs necessary IO actions to retrieve stage execution outputs.

cmdSpec

protected open override val cmdSpec: CmdBuilder

Command to execute during the pipeline stage.

config

open override val config: StdioTest.Config

configKeySrc

val configKeySrc: String?

container

var container: DockerContainer?

diff

private val diff: CmdUtils.Var

diffFlags

private val diffFlags: List<Settings.DiffIgnoreFlag>?

distro

protected val distro: BaseDockerfile

Base distro image for this pipeline stage.

docker

protected lateinit var docker: DockerDaemon

Instance to the Docker daemon.

dockerfileSpec

protected open override val dockerfileSpec: DockerfileBuilder.() -> Unit

Additional specifications to add to the Dockerfile.

environmentVars

protected open val environmentVars: List<String>

Environment variables to provide to the runtime environment.

exitCode

val CmdUtils.Var.exitCode: Int

Convenience property for retrieving exitcode of a variable.

expect

private val expect: CmdUtils.Var

expected

private val expected: StdioTest.InputSrc

file

private val file: String

hasDynamicDockerfileSpec

protected open override val hasDynamicDockerfileSpec: Boolean = true

Whether the dockerfileSpec contains directives which are evaluated at pipeline execution time.

hasTimedOut

protected var hasTimedOut: Boolean

hidden

private val hidden: Set<TestCase.HiddenItem>

hostPath

protected var hostPath: Path?

Path to mount to the host system as part of the pipeline, if this stage accepts/emits a HostVolume.

private val id: Int

imageTag

protected val imageTag: String?

Image tag to use for caching pipeline stage images.

input

private val input: StdioTest.InputSrc?

inType

val inType: KClass<out StageResult>

isCacheImage

private val isCacheImage: Boolean = true

Whether to cache this image in the local Docker registry.

logger

protected val logger: Logger

logVolume

var logVolume: DockerVolume?

mntMountMode

protected open val mntMountMode: AccessMode

Mode to mount the mountPath as.

mountPath

protected val mountPath: Path? = null

Path to mount to the host system for supplementary use, if any.

outputLogger

var outputLogger: ContainerExecLogger?

The logger output are stored in logs of outputLogger after stage execution

outType

val outType: KClass<out StageResult>

parserContext

protected var parserContext: ConfigParsable.Context?

pipelinePath

val pipelinePath: String

reportUnit

open override val reportUnit: StdioTest.Report

requestedResources

protected open val requestedResources: EnvContext.RequestedSystemResources

The system resources which control what the container is allowed to access.

result

private val result: CmdUtils.Var

runner

open override val runner: DockerRunner

score

private val score: Double?

scoreGenerator

open override val scoreGenerator: Lazy<StandardScoreGenerators.Single>

scoreUnits

open val scoreUnits: List<ScoreReportUnit>

stderr

val CmdUtils.Var.stderr: List<String>

Convenience property for retrieving stderr content of a variable line-by-line.

stdin

private val stdin: CmdUtils.Var

stdout

val CmdUtils.Var.stdout: List<String>

Convenience property for retrieving stdout content of a variable line-by-line.

traceableState

open override val traceableState: AtomicReference<TraceableState<PipelineStage.ExecStateData, Unit>>

visibility

private val visibility: TestCase.Visibility

volMountMode

protected open val volMountMode: AccessMode

Mode to mount the in-place volume as.

workingDir

protected open override val workingDir: String

Working directory of the container.

Functions

buildCmd

fun buildCmd(configure: CmdBuilder.() -> Unit): CmdBuilder

Builder method for CmdBuilder using the command language cmdLang of the stage.

buildCmdWith

fun buildCmdWith(cmd: CmdBuilder.() -> String): CmdBuilder

Builder method for CmdBuilder using the command language cmdLang of the stage.

configureContainer

protected open fun CreateContainerCmd.configureContainer(input: StageResult): CreateContainerCmd

Configures the container during execution of the pipeline.

contentOrDefault

protected fun <R> CmdUtils.Var.Result<R>.contentOrDefault(default: R): R

Returns the content of this result (stdout, stderr, or exitCode); Otherwise returns a default value generated by default.

execute

protected suspend override fun execute(input: StageResult): StageResult

execWithInput

suspend fun execWithInput(input: StageResult): StageResult

getDockerfile

private suspend fun getDockerfile(): Path

Base Dockerfile for all pipeline stage.

getDockerImage

protected suspend fun getDockerImage(force: Boolean = false): DockerImage

Builds a Docker image based on the Dockerfile specification as defined by this stage, overwriting any previously cached image if exists.

getHostConfig

private suspend fun getHostConfig(inVolume: DockerVolume?): Pair<HostConfig, DockerVolume?>

Determines the host configuration of the container.

installPackages

fun installPackages(additionalPackages: List<String> = emptyList(), vararg packages: String): DockerfileBuilder.() -> Unit

Dockerfile spec for installing packages

logContainerInfo

protected suspend fun logContainerInfo(image: DockerImage, hostConfig: HostConfig)

Logs the information used to create the container for this pipeline stage.

markStageAsTimedOut

protected fun markStageAsTimedOut()

onExecComplete

protected open suspend override fun onExecComplete()

onExecFailed

protected fun onExecFailed(tr: Throwable)

onExecFailedImpl

protected open override fun onExecFailedImpl(tr: Throwable)

onInitParserContext

protected open fun onInitParserContext(configContext: ConfigParsable.Context)

postExecCleanup

protected suspend fun postExecCleanup(startTime: Instant, success: Boolean)

Performs cleanup after the execution of the container.

putParserContext

fun putParserContext(configContext: ConfigParsable.Context)

putRunner

fun putRunner(runner: Runner)

redactMsg

private fun redactMsg(): List<String>?

removeContainer

private suspend fun removeContainer()

Removes the container and temporary log volume created by this pipeline stage.

runContainer

protected open suspend fun runContainer(input: StageResult, hostConfig: HostConfig, outVolume: DockerVolume?): DockerVolume?

Builds the Docker image backing this pipeline stage, and runs the container.

selectSrc

private fun selectSrc(src: StdioTest.InputSrc): String

Depending on the nature of src, builds the corresponding command to read in the src in a shell Var. A InputSrc.Literal is read-in using heredoc, while a InputSrc.Path to a file is cat-ed in.

transformResult

private fun transformResult(outVolume: DockerVolume?): StageResult

Transforms the result of the stage into a StageResult.

Var

fun Var(baseName: String): CmdUtils.Var

Variable builder inheriting the CmdLang of this stage.