jenkins扩展参数插件groovy脚本

Question

该插件的网站说您可以创建一个groovy脚本来运行以确定参数列表.

这怎么解决了？说明书没有说什么.

1. 在什么上下文中运行脚本？
2. 我应该从脚本中返回什么？
3. 什么目录是脚本的cwd？它是环境变量WORKSPACE吗？
4. 有一个额外的字段叫做variable bindings.这是怎么用的？

Answer 1

我不得不深入研究源代码以找到这些问题的答案,所以我希望这有助于其他所有人.

1.脚本在什么上下文中运行？

该脚本在groovy.lang.GroovyShell中运行.该类目前来自Groovy 1.8.5库.这是代码的摘录:

// line 419 - 443 of the ExtendedChoiceParamaterDefinition
else if(!StringUtils.isBlank(groovyScript)) {
    try {
        GroovyShell groovyShell = new GroovyShell();
        setBindings(groovyShell, bindings);
        Object groovyValue = groovyShell.evaluate(groovyScript);
        String processedGroovyValue = processGroovyValue(isDefault, groovyValue);
        return processedGroovyValue;
    }
    catch(Exception e) {

    }
}
else if(!StringUtils.isBlank(groovyScriptFile)) {
    try {
        GroovyShell groovyShell = new GroovyShell();
        setBindings(groovyShell, bindings);
        groovyScript = Util.loadFile(new File(groovyScriptFile));
        Object groovyValue = groovyShell.evaluate(groovyScript);
        String processedGroovyValue = processGroovyValue(isDefault, groovyValue);
        return processedGroovyValue;
    }
    catch(Exception e) {

    }
}

2.我应该从脚本中返回什么？

如上面的代码所示,脚本应返回一个字符串,其中包含您在paramater或String []数组中指定的任何分隔符.这是一个处理脚本返回值的函数片段:

// line 450 - 465 of ExtendedChoiceParameterDefinition
private String processGroovyValue(boolean isDefault, Object groovyValue) {
    String value = null;
    if(groovyValue instanceof String[]) {
        String[] groovyValues = (String[])groovyValue;
        if(!isDefault) {
            value = StringUtils.join((String[])groovyValue, multiSelectDelimiter);
        }
        else if(groovyValues.length > 0) {
            value = groovyValues[0];
        }
    }
    else if(groovyValue instanceof String) {
        value = (String)groovyValue;
    }
    return value;
}

3.脚本的cwd是什么目录？它是环境变量WORKSPACE吗？

有关系吗？您可以使用脚本在脚本中访问环境变量WORKSPACE

Map<String, String> props = System.getenv();
def currentDir = props.get('WORKSPACE');

4.有一个额外的字段称为变量绑定.这是怎么用的？

这是属性文件格式化的key = value文件.这些名称然后可以在groovy脚本中解析.

    e.g.
    key1=foo
    prop2=bar