# stage * [build stage](#build-stage) * [show build stages details](#show-build-stages-details) * [get parent stage ID](#get-parent-stage-id) * [get stage build status via parent stage name](#get-stage-build-status-via-parent-stage-name) ## build stage > \[!NOTE|label:references:] > > * [CpsFlowExecution](https://javadoc.jenkins.io/plugin/workflow-cps/org/jenkinsci/plugins/workflow/cps/CpsFlowExecution.html) > > ``` > CpsFlowExecution goes through the following states: > > +----------------------+ > | | > v | > PERSISTED --> PREPARING --> SUSPENDED --> RUNNABLE --> RUNNING --> COMPLETE > ^ > | > INITIAL > ``` > * [Access Stage results in Workflow/ Pipeline plugin](https://stackoverflow.com/a/59854515/2940319) > * [pipeline中任务分段日志获取](https://gingkoleaf.github.io/2019/10/22/jenkins/jenkins-pipeline-stage-log/) > * [GuillaumeSmaha/build-stages-status.groovy](https://gist.github.com/GuillaumeSmaha/fdef2088f7415c60adf95d44073c3c88) > * [Access Stage name during the build in Jenkins pipeline](https://stackoverflow.com/a/45224119/2940319) > * [jenkinsci/plugins/workflow/cps/FlowDurabilityTest.java](https://github.com/jenkinsci/workflow-cps-plugin/blob/master/src/test/java/org/jenkinsci/plugins/workflow/cps/FlowDurabilityTest.java#L273) > * [pipeline-model-definition/src/main/groovy/org/jenkinsci/plugins/pipeline/modeldefinition/Utils.groovy](https://github.com/jenkinsci/pipeline-model-definition-plugin/blob/master/pipeline-model-definition/src/main/groovy/org/jenkinsci/plugins/pipeline/modeldefinition/Utils.groovy) > * [`findStageFlowNodes`](https://github.com/jenkinsci/pipeline-model-definition-plugin/blob/master/pipeline-model-definition/src/main/groovy/org/jenkinsci/plugins/pipeline/modeldefinition/Utils.groovy#L230) > * [`markStageWithTag`](https://github.com/jenkinsci/pipeline-model-definition-plugin/blob/master/pipeline-model-definition/src/main/groovy/org/jenkinsci/plugins/pipeline/modeldefinition/Utils.groovy#L311) > * [How to find the agent that a FlowNode is executing on?](https://groups.google.com/g/jenkinsci-dev/c/PCDHBDZDm90) > * [`FlowGraphWalker` - How to get workspace of jenkins pipeline plugin job (WorkflowRun object java API )](https://stackoverflow.com/a/43999292/2940319) > * [Jenkins API - Get current pipeline stage of the build](https://stackoverflow.com/a/68087806/2940319) ### show build stages details ```groovy import org.jenkinsci.plugins.workflow.job.* import org.jenkinsci.plugins.workflow.flow.* import io.jenkins.blueocean.rest.impl.pipeline.* import org.jenkinsci.plugins.workflow.cps.* import org.jenkinsci.plugins.workflow.graph.FlowNode; final String JOB_NAME = '/marslo/sandbox' final int BUILD_NUMBER = 17 WorkflowRun run = jenkins.model.Jenkins.instance .getItemByFullName( JOB_NAME ) .getBuildByNumber( BUILD_NUMBER ) PipelineNodeGraphVisitor visitor = new PipelineNodeGraphVisitor(run) List flowNodes = visitor.getPipelineNodes() flowNodes.each { println """ ${it.getDisplayName()} : getRun() : ${it.getRun()} getResult : ${it.status.getResult()} getState : ${it.status.getState()} getType : ${it.getType()} getId : ${it.getId()} isActive : ${it.node.active} searchUrl : ${it.node.getSearchUrl()} getUrl : ${jenkins.model.Jenkins.instance.getRootUrl() + it.node.getUrl()} iconColor : ${it.node.getIconColor()} """ // println """ // getError : ${it.node.getError()} // getAction : ${it.node.getActions()} // getDisplayFunctionName : ${it.node.getDisplayFunctionName()} // getTypeDisplayName : ${it.node.getTypeDisplayName()} // getTypeFunctionName : ${it.node.getTypeFunctionName()} // it.node.metaClass.methods.name : ${it.node.metaClass.methods*.name.sort().unique()} // it.getClass() : ${it.getClass()} // """ println " parents : " + it.getParents().collect { p -> [ 'name' : p.displayName, 'status' : p.status.getResult(), 'id' : p.id, 'active' : p.node.active ] }.flatten() println '--------------' } ``` * result ![build-stage-details](/files/6cimEhwgmKA6VgCNJovN) ### get parent stage ID ```groovy import org.jenkinsci.plugins.workflow.job.* import org.jenkinsci.plugins.workflow.flow.* import org.jenkinsci.plugins.workflow.cps.* import org.jenkinsci.plugins.workflow.graph.FlowNode; import io.jenkins.blueocean.rest.impl.pipeline.* import io.jenkins.blueocean.rest.model.* import io.jenkins.blueocean.rest.model.BlueRun.* def withFlowNodes( String name, int buildNumber, Closure body ) { WorkflowRun run = jenkins.model.Jenkins.instance .getItemByFullName( name ) .getBuildByNumber( buildNumber ) PipelineNodeGraphVisitor visitor = new PipelineNodeGraphVisitor( run ) List flowNodes = visitor.getPipelineNodes() body( flowNodes ) } def isStageFinished( String keyword, String job, int buildNumber, String type = 'parallel' ) { withFlowNodes ( job, buildNumber ) { flowNodes -> List parentIds = flowNodes.findAll { it.displayName.startsWith(keyword) && it.getType() == FlowNodeWrapper.NodeType.valueOf( type.toUpperCase() ) }.collectMany { it.parents.collect{ p -> p.id } }.unique() flowNodes.findAll { parentIds.contains( it.id ) }.every { it.status.getState() == BlueRun.BlueRunState.FINISHED } } // withFlowNodes } ``` ### get stage build status via parent stage name ```groovy import org.jenkinsci.plugins.workflow.job.* import org.jenkinsci.plugins.workflow.flow.* import org.jenkinsci.plugins.workflow.cps.* import org.jenkinsci.plugins.workflow.graph.FlowNode; import io.jenkins.blueocean.rest.impl.pipeline.* import io.jenkins.blueocean.rest.model.* import io.jenkins.blueocean.rest.model.BlueRun.* @NonCPS def on( String job, int buildNumber ) { [ isBuilding : { -> isBuilding( job, buildNumber ) } stageStatus : { String keyword, String type = 'parallel', String parentStage = 'Parallel' -> stageStatus ( keyword, job, buildNumber, type, parentStage ) } ] } Boolean isBuilding( String job, int buildNumber ) { jenkins.model.Jenkins.instance .getItemByFullName( job ) .getBuildByNumber( buildNumber ) .isInProgress() } def withFlowNodes( String name, int buildNumber, Closure body ) { WorkflowRun run = jenkins.model.Jenkins.instance .getItemByFullName( name ) .getBuildByNumber( buildNumber ) PipelineNodeGraphVisitor visitor = new PipelineNodeGraphVisitor( run ) List flowNodes = visitor.getPipelineNodes() body( flowNodes ) } def stageStatus( String keyword , String job , int buildNumber , String type = 'parallel' , String parentStage = 'Parallel' ) { if ( ! isBuilding(job, buildNumber) ) { println( "pipeline ${job} #${buildNumber} haven't started yet" ) return false } withFlowNodes ( job, buildNumber ) { flowNodes -> List parentIds = flowNodes.findAll { it.displayName.startsWith(keyword) && it.getType() == FlowNodeWrapper.NodeType.valueOf( type.toUpperCase() ) }.collectMany { it.parents.findAll { p -> p.displayName == parentStage } .collect { p -> p.id } }.unique() return parentIds ? flowNodes.findAll { parentIds.contains( it.id ) }.collect { it.status.getState() } : false } // withFlowNodes } // call on( BUILD_NAME, BUILD_NUMBER ).stageStatus( stageName ) ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://imarslo.gitbook.io/handbook/jenkins/script/stage.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.