🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more
Socket
DemoInstallSign in
Socket

jira-ctrf

Package Overview
Dependencies
Maintainers
0
Versions
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

jira-ctrf

Create Jira issues with test results from popular testing frameworks

0.0.1
latest
Source
npm
Version published
Maintainers
0
Created
Source

Jira Test Results Notification

Send Jira issue with test results from popular testing frameworks

A Jira test reporting tool that supports all major testing frameworks. Generate, publish and alert your team with detailed test results, including summaries, in-depth reports, failed test analyses, flaky test detection directly to your chosen Jira project.

💚

CTRF tooling is open source and free to use

You can support the project with a follow and a star

GitHub stars GitHub followers

Maintained by Matthew Thomas
Contributions are very welcome!
Explore more integrations

Features

  • Create Issue in Jira: Automatically create an issue in Jira.
  • Send Flaky Test Details to Jira: Automatically send flaky test details to a Jira issue.
  • Conditional Notifications: Use the --onFailOnly option to send notifications only if tests fail.

Example view

Setup

You'll need a CTRF report generated by your testing framework. CTRF reporters are available for most testing frameworks and easy to install.

No CTRF reporter? No problem!

Use junit-to-ctrf to convert a JUnit report to CTRF.

Set the Environment Variable

Set the webhook URL as an environment variable in your shell or CI environment:

export JIRA_URL='https://your-domain.atlassian.net'
export JIRA_EMAIL='your-email@example.com'
export JIRA_API_TOKEN='your-jira-api-token'

Make sure to replace 'https://your-domain.atlassian.net' with your actual Jira URL.

You might want to store these as secrets in your CI environment.

Usage

You can use a glob pattern or a single file path to send the test results summary to Jira.

Results

To send the test results summary to Jira:

npx jira-ctrf results /path/to/ctrf-report.json

You can use a glob pattern with multiple files which will be merged together:

npx jira-ctrf results "ctrf/*.json"

Flaky

To send flaky test report to Jira:

npx jira-ctrf flaky /path/to/ctrf-report.json

Send Only on Failures

To send the test results summary to Jira only if there are failed tests, use the --onFailOnly option:

npx jira-ctrf results /path/to/ctrf-file.json --onFailOnly

Custom Notification Title

You can choose a custom title for your notification, use the --title option:

npx jira-ctrf results /path/to/ctrf-file.json --title "Custom Title"

Options

OptionDescriptionDefault
titleCustom title for the Jira issue"Test Results Summary"
prefixText to add before the test results""
suffixText to add after the test results""
onFailOnlyOnly create Jira issues when tests failfalse
projectJira project keyFrom JIRA_PROJECT_KEY env var
issueTypeJira issue type"Bug"
issueTypeIdJira issue type ID (use instead of issueType)undefined
labelsLabels to add to the Jira issue[]
componentsComponents to add to the Jira issue[]
assigneeUsername of the person to assign the Jira issue toundefined
priorityPriority of the Jira issueundefined
debugEnable debug mode to see the payload being sent to Jirafalse

Merge reports

If you use a glob pattern, the reports will be merged automatically.

Otherwise, the ctrf-cli package provides a method to merge multiple ctrf json files into a single file.

After executing your tests, use the following command:

npx ctrf merge <directory>

Replace directory with the path to the directory containing the CTRF reports you want to merge.

Programmatic Usage

You can use the package programmatically to send notifications to Jira. To install the package, run:

npm install jira-ctrf

The package exports the following functions:

  • sendTestResultsToJira
  • sendFlakyResultsToJira
import { sendTestResultsToJira } from 'jira-ctrf';

sendTestResultsToJira(report);

What is CTRF?

CTRF is a universal JSON test report schema that addresses the lack of a standardized format for JSON test reports.

Consistency Across Tools: Different testing tools and frameworks often produce reports in varied formats. CTRF ensures a uniform structure, making it easier to understand and compare reports, regardless of the testing tool used.

Language and Framework Agnostic: It provides a universal reporting schema that works seamlessly with any programming language and testing framework.

Facilitates Better Analysis: With a standardized format, programatically analyzing test outcomes across multiple platforms becomes more straightforward.

Support Us

If you find this project useful, consider giving it a GitHub star ⭐ It means a lot to us.

FAQs

Package last updated on 10 Mar 2025

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts