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

JUnit5Compile

class JUnit5Compile(val distro: LangDockerfile.Java, val config: JUnit5Compile.Config) : JavaCompile, Reportable

Pipeline stage which compiles Java source files with the JUnit Platform JAR.

Parameters

distro

Distro image to use for compiling the classes.

config

The configuration to instantiate this class.

Constructors

JUnit5Compile

constructor(distro: LangDockerfile.Java, config: JUnit5Compile.Config)

Types

Config

data class Config(val fileList: List<PathSpec>, val classpath: List<String>?, val flags: List<String>?, val outDir: String?, val junitVersion: String?) : ConfigUnit

Properties

_runner

protected lateinit var _runner: Runner

additionalPackages

private val additionalPackages: List<String>

allowNetwork

protected open val ~~allowNetwork~~: Boolean

Whether the container is allowed network access.

className

open val className: String

classpath

private val classpath: List<String>

classpathOpts

private val classpathOpts: List<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 override val cmdSpec: CmdBuilder

Command to execute during the pipeline stage.

compile

private val compile: CmdUtils.Var

compileDirMode

private val compileDirMode: Boolean

config

override val config: JavaCompile.Config

configKeySrc

val configKeySrc: String?

container

var container: DockerContainer?

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.

fileListStr

private val fileListStr: String

hasDynamicDockerfileSpec

protected override val hasDynamicDockerfileSpec: Boolean

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

hasTimedOut

protected var hasTimedOut: Boolean

hostPath

protected var hostPath: Path?

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

imageTag

protected val imageTag: String?

Image tag to use for caching pipeline stage images.

inType

val inType: KClass<out StageResult>

isCacheImage

private val isCacheImage: Boolean = true

Whether to cache this image in the local Docker registry.

junitInfo

private val junitInfo: JUnit.DockerInfo

logger

protected val logger: Logger

logVolume

var logVolume: DockerVolume?

mappedFileList

private val mappedFileList: List<String>

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.

optionsList

private val optionsList: List<String>

outDir

private val outDir: String

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?

pathList

private val pathList: List<PathSpec>

pipelinePath

val pipelinePath: String

reportUnit

open override val reportUnit: Compile.Report

requestedResources

protected open val requestedResources: EnvContext.RequestedSystemResources

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

runner

open override val runner: DockerRunner

scoreGenerator

open val scoreGenerator: Lazy<ScoreGenerator>?

scoreUnits

open val scoreUnits: List<ScoreReportUnit>

srcList

private val srcList: CmdUtils.Var

stderr

val CmdUtils.Var.stderr: List<String>

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

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>>

volMountMode

protected open val volMountMode: AccessMode

Mode to mount the in-place volume as.

workingDir

protected 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.

buildCompileCmd

fun buildCompileCmd(preCmdSpec: CmdBuilder.() -> Unit = {}, postCmdSpec: CmdBuilder.() -> Unit = {}, compileCmdSpec: CmdBuilder.() -> String): CmdBuilder

Wrapper for building cmdSpec in concrete compile classes that exports compilation command results.

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)

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.

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.