将 MeterSphere 集成到流水线

本教程演示如何将 MeterSphere 集成到流水线。

准备工作

动手实验

步骤 1:在 MeterSphere 上创建 API Keys

  1. 登录 MeterSphere 控制台。访问个人信息下的 API Keys,点击新建来创建 API Keys。

    create-api-keys

  2. API Keys 创建好之后,您可以进行查看。复制 Access Key

    api-key-created

  3. 点击 Secret Key 下的显示并复制 Secret Key。

    click-show

    copy-secret-key

步骤 2:在 Jenkins 上安装 MeterSphere 插件

  1. 登录 Jenkins 控制台,点击 Manage Jenkins。有关如何登录 Jenkins 控制台的更多信息,请参考将 SonarQube 集成到流水线

    click-manage-jenkins

  2. Manage Jenkins 页面,下滑至 Manage Plugins 并点击。

    click-manage-plugins

  3. 访问高级选项卡,下滑至上传插件。点击文件旁边的按钮上传 MeterSphere 插件的 HPI 文件

    choose-file

  4. 上传 HPI 文件之后,点击上传以继续。

    click-upload

  5. 您可以在页面上看到安装状态,请确保选择安装完成后重启 Jenkins(空闲时)。安装成功后,Jenkins 会重启。

    installation-success

  6. 待 Jenkins 完成重启,请登录并再次访问 Manage Jenkins 中的 Manage Plugins。在已安装选项卡,可以看到已安装 MeterSphere 插件。

    installed-tab

    metersphere-in-list

步骤 3:生成流水线代码段

  1. 点击新建Item 创建条目。

    click-new-item

  2. 将条目名称设为 metersphere-test,选择流水线。点击确定继续。

    set-item-info

  3. 在本教程中,直接点击保存使用默认设置。

    click-save

  4. Pipeline metersphere-test 页面,点击流水线语法

    click-pipeline-syntax

  5. 步骤下,选择范例步骤下拉菜单中的 meterSphere: MeterSphere

    select-metersphere

  6. 输入上述步骤中创建的 MeterSphere API Keys 以及 API Endpoint http://NodeIP:NodePort。您可以在下拉菜单中设置其他的值,然后点击生成流水线脚本

    input-values

    备注

    本教程使用 MeterSphere 的 demo-workspace 工作空间和 demo 项目进行演示。您首先需要创建工作空间和项目,并在 MeterSphere 上配置测试用例,否则上图所示的下拉列表里将没有可选的条目。有关如何使用 MeterSphere 的更多信息,请参考 MeterSphere GitHub 网站

  7. 您将看到以下输出:

    snippet-output

步骤 4:创建流水线

  1. project-regular 身份登录 KubeSphere 的 Web 控制台。在 DevOps 工程中,访问流水线,然后点击创建

    create-pipeline

  2. 名称设置为 metersphere-pipeline,点击下一步。在高级设置页面,点击创建使用默认配置。

    set-pipeline-name

    click-create-pipeline

  3. 点击列表中的流水线访问其详情页,然后点击编辑 Jenkinsfile

    click-pilepine-item

    edit-jenkinsfile

  4. 在出现的对话框中,根据之前的步骤中 Jenkins 生成的代码段输入以下流水线代码,然后点击确定

    1. node('base') {
    2. stage('stage-zewwa') {
    3. meterSphere method: 'single',
    4. msAccessKey: 'O4baJHYpybhPizFS',
    5. msEndpoint: 'http://103.61.37.135:31397/',
    6. msSecretKey: 'tIKidlPrpZFJgGl9',
    7. projectId: 'e72714e2-dfc5-4370-a9bc-f17e596caf66',
    8. result: 'jenkins',
    9. testCaseId: '2fc3210b-6c99-4633-9701-1a8941640018',
    10. testPlanId: '',
    11. workspaceId: 'f9dbbadb-0d0c-4d2e-bf6d-0e996d92899d'
    12. }
    13. }

    pipeline-script

    备注

    请确保将以下字段的值更改为您在 Jenkins 控制台上生成的值: msAccessKeymsSecretKeymsEndpointprojectIdtestCaseIdworkspaceId

  5. 点击运行来运行流水线。

    run-pipeline

  6. 稍等片刻,您可以在活动选项卡下看到流水线的状态变为成功。点击该流水线查看其详情。

    pipeline-success

  7. 在详情页,您可以点击右上角的显示日志来查看日志。

    show-logs

    view-logs

  8. 您可以在 MeterSphere 的控制台上查看测试报告,点击测试报告可查看其详情。

    test-report

    test-report-detail