runner-api/dev.ust.zinc.grader.util/CmdBuilder

CmdBuilder

class CmdBuilder(val cmdLang: CmdLang, val outputHandler: CmdOutputHandler) : CmdLang

Builder that constructs and specifies commands for a pipeline stage to execute, packaged convenient methods for common tasks like reporting command results.

Constructors

CmdBuilder

constructor(cmdLang: CmdLang, outputHandler: CmdOutputHandler)

Types

Cmd

sealed class Cmd(val cmd: String)

Represents a wrapped type around a string command with variants to handle optional interaction with a Var.

Companion

object Companion

Properties

cmd

val cmd: String

Resultant command specification for the entire builder. A property for getting a view of the current set of commands in this CmdBuilder.

cmdLang

private val cmdLang: CmdLang

the language that commands are written in.

core

private val core: MutableList<CmdBuilder.Cmd>

Internal representation of the core commands: commands that are the main intented action in the stage and are not solely for supporting outputting.

coreCmd

val coreCmd: String

Simplified and more readable command specification for the entire builder, omitting all capturing of useful variable results. A property for getting a view of the current set of literal commands in this CmdBuilder.

DEFAULT_EXITCODE

open override val DEFAULT_EXITCODE: Int

Default exitcode of a variable if stage execution timed out.

exiting

private var exiting: CmdBuilder.Cmd?

Internal representation of the exit command of the stage. If it is null, no exiting command will be issued by the builder for the user.

hereDoc

open override val hereDoc: CmdLang.HereDoc

Heredoc with certain delimiters under this CmdLang.

isLoggingFullCmd

var isLoggingFullCmd: Boolean

outputHandler

private val outputHandler: CmdOutputHandler

handler of command outputs under cmdLang.

Functions

add

fun add(v: CmdUtils.Var? = null, cmd: () -> String): CmdBuilder

Primary action that appends a command to the CmdBuilder.

catFile

open override fun catFile(path: String): String

Read-out file into stdout

deref

open override fun deref(variable: String): String

Interpret the variable if it is defined the command line environment by dereferencing.

exitCmd

open override fun exitCmd(exitcode: String): String

Command for exiting with a given exitcode integer or expression.

exitWith

fun exitWith(v: CmdUtils.Var): CmdBuilder

Action that makes the entire command exit according to exit code of a used Var.

fun exitWith(exitCode: Int): CmdBuilder

Action that makes the entire command exit according to exitCode.

expand

open override fun expand(cmd: String): String

Expand and interpret the command expression in the shell, so that it can be used to construct further commands by substituting.

from

open override fun <T> from(result: CmdUtils.Var.Result<T>): String

Command building combinators to pipe contents from previously saved Var.baseName's stdout/stderr.

logFullCmd

fun logFullCmd(): CmdBuilder

Action that enables the logging of expanded full commands instead of just the core command fragments.

makeHeredoc

open override fun makeHeredoc(content: String): String

Command building combinator to make heredocs normally. Usually to be registed into a Var or piped into other commands.

makePipedHeredoc

open override fun makePipedHeredoc(content: String, pipeToCmd: String): String

Command building combinator to make heredocs and then have a command to pipe the heredoc into. Usually to be registed into a Var or piped into other commands.

open override fun print(content: String): String

Command to print content into the console.

rangeTo

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

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

viewCmd

private fun viewCmd(block: MutableList<String>.() -> Unit): String

Helper method for generating a view of the internal representation of the commands.