A B C D E F G H I J K L M N O P Q R S T U V W X Y Z _

A

addArc(List) - Method in ExecutionGraph

addIsolate(def) - Method in ExecutionGraph

Appends a new arc of nodes to the graph.

addSuccession(def, def) - Method in ExecutionGraph

ancestorsOf(def) - Method in ExecutionGraph

All ancestors of (nodes eventually leading to) the given node.

arg(def) - Method in Utility

Quotes the given shell argument.

args(List) - Method in Utility

Quotes all given shell arguments.

assertValid(String) - Method in PipelineBuilder.Validator

Validates the given configuration against the schema.

assignLocalName(def) - Method in PipelineRunner

Assigns to the given image a random name that can be used as a reference for other applications in the same pipeline where an ID is not suitable, such as use as a base image in the build of a subsequent stage.

B

bind(String, def) - Method in ExecutionContext.NodeContext

Binds a value to a name in the globals store under the node's namespace.

binding(def, String) - Method in ExecutionContext.NodeContext

Retrieves a value previously bound using bind() under the given ancestor node's namespace and name.

build(def, def) - Method in PipelineBuilder

Builds a single-node Jenkins workflow script for each of the configured pipelines.

build(String, Map, URI, List, String) - Method in PipelineRunner

Builds the given image variant and returns an ID for the resulting image.

build(def, def) - Method in PipelineStage

Builds the configured Blubber variant.

C

closure(def) - Method in PipelineStage

Constructs and returns a closure for this pipeline stage using the given Jenkins workflow script object.

collectAllNested(def, def) - Method in Utility

Similar to collectNested, recursively iterates through the given object's collections and transforms each value by calling the given closure.

commitAndPush(Map) - Method in PipelineRunner

copy(def, def) - Method in PipelineStage

Copy files from the filesystem of a previously run container.

copyFilesFrom(String, String, String, def) - Method in PipelineRunner

Copies files from the filesystem of the given stopped container into the working directory.

D

defaultConfig(Map) - Method in PipelineStage

Returns an config based on the given one but with default values inserted.

deploy(String, String, Map) - Method in PipelineRunner

Deploys the given registered image using the configured Helm chart and returns the name of the release.

deploy(def, def) - Method in PipelineStage

Deploy a published image to a WMF k8s cluster.

deployWithChart(String, String, String, String, def, Map) - Method in PipelineRunner

Deploys the given registered image using the given Helm chart and returns the name of the release.

dive(Map) - Method in ExecutionContext.NodeContext

Creates and returns a new anonymous NodeContext for use in representing child context frames.

E

envs(Map) - Method in Utility

Combines all given environment variables into docker option format

equals(ExecutionGraph) - Method in ExecutionGraph

Whether the given graph is equal to this one.

ExecutionContext - Class in org.wikimedia.integration

Provides execution context and value bindings to graph nodes.

ExecutionContext.AncestorNotFoundException - Class in org.wikimedia.integration

ExecutionContext.InsufficientInputException - Class in org.wikimedia.integration

ExecutionContext.NameAlreadyBoundException - Class in org.wikimedia.integration

ExecutionContext.NameNotFoundException - Class in org.wikimedia.integration

ExecutionContext.NodeContext - Class in org.wikimedia.integration

Provides an execution context for a single given node that can resolve bindings for values stored by ancestor nodes, set its own values, and safely interpolate user-provided strings.

ExecutionContext.NodeContext(def, def, def) - Constructor in ExecutionContext.NodeContext

ExecutionContext(def) - Constructor in ExecutionContext

ExecutionGraph - Class in org.wikimedia.integration

Represents a directed acyclic graph (DAG) for defining pipeline stage dependencies and scheduling them in a parallel topological-sort order.

ExecutionGraph(List) - Constructor in ExecutionGraph

Constructs a directed execution graph using the given sets of edge sequences (arcs).

exports(def, def) - Method in PipelineStage

Binds a number of new values for reference in subsequent stages.

F

formatDashboard() - Method in GerritPipelineComment

formatImage() - Method in GerritPipelineComment

formatMessage() - Method in GerritPipelineComment

Format final message output

formatResult() - Method in GerritPipelineComment

formatTags() - Method in GerritPipelineComment

fromZuul(Map) - Method in PatchSet

Constructs a new PatchSet from the given parameters set by Zuul during CI gating: ZUUL_PROJECT, ZUUL_URL, ZUUL_REF, and ZUUL_COMMIT.

G

generateCredential(Map) - Method in PipelineCredentialManager

Returns a credential class based on credential object

GerritComment - Class in org.wikimedia.integration

Abstract class to represent the contract of a gerrit comment

GerritPipelineComment - Class in org.wikimedia.integration

Gerrit revision that can be used to comment on a gerrit patchset

GerritPipelineComment(Map) - Constructor in GerritPipelineComment

GerritReview - Class in org.wikimedia.integration

Gerrit review that can be used to comment on a gerrit patchset

GerritReview(def, GerritComment) - Constructor in GerritReview

getAll(String) - Method in ExecutionContext.NodeContext

Returns all objects bound to the given name under any node namespace, as well as the node under which it is found.

getAllKeys() - Method in ExecutionContext

Returns the names of all values bound by node contexts.

getAt(String) - Method in ExecutionContext.NodeContext

Operator alias for binding(java.lang.String) or, if a "namespace.key" is given, binding(def, java.lang.String).

getBinding() - Method in JenkinsCredential

Returns a map of the credential bindings

getBinding() - Method in SSHKeyCredential

getBinding() - Method in StringCredential

getBinding() - Method in UsernamePasswordCredential

getBody() - Method in GerritReview

Format gerritcomment as a json message.

getConfigFile(String, boolean) - Method in PipelineRunner

Returns a path under configPath to the given config file.

getDockerEnvVars() - Method in JenkinsCredential

Returns a map of the environment variables in which to store the credential values, for use in the docker run command

getDockerEnvVars() - Method in SSHKeyCredential

getDockerEnvVars() - Method in StringCredential

getDockerEnvVars() - Method in UsernamePasswordCredential

getMessage() - Method in ExecutionContext.AncestorNotFoundException

getMessage() - Method in ExecutionContext.InsufficientInputException

getMessage() - Method in ExecutionContext.NameAlreadyBoundException

getMessage() - Method in ExecutionContext.NameNotFoundException

getMessage() - Method in Lexer.InvalidVariableException

getMessage() - Method in Pipeline.ValidationException

getProject() - Method in GerritReview

URLEncoded ZUUL_PROJECT from the environment.

getRequestURL() - Method in GerritReview

Return a full authorized url for a gerrit revision review.

getRequiredNodeLabels() - Method in Pipeline

Returns a set of node labels that will be required for this pipeline to function correctly.

getRequiredNodeLabels() - Method in PipelineStage

Returns a set of node labels that will be required for this stage to function correctly.

getReviewers(def) - Method in PipelineStage

getSCM(Map) - Method in PatchSet

Returns an SCM mapping that the Jenkins `checkout` function can use to clone the project repo and check out the patch set.

getTempFile(String, boolean) - Method in PipelineRunner

Returns a path under configPath to a temp file with the given base name.

H

hasAllowedFrontend(String) - Method in PipelineRunner

Tests the given config string and returns whether the BuildKit frontend referenced in the syntax line is allowed to be used over ours.

hasServiceUserTag(def) - Method in PipelineStage

I

inDegreeOf(def) - Method in ExecutionGraph

The number of nodes that lead directly to the given one.

interpolate(def) - Method in ExecutionContext.NodeContext

Interpolates the given object by evaluating all list comprehensions and substituting all variable expressions with previously bound values.

inTo(def) - Method in ExecutionGraph

The nodes that lead directly to the given one.

isDirectory(String) - Method in PipelineRunner

Whether the given path is a directory or not.

isolates - Field in ExecutionGraph

Set of graph isolates, nodes that are unconnected from all other nodes.

J

JenkinsCredential - Class in org.wikimedia.integration

A class for a credential

K

kubeCmd(String) - Method in PipelineRunner

Execute a helm command

L

leaves() - Method in ExecutionGraph

Returns all nodes that have no outgoing edges.

Lexer - Class in org.wikimedia.integration

A lexical scanner for processing variable syntax in strings.

Lexer.InvalidVariableException - Class in org.wikimedia.integration

Lexer.Literal - Class in org.wikimedia.integration

Token representing a literal substring within the source string.

Lexer.Literal(String) - Constructor in Lexer.Literal

Lexer.Token - Class in org.wikimedia.integration

Base class from which literal and variable tokens are derived.

Lexer.Variable - Class in org.wikimedia.integration

Token representing a variable within the source string.

M

mapStrings(def, def) - Method in Utility

Iterates recursively over lists and maps in the given object and returns a new object where each member string has been mapped to a new value using the given closure.

merge(Map) - Method in Utility

Merges two or more maps recursively.

mod(def) - Method in ExecutionContext.NodeContext

Operator alias for interpolate().

N

nodes() - Method in ExecutionGraph

All nodes in the graph.

notify(def, def) - Method in PipelineStage

Notifies folks of stage failure according to the stage or pipeline level configuration.

O

ofNode(def) - Method in ExecutionContext

Create and return an execution context for the given node.

or(ExecutionGraph) - Method in ExecutionGraph

Returns a union of this graph and the given one.

outDegreeOf(def) - Method in ExecutionGraph

The number of nodes the given one directly leads to.

outOf(def) - Method in ExecutionGraph

The nodes the given one directly leads to.

P

parseImageRef(String) - Method in Utility

Parses the given OCI image ref into constituent parts: (name, tag, digest).

parseJson(def) - Method in PipelineStage

PatchSet - Class in org.wikimedia.integration

Provides an interface to a patch set being gated by WMF CI.

Pipeline - Class in org.wikimedia.integration

Defines a Jenkins Workflow based on a given configuration.

Pipeline.ValidationException - Class in org.wikimedia.integration

Pipeline(String, Map, Map, List) - Constructor in Pipeline

Constructs a new pipeline with the given name and configuration.

PipelineBuilder - Class in org.wikimedia.integration

PipelineBuilder.Validator - Class in org.wikimedia.integration

Validates user provided configuration against the defined schema using a tool called ajv (Another JSON Validator).

PipelineBuilder(Map, String, List) - Constructor in PipelineBuilder

Constructs a new {@PipelineBuilder} from the given YAML configuration.

PipelineCredentialManager - Class in org.wikimedia.integration

PipelineRunner - Class in org.wikimedia.integration

Provides an interface to common pipeline build/run/deploy functions.

PipelineRunner.RunResult - Class in org.wikimedia.integration

State of a run container returned by run.

PipelineRunner(Map, def) - Constructor in PipelineRunner

Constructor with Jenkins workflow script context and settings.

pipelines(def) - Method in PipelineBuilder

Constructs and returns all pipelines from the given configuration.

PipelineStage - Class in org.wikimedia.integration

PipelineStage(Pipeline, String, Map, def) - Constructor in PipelineStage

plus(ExecutionGraph) - Method in ExecutionGraph

Returns a concatenation of this graph and the given one.

post(def, GerritComment) - Method in GerritReview

Static method to POST GerritComment to a particular change.

progression - Field in ExecutionGraph

Map of graph progression, nodes and their successor (out) nodes.

promote(def, def) - Method in PipelineStage

Promote a published artifact (create a patchset to change the image version in the deployment-charts repo).

publish(def, def) - Method in PipelineStage

Push a built image variant to the WMF Docker registry.

purgeRelease(String) - Method in PipelineRunner

Deletes and purges the given Helm release.

purgeReleases(List) - Method in PipelineRunner

Deletes and purges the given Helm release.

putAt(String, def) - Method in ExecutionContext.NodeContext

Operator alias for bind().

Q

qualifyRegistryPath(String, String) - Method in PipelineRunner

Fully qualifies an image name to a public registry path.

R

randomAlphanum(def) - Method in Utility

Returns a random alpha-numeric string that's length long.

recession - Field in ExecutionGraph

Map of graph recession, nodes and their predecessor (in) nodes.

registerAs(String, String, String) - Method in PipelineRunner

Name and push an image specified by the given image ID to the WMF Docker registry.

removeContainers(List) - Method in PipelineRunner

Removes the given containers, forcefully stopping them if they're still running.

removeImage(String) - Method in PipelineRunner

Removes the given image from the local cache.

removeImages(List) - Method in PipelineRunner

Removes the given images from the local cache.

reportImageToGerrit(def, def) - Method in PipelineRunner

Submits a comment to Gerrit with the build result and links to published images.

roots() - Method in ExecutionGraph

Returns all nodes that have no incoming edges.

run(String, List, Map, List, Integer, Boolean) - Method in PipelineRunner

Runs a container using the image specified by the given ID.

run(def, def) - Method in PipelineStage

Runs the entry point of a built image variant.

runner(def) - Method in Pipeline

Returns a PipelineRunner for this pipeline and the given workflow script object.

S

sanitizeRelativePath(String) - Method in Utility

Forces the given path to be relative and absent any parent directory links (..

scan(String) - Method in Lexer.Variable

Scans the start of the given string for a valid variable expression.

setup(def, def) - Method in PipelineStage

Performs setup steps, checkout out the repo and binding useful values to be used by all other stages (default image labels, project identifier, timestamp, etc).

SSHKeyCredential - Class in org.wikimedia.integration

An SSH key credential

stack() - Method in ExecutionGraph

Returns each concurrent node "frames" of the graph in a topological sort order.

stack() - Method in Pipeline

Returns the pipeline's stage stack bound with an execution context.

StringCredential - Class in org.wikimedia.integration

A text credential

T

teardown(def, def) - Method in PipelineStage

Performs teardown steps, removing images and helm releases, and reporting back to Gerrit.

testRelease(String) - Method in PipelineRunner

Runs end-to-end tests for the given release via `helm test`.

timestampLabel() - Method in Utility

Returns a timestamp suitable for use in image names, tags, etc.

tokenize(String) - Method in Lexer

Lexes the given string for valid syntax and returns a List of Literal and Variable tokens.

toString() - Method in ExecutionGraph

A string representation of the graph compatible with dot.

toString() - Method in Lexer.Token

trigger(def, def) - Method in PipelineStage

Trigger a downstream job on the local Jenkins server

triggerJob(Map) - Method in PipelineRunner

Trigger a downstream job on the local Jenkins server

U

updateChart(def, def, def) - Method in PipelineRunner

updateCharts(List, List) - Method in PipelineRunner

UsernamePasswordCredential - Class in org.wikimedia.integration

A username and password credential

Utility - Class in org.wikimedia.integration

Static functions of global utility plopped into a class.

V

validate() - Method in Pipeline

Validates the pipeline configuration, throwing a ValidationException if anything is amiss.

W

withBlubberConfig(def, Closure) - Method in PipelineRunner

Temporarily overrides the blubberConfig with the given config which can either be a path to a new config file or an object containing valid inline Blubber configuration.

withDocker(Map, Closure) - Method in PipelineRunner

Evaluates the given closure, passing it a docker command that uses the given Docker configuration.

withOutput(String, Integer, Closure) - Method in PipelineRunner

Rewrites the given command with a stdout redirect to `tee` to both capture its output to a file and maintain its output to the console.

withTempDirectory(Closure) - Method in PipelineRunner

Creates a temporary directory, calls the given closure with the directory as an argument, and ensures the directory is removed.

withTempFile(String, Closure) - Method in PipelineRunner

Generates a path to a new temporary file under the pipeline directory, calls the given closure using the new path, and cleans up by deleting the temporary file.

X

Y

Z

_