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

Reporter

open class Reporter(val outPaths: MountedPaths)

Inheritors

Runner

Constructors

Reporter

constructor(outPaths: MountedPaths)

Properties

_reportUnits

private val _reportUnits: MutableList<ReportUnit>

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

reportUnits

val reportUnits: List<ReportUnit>

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

Functions

appendToFile

fun appendToFile(relativePath: String, content: String)

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

compressFile

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

Compresses a file relative to context.outPaths.hostRoot.

decompressFile

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

Decompresses a file relative to context.outPaths.hostRoot.

exportConfigError

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

exportReport

fun exportReport(): ReportT

Returns the generated ReportT

putContextErrors

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

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

writeToFile

fun writeToFile(relativePath: String, content: String)

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