runner-api/dev.ust.zinc.grader.runner/Runner

Runner

abstract class Runner(val stages: Pipeline, val context: Runner.Context) : Reporter, AutoCloseable, CoroutineScope, StateTraceable<Runner.ExecStateData, Unit>

A runner which can be used to execute a pipeline.

Parameters

context

Context stores the required paths for Runner to reach files from both the host and remote

Constructors

Runner

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

Types

Companion

object Companion

Context

open class Context(val submissionId: String, val assignmentConfigId: Long, stageWaitDuration: Duration = Duration.ofMinutes(1), earlyReturnOnThrow: Boolean = false, val envContext: EnvContext) : PartialContext

Context captures paths and naming conventions of the various machines involved in the Runner Such that this could be dynamically crafted and injected to the Runner, independent of the pipeline

ExecStateData

abstract class ExecStateData

The data associated with the execution state used by StateTraceable.

PipelineError

data class PipelineError(val stage: PipelineStage, val tr: Throwable)

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>

closeState

val closeState: CloseableState

The current CloseableState of this runner.

context

val context: Runner.Context

coroutineContext

open override val coroutineContext: CoroutineContext

envLogPath

val envLogPath: Path

The temporary directory relative to the virtualization environment created for file exchange between the grader and the virtualization environment.

execDuration

var execDuration: Duration?

The time taken to run execWithInput, or null if the method has not started or has not terminated.

graderLogPath

val graderLogPath: Path

The temporary directory relative to the grader environment created for file exchange between the grader and the virtualization environment.

isExecInvoked

private val isExecInvoked: AtomicBoolean

logger

protected val logger: Logger

memoReport

private val memoReport: ReportT

Generates and memoizes ReportT from collected _reportUnits This should be a pure operation in that successive generations of the report yields the same result

outPaths

private val outPaths: MountedPaths

pipelineErrs

val pipelineErrs: List<Runner.PipelineError>

List of all PipelineError, in order of appearance.

reportUnits

val reportUnits: List<ReportUnit>

_reportUnits is to be updated across stages of a runner for appending reporting information

stages

val stages: Pipeline

traceableState

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

Functions

appendToFile

fun appendToFile(relativePath: String, content: String)

Appends content to a file relative to context.outPaths.hostRoot for exporting.

override fun close()

closeImpl

@MustBeInvokedByOverriders

protected open fun closeImpl()

Implementation for AutoCloseable.close.

compressFile

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

Compresses a file relative to context.outPaths.hostRoot.

createLogDirectories

protected fun createLogDirectories()

Creates directories for exchanging files between the grader environment and the virtualization environment.

decompressFile

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

Decompresses a file relative to context.outPaths.hostRoot.

execWithInput

suspend fun execWithInput(input: Any): StageResult

Executes the pipeline using the given input as the input to the entire pipeline.

execWithInputImpl

protected abstract suspend fun execWithInputImpl(input: Any): StageResult

Implementation for execWithInput.

exportConfigError

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

exportReport

fun exportReport(): ReportT

Returns the generated ReportT

nonFatalErrors

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

Generates ErrorUnit.PipelineErrorUnit.NonFatalError's based on a _pipelineErrs Intended to be used with pipelineErrs after successful pipeline execution

printErrors

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

putContextErrors

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

putError

fun putError(pipelineError: Runner.PipelineError)

Records an error emitted by a pipeline stage.

putReportUnit

fun putReportUnit(unit: ReportUnit)

Appends ReportUnit of a Reportable to _reportUnits

readFromFile

fun readFromFile(relativePath: String): String

readLinesFromFile

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

readLinesFromFile reads files on reachable from context.outPaths.hostRoot and return the file content as lines for reporting readFromFile does the same as readLinesFromFile but returns a long string

removeLogDirectories

protected fun removeLogDirectories()

Removes the directories created from createLogDirectories.

toDigestString

fun toDigestString(concreteClassName: Boolean = true): String

Returns a string representation of this Runner, simplified to only contain the assignment configuration and submission IDs.

writeToFile

fun writeToFile(relativePath: String, content: String)

writeToFile writes content to a file reachable from context.outPaths.hostRoot for exporting