docker-virt/dev.ust.zinc.grader.virtualization.docker/DockerfileBuilder

DockerfileBuilder

class DockerfileBuilder : Cloneable

Kotlin DSL representation of a Dockerfile.

TODO(Derppening): Unit test the hell out of this

Constructors

DockerfileBuilder

constructor()

Types

Companion

object Companion

Form

enum Form(val _base: DockerfileBuilder.Form? = null) : Enum<DockerfileBuilder.Form>

Enumeration for accepted argument forms in Dockerfile.

Instruction

private enum Instruction : Enum<DockerfileBuilder.Instruction>

Enumeration of all known instructions as of Docker 19.03.

PortProtocol

enum PortProtocol : Enum<DockerfileBuilder.PortProtocol>

Enumeration of available port protocols.

Properties

_lines

private val _lines: MutableList<String>

lines

val lines: List<String>

Functions

ADD

fun ADD(args: () -> String): DockerfileBuilder

Insert an ADD instruction into the Dockerfile with args as its argument(s).

fun ADD(dest: String, vararg src: String): DockerfileBuilder

fun ADD(form: DockerfileBuilder.Form, dest: String, vararg src: String): DockerfileBuilder

fun ADD(chown: Pair<String, String>, dest: String, vararg src: String): DockerfileBuilder

fun ADD(form: DockerfileBuilder.Form, chown: Pair<String, String>, dest: String, vararg src: String): DockerfileBuilder

Inserts an ADD instruction into the Dockerfile.

addInstruction

private fun addInstruction(instruction: DockerfileBuilder.Instruction, arg: String): DockerfileBuilder

Adds an instruction to the Dockerfile.

ARG

fun ARG(args: () -> String): DockerfileBuilder

Insert an ARG instruction into the Dockerfile with args as its argument(s).

fun ARG(arg: Pair<String, String?>): DockerfileBuilder

Insert an ARG instruction into the Dockerfile.

build

fun build(): Path

Builds this DockerfileBuilder and exports the file to a temporary location.

clone

open override fun clone(): DockerfileBuilder

CMD

fun CMD(args: () -> String): DockerfileBuilder

Inserts a CMD instruction into the Dockerfile with args as its argument(s).

fun CMD(executable: String, vararg param: String): DockerfileBuilder

fun CMD(form: DockerfileBuilder.Form, executable: String, vararg param: String): DockerfileBuilder

Inserts a CMD instruction into the Dockerfile.

COMMENT

fun COMMENT(comment: String): DockerfileBuilder

Adds a comment to the dockerfile.

COPY

fun COPY(args: () -> String): DockerfileBuilder

Insert a COPY instruction into the Dockerfile with args as its argument(s).

fun COPY(dest: String, vararg src: String): DockerfileBuilder

fun COPY(form: DockerfileBuilder.Form, dest: String, vararg src: String): DockerfileBuilder

fun COPY(form: DockerfileBuilder.Form, opts: Map<String, String>, dest: String, vararg src: String): DockerfileBuilder

Inserts a COPY instruction into the Dockerfile.

fun COPY(opts: Map<String, String>, dest: String, vararg src: String): DockerfileBuilder

Inserts an COPY instruction into the Dockerfile.

ENTRYPOINT

fun ENTRYPOINT(args: () -> String): DockerfileBuilder

Insert an ENTRYPOINT instruction into the Dockerfile with args as its argument(s).

fun ENTRYPOINT(executable: String, vararg param: String): DockerfileBuilder

fun ENTRYPOINT(form: DockerfileBuilder.Form, executable: String, vararg param: String): DockerfileBuilder

Insert an ENTRYPOINT instruction into the Dockerfile.

ENV

fun ENV(vararg vars: Pair<String, String>): DockerfileBuilder

fun ENV(key: String, value: String): DockerfileBuilder

Inserts an ENV instruction into the Dockerfile.

fun ENV(args: () -> String): DockerfileBuilder

Inserts an ENV instruction into the Dockerfile with args as its argument(s).

EXPOSE

fun EXPOSE(vararg ports: Pair<Int, DockerfileBuilder.PortProtocol?>): DockerfileBuilder

fun EXPOSE(vararg ports: Int): DockerfileBuilder

Inserts an EXPOSE instruction into the Dockerfile.

fun EXPOSE(args: () -> String): DockerfileBuilder

Inserts an EXPOSE instruction into the Dockerfile with args as its argument(s).

FROM

fun FROM(args: () -> String): DockerfileBuilder

Inserts a FROM instruction into the Dockerfile with args as its argument(s).

fun FROM(image: String, asAlias: String? = null): DockerfileBuilder

Inserts a FROM instruction into the Dockerfile.

HEALTHCHECK

fun HEALTHCHECK(args: () -> String): DockerfileBuilder

Insert a HEALTHCHECK instruction into the Dockerfile with args as its argument(s).

fun HEALTHCHECK(command: String?, options: String? = null): DockerfileBuilder

Insert a HEALTHCHECK instruction into the Dockerfile.

joinAsJson

private fun <T> Array<T>.joinAsJson(transform: (T) -> CharSequence? = { "\"$it\"" }): String

Joins an Array of objects into a JSON String array.

joinAsString

private fun <T> Array<T>.joinAsString(transform: (T) -> CharSequence? = null): String

Joins an Array of objects into a space-delimited single string.

LABEL

fun LABEL(vararg labels: Pair<String, String>): DockerfileBuilder

Inserts a LABEL instruction into the Dockerfile.

fun LABEL(args: () -> String): DockerfileBuilder

Inserts a LABEL instruction into the Dockerfile with args as its argument(s).

ONBUILD

fun ONBUILD(args: () -> String): DockerfileBuilder

Insert an ONBUILD instruction into the Dockerfile with args as its argument(s).

fun ONBUILD(instruction: String): DockerfileBuilder

Insert an ONBUILD instruction into the Dockerfile.

RUN

fun RUN(args: () -> String): DockerfileBuilder

Inserts a RUN instruction into the Dockerfile with args as its argument(s).

fun RUN(executable: String, vararg param: String): DockerfileBuilder

fun RUN(form: DockerfileBuilder.Form, executable: String, vararg param: String): DockerfileBuilder

Inserts a RUN instruction into the Dockerfile.

SHELL

fun SHELL(args: () -> String): DockerfileBuilder

Insert a SHELL instruction into the Dockerfile with args as its argument(s).

fun SHELL(executable: String, vararg parameters: String): DockerfileBuilder

Insert a SHELL instruction into the Dockerfile.

STOPSIGNAL

fun STOPSIGNAL(args: () -> String): DockerfileBuilder

Insert a STOPSIGNAL instruction into the Dockerfile with args as its argument(s).

fun STOPSIGNAL(signalNo: Int): DockerfileBuilder

fun STOPSIGNAL(signalName: String): DockerfileBuilder

Insert a STOPSIGNAL instruction into the Dockerfile.

USER

fun USER(args: () -> String): DockerfileBuilder

Insert a USER instruction into the Dockerfile with args as its argument(s).

fun USER(uid: Int, gid: Int?): DockerfileBuilder

fun USER(user: String, group: String?): DockerfileBuilder

Insert a USER instruction into the Dockerfile.

VOLUME

fun VOLUME(vararg volumes: String): DockerfileBuilder

fun VOLUME(form: DockerfileBuilder.Form, vararg volumes: String): DockerfileBuilder

Insert a VOLUME instruction into the Dockerfile.

fun VOLUME(args: () -> String): DockerfileBuilder

Insert a VOLUME instruction into the Dockerfile with args as its argument(s).

WORKDIR

fun WORKDIR(args: () -> String): DockerfileBuilder

Insert an WORKDIR instruction into the Dockerfile with args as its argument(s).

fun WORKDIR(dir: String): DockerfileBuilder

Insert an WORKDIR instruction into the Dockerfile.