docker-runner/dev.ust.zinc.grader.runner/DockerRunner

DockerRunner

class DockerRunner(stages: Pipeline, context: DockerRunner.Context) : Runner, AutoCloseable, VolumeTrackable<DockerVolume>

Runner to execute a pipeline on docker and generates a ReportT

Default values for constructor creates a trivial DockerRunner just to emit errors in a ReportT

Constructors

DockerRunner

constructor(stages: Pipeline, context: DockerRunner.Context)

Types

Companion

object Companion

Context

class Context(submissionId: String, assignmentConfigId: Long, stageWaitDuration: Duration = Duration.ofMinutes(1), earlyReturnOnThrow: Boolean = false, envContext: DockerContext) : Runner.Context

ExecStateData

data class ExecStateData(val stageIdx: Int, val stagePhase: DockerRunner.ExecStateData.StagePhase) : Runner.ExecStateData

Properties

_closeState

private val _closeState: AtomicReference<CloseableState>

_envLogPath

private var _envLogPath: Path?

_graderLogPath

private var _graderLogPath: Path?

_pipelineErrs

private val _pipelineErrs: MutableList<Runner.PipelineError>

_reportUnits

private val _reportUnits: MutableList<ReportUnit>

asyncBind

private val asyncBind: Deferred<DockerDaemon>

Asynchronous task which binds this runner to a daemon.

asyncUnbind

private val asyncUnbind: Job

Asynchronous task which unbinds this runner from a daemon.

closeState

val closeState: CloseableState

context

val context: Runner.Context

coroutineContext

open override val coroutineContext: CoroutineContext

dockerRequestedResources

val Runner.dockerRequestedResources: DockerContext.RequestedSystemResources

Shortcut for obtaining the DockerContext.RequestedSystemResources of a Runner.

dockerResourceReservation

val Runner.dockerResourceReservation: DockerContext.ResourceReservation

Shortcut for obtaining the DockerContext.ResourceReservation of a Runner.

envLogPath

val envLogPath: Path

execDuration

var execDuration: Duration?

graderLogPath

val graderLogPath: Path

isExecInvoked

private val isExecInvoked: AtomicBoolean

logger

protected val logger: Logger

memoReport

private val memoReport: ReportT

outPaths

private val outPaths: MountedPaths

pipelineErrs

val pipelineErrs: List<Runner.PipelineError>

reportUnits

val reportUnits: List<ReportUnit>

stages

val stages: Pipeline

traceableState

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

volumeTracker

open override val volumeTracker: EnvVolumeTracker<DockerVolume>

Functions

addTrackedVolume

open fun addTrackedVolume(volume: DockerVolume): Boolean

appendToFile

fun appendToFile(relativePath: String, content: String)

override fun close()

closeImpl

protected open override fun closeImpl()

compressFile

fun compressFile(relativePath: String, compressorName: String, keepOriginal: Boolean): Path

createLogDirectories

protected fun createLogDirectories()

decompressFile

fun decompressFile(relativePath: String, keepOriginal: Boolean): Path

execWithInput

suspend fun execWithInput(input: Any): StageResult

execWithInputAsync

private suspend fun execWithInputAsync(input: Any): Deferred<StageResult>

Asynchronous implementation of execWithInput.

execWithInputImpl

protected open suspend override fun execWithInputImpl(input: Any): StageResult

exportConfigError

fun exportConfigError(configErrors: List<ErrorUnit.ConfigErrorUnit>): String?

exportReport

fun exportReport(): ReportT

nonFatalErrors

fun nonFatalErrors(_pipelineErrs: List<Runner.PipelineError>): List<ErrorUnit.PipelineErrorUnit.NonFatalError>

printErrors

fun printErrors(logMethod: (String) -> Unit)

putContextErrors

fun putContextErrors(contextErrors: List<ErrorUnit.ContextErrorUnit>)

putError

fun putError(pipelineError: Runner.PipelineError)

putReportUnit

fun putReportUnit(unit: ReportUnit)

readFromFile

fun readFromFile(relativePath: String): String

readLinesFromFile

fun readLinesFromFile(relativePath: String): List<String>

removeLogDirectories

protected fun removeLogDirectories()

toDebugString

private fun Runner.toDebugString(): String

toDigestString

fun toDigestString(concreteClassName: Boolean): String

writeToFile

fun writeToFile(relativePath: String, content: String)