runner-api/dev.ust.zinc.grader.util.cmdlang/NoOpOutputHandler

NoOpOutputHandler

class NoOpOutputHandler : CmdOutputHandler

A mocking implementation of a command output handler.

This is intended to be used only in mocking tests of a CmdLang in a CmdBuilder that involve trivial output handling. This should not be used when using the CmdLang as a utilities, where CmdLang.outputHandler should be overridden as null, to allow for runtime checks of outputHandler if accidentally used.

Constructors

NoOpOutputHandler

constructor()

Properties

graderLogPath

protected val graderLogPath: Path

Root directory path where arbitrary grader output files from stage execution are stored under as logs.

Functions

collectOutput

open override fun collectOutput(onSuccess: (Path) -> Unit, onFailure: (Path) -> Unit)

IO action to perform after stage execution (under an environment like a container), in order to load stage output files from the file system for reading and further reporting. This method shall put the contents of output files into a readable internal state representing the outputs.

getResultContent

open override fun getResultContent(result: CmdUtils.Var.Result<*>): List<String>

Retrieves the stored content for result after stage execution. This method should utilize the outputs state to derive and return the content.

onAfterCore

open fun onAfterCore(): List<String>

Commands to execute after any core commands.

onAfterCoreIfWithVar

open fun onAfterCoreIfWithVar(): List<String>

Commands to execute after any core commands and onAfterCore commands.

onBeforeCore

open fun onBeforeCore(): List<String>

Commands to execute before any core commands.

rangeTo

open operator fun String.rangeTo(rest: String): String

Command building combinator to concat different parts of the command with proper spacing.

open override fun CmdUtils.Var.register(cmd: String): String

setup

open fun setup()

Setup actions required to take before container execution for this output handler to run successfully. For example: delete all files at mount mount, create directories at mount point.