代码之家 › 专栏 › 技术社区 › Florian Castellane raidsan

jenkins管道:构建步骤的返回值

jenkins-pipeline groovy jenkins

Florian Castellane raidsan · 技术社区 · 6 年前

在jenkins的集成管道中,我使用 the build step ,如下所示:

stage('trigger all builds')
{
  parallel
  {
    stage('componentA')
    {
      steps
      {
        script 
        {
          def myjob=build job: 'componentA', propagate: true, wait: true
        }
      }
    }
    stage('componentB')
    {
      steps 
      {
        script
        {
          def myjob=build job: 'componentB', propagate: true, wait: true
        }
      }
    }
  }
}

我想访问 build 步骤,以便我可以在groovy脚本中知道触发了什么作业名、编号。

我在示例中发现,返回的对象具有如下getter getProjectName() 或 getNumber() 我可以用来做这个。

但是,我如何知道返回对象的确切类以及可以对其调用的方法列表?这个好像是 Pipeline documentation 是的。我特别要求这种情况,但一般来说,我如何知道返回对象的类及其文档?

1 回复 | 直到 6 年前

mkobit 6 年前

step文档是基于一些与插件捆绑在一起的文件生成的,这些文件有时是不够的。一个简单的方法就是打印出 class 通过调用 getClass 以下内容:

def myjob=build job: 'componentB', propagate: true, wait: true
echo "${myjob.getClass()}"

这个输出将告诉您结果(在本例中)是 org.jenkinsci.plugins.workflow.support.steps.build.RunWrapper 它有 published Javadoc 是的。

对于其他情况,我通常必须深入研究jenkins源代码。以下是我的总体策略:

找出这个步骤是从哪个插件来的, jenkins.io steps reference ,或者只是在网上搜索
从 plugin site ,转到 source code repository
搜索步骤名称的字符串文本,并找到返回该字符串的步骤类型。在这种情况下,它看起来来自 the BuildTriggerStep class, which extends AbstractStepImpl
```
@Override
public String getFunctionName() {
    return "build";
}
```

看看 the nested DescriptorImpl to see what execution class is returned

public DescriptorImpl() {
    super(BuildTriggerStepExecution.class);
}

去 BuildTriggerStepExecution and look at the execution body in the start() method
翻阅 workflow step README 表明有东西应该调用 context.onSuccess(value) 返回结果。在这个文件中有一个位置,但那只在“不等待”情况下,它总是立即返回,并且 null ( source )中。
```
if (step.getWait()) {
    return false;
} else {
    getContext().onSuccess(null);
    return true;
}
```

好的,所以它不会在步骤执行中完成,所以它必须是somwhere-else。我们还可以在存储库中搜索 onSuccess 看看这个插件还能触发什么。 We find that a RunListener implementation handles setting the result asynchronously for the step execution if it has been configured that way:

for (BuildTriggerAction.Trigger trigger : BuildTriggerAction.triggersFor(run)) {
    LOGGER.log(Level.FINE, "completing {0} for {1}", new Object[] {run, trigger.context});
    if (!trigger.propagate || run.getResult() == Result.SUCCESS) {
        if (trigger.interruption == null) {
            trigger.context.onSuccess(new RunWrapper(run, false));
        } else {
            trigger.context.onFailure(trigger.interruption);
        }
    } else {
        trigger.context.onFailure(new AbortException(run.getFullDisplayName() + " completed with status " + run.getResult() + " (propagate: false to ignore)"));
    }
}
run.getActions().removeAll(run.getActions(BuildTriggerAction.class));

这个 trigger.context.onSuccess(new RunWrapper(run, false)); 在那里 RunWrapper 结果来自