jira-codeception-extension

This package provides an extension for Codeception to create issues in Jira automatically when a test fails.

How it works?

When you run a test and it fails the extension will connect with your Jira instance through the Jira API and create an issue containing the data generated by Codeception at the moment of the failure. The number of issues created will vary depending on the number of failed tests, if two tests failed then two separated issues will be created.

The issue will contain the following data:

• Test Name
• Failure Message
• Failed Step
• File Name
• Stack Trace

Configuration Example

This extension creates a Jira issue after a test failure. To use this extension a valid Jira configuration is required.

• host: A Jira instance.
• user: A valid user that has permission to create issues in the specified project.
• token: A valid token for the specified user. The API will not accept the user password so a token is required. You can create a token in the user configuration panel, for more information follow the Jira official documentation here.
• projectKey: A valid Jira project key (e.g. TA, ZTE, ETC).
• issueType: Usually the issue is created as a Bug but you can change it for Task or another valid issue type available in your Jira instance.
• debugMode: In case you are creating tests or debugging tests you may not want to create issues (and I don't recommend it) so setting this config to true the extension will not create issues in production set it back to false.
• singleIssue: Set it to true if you wish to create only one issue in Jira containing all the failed tests, this mode logs less info, it will only log the Failed Test, the Step, and the File which the test is included. Creating a single issue doesn't polute your project board with multiple tickets.

Configuration 'codeception.yml' example:

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