如何在jenkinsFile中调用jenkins共享库方法

时间:2020-04-21 11:45:52

标签: jenkins-pipeline shared-libraries jenkins-groovy

说明

我正在将我的项目jenkinsfiles转换为共享库,并在groovy中创建可重用的方法。我正在使用Extended_choice_parameter插件在Jenkins中进行参数化构建。我用它来传递值,例如簇,阶段,凭证等给詹金斯工作。 现在,我想使用Jenkins共享库,可以在其中定义带参数的函数,并在带参数的jenkinsfile中调用它们。

问题

虽然在jenkinsFile的“管道”内部使用了参数共享库作为参数,但是却出现了与参数功能使用相关的错误。我已创建此文件 jobParams.groovy

List commonParams() {
     //return list of parameters
     def paramsList = [
        choice(name: 'stage', choices: ['lab', 'dev', 'qa', 'uat', 'prod'], description: 'select stage name' ),
        choice(name: 'playbook',
                choices: [  '',
                            'Linux',
                            'Unix',
                            'CentOS',
                            'Ubuntu',
                            'Debian'
                          ],
                description: 'select the playbook to deploy'
              ),
        credentials(name: 'sshCredentialsId', defaultValue: 'lc_ikep_ansible', credentialType: "Username with password", required: true, description: 'SSH credentials for Ansible' ) ,
        string(name: 'ansibleTags', defaultValue: '', description: 'Type in ansibleTags separated by space, example: "pre-install ikep-acls"'),
        string(name: 'extraVars', defaultValue: '', description: 'Type in extraVars in format: --extra-vars=\'{key1: {key2: \"value2\", key3: \"value3\"}}\''),
        choice(name: 'verboseLogging', choices: ['', '-v', '-vvv', '-vvvv'], description: 'Select ansible verbose logging'),
        booleanParam( name: 'forceDeploy',
                      defaultValue: false,
                      description: 'Activate to force deployment for non-master branches'
                    )
     ]

     return paramsList

}

现在我在jenkinsfile中调用此列表,因为这些参数是在我们单击jenkins中的BUILD之前生成的。 使用以下代码,我可以打印上面LIST中定义的所有参数。但是现在我该如何使用它作为参数在詹金斯中生成构建参数。

/* Pipeline */
def commonParams = jobParams.commonParams()
    String listAsString =  "[\"${commonParams.join('", "')}\"]"
    echo "printing variables ${listAsString}"

请提出建议,因为我在搜索互联网时未找到有效的用例。在jenkins文件中的管道块内部中,我尝试了以下操作,但它给出了错误说明

pipeline {
  agent { label "ansibleDeployments"}
  options { 
    ansiColor('xterm') 
    disableConcurrentBuilds()
    }
  environment {
    ansibleTags = 'all'
    }
  parameters {
    (listAsString)
    }

错误

WorkflowScript: 67: Expected a build parameter definition @ line 67, column 5.
       (listAsString)
       ^

1 个答案:

答案 0 :(得分:0)

似乎您正在传递字符串而不是列表,参数块可能会收到一个列表。

parameters << commonParams

您还可以在https://jenkins.io/doc/pipeline/steps/

中检查每个闭包的定义