Extensions Reference

Extensions enhance TestBeats' capability to provide richer and more contextualized information in your notification targets. They add additional data, formatting, and functionality to your test reports.

For extension concepts, syntax, and how they attach to targets, see Introduction.

Available Extensions

• CI Info - Display CI/CD pipeline information
• Hyperlinks - Add clickable links to reports
• Mentions - Mention team members and groups
• Metadata - Include custom metadata and context
• Chart Test Summary - Visual test result charts
• ReportPortal Analysis - ReportPortal integration
• ReportPortal History - Historical ReportPortal data
• Percy Analysis - Visual regression testing integration
• Custom - Create your own custom extensions

Automation and portal extensions (guides)

These extensions use the name values below in JSON configuration. Full setup and behavior are covered in the guides:

• AI Failure Summary — ai-failure-summary
• Failure Analysis — failure-analysis
• Smart Analysis — smart-analysis
• Error Clusters — error-clusters
• AI Failure Signature — failure-signatures
• browserstack — BrowserStack build and session metadata (JSON inputs only; no separate guide yet)

How Extensions Work

Extensions are modular components that can be added to your TestBeats configuration to enhance the information displayed in your notification targets. They work by:

1. Processing test data - Extensions analyze your test results and extract relevant information
2. Enriching reports - They add context, metadata, and visual elements to your reports
3. Enhancing notifications - Extensions can modify how information is presented in Slack, Teams, and other targets

Extension Configuration

Extensions are configured in your testbeats.json file under the extensions section:

{
  "targets": [
    {
      "name": "slack",
      "inputs": {
        "url": "{SLACK_WEBHOOK_URL}"
      }
    }
  ],
  "extensions": [
    {
      "name": "ci-info"
    },
    {
      "name": "mentions",
      "inputs": {
        "users": [
          {
            "name": "Jon",
            "teams_upn": "[email protected]"
          },
          {
            "name": "qa-team",
            "slack_gid": "UXXXXXXX"
          }
        ]
      }
    }
  ]
}