写点什么

软件测试 | Jenkinsfile 语法

  • 2023-03-05
    北京
  • 本文字数:1420 字

    阅读完需:约 5 分钟

实现 Pipeline 功能的脚本语言叫做 Jenkinsfile,由 Groovy 语言实现。Jenkinsfile 一般是放在项目根目 录,随项目一起受源代码管理软件控制,无需像创建"自由风格\"项目一样,每次可能需要拷贝很多设 置到新项目,提供了一些直接的好处:

  • Pipeline 上的代码审查/迭代

  • Pipeline 的审计跟踪

  • Pipeline 的唯一真实来源,可以由项目的多个成员查看和编辑

Pipeline 支持:Declarative(在 Pipeline 2.5 中引入)和 Scripted Pipeline 两种格式。两者都支持建立 Pipeline,两者都可以用于在 Web UI 中定义一个流水线 Jenkinsfile,将 Jenkinsfile 文件创建并检查到 源代码控制库中通常被认为是最佳做法。

Declared Pipeline

Declared Pipeline 语句树

Declared Pipeline 必须包含在固定格式 Pipeline {} 块内,每个声明语句必须独立一行,行尾无需使用分 号。块( blocks{} )只能包含章节(Sections),指令(Directives),步骤(Steps)或赋值语句。 Declared Pipeline 语句树

块 blocks{}

由大括号括起来的语句,如 Pipeline{},Section{},parameters{},script{}

章节(Sections)

章节中通常包含一个或多个指令或步骤。如 agent 、post、stages、steps

指令(Directives)

environment、options、parameters、triggers(触发)、stage、tools、when

节点(agent)

必须存在,agent 必须在 Pipeline 块内的顶层定义,但 stage 内是否使用使可选的

参数: any/none/label/node/docker/dockerfile

常用选项 label/cuetomWorkspace/reuseNode

示例:

agent { label 'my-label' }agent { node { label 'my-label' customWorkspace '/some/other/path' }}agent { docker { image 'nginx:1.12.2' label 'my-label' args '-v /tmp:/tmp' }}
复制代码

构建后(post)

不是必须,用于 Pipeline 的最外层或者 stage{} 中,主要用于表达 Jenkins 完成构建动作之后需要做的 事情。 示例:

pipeline { agent any stages { stage('Example'){ steps { echo 'Hello world' } } } post { always { echo 'say goodbay' } }}
复制代码

阶段集 (stages)

必须存在,包括顺序执行的一个或多个 stage 命令,在 Pipeline 内仅能使用一次,通常位于 agent/ options 后面。

步骤 steps

必须存在,steps 位于 stage 指令块内部,包括一个或多个 step。仅有一个 step 的情况下可以忽略关键 字 step 及其{}。

环境 environment

不是必须,environment 定义了一组全局的环境变量键值对,存在于 pipeline {} 或者 stage 指令内。执 行特殊方法 credentials()可以获取 Jenkins 中预定义的凭证明文内容。

示例:

environment {CC='clang'}environment {AN_ACCESS_KEY = credentials('my-prefined-secret-text')}steps {sh 'printenv'}
复制代码

选项 options

不是必须,预定义 Pipeline 专有的配置信息,仅可定义一次

示例:

pipeline { agent any options{ timeout(time:1,unit: 'HOURS') }}
复制代码

参数 parameters

不是必须, 定义参数化构建的参数可选参数, 参数类型 booleanParam,choice,file,text, password,run,string 示例:

parameters { string(name: 'PERSON', defaultValue: 'Jenkins', description: '输入的文本参数') choice(name: 'CHOICE', choices: ['One', 'Two', 'Three'], description:'Pick something')}
复制代码

触发器 triggers

不是必须,定义 Pipeline 被自动触发的方式选项 cron、pollSCM、upstream

示例:

triggers { cron('0 8 * * 1-5')}
复制代码

搜索微信公众号:TestingStudio 霍格沃兹的干货都很硬核

用户头像

社区:ceshiren.com 微信:ceshiren2023 2022-08-29 加入

微信公众号:霍格沃兹测试开发 提供性能测试、自动化测试、测试开发等资料、实事更新一线互联网大厂测试岗位内推需求,共享测试行业动态及资讯,更可零距离接触众多业内大佬

评论

发布
暂无评论
软件测试 | Jenkinsfile语法_测试_测吧(北京)科技有限公司_InfoQ写作社区