zoocha/jira-codeception-extension

此软件包为Codeception提供扩展功能,以便在测试失败时自动创建Jira问题。

v0.0.4 2022-05-12 17:49 UTC

This package is auto-updated.

Last update: 2024-09-12 23:18:22 UTC


README

此软件包为Codeception提供扩展功能,以便在测试失败时自动在Jira中创建问题。

它是如何工作的?

当你运行一个测试并且它失败时,该扩展将通过Jira API连接到你的Jira实例,并创建一个包含在失败时刻由Codeception生成数据的问题。创建的问题数量将根据失败测试的数量而变化,如果有两个测试失败,则将创建两个独立的问题。

问题将包含以下数据

  • 测试名称
  • 失败信息
  • 失败步骤
  • 文件名
  • 堆栈跟踪

配置示例

此扩展在测试失败后创建Jira问题。要使用此扩展,需要一个有效的Jira配置。

  • host: Jira实例。
  • user: 有权在指定项目中创建问题的有效用户。
  • token: 指定用户的有效令牌。API不会接受用户密码,因此需要一个令牌。你可以在用户配置面板中创建令牌,更多详情请参阅Jira官方文档 这里
  • projectKey: 有效的Jira项目键(例如,TA,ZTE,ETC)。
  • issueType: 通常问题会被创建为缺陷,但你也可以将其更改为任务或其他在Jira实例中可用的有效问题类型。
  • debugMode: 如果你正在创建测试或调试测试,可能不希望创建问题(我不推荐这样做),因此将此配置设置为true,则扩展不会在生产环境中创建问题,将其设置回false。
  • singleIssue: 如果你希望只创建一个包含所有失败测试的Jira问题,请将此设置为true,此模式记录的信息较少,它只会记录失败测试、步骤和包含测试的文件。创建单个问题不会污染你的项目板上的多个条目。

配置 'codeception.yml' 示例

extensions:
  enabled:
    - Codeception\Extension\JiraExtension
  config:
    Codeception\Extension\JiraExtension:
      host: https://yourdomain.atlassian.net
      user: email@mail.com
      token: Tg7womaGGFpn9EC16qD3L7T6
      projectKey: JE
      issueType: Bug
      label:
        - autotest_bug
      debugMode: false
      singleIssue: false